blob: f29bf50ad0b14040339559c3cb794f01ff32516f [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
130 U-Boot v2010.09-rc1 - Release candiate 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
328- CPU Module Type: (if CONFIG_COGENT is defined)
329 Define exactly one of
330 CONFIG_CMA286_60_OLD
331--- FIXME --- not tested yet:
332 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
333 CONFIG_CMA287_23, CONFIG_CMA287_50
334
335- Motherboard Type: (if CONFIG_COGENT is defined)
336 Define exactly one of
337 CONFIG_CMA101, CONFIG_CMA102
338
339- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
340 Define one or more of
341 CONFIG_CMA302
342
343- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
344 Define one or more of
345 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200346 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000347 a "rotator" |\-/|\-/
348
Lei Wen20014762011-02-09 18:06:58 +0530349- Marvell Family Member
350 CONFIG_SYS_MVFS - define it if you want to enable
351 multiple fs option at one time
352 for marvell soc family
353
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200354- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000355 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
356 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000357 e.g. if there is no 32KHz
358 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000359 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
360 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000361
wdenk20bddb32004-09-28 17:59:53 +0000362- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200363 CONFIG_SYS_8xx_CPUCLK_MIN
364 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000365 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000366 See doc/README.MPC866
367
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200368 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000369
wdenk544e9732004-02-06 23:19:44 +0000370 Define this to measure the actual CPU clock instead
371 of relying on the correctness of the configured
372 values. Mostly useful for board bringup to make sure
373 the PLL is locked at the intended frequency. Note
374 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200375 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000376
Heiko Schocher734f0272009-03-12 07:37:15 +0100377 CONFIG_SYS_DELAYED_ICACHE
378
379 Define this option if you want to enable the
380 ICache only when Code runs from RAM.
381
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600382- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000383 CONFIG_SYS_PPC64
384
385 Specifies that the core is a 64-bit PowerPC implementation (implements
386 the "64" category of the Power ISA). This is necessary for ePAPR
387 compliance, among other possible reasons.
388
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600389 CONFIG_SYS_FSL_TBCLK_DIV
390
391 Defines the core time base clock divider ratio compared to the
392 system clock. On most PQ3 devices this is 8, on newer QorIQ
393 devices it can be 16 or 32. The ratio varies from SoC to Soc.
394
Kumar Gala179b1b22011-05-20 00:39:21 -0500395 CONFIG_SYS_FSL_PCIE_COMPAT
396
397 Defines the string to utilize when trying to match PCIe device
398 tree nodes for the given platform.
399
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000400 CONFIG_SYS_PPC_E500_DEBUG_TLB
401
402 Enables a temporary TLB entry to be used during boot to work
403 around limitations in e500v1 and e500v2 external debugger
404 support. This reduces the portions of the boot code where
405 breakpoints and single stepping do not work. The value of this
406 symbol should be set to the TLB1 entry to be used for this
407 purpose.
408
Scott Wood80806962012-08-14 10:14:53 +0000409 CONFIG_SYS_FSL_ERRATUM_A004510
410
411 Enables a workaround for erratum A004510. If set,
412 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
413 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
414
415 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
416 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
417
418 Defines one or two SoC revisions (low 8 bits of SVR)
419 for which the A004510 workaround should be applied.
420
421 The rest of SVR is either not relevant to the decision
422 of whether the erratum is present (e.g. p2040 versus
423 p2041) or is implied by the build target, which controls
424 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
425
426 See Freescale App Note 4493 for more information about
427 this erratum.
428
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530429 CONFIG_A003399_NOR_WORKAROUND
430 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800431 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530432
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530433 CONFIG_A008044_WORKAROUND
434 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800435 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530436
Scott Wood80806962012-08-14 10:14:53 +0000437 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
438
439 This is the value to write into CCSR offset 0x18600
440 according to the A004510 workaround.
441
Priyanka Jainc73b9032013-07-02 09:21:04 +0530442 CONFIG_SYS_FSL_DSP_DDR_ADDR
443 This value denotes start offset of DDR memory which is
444 connected exclusively to the DSP cores.
445
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530446 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
447 This value denotes start offset of M2 memory
448 which is directly connected to the DSP core.
449
Priyanka Jainc73b9032013-07-02 09:21:04 +0530450 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
451 This value denotes start offset of M3 memory which is directly
452 connected to the DSP core.
453
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530454 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
455 This value denotes start offset of DSP CCSR space.
456
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530457 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
458 Single Source Clock is clocking mode present in some of FSL SoC's.
459 In this mode, a single differential clock is used to supply
460 clocks to the sysclock, ddrclock and usbclock.
461
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530462 CONFIG_SYS_CPC_REINIT_F
463 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800464 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530465
Tang Yuantiana7364af2014-04-17 15:33:46 +0800466 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800467 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800468 supported, core will start to execute uboot when wakes up.
469
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000470- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700471 CONFIG_SYS_GENERIC_GLOBAL_DATA
472 Defines global data is initialized in generic board board_init_f().
473 If this macro is defined, global data is created and cleared in
474 generic board board_init_f(). Without this macro, architecture/board
475 should initialize global data before calling board_init_f().
476
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000477 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
478
479 Defines the endianess of the CPU. Implementation of those
480 values is arch specific.
481
York Sunf0626592013-09-30 09:22:09 -0700482 CONFIG_SYS_FSL_DDR
483 Freescale DDR driver in use. This type of DDR controller is
484 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
485 SoCs.
486
487 CONFIG_SYS_FSL_DDR_ADDR
488 Freescale DDR memory-mapped register base.
489
490 CONFIG_SYS_FSL_DDR_EMU
491 Specify emulator support for DDR. Some DDR features such as
492 deskew training are not available.
493
494 CONFIG_SYS_FSL_DDRC_GEN1
495 Freescale DDR1 controller.
496
497 CONFIG_SYS_FSL_DDRC_GEN2
498 Freescale DDR2 controller.
499
500 CONFIG_SYS_FSL_DDRC_GEN3
501 Freescale DDR3 controller.
502
York Sun2896cb72014-03-27 17:54:47 -0700503 CONFIG_SYS_FSL_DDRC_GEN4
504 Freescale DDR4 controller.
505
York Sun461c9392013-09-30 14:20:51 -0700506 CONFIG_SYS_FSL_DDRC_ARM_GEN3
507 Freescale DDR3 controller for ARM-based SoCs.
508
York Sunf0626592013-09-30 09:22:09 -0700509 CONFIG_SYS_FSL_DDR1
510 Board config to use DDR1. It can be enabled for SoCs with
511 Freescale DDR1 or DDR2 controllers, depending on the board
512 implemetation.
513
514 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400515 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700516 Freescale DDR2 or DDR3 controllers, depending on the board
517 implementation.
518
519 CONFIG_SYS_FSL_DDR3
520 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700521 Freescale DDR3 or DDR3L controllers.
522
523 CONFIG_SYS_FSL_DDR3L
524 Board config to use DDR3L. It can be enabled for SoCs with
525 DDR3L controllers.
526
527 CONFIG_SYS_FSL_DDR4
528 Board config to use DDR4. It can be enabled for SoCs with
529 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700530
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530531 CONFIG_SYS_FSL_IFC_BE
532 Defines the IFC controller register space as Big Endian
533
534 CONFIG_SYS_FSL_IFC_LE
535 Defines the IFC controller register space as Little Endian
536
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530537 CONFIG_SYS_FSL_PBL_PBI
538 It enables addition of RCW (Power on reset configuration) in built image.
539 Please refer doc/README.pblimage for more details
540
541 CONFIG_SYS_FSL_PBL_RCW
542 It adds PBI(pre-boot instructions) commands in u-boot build image.
543 PBI commands can be used to configure SoC before it starts the execution.
544 Please refer doc/README.pblimage for more details
545
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530546 CONFIG_SPL_FSL_PBL
547 It adds a target to create boot binary having SPL binary in PBI format
548 concatenated with u-boot binary.
549
York Sun29647ab2014-02-10 13:59:42 -0800550 CONFIG_SYS_FSL_DDR_BE
551 Defines the DDR controller register space as Big Endian
552
553 CONFIG_SYS_FSL_DDR_LE
554 Defines the DDR controller register space as Little Endian
555
York Sun3a0916d2014-02-10 13:59:43 -0800556 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
557 Physical address from the view of DDR controllers. It is the
558 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
559 it could be different for ARM SoCs.
560
York Sunc459ae62014-02-10 13:59:44 -0800561 CONFIG_SYS_FSL_DDR_INTLV_256B
562 DDR controller interleaving on 256-byte. This is a special
563 interleaving mode, handled by Dickens for Freescale layerscape
564 SoCs with ARM core.
565
York Sun79a779b2014-08-01 15:51:00 -0700566 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
567 Number of controllers used as main memory.
568
569 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
570 Number of controllers used for other than main memory.
571
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530572 CONFIG_SYS_FSL_HAS_DP_DDR
573 Defines the SoC has DP-DDR used for DPAA.
574
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530575 CONFIG_SYS_FSL_SEC_BE
576 Defines the SEC controller register space as Big Endian
577
578 CONFIG_SYS_FSL_SEC_LE
579 Defines the SEC controller register space as Little Endian
580
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100581- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200582 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100583
584 Defines the Monahans run mode to oscillator
585 ratio. Valid values are 8, 16, 24, 31. The core
586 frequency is this value multiplied by 13 MHz.
587
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200588 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200589
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100590 Defines the Monahans turbo mode to oscillator
591 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200592 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100593 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200594
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200595- MIPS CPU options:
596 CONFIG_SYS_INIT_SP_OFFSET
597
598 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
599 pointer. This is needed for the temporary stack before
600 relocation.
601
602 CONFIG_SYS_MIPS_CACHE_MODE
603
604 Cache operation mode for the MIPS CPU.
605 See also arch/mips/include/asm/mipsregs.h.
606 Possible values are:
607 CONF_CM_CACHABLE_NO_WA
608 CONF_CM_CACHABLE_WA
609 CONF_CM_UNCACHED
610 CONF_CM_CACHABLE_NONCOHERENT
611 CONF_CM_CACHABLE_CE
612 CONF_CM_CACHABLE_COW
613 CONF_CM_CACHABLE_CUW
614 CONF_CM_CACHABLE_ACCELERATED
615
616 CONFIG_SYS_XWAY_EBU_BOOTCFG
617
618 Special option for Lantiq XWAY SoCs for booting from NOR flash.
619 See also arch/mips/cpu/mips32/start.S.
620
621 CONFIG_XWAY_SWAP_BYTES
622
623 Enable compilation of tools/xway-swap-bytes needed for Lantiq
624 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
625 be swapped if a flash programmer is used.
626
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000627- ARM options:
628 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
629
630 Select high exception vectors of the ARM core, e.g., do not
631 clear the V bit of the c1 register of CP15.
632
Aneesh Vb8e40802012-03-08 07:20:19 +0000633 CONFIG_SYS_THUMB_BUILD
634
635 Use this flag to build U-Boot using the Thumb instruction
636 set for ARM architectures. Thumb instruction set provides
637 better code density. For ARM architectures that support
638 Thumb2 this flag will result in Thumb2 code generated by
639 GCC.
640
Stephen Warrenc63c3502013-03-04 13:29:40 +0000641 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000642 CONFIG_ARM_ERRATA_742230
643 CONFIG_ARM_ERRATA_743622
644 CONFIG_ARM_ERRATA_751472
Nitin Garg245defa2014-04-02 08:55:02 -0500645 CONFIG_ARM_ERRATA_761320
Ian Campbell363e4242015-09-29 10:27:09 +0100646 CONFIG_ARM_ERRATA_773022
647 CONFIG_ARM_ERRATA_774769
648 CONFIG_ARM_ERRATA_794072
Stephen Warrene9d59c92013-02-26 12:28:27 +0000649
650 If set, the workarounds for these ARM errata are applied early
651 during U-Boot startup. Note that these options force the
652 workarounds to be applied; no CPU-type/version detection
653 exists, unlike the similar options in the Linux kernel. Do not
654 set these options unless they apply!
655
York Sun77a10972015-03-20 19:28:08 -0700656 COUNTER_FREQUENCY
657 Generic timer clock source frequency.
658
659 COUNTER_FREQUENCY_REAL
660 Generic timer clock source frequency if the real clock is
661 different from COUNTER_FREQUENCY, and can only be determined
662 at run time.
663
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500664 NOTE: The following can be machine specific errata. These
665 do have ability to provide rudimentary version and machine
666 specific checks, but expect no product checks.
Nishanth Menon3f445112015-03-09 17:12:01 -0500667 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500668 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500669 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500670 CONFIG_ARM_ERRATA_798870
Nishanth Menon6e2bd2e2015-07-27 16:26:05 -0500671 CONFIG_ARM_ERRATA_801819
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500672
Stephen Warren8d1fb312015-01-19 16:25:52 -0700673- Tegra SoC options:
674 CONFIG_TEGRA_SUPPORT_NON_SECURE
675
676 Support executing U-Boot in non-secure (NS) mode. Certain
677 impossible actions will be skipped if the CPU is in NS mode,
678 such as ARM architectural timer initialization.
679
wdenk9b7f3842003-10-09 20:09:04 +0000680- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000681 CONFIG_CLOCKS_IN_MHZ
682
683 U-Boot stores all clock information in Hz
684 internally. For binary compatibility with older Linux
685 kernels (which expect the clocks passed in the
686 bd_info data to be in MHz) the environment variable
687 "clocks_in_mhz" can be defined so that U-Boot
688 converts clock data to MHZ before passing it to the
689 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000690 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100691 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000692 default environment.
693
wdenk9b7f3842003-10-09 20:09:04 +0000694 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
695
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800696 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000697 expect it to be in bytes, others in MB.
698 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
699
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400700 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200701
702 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400703 passed using flattened device trees (based on open firmware
704 concepts).
705
706 CONFIG_OF_LIBFDT
707 * New libfdt-based support
708 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500709 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400710
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200711 OF_CPU - The proper name of the cpus node (only required for
712 MPC512X and MPC5xxx based boards).
713 OF_SOC - The proper name of the soc node (only required for
714 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200715 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600716 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200717
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200718 boards with QUICC Engines require OF_QE to set UCC MAC
719 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500720
Kumar Gala1e26aa52006-01-11 13:54:17 -0600721 CONFIG_OF_BOARD_SETUP
722
723 Board code has addition modification that it wants to make
724 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000725
Simon Glass6c0be912014-10-23 18:58:54 -0600726 CONFIG_OF_SYSTEM_SETUP
727
728 Other code has addition modification that it wants to make
729 to the flat device tree before handing it off to the kernel.
730 This causes ft_system_setup() to be called before booting
731 the kernel.
732
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500733 CONFIG_OF_BOOT_CPU
734
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200735 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500736 param header, the default value is zero if undefined.
737
Heiko Schocherffb293a2009-09-23 07:56:08 +0200738 CONFIG_OF_IDE_FIXUP
739
740 U-Boot can detect if an IDE device is present or not.
741 If not, and this new config option is activated, U-Boot
742 removes the ATA node from the DTS before booting Linux,
743 so the Linux IDE driver does not probe the device and
744 crash. This is needed for buggy hardware (uc101) where
745 no pull down resistor is connected to the signal IDE5V_DD7.
746
Igor Grinberg06890672011-07-14 05:45:07 +0000747 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
748
749 This setting is mandatory for all boards that have only one
750 machine type and must be used to specify the machine type
751 number as it appears in the ARM machine registry
752 (see http://www.arm.linux.org.uk/developer/machines/).
753 Only boards that have multiple machine types supported
754 in a single configuration file and the machine type is
755 runtime discoverable, do not have to use this setting.
756
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100757- vxWorks boot parameters:
758
759 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700760 environments variables: bootdev, bootfile, ipaddr, netmask,
761 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100762 It loads the vxWorks image pointed bootfile.
763
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100764 Note: If a "bootargs" environment is defined, it will overwride
765 the defaults discussed just above.
766
Aneesh V960f5c02011-06-16 23:30:47 +0000767- Cache Configuration:
768 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
769 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
770 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
771
Aneesh V686a0752011-06-16 23:30:51 +0000772- Cache Configuration for ARM:
773 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
774 controller
775 CONFIG_SYS_PL310_BASE - Physical base address of PL310
776 controller register space
777
wdenkda04a8b2004-08-02 23:22:59 +0000778- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200779 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000780
781 Define this if you want support for Amba PrimeCell PL010 UARTs.
782
Andreas Engel0813b122008-09-08 14:30:53 +0200783 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000784
785 Define this if you want support for Amba PrimeCell PL011 UARTs.
786
787 CONFIG_PL011_CLOCK
788
789 If you have Amba PrimeCell PL011 UARTs, set this variable to
790 the clock speed of the UARTs.
791
792 CONFIG_PL01x_PORTS
793
794 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
795 define this to a list of base addresses for each (supported)
796 port. See e.g. include/configs/versatile.h
797
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400798 CONFIG_SERIAL_HW_FLOW_CONTROL
799
800 Define this variable to enable hw flow control in serial driver.
801 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000802
wdenkc6097192002-11-03 00:24:07 +0000803- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000804 Depending on board, define exactly one serial port
805 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
806 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
807 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000808
809 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
810 port routines must be defined elsewhere
811 (i.e. serial_init(), serial_getc(), ...)
812
813 CONFIG_CFB_CONSOLE
814 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000815 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000816 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
817 (default big endian)
818 VIDEO_HW_RECTFILL graphic chip supports
819 rectangle fill
820 (cf. smiLynxEM)
821 VIDEO_HW_BITBLT graphic chip supports
822 bit-blit (cf. smiLynxEM)
823 VIDEO_VISIBLE_COLS visible pixel columns
824 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000825 VIDEO_VISIBLE_ROWS visible pixel rows
826 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000827 VIDEO_DATA_FORMAT graphic data format
828 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000829 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000830 VIDEO_KBD_INIT_FCT keyboard int fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700831 (i.e. rx51_kp_init())
wdenkc6097192002-11-03 00:24:07 +0000832 VIDEO_TSTC_FCT test char fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700833 (i.e. rx51_kp_tstc)
wdenkc6097192002-11-03 00:24:07 +0000834 VIDEO_GETC_FCT get char fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700835 (i.e. rx51_kp_getc)
wdenkc6097192002-11-03 00:24:07 +0000836 CONFIG_VIDEO_LOGO display Linux logo in
837 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000838 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
839 linux_logo.h for logo.
840 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000841 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200842 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000843 the logo
Tim Harvey98899462016-05-24 14:59:59 -0700844 CONFIG_HIDE_LOGO_VERSION
845 do not display bootloader
846 version string
wdenkc6097192002-11-03 00:24:07 +0000847
Pali Rohár4a57da32012-10-19 13:30:09 +0000848 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
849 a limited number of ANSI escape sequences (cursor control,
850 erase functions and limited graphics rendition control).
851
wdenk4a5c8a72003-03-06 00:02:04 +0000852 When CONFIG_CFB_CONSOLE is defined, video console is
853 default i/o. Serial console can be forced with
854 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000855
wdenk1ebf41e2004-01-02 14:00:00 +0000856 When CONFIG_SILENT_CONSOLE is defined, all console
857 messages (by U-Boot and Linux!) can be silenced with
858 the "silent" environment variable. See
859 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000860
Heiko Schocher62759562013-10-22 11:06:06 +0200861 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
862 is 0x00.
863 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
864 is 0xa0.
865
wdenkc6097192002-11-03 00:24:07 +0000866- Console Baudrate:
867 CONFIG_BAUDRATE - in bps
868 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200869 CONFIG_SYS_BAUDRATE_TABLE, see below.
870 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000871
Heiko Schocher327480a2009-01-30 12:55:38 +0100872- Console Rx buffer length
873 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
874 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100875 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100876 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
877 must be defined, to setup the maximum idle timeout for
878 the SMC.
879
Graeme Russ3c28f482011-09-01 00:48:27 +0000880- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200881 Prior to the console being initialised (i.e. serial UART
882 initialised etc) all console output is silently discarded.
883 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
884 buffer any console messages prior to the console being
885 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
886 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
887 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200888 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200889 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000890
Hans de Goedee355da02015-05-05 13:13:36 +0200891 Note that when printing the buffer a copy is made on the
892 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
893
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200894 'Sane' compilers will generate smaller code if
895 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000896
wdenkc6097192002-11-03 00:24:07 +0000897- Autoboot Command:
898 CONFIG_BOOTCOMMAND
899 Only needed when CONFIG_BOOTDELAY is enabled;
900 define a command string that is automatically executed
901 when no character is read on the console interface
902 within "Boot Delay" after reset.
903
904 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000905 This can be used to pass arguments to the bootm
906 command. The value of CONFIG_BOOTARGS goes into the
907 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000908
909 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000910 The value of these goes into the environment as
911 "ramboot" and "nfsboot" respectively, and can be used
912 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200913 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000914
Heiko Schocher040c5c32013-11-04 14:04:59 +0100915- Bootcount:
916 CONFIG_BOOTCOUNT_LIMIT
917 Implements a mechanism for detecting a repeating reboot
918 cycle, see:
919 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
920
921 CONFIG_BOOTCOUNT_ENV
922 If no softreset save registers are found on the hardware
923 "bootcount" is stored in the environment. To prevent a
924 saveenv on all reboots, the environment variable
925 "upgrade_available" is used. If "upgrade_available" is
926 0, "bootcount" is always 0, if "upgrade_available" is
927 1 "bootcount" is incremented in the environment.
928 So the Userspace Applikation must set the "upgrade_available"
929 and "bootcount" variable to 0, if a boot was successfully.
930
wdenkc6097192002-11-03 00:24:07 +0000931- Pre-Boot Commands:
932 CONFIG_PREBOOT
933
934 When this option is #defined, the existence of the
935 environment variable "preboot" will be checked
936 immediately before starting the CONFIG_BOOTDELAY
937 countdown and/or running the auto-boot command resp.
938 entering interactive mode.
939
940 This feature is especially useful when "preboot" is
941 automatically generated or modified. For an example
942 see the LWMON board specific code: here "preboot" is
943 modified when the user holds down a certain
944 combination of keys on the (special) keyboard when
945 booting the systems
946
947- Serial Download Echo Mode:
948 CONFIG_LOADS_ECHO
949 If defined to 1, all characters received during a
950 serial download (using the "loads" command) are
951 echoed back. This might be needed by some terminal
952 emulations (like "cu"), but may as well just take
953 time on others. This setting #define's the initial
954 value of the "loads_echo" environment variable.
955
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500956- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000957 CONFIG_KGDB_BAUDRATE
958 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200959 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000960
961- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500962 Monitor commands can be included or excluded
963 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000964 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500965 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000966
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500967 The default command configuration includes all commands
968 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000969
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100970 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500971 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500972 CONFIG_CMD_BDI bdinfo
973 CONFIG_CMD_BEDBUG * Include BedBug Debugger
974 CONFIG_CMD_BMP * BMP support
975 CONFIG_CMD_BSP * Board specific commands
976 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400977 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500978 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800979 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500980 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500981 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500982 CONFIG_CMD_DATE * support for RTC, date/time...
983 CONFIG_CMD_DHCP * DHCP support
984 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600985 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
986 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
987 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
988 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500989 CONFIG_CMD_DTT * Digital Therm and Thermostat
990 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500991 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500992 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanov37dda1c2016-04-16 17:55:03 +0300993 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500994 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600995 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600996 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500997 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500998 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000999 CONFIG_CMD_EXT2 * ext2 command support
1000 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001001 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1002 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001003 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001004 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001005 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001006 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001007 CONFIG_CMD_FLASH flinfo, erase, protect
1008 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001009 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001010 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001011 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001012 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001013 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001014 CONFIG_CMD_I2C * I2C serial bus support
1015 CONFIG_CMD_IDE * IDE harddisk support
1016 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001017 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001018 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001019 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001020 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001021 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001022 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001023 CONFIG_CMD_IRQ * irqinfo
1024 CONFIG_CMD_ITEST Integer/string test of 2 values
1025 CONFIG_CMD_JFFS2 * JFFS2 Support
1026 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001027 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001028 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1029 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001030 CONFIG_CMD_LOADB loadb
1031 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001032 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001033 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001034 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001035 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001036 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001037 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001038 CONFIG_CMD_MISC Misc functions like sleep etc
1039 CONFIG_CMD_MMC * MMC memory mapped support
1040 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001041 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001042 CONFIG_CMD_NAND * NAND support
1043 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001044 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001045 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001046 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001047 CONFIG_CMD_PCI * pciinfo
1048 CONFIG_CMD_PCMCIA * PCMCIA support
1049 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1050 host
1051 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001052 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001053 CONFIG_CMD_REGINFO * Register dump
1054 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001055 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001056 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -06001057 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001058 CONFIG_CMD_SDRAM * print SDRAM configuration information
1059 (requires CONFIG_CMD_I2C)
1060 CONFIG_CMD_SETGETDCR Support for DCR Register access
1061 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001062 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001063 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001064 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001065 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001066 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001067 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001068 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001069 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001070 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1071 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001072 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001073 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001074 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001075 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001076 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001077
1078 EXAMPLE: If you want all functions except of network
1079 support you can write:
1080
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001081 #include "config_cmd_all.h"
1082 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001083
Gerald Van Barend6abef42007-03-31 12:23:51 -04001084 Other Commands:
1085 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001086
1087 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001088 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001089 what you (and your U-Boot users) are doing. Data
1090 cache cannot be enabled on systems like the 8xx or
1091 8260 (where accesses to the IMMR region must be
1092 uncached), and it cannot be disabled on all other
1093 systems where we (mis-) use the data cache to hold an
1094 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001095
1096
1097 XXX - this list needs to get updated!
1098
Simon Glassaa34ef22016-03-13 19:07:28 -06001099- Removal of commands
1100 If no commands are needed to boot, you can disable
1101 CONFIG_CMDLINE to remove them. In this case, the command line
1102 will not be available, and when U-Boot wants to execute the
1103 boot command (on start-up) it will call board_run_command()
1104 instead. This can reduce image size significantly for very
1105 simple boot procedures.
1106
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001107- Regular expression support:
1108 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001109 If this variable is defined, U-Boot is linked against
1110 the SLRE (Super Light Regular Expression) library,
1111 which adds regex support to some commands, as for
1112 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001113
Simon Glass3d686442011-10-15 05:48:20 +00001114- Device tree:
1115 CONFIG_OF_CONTROL
1116 If this variable is defined, U-Boot will use a device tree
1117 to configure its devices, instead of relying on statically
1118 compiled #defines in the board file. This option is
1119 experimental and only available on a few boards. The device
1120 tree is available in the global data as gd->fdt_blob.
1121
Simon Glass5cb34db2011-10-24 19:15:31 +00001122 U-Boot needs to get its device tree from somewhere. This can
1123 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001124
1125 CONFIG_OF_EMBED
1126 If this variable is defined, U-Boot will embed a device tree
1127 binary in its image. This device tree file should be in the
1128 board directory and called <soc>-<board>.dts. The binary file
1129 is then picked up in board_init_f() and made available through
1130 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001131
Simon Glass5cb34db2011-10-24 19:15:31 +00001132 CONFIG_OF_SEPARATE
1133 If this variable is defined, U-Boot will build a device tree
1134 binary. It will be called u-boot.dtb. Architecture-specific
1135 code will locate it at run-time. Generally this works by:
1136
1137 cat u-boot.bin u-boot.dtb >image.bin
1138
1139 and in fact, U-Boot does this for you, creating a file called
1140 u-boot-dtb.bin which is useful in the common case. You can
1141 still use the individual files if you need something more
1142 exotic.
1143
wdenkc6097192002-11-03 00:24:07 +00001144- Watchdog:
1145 CONFIG_WATCHDOG
1146 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001147 support for the SoC. There must be support in the SoC
1148 specific code for a watchdog. For the 8xx and 8260
1149 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1150 register. When supported for a specific SoC is
1151 available, then no further board specific code should
1152 be needed to use it.
1153
1154 CONFIG_HW_WATCHDOG
1155 When using a watchdog circuitry external to the used
1156 SoC, then define this variable and provide board
1157 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001158
Heiko Schocher735326c2015-01-21 08:38:22 +01001159 CONFIG_AT91_HW_WDT_TIMEOUT
1160 specify the timeout in seconds. default 2 seconds.
1161
stroeseb9c17c52003-04-04 15:53:41 +00001162- U-Boot Version:
1163 CONFIG_VERSION_VARIABLE
1164 If this variable is defined, an environment variable
1165 named "ver" is created by U-Boot showing the U-Boot
1166 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001167 Any change to this variable will be reverted at the
1168 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001169
wdenkc6097192002-11-03 00:24:07 +00001170- Real-Time Clock:
1171
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001172 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001173 has to be selected, too. Define exactly one of the
1174 following options:
1175
1176 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1177 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001178 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001179 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001180 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001181 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001182 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001183 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001184 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001185 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001186 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001187 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001188 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1189 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001190
wdenkb9bbd242003-06-30 16:24:52 +00001191 Note that if the RTC uses I2C, then the I2C interface
1192 must also be configured. See I2C Support, below.
1193
Peter Tyser9902e422008-12-17 16:36:21 -06001194- GPIO Support:
1195 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001196
Chris Packham9b383202010-12-19 10:12:13 +00001197 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1198 chip-ngpio pairs that tell the PCA953X driver the number of
1199 pins supported by a particular chip.
1200
Peter Tyser9902e422008-12-17 16:36:21 -06001201 Note that if the GPIO device uses I2C, then the I2C interface
1202 must also be configured. See I2C Support, below.
1203
Simon Glass4dc47ca2014-06-11 23:29:41 -06001204- I/O tracing:
1205 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1206 accesses and can checksum them or write a list of them out
1207 to memory. See the 'iotrace' command for details. This is
1208 useful for testing device drivers since it can confirm that
1209 the driver behaves the same way before and after a code
1210 change. Currently this is supported on sandbox and arm. To
1211 add support for your architecture, add '#include <iotrace.h>'
1212 to the bottom of arch/<arch>/include/asm/io.h and test.
1213
1214 Example output from the 'iotrace stats' command is below.
1215 Note that if the trace buffer is exhausted, the checksum will
1216 still continue to operate.
1217
1218 iotrace is enabled
1219 Start: 10000000 (buffer start address)
1220 Size: 00010000 (buffer size)
1221 Offset: 00000120 (current buffer offset)
1222 Output: 10000120 (start + offset)
1223 Count: 00000018 (number of trace records)
1224 CRC32: 9526fb66 (CRC32 of all trace records)
1225
wdenkc6097192002-11-03 00:24:07 +00001226- Timestamp Support:
1227
wdenk4a5c8a72003-03-06 00:02:04 +00001228 When CONFIG_TIMESTAMP is selected, the timestamp
1229 (date and time) of an image is printed by image
1230 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001231 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001232
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001233- Partition Labels (disklabels) Supported:
1234 Zero or more of the following:
1235 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1236 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1237 Intel architecture, USB sticks, etc.
1238 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1239 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1240 bootloader. Note 2TB partition limit; see
1241 disk/part_efi.c
1242 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001243
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001244 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001245 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001246 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001247
1248- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001249 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1250 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001251
wdenk369d43d2004-03-14 14:09:05 +00001252 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1253 be performed by calling the function
1254 ide_set_reset(int reset)
1255 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001256
1257- ATAPI Support:
1258 CONFIG_ATAPI
1259
1260 Set this to enable ATAPI support.
1261
wdenkf602aa02004-03-13 23:29:43 +00001262- LBA48 Support
1263 CONFIG_LBA48
1264
1265 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001266 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001267 Whithout these , LBA48 support uses 32bit variables and will 'only'
1268 support disks up to 2.1TB.
1269
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001270 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001271 When enabled, makes the IDE subsystem use 64bit sector addresses.
1272 Default is 32bit.
1273
wdenkc6097192002-11-03 00:24:07 +00001274- SCSI Support:
1275 At the moment only there is only support for the
1276 SYM53C8XX SCSI controller; define
1277 CONFIG_SCSI_SYM53C8XX to enable it.
1278
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001279 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1280 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1281 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001282 maximum numbers of LUNs, SCSI ID's and target
1283 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001284 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001285
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001286 The environment variable 'scsidevs' is set to the number of
1287 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001288
wdenkc6097192002-11-03 00:24:07 +00001289- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001290 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001291 Support for Intel 8254x/8257x gigabit chips.
1292
1293 CONFIG_E1000_SPI
1294 Utility code for direct access to the SPI bus on Intel 8257x.
1295 This does not do anything useful unless you set at least one
1296 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1297
1298 CONFIG_E1000_SPI_GENERIC
1299 Allow generic access to the SPI bus on the Intel 8257x, for
1300 example with the "sspi" command.
1301
1302 CONFIG_CMD_E1000
1303 Management command for E1000 devices. When used on devices
1304 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001305
wdenkc6097192002-11-03 00:24:07 +00001306 CONFIG_EEPRO100
1307 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001308 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001309 write routine for first time initialisation.
1310
1311 CONFIG_TULIP
1312 Support for Digital 2114x chips.
1313 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1314 modem chip initialisation (KS8761/QS6611).
1315
1316 CONFIG_NATSEMI
1317 Support for National dp83815 chips.
1318
1319 CONFIG_NS8382X
1320 Support for National dp8382[01] gigabit chips.
1321
wdenkaa603362003-05-12 21:50:16 +00001322- NETWORK Support (other):
1323
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001324 CONFIG_DRIVER_AT91EMAC
1325 Support for AT91RM9200 EMAC.
1326
1327 CONFIG_RMII
1328 Define this to use reduced MII inteface
1329
1330 CONFIG_DRIVER_AT91EMAC_QUIET
1331 If this defined, the driver is quiet.
1332 The driver doen't show link status messages.
1333
Rob Herringc9830dc2011-12-15 11:15:49 +00001334 CONFIG_CALXEDA_XGMAC
1335 Support for the Calxeda XGMAC device
1336
Ashok93fb8722012-10-15 06:20:47 +00001337 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001338 Support for SMSC's LAN91C96 chips.
1339
1340 CONFIG_LAN91C96_BASE
1341 Define this to hold the physical address
1342 of the LAN91C96's I/O space
1343
1344 CONFIG_LAN91C96_USE_32_BIT
1345 Define this to enable 32 bit addressing
1346
Ashok93fb8722012-10-15 06:20:47 +00001347 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001348 Support for SMSC's LAN91C111 chip
1349
1350 CONFIG_SMC91111_BASE
1351 Define this to hold the physical address
1352 of the device (I/O space)
1353
1354 CONFIG_SMC_USE_32_BIT
1355 Define this if data bus is 32 bits
1356
1357 CONFIG_SMC_USE_IOFUNCS
1358 Define this to use i/o functions instead of macros
1359 (some hardware wont work with macros)
1360
Heiko Schocher7d037f72011-11-15 10:00:04 -05001361 CONFIG_DRIVER_TI_EMAC
1362 Support for davinci emac
1363
1364 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1365 Define this if you have more then 3 PHYs.
1366
Macpaul Lin199c6252010-12-21 16:59:46 +08001367 CONFIG_FTGMAC100
1368 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1369
1370 CONFIG_FTGMAC100_EGIGA
1371 Define this to use GE link update with gigabit PHY.
1372 Define this if FTGMAC100 is connected to gigabit PHY.
1373 If your system has 10/100 PHY only, it might not occur
1374 wrong behavior. Because PHY usually return timeout or
1375 useless data when polling gigabit status and gigabit
1376 control registers. This behavior won't affect the
1377 correctnessof 10/100 link speed update.
1378
Mike Rapoportf4761af2009-11-11 10:03:03 +02001379 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001380 Support for SMSC's LAN911x and LAN921x chips
1381
Mike Rapoportf4761af2009-11-11 10:03:03 +02001382 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001383 Define this to hold the physical address
1384 of the device (I/O space)
1385
Mike Rapoportf4761af2009-11-11 10:03:03 +02001386 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001387 Define this if data bus is 32 bits
1388
Mike Rapoportf4761af2009-11-11 10:03:03 +02001389 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001390 Define this if data bus is 16 bits. If your processor
1391 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001392 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001393
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001394 CONFIG_SH_ETHER
1395 Support for Renesas on-chip Ethernet controller
1396
1397 CONFIG_SH_ETHER_USE_PORT
1398 Define the number of ports to be used
1399
1400 CONFIG_SH_ETHER_PHY_ADDR
1401 Define the ETH PHY's address
1402
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001403 CONFIG_SH_ETHER_CACHE_WRITEBACK
1404 If this option is set, the driver enables cache flush.
1405
Heiko Schocher2b387762014-07-18 06:07:19 +02001406- PWM Support:
1407 CONFIG_PWM_IMX
1408 Support for PWM modul on the imx6.
1409
Vadim Bendeburydac69642011-10-17 08:36:14 +00001410- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001411 CONFIG_TPM
1412 Support TPM devices.
1413
Christophe Ricard8759ff82015-10-06 22:54:41 +02001414 CONFIG_TPM_TIS_INFINEON
1415 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001416 per system is supported at this time.
1417
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001418 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1419 Define the burst count bytes upper limit
1420
Christophe Ricard88249232016-01-21 23:27:13 +01001421 CONFIG_TPM_ST33ZP24
1422 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1423
1424 CONFIG_TPM_ST33ZP24_I2C
1425 Support for STMicroelectronics ST33ZP24 I2C devices.
1426 Requires TPM_ST33ZP24 and I2C.
1427
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001428 CONFIG_TPM_ST33ZP24_SPI
1429 Support for STMicroelectronics ST33ZP24 SPI devices.
1430 Requires TPM_ST33ZP24 and SPI.
1431
Dirk Eibach20489092013-06-26 15:55:15 +02001432 CONFIG_TPM_ATMEL_TWI
1433 Support for Atmel TWI TPM device. Requires I2C support.
1434
Che-liang Chiouacea5702013-04-12 11:04:34 +00001435 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001436 Support for generic parallel port TPM devices. Only one device
1437 per system is supported at this time.
1438
1439 CONFIG_TPM_TIS_BASE_ADDRESS
1440 Base address where the generic TPM device is mapped
1441 to. Contemporary x86 systems usually map it at
1442 0xfed40000.
1443
Reinhard Pfau4fece432013-06-26 15:55:13 +02001444 CONFIG_CMD_TPM
1445 Add tpm monitor functions.
1446 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1447 provides monitor access to authorized functions.
1448
1449 CONFIG_TPM
1450 Define this to enable the TPM support library which provides
1451 functional interfaces to some TPM commands.
1452 Requires support for a TPM device.
1453
1454 CONFIG_TPM_AUTH_SESSIONS
1455 Define this to enable authorized functions in the TPM library.
1456 Requires CONFIG_TPM and CONFIG_SHA1.
1457
wdenkc6097192002-11-03 00:24:07 +00001458- USB Support:
1459 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001460 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001461 CONFIG_USB_UHCI to enable it.
1462 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001463 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001464 storage devices.
1465 Note:
1466 Supported are USB Keyboards and USB Floppy drives
1467 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001468 MPC5200 USB requires additional defines:
1469 CONFIG_USB_CLOCK
1470 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001471 CONFIG_PSC3_USB
1472 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001473 CONFIG_USB_CONFIG
1474 for differential drivers: 0x00001000
1475 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001476 for differential drivers on PSC3: 0x00000100
1477 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001478 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001479 May be defined to allow interrupt polling
1480 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001481
Simon Glass5978cdb2012-02-27 10:52:47 +00001482 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1483 txfilltuning field in the EHCI controller on reset.
1484
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001485 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1486 HW module registers.
1487
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001488- USB Device:
1489 Define the below if you wish to use the USB console.
1490 Once firmware is rebuilt from a serial console issue the
1491 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001492 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001493 it has found a new device. The environment variable usbtty
1494 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001495 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001496 Common Device Class Abstract Control Model serial device.
1497 If you select usbtty = gserial you should be able to enumerate
1498 a Linux host by
1499 # modprobe usbserial vendor=0xVendorID product=0xProductID
1500 else if using cdc_acm, simply setting the environment
1501 variable usbtty to be cdc_acm should suffice. The following
1502 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001503
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001504 CONFIG_USB_DEVICE
1505 Define this to build a UDC device
1506
1507 CONFIG_USB_TTY
1508 Define this to have a tty type of device available to
1509 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001510
Vipin KUMARbdb17702012-03-26 15:38:06 +05301511 CONFIG_USBD_HS
1512 Define this to enable the high speed support for usb
1513 device and usbtty. If this feature is enabled, a routine
1514 int is_usbd_high_speed(void)
1515 also needs to be defined by the driver to dynamically poll
1516 whether the enumeration has succeded at high speed or full
1517 speed.
1518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001519 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001520 Define this if you want stdin, stdout &/or stderr to
1521 be set to usbtty.
1522
1523 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001524 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001525 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001526 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001527
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001528 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001529 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001530 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001531
Wolfgang Denke2601822006-06-14 18:14:56 +02001532 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001533 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001534 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001535 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1536 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1537 should pretend to be a Linux device to it's target host.
1538
1539 CONFIG_USBD_MANUFACTURER
1540 Define this string as the name of your company for
1541 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001542
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001543 CONFIG_USBD_PRODUCT_NAME
1544 Define this string as the name of your product
1545 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001546
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001547 CONFIG_USBD_VENDORID
1548 Define this as your assigned Vendor ID from the USB
1549 Implementors Forum. This *must* be a genuine Vendor ID
1550 to avoid polluting the USB namespace.
1551 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001552
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001553 CONFIG_USBD_PRODUCTID
1554 Define this as the unique Product ID
1555 for your device
1556 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001557
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001558- ULPI Layer Support:
1559 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1560 the generic ULPI layer. The generic layer accesses the ULPI PHY
1561 via the platform viewport, so you need both the genric layer and
1562 the viewport enabled. Currently only Chipidea/ARC based
1563 viewport is supported.
1564 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1565 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001566 If your ULPI phy needs a different reference clock than the
1567 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1568 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001569
wdenk7a428cc2003-06-15 22:40:42 +00001570- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001571 The MMC controller on the Intel PXA is supported. To
1572 enable this define CONFIG_MMC. The MMC can be
1573 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001574 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001575 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1576 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001577
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001578 CONFIG_SH_MMCIF
1579 Support for Renesas on-chip MMCIF controller
1580
1581 CONFIG_SH_MMCIF_ADDR
1582 Define the base address of MMCIF registers
1583
1584 CONFIG_SH_MMCIF_CLK
1585 Define the clock frequency for MMCIF
1586
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001587 CONFIG_GENERIC_MMC
1588 Enable the generic MMC driver
1589
1590 CONFIG_SUPPORT_EMMC_BOOT
1591 Enable some additional features of the eMMC boot partitions.
1592
1593 CONFIG_SUPPORT_EMMC_RPMB
1594 Enable the commands for reading, writing and programming the
1595 key for the Replay Protection Memory Block partition in eMMC.
1596
Tom Rini58a8d322013-03-14 05:32:47 +00001597- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001598 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001599 This enables the USB portion of the DFU USB class
1600
1601 CONFIG_CMD_DFU
1602 This enables the command "dfu" which is used to have
1603 U-Boot create a DFU class device via USB. This command
1604 requires that the "dfu_alt_info" environment variable be
1605 set and define the alt settings to expose to the host.
1606
1607 CONFIG_DFU_MMC
1608 This enables support for exposing (e)MMC devices via DFU.
1609
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001610 CONFIG_DFU_NAND
1611 This enables support for exposing NAND devices via DFU.
1612
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301613 CONFIG_DFU_RAM
1614 This enables support for exposing RAM via DFU.
1615 Note: DFU spec refer to non-volatile memory usage, but
1616 allow usages beyond the scope of spec - here RAM usage,
1617 one that would help mostly the developer.
1618
Heiko Schochera2f831e2013-06-12 06:05:51 +02001619 CONFIG_SYS_DFU_DATA_BUF_SIZE
1620 Dfu transfer uses a buffer before writing data to the
1621 raw storage device. Make the size (in bytes) of this buffer
1622 configurable. The size of this buffer is also configurable
1623 through the "dfu_bufsiz" environment variable.
1624
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001625 CONFIG_SYS_DFU_MAX_FILE_SIZE
1626 When updating files rather than the raw storage device,
1627 we use a static buffer to copy the file into and then write
1628 the buffer once we've been given the whole file. Define
1629 this to the maximum filesize (in bytes) for the buffer.
1630 Default is 4 MiB if undefined.
1631
Heiko Schochere1ba1512014-03-18 08:09:56 +01001632 DFU_DEFAULT_POLL_TIMEOUT
1633 Poll timeout [ms], is the timeout a device can send to the
1634 host. The host must wait for this timeout before sending
1635 a subsequent DFU_GET_STATUS request to the device.
1636
1637 DFU_MANIFEST_POLL_TIMEOUT
1638 Poll timeout [ms], which the device sends to the host when
1639 entering dfuMANIFEST state. Host waits this timeout, before
1640 sending again an USB request to the device.
1641
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001642- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001643 CONFIG_USB_FUNCTION_FASTBOOT
1644 This enables the USB part of the fastboot gadget
1645
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001646 CONFIG_CMD_FASTBOOT
1647 This enables the command "fastboot" which enables the Android
1648 fastboot mode for the platform's USB device. Fastboot is a USB
1649 protocol for downloading images, flashing and device control
1650 used on Android devices.
1651 See doc/README.android-fastboot for more information.
1652
1653 CONFIG_ANDROID_BOOT_IMAGE
1654 This enables support for booting images which use the Android
1655 image format header.
1656
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001657 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001658 The fastboot protocol requires a large memory buffer for
1659 downloads. Define this to the starting RAM address to use for
1660 downloaded images.
1661
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001662 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001663 The fastboot protocol requires a large memory buffer for
1664 downloads. This buffer should be as large as possible for a
1665 platform. Define this to the size available RAM for fastboot.
1666
Steve Raebfb9ba42014-08-26 11:47:28 -07001667 CONFIG_FASTBOOT_FLASH
1668 The fastboot protocol includes a "flash" command for writing
1669 the downloaded image to a non-volatile storage device. Define
1670 this to enable the "fastboot flash" command.
1671
1672 CONFIG_FASTBOOT_FLASH_MMC_DEV
1673 The fastboot "flash" command requires additional information
1674 regarding the non-volatile storage device. Define this to
1675 the eMMC device that fastboot should use to store the image.
1676
Steve Rae7d059342014-12-12 15:51:54 -08001677 CONFIG_FASTBOOT_GPT_NAME
1678 The fastboot "flash" command supports writing the downloaded
1679 image to the Protective MBR and the Primary GUID Partition
1680 Table. (Additionally, this downloaded image is post-processed
1681 to generate and write the Backup GUID Partition Table.)
1682 This occurs when the specified "partition name" on the
1683 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001684 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001685
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001686 CONFIG_FASTBOOT_MBR_NAME
1687 The fastboot "flash" command supports writing the downloaded
1688 image to DOS MBR.
1689 This occurs when the "partition name" specified on the
1690 "fastboot flash" command line matches this value.
1691 If not defined the default value "mbr" is used.
1692
wdenkda04a8b2004-08-02 23:22:59 +00001693- Journaling Flash filesystem support:
1694 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1695 CONFIG_JFFS2_NAND_DEV
1696 Define these for a default partition on a NAND device
1697
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001698 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1699 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001700 Define these for a default partition on a NOR device
1701
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001702 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001703 Define this to create an own partition. You have to provide a
1704 function struct part_info* jffs2_part_info(int part_num)
1705
1706 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001707 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001708 to disable the command chpart. This is the default when you
1709 have not defined a custom partition
1710
Donggeun Kim8f814002011-10-24 21:15:28 +00001711- FAT(File Allocation Table) filesystem write function support:
1712 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001713
1714 Define this to enable support for saving memory data as a
1715 file in FAT formatted partition.
1716
1717 This will also enable the command "fatwrite" enabling the
1718 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001719
Gabe Black7f8574c2012-10-12 14:26:11 +00001720CBFS (Coreboot Filesystem) support
1721 CONFIG_CMD_CBFS
1722
1723 Define this to enable support for reading from a Coreboot
1724 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1725 and cbfsload.
1726
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301727- FAT(File Allocation Table) filesystem cluster size:
1728 CONFIG_FS_FAT_MAX_CLUSTSIZE
1729
1730 Define the max cluster size for fat operations else
1731 a default value of 65536 will be defined.
1732
wdenkc6097192002-11-03 00:24:07 +00001733- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001734 See Kconfig help for available keyboard drivers.
1735
1736 CONFIG_KEYBOARD
1737
1738 Define this to enable a custom keyboard support.
1739 This simply calls drv_keyboard_init() which must be
1740 defined in your board-specific files. This option is deprecated
1741 and is only used by novena. For new boards, use driver model
1742 instead.
wdenkc6097192002-11-03 00:24:07 +00001743
1744- Video support:
1745 CONFIG_VIDEO
1746
1747 Define this to enable video support (for output to
1748 video).
1749
1750 CONFIG_VIDEO_CT69000
1751
1752 Enable Chips & Technologies 69000 Video chip
1753
1754 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001755 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001756 video output is selected via environment 'videoout'
1757 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1758 assumed.
wdenkc6097192002-11-03 00:24:07 +00001759
wdenkd3602132004-03-25 15:14:43 +00001760 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001761 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001762 are possible:
1763 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001764 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001765
1766 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1767 -------------+---------------------------------------------
1768 8 bits | 0x301* 0x303 0x305 0x161 0x307
1769 15 bits | 0x310 0x313 0x316 0x162 0x319
1770 16 bits | 0x311 0x314 0x317 0x163 0x31A
1771 24 bits | 0x312 0x315 0x318 ? 0x31B
1772 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001773 (i.e. setenv videomode 317; saveenv; reset;)
1774
wdenkd3602132004-03-25 15:14:43 +00001775 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001776 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001777
1778
stroeseb9c17c52003-04-04 15:53:41 +00001779 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001780 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001781 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1782 or CONFIG_VIDEO_SED13806_16BPP
1783
Timur Tabi020edd22011-02-15 17:09:19 -06001784 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001785 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001786 SOCs that have a DIU should define this macro to enable DIU
1787 support, and should also define these other macros:
1788
1789 CONFIG_SYS_DIU_ADDR
1790 CONFIG_VIDEO
1791 CONFIG_CMD_BMP
1792 CONFIG_CFB_CONSOLE
1793 CONFIG_VIDEO_SW_CURSOR
1794 CONFIG_VGA_AS_SINGLE_DEVICE
1795 CONFIG_VIDEO_LOGO
1796 CONFIG_VIDEO_BMP_LOGO
1797
Timur Tabi32f709e2011-04-11 14:18:22 -05001798 The DIU driver will look for the 'video-mode' environment
1799 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001800 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001801 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001802
wdenkc6097192002-11-03 00:24:07 +00001803- LCD Support: CONFIG_LCD
1804
1805 Define this to enable LCD support (for output to LCD
1806 display); also select one of the supported displays
1807 by defining one of these:
1808
Stelian Popf6f86652008-05-09 21:57:18 +02001809 CONFIG_ATMEL_LCD:
1810
1811 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1812
wdenkc0d54ae2003-11-25 16:55:19 +00001813 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001814
wdenkc0d54ae2003-11-25 16:55:19 +00001815 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001816
wdenkc0d54ae2003-11-25 16:55:19 +00001817 CONFIG_NEC_NL6448BC20
1818
1819 NEC NL6448BC20-08. 6.5", 640x480.
1820 Active, color, single scan.
1821
1822 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001823
wdenkc0d54ae2003-11-25 16:55:19 +00001824 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001825 Active, color, single scan.
1826
1827 CONFIG_SHARP_16x9
1828
1829 Sharp 320x240. Active, color, single scan.
1830 It isn't 16x9, and I am not sure what it is.
1831
1832 CONFIG_SHARP_LQ64D341
1833
1834 Sharp LQ64D341 display, 640x480.
1835 Active, color, single scan.
1836
1837 CONFIG_HLD1045
1838
1839 HLD1045 display, 640x480.
1840 Active, color, single scan.
1841
1842 CONFIG_OPTREX_BW
1843
1844 Optrex CBL50840-2 NF-FW 99 22 M5
1845 or
1846 Hitachi LMG6912RPFC-00T
1847 or
1848 Hitachi SP14Q002
1849
1850 320x240. Black & white.
1851
1852 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001853 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001854
Simon Glass599a4df2012-10-17 13:24:54 +00001855 CONFIG_LCD_ALIGNMENT
1856
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001857 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001858 defined then the LCD will be aligned to this value instead.
1859 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1860 here, since it is cheaper to change data cache settings on
1861 a per-section basis.
1862
Simon Glassaf3e2802012-10-17 13:24:59 +00001863 CONFIG_CONSOLE_SCROLL_LINES
1864
1865 When the console need to be scrolled, this is the number of
1866 lines to scroll by. It defaults to 1. Increasing this makes
1867 the console jump but can help speed up operation when scrolling
1868 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001869
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001870 CONFIG_LCD_ROTATION
1871
1872 Sometimes, for example if the display is mounted in portrait
1873 mode or even if it's mounted landscape but rotated by 180degree,
1874 we need to rotate our content of the display relative to the
1875 framebuffer, so that user can read the messages which are
1876 printed out.
1877 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1878 initialized with a given rotation from "vl_rot" out of
1879 "vidinfo_t" which is provided by the board specific code.
1880 The value for vl_rot is coded as following (matching to
1881 fbcon=rotate:<n> linux-kernel commandline):
1882 0 = no rotation respectively 0 degree
1883 1 = 90 degree rotation
1884 2 = 180 degree rotation
1885 3 = 270 degree rotation
1886
1887 If CONFIG_LCD_ROTATION is not defined, the console will be
1888 initialized with 0degree rotation.
1889
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001890 CONFIG_LCD_BMP_RLE8
1891
1892 Support drawing of RLE8-compressed bitmaps on the LCD.
1893
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001894 CONFIG_I2C_EDID
1895
1896 Enables an 'i2c edid' command which can read EDID
1897 information over I2C from an attached LCD display.
1898
wdenkeb20ad32003-09-05 23:19:14 +00001899- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001900
wdenk57b2d802003-06-27 21:31:46 +00001901 If this option is set, the environment is checked for
1902 a variable "splashimage". If found, the usual display
1903 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001904 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001905 specified in "splashimage" is loaded instead. The
1906 console is redirected to the "nulldev", too. This
1907 allows for a "silent" boot where a splash screen is
1908 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001909
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001910 CONFIG_SPLASHIMAGE_GUARD
1911
1912 If this option is set, then U-Boot will prevent the environment
1913 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001914 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001915 This option is useful for targets where, due to alignment
1916 restrictions, an improperly aligned BMP image will cause a data
1917 abort. If you think you will not have problems with unaligned
1918 accesses (for example because your toolchain prevents them)
1919 there is no need to set this option.
1920
Matthias Weisser53884182009-07-09 16:07:30 +02001921 CONFIG_SPLASH_SCREEN_ALIGN
1922
1923 If this option is set the splash image can be freely positioned
1924 on the screen. Environment variable "splashpos" specifies the
1925 position as "x,y". If a positive number is given it is used as
1926 number of pixel from left/top. If a negative number is given it
1927 is used as number of pixel from right/bottom. You can also
1928 specify 'm' for centering the image.
1929
1930 Example:
1931 setenv splashpos m,m
1932 => image at center of screen
1933
1934 setenv splashpos 30,20
1935 => image at x = 30 and y = 20
1936
1937 setenv splashpos -10,m
1938 => vertically centered image
1939 at x = dspWidth - bmpWidth - 9
1940
Stefan Roesed9d97742005-09-22 09:04:17 +02001941- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1942
1943 If this option is set, additionally to standard BMP
1944 images, gzipped BMP images can be displayed via the
1945 splashscreen support or the bmp command.
1946
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001947- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1948
1949 If this option is set, 8-bit RLE compressed BMP images
1950 can be displayed via the splashscreen support or the
1951 bmp command.
1952
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001953- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001954 CONFIG_CMD_ZIP
1955
1956 If this option is set, it would use zlib deflate method
1957 to compress the specified memory at its best effort.
1958
wdenk710e3502003-08-29 20:57:53 +00001959- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001960 CONFIG_GZIP
1961
1962 Enabled by default to support gzip compressed images.
1963
wdenk710e3502003-08-29 20:57:53 +00001964 CONFIG_BZIP2
1965
1966 If this option is set, support for bzip2 compressed
1967 images is included. If not, only uncompressed and gzip
1968 compressed images are supported.
1969
wdenk9c53f402003-10-15 23:53:47 +00001970 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001971 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001972 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001973
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001974 CONFIG_LZMA
1975
1976 If this option is set, support for lzma compressed
1977 images is included.
1978
1979 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1980 requires an amount of dynamic memory that is given by the
1981 formula:
1982
1983 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1984
1985 Where lc and lp stand for, respectively, Literal context bits
1986 and Literal pos bits.
1987
1988 This value is upper-bounded by 14MB in the worst case. Anyway,
1989 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1990 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1991 a very small buffer.
1992
1993 Use the lzmainfo tool to determinate the lc and lp values and
1994 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001995 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001996
Kees Cook5b06e642013-08-16 07:59:12 -07001997 CONFIG_LZO
1998
1999 If this option is set, support for LZO compressed images
2000 is included.
2001
wdenk0e2bd9c2004-06-06 21:51:03 +00002002- MII/PHY support:
2003 CONFIG_PHY_ADDR
2004
2005 The address of PHY on MII bus.
2006
2007 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2008
2009 The clock frequency of the MII bus
2010
2011 CONFIG_PHY_GIGE
2012
2013 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002014 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002015
2016 CONFIG_PHY_RESET_DELAY
2017
2018 Some PHY like Intel LXT971A need extra delay after
2019 reset before any MII register access is possible.
2020 For such PHY, set this option to the usec delay
2021 required. (minimum 300usec for LXT971A)
2022
2023 CONFIG_PHY_CMD_DELAY (ppc4xx)
2024
2025 Some PHY like Intel LXT971A need extra delay after
2026 command issued before MII status register can be read
2027
wdenkc6097192002-11-03 00:24:07 +00002028- IP address:
2029 CONFIG_IPADDR
2030
2031 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002032 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002033 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002034 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002035
2036- Server IP address:
2037 CONFIG_SERVERIP
2038
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002039 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002040 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002041 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002042
Robin Getz470a6d42009-07-21 12:15:28 -04002043 CONFIG_KEEP_SERVERADDR
2044
2045 Keeps the server's MAC address, in the env 'serveraddr'
2046 for passing to bootargs (like Linux's netconsole option)
2047
Wolfgang Denk26da2992011-10-26 10:21:22 +00002048- Gateway IP address:
2049 CONFIG_GATEWAYIP
2050
2051 Defines a default value for the IP address of the
2052 default router where packets to other networks are
2053 sent to.
2054 (Environment variable "gatewayip")
2055
2056- Subnet mask:
2057 CONFIG_NETMASK
2058
2059 Defines a default value for the subnet mask (or
2060 routing prefix) which is used to determine if an IP
2061 address belongs to the local subnet or needs to be
2062 forwarded through a router.
2063 (Environment variable "netmask")
2064
David Updegraff7280da72007-06-11 10:41:07 -05002065- Multicast TFTP Mode:
2066 CONFIG_MCAST_TFTP
2067
2068 Defines whether you want to support multicast TFTP as per
2069 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002070 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002071 driver in use must provide a function: mcast() to join/leave a
2072 multicast group.
2073
wdenkc6097192002-11-03 00:24:07 +00002074- BOOTP Recovery Mode:
2075 CONFIG_BOOTP_RANDOM_DELAY
2076
2077 If you have many targets in a network that try to
2078 boot using BOOTP, you may want to avoid that all
2079 systems send out BOOTP requests at precisely the same
2080 moment (which would happen for instance at recovery
2081 from a power failure, when all systems will try to
2082 boot, thus flooding the BOOTP server. Defining
2083 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2084 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002085 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002086
2087 1st BOOTP request: delay 0 ... 1 sec
2088 2nd BOOTP request: delay 0 ... 2 sec
2089 3rd BOOTP request: delay 0 ... 4 sec
2090 4th and following
2091 BOOTP requests: delay 0 ... 8 sec
2092
Thierry Reding8977cda2014-08-19 10:21:24 +02002093 CONFIG_BOOTP_ID_CACHE_SIZE
2094
2095 BOOTP packets are uniquely identified using a 32-bit ID. The
2096 server will copy the ID from client requests to responses and
2097 U-Boot will use this to determine if it is the destination of
2098 an incoming response. Some servers will check that addresses
2099 aren't in use before handing them out (usually using an ARP
2100 ping) and therefore take up to a few hundred milliseconds to
2101 respond. Network congestion may also influence the time it
2102 takes for a response to make it back to the client. If that
2103 time is too long, U-Boot will retransmit requests. In order
2104 to allow earlier responses to still be accepted after these
2105 retransmissions, U-Boot's BOOTP client keeps a small cache of
2106 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2107 cache. The default is to keep IDs for up to four outstanding
2108 requests. Increasing this will allow U-Boot to accept offers
2109 from a BOOTP client in networks with unusually high latency.
2110
stroesee0aadfb2003-08-28 14:17:32 +00002111- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002112 You can fine tune the DHCP functionality by defining
2113 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002114
Jon Loeliger5336a762007-07-09 22:08:34 -05002115 CONFIG_BOOTP_SUBNETMASK
2116 CONFIG_BOOTP_GATEWAY
2117 CONFIG_BOOTP_HOSTNAME
2118 CONFIG_BOOTP_NISDOMAIN
2119 CONFIG_BOOTP_BOOTPATH
2120 CONFIG_BOOTP_BOOTFILESIZE
2121 CONFIG_BOOTP_DNS
2122 CONFIG_BOOTP_DNS2
2123 CONFIG_BOOTP_SEND_HOSTNAME
2124 CONFIG_BOOTP_NTPSERVER
2125 CONFIG_BOOTP_TIMEOFFSET
2126 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002127 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002128
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002129 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2130 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002131
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002132 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2133 after the configured retry count, the call will fail
2134 instead of starting over. This can be used to fail over
2135 to Link-local IP address configuration if the DHCP server
2136 is not available.
2137
stroesee0aadfb2003-08-28 14:17:32 +00002138 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2139 serverip from a DHCP server, it is possible that more
2140 than one DNS serverip is offered to the client.
2141 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2142 serverip will be stored in the additional environment
2143 variable "dnsip2". The first DNS serverip is always
2144 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002145 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002146
2147 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2148 to do a dynamic update of a DNS server. To do this, they
2149 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002150 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002151 of the "hostname" environment variable is passed as
2152 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002153
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002154 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2155
2156 A 32bit value in microseconds for a delay between
2157 receiving a "DHCP Offer" and sending the "DHCP Request".
2158 This fixes a problem with certain DHCP servers that don't
2159 respond 100% of the time to a "DHCP request". E.g. On an
2160 AT91RM9200 processor running at 180MHz, this delay needed
2161 to be *at least* 15,000 usec before a Windows Server 2003
2162 DHCP server would reply 100% of the time. I recommend at
2163 least 50,000 usec to be safe. The alternative is to hope
2164 that one of the retries will be successful but note that
2165 the DHCP timeout and retry process takes a longer than
2166 this delay.
2167
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002168 - Link-local IP address negotiation:
2169 Negotiate with other link-local clients on the local network
2170 for an address that doesn't require explicit configuration.
2171 This is especially useful if a DHCP server cannot be guaranteed
2172 to exist in all environments that the device must operate.
2173
2174 See doc/README.link-local for more information.
2175
wdenk145d2c12004-04-15 21:48:45 +00002176 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002177 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002178
2179 The device id used in CDP trigger frames.
2180
2181 CONFIG_CDP_DEVICE_ID_PREFIX
2182
2183 A two character string which is prefixed to the MAC address
2184 of the device.
2185
2186 CONFIG_CDP_PORT_ID
2187
2188 A printf format string which contains the ascii name of
2189 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002190 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002191
2192 CONFIG_CDP_CAPABILITIES
2193
2194 A 32bit integer which indicates the device capabilities;
2195 0x00000010 for a normal host which does not forwards.
2196
2197 CONFIG_CDP_VERSION
2198
2199 An ascii string containing the version of the software.
2200
2201 CONFIG_CDP_PLATFORM
2202
2203 An ascii string containing the name of the platform.
2204
2205 CONFIG_CDP_TRIGGER
2206
2207 A 32bit integer sent on the trigger.
2208
2209 CONFIG_CDP_POWER_CONSUMPTION
2210
2211 A 16bit integer containing the power consumption of the
2212 device in .1 of milliwatts.
2213
2214 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2215
2216 A byte containing the id of the VLAN.
2217
wdenkc6097192002-11-03 00:24:07 +00002218- Status LED: CONFIG_STATUS_LED
2219
2220 Several configurations allow to display the current
2221 status using a LED. For instance, the LED will blink
2222 fast while running U-Boot code, stop blinking as
2223 soon as a reply to a BOOTP request was received, and
2224 start blinking slow once the Linux kernel is running
2225 (supported by a status LED driver in the Linux
2226 kernel). Defining CONFIG_STATUS_LED enables this
2227 feature in U-Boot.
2228
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002229 Additional options:
2230
2231 CONFIG_GPIO_LED
2232 The status LED can be connected to a GPIO pin.
2233 In such cases, the gpio_led driver can be used as a
2234 status LED backend implementation. Define CONFIG_GPIO_LED
2235 to include the gpio_led driver in the U-Boot binary.
2236
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002237 CONFIG_GPIO_LED_INVERTED_TABLE
2238 Some GPIO connected LEDs may have inverted polarity in which
2239 case the GPIO high value corresponds to LED off state and
2240 GPIO low value corresponds to LED on state.
2241 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2242 with a list of GPIO LEDs that have inverted polarity.
2243
wdenkc6097192002-11-03 00:24:07 +00002244- CAN Support: CONFIG_CAN_DRIVER
2245
2246 Defining CONFIG_CAN_DRIVER enables CAN driver support
2247 on those systems that support this (optional)
2248 feature, like the TQM8xxL modules.
2249
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002250- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002251
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002252 This enable the NEW i2c subsystem, and will allow you to use
2253 i2c commands at the u-boot command line (as long as you set
2254 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2255 based realtime clock chips or other i2c devices. See
2256 common/cmd_i2c.c for a description of the command line
2257 interface.
2258
2259 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002260 - drivers/i2c/soft_i2c.c:
2261 - activate first bus with CONFIG_SYS_I2C_SOFT define
2262 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2263 for defining speed and slave address
2264 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2265 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2266 for defining speed and slave address
2267 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2268 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2269 for defining speed and slave address
2270 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2271 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2272 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002273
Heiko Schocherf2850742012-10-24 13:48:22 +02002274 - drivers/i2c/fsl_i2c.c:
2275 - activate i2c driver with CONFIG_SYS_I2C_FSL
2276 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2277 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2278 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2279 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002280 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002281 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2282 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2283 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2284 second bus.
2285
Simon Glass026fefb2012-10-30 07:28:53 +00002286 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002287 - activate this driver with CONFIG_SYS_I2C_TEGRA
2288 - This driver adds 4 i2c buses with a fix speed from
2289 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002290
Dirk Eibach42b204f2013-04-25 02:40:01 +00002291 - drivers/i2c/ppc4xx_i2c.c
2292 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2293 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2294 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2295
trema49f40a2013-09-21 18:13:35 +02002296 - drivers/i2c/i2c_mxc.c
2297 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002298 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2299 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2300 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2301 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002302 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2303 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2304 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2305 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2306 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2307 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002308 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2309 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002310 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002311 for speed, and 0 for slave.
2312
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002313 - drivers/i2c/rcar_i2c.c:
2314 - activate this driver with CONFIG_SYS_I2C_RCAR
2315 - This driver adds 4 i2c buses
2316
2317 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2318 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2319 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2320 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2321 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2322 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2323 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2324 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2325 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2326
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002327 - drivers/i2c/sh_i2c.c:
2328 - activate this driver with CONFIG_SYS_I2C_SH
2329 - This driver adds from 2 to 5 i2c buses
2330
2331 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2332 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2333 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2334 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2335 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2336 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2337 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2338 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2339 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2340 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2341 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2342 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002343 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002344
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002345 - drivers/i2c/omap24xx_i2c.c
2346 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2347 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2348 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2349 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2350 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2351 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2352 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2353 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2354 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2355 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2356 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2357
Heiko Schocher465819a2013-11-08 07:30:53 +01002358 - drivers/i2c/zynq_i2c.c
2359 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2360 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2361 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2362
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302363 - drivers/i2c/s3c24x0_i2c.c:
2364 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2365 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2366 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2367 with a fix speed from 100000 and the slave addr 0!
2368
Dirk Eibachb9577432014-07-03 09:28:18 +02002369 - drivers/i2c/ihs_i2c.c
2370 - activate this driver with CONFIG_SYS_I2C_IHS
2371 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2372 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2373 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2374 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2375 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2376 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2377 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2378 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2379 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2380 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2381 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2382 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002383 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2384 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2385 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2386 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2387 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2388 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2389 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2390 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2391 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002392
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002393 additional defines:
2394
2395 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002396 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002397 don't use/have i2c muxes on your i2c bus, this
2398 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2399 omit this define.
2400
2401 CONFIG_SYS_I2C_DIRECT_BUS
2402 define this, if you don't use i2c muxes on your hardware.
2403 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2404 omit this define.
2405
2406 CONFIG_SYS_I2C_MAX_HOPS
2407 define how many muxes are maximal consecutively connected
2408 on one i2c bus. If you not use i2c muxes, omit this
2409 define.
2410
2411 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002412 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002413 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2414 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2415 CONFIG_SYS_NUM_I2C_BUSES = 9:
2416
2417 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2418 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2419 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2420 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2421 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2422 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2423 {1, {I2C_NULL_HOP}}, \
2424 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2425 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2426 }
2427
2428 which defines
2429 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002430 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2431 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2432 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2433 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2434 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002435 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002436 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2437 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002438
2439 If you do not have i2c muxes on your board, omit this define.
2440
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002441- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002442
2443 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2444 provides the following compelling advantages:
2445
2446 - more than one i2c adapter is usable
2447 - approved multibus support
2448 - better i2c mux support
2449
2450 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002451
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002452 These enable legacy I2C serial bus commands. Defining
2453 CONFIG_HARD_I2C will include the appropriate I2C driver
2454 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002455
wdenk21136db2003-07-16 21:53:01 +00002456 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002457 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002458 CONFIG_COMMANDS) and communicate with i2c based realtime
2459 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002460 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002461
Ben Warren45657152006-09-07 16:50:54 -04002462 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002463
wdenk21136db2003-07-16 21:53:01 +00002464 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002465 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002466
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002467 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002468 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002469 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002470 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002471
Peter Tysere4d1abc2010-04-12 22:28:21 -05002472 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002473 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002474 and so its address should therefore be cleared to 0 (See,
2475 eg, MPC823e User's Manual p.16-473). So, set
2476 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002477
Eric Millbrandt12990a42009-09-03 08:09:44 -05002478 CONFIG_SYS_I2C_INIT_MPC5XXX
2479
2480 When a board is reset during an i2c bus transfer
2481 chips might think that the current transfer is still
2482 in progress. Reset the slave devices by sending start
2483 commands until the slave device responds.
2484
wdenk21136db2003-07-16 21:53:01 +00002485 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002486
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002487 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002488 then the following macros need to be defined (examples are
2489 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002490
2491 I2C_INIT
2492
wdenkb9bbd242003-06-30 16:24:52 +00002493 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002494 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002495
wdenk544e9732004-02-06 23:19:44 +00002496 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002497
wdenkc6097192002-11-03 00:24:07 +00002498 I2C_PORT
2499
wdenk4a5c8a72003-03-06 00:02:04 +00002500 (Only for MPC8260 CPU). The I/O port to use (the code
2501 assumes both bits are on the same port). Valid values
2502 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002503
2504 I2C_ACTIVE
2505
2506 The code necessary to make the I2C data line active
2507 (driven). If the data line is open collector, this
2508 define can be null.
2509
wdenkb9bbd242003-06-30 16:24:52 +00002510 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2511
wdenkc6097192002-11-03 00:24:07 +00002512 I2C_TRISTATE
2513
2514 The code necessary to make the I2C data line tri-stated
2515 (inactive). If the data line is open collector, this
2516 define can be null.
2517
wdenkb9bbd242003-06-30 16:24:52 +00002518 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2519
wdenkc6097192002-11-03 00:24:07 +00002520 I2C_READ
2521
York Sun4a598092013-04-01 11:29:11 -07002522 Code that returns true if the I2C data line is high,
2523 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002524
wdenkb9bbd242003-06-30 16:24:52 +00002525 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2526
wdenkc6097192002-11-03 00:24:07 +00002527 I2C_SDA(bit)
2528
York Sun4a598092013-04-01 11:29:11 -07002529 If <bit> is true, sets the I2C data line high. If it
2530 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002531
wdenkb9bbd242003-06-30 16:24:52 +00002532 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002533 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002534 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002535
wdenkc6097192002-11-03 00:24:07 +00002536 I2C_SCL(bit)
2537
York Sun4a598092013-04-01 11:29:11 -07002538 If <bit> is true, sets the I2C clock line high. If it
2539 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002540
wdenkb9bbd242003-06-30 16:24:52 +00002541 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002542 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002543 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002544
wdenkc6097192002-11-03 00:24:07 +00002545 I2C_DELAY
2546
2547 This delay is invoked four times per clock cycle so this
2548 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002549 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002550 like:
2551
wdenkb9bbd242003-06-30 16:24:52 +00002552 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002553
Mike Frysingeree12d542010-07-21 13:38:02 -04002554 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2555
2556 If your arch supports the generic GPIO framework (asm/gpio.h),
2557 then you may alternatively define the two GPIOs that are to be
2558 used as SCL / SDA. Any of the previous I2C_xxx macros will
2559 have GPIO-based defaults assigned to them as appropriate.
2560
2561 You should define these to the GPIO value as given directly to
2562 the generic GPIO functions.
2563
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002564 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002565
wdenk57b2d802003-06-27 21:31:46 +00002566 When a board is reset during an i2c bus transfer
2567 chips might think that the current transfer is still
2568 in progress. On some boards it is possible to access
2569 the i2c SCLK line directly, either by using the
2570 processor pin as a GPIO or by having a second pin
2571 connected to the bus. If this option is defined a
2572 custom i2c_init_board() routine in boards/xxx/board.c
2573 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002574
Richard Retanubundf0149c2010-04-12 15:08:17 -04002575 CONFIG_SYS_I2C_BOARD_LATE_INIT
2576
2577 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2578 defined a custom i2c_board_late_init() routine in
2579 boards/xxx/board.c is run AFTER the operations in i2c_init()
2580 is completed. This callpoint can be used to unreset i2c bus
2581 using CPU i2c controller register accesses for CPUs whose i2c
2582 controller provide such a method. It is called at the end of
2583 i2c_init() to allow i2c_init operations to setup the i2c bus
2584 controller on the CPU (e.g. setting bus speed & slave address).
2585
wdenk0e2bd9c2004-06-06 21:51:03 +00002586 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2587
2588 This option enables configuration of bi_iic_fast[] flags
2589 in u-boot bd_info structure based on u-boot environment
2590 variable "i2cfast". (see also i2cfast)
2591
Ben Warren45657152006-09-07 16:50:54 -04002592 CONFIG_I2C_MULTI_BUS
2593
2594 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002595 must have a controller. At any point in time, only one bus is
2596 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002597 Note that bus numbering is zero-based.
2598
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002599 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002600
2601 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002602 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002603 is set, specify a list of bus-device pairs. Otherwise, specify
2604 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002605
2606 e.g.
2607 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002608 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002609
2610 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2611
Wolfgang Denk092ae952011-10-26 10:21:21 +00002612 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002613 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002614
2615 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2616
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002617 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002618
2619 If defined, then this indicates the I2C bus number for DDR SPD.
2620 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2621
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002622 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002623
2624 If defined, then this indicates the I2C bus number for the RTC.
2625 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002627 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002628
2629 If defined, then this indicates the I2C bus number for the DTT.
2630 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2631
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002632 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002633
2634 If defined, specifies the I2C address of the DTT device.
2635 If not defined, then U-Boot uses predefined value for
2636 specified DTT device.
2637
Andrew Dyer58c41f92008-12-29 17:36:01 -06002638 CONFIG_SOFT_I2C_READ_REPEATED_START
2639
2640 defining this will force the i2c_read() function in
2641 the soft_i2c driver to perform an I2C repeated start
2642 between writing the address pointer and reading the
2643 data. If this define is omitted the default behaviour
2644 of doing a stop-start sequence will be used. Most I2C
2645 devices can use either method, but some require one or
2646 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002647
wdenkc6097192002-11-03 00:24:07 +00002648- SPI Support: CONFIG_SPI
2649
2650 Enables SPI driver (so far only tested with
2651 SPI EEPROM, also an instance works with Crystal A/D and
2652 D/As on the SACSng board)
2653
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002654 CONFIG_SH_SPI
2655
2656 Enables the driver for SPI controller on SuperH. Currently
2657 only SH7757 is supported.
2658
wdenkc6097192002-11-03 00:24:07 +00002659 CONFIG_SOFT_SPI
2660
wdenk4a5c8a72003-03-06 00:02:04 +00002661 Enables a software (bit-bang) SPI driver rather than
2662 using hardware support. This is a general purpose
2663 driver that only requires three general I/O port pins
2664 (two outputs, one input) to function. If this is
2665 defined, the board configuration must define several
2666 SPI configuration items (port pins to use, etc). For
2667 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002668
Ben Warren7efe9272008-01-16 22:37:35 -05002669 CONFIG_HARD_SPI
2670
2671 Enables a hardware SPI driver for general-purpose reads
2672 and writes. As with CONFIG_SOFT_SPI, the board configuration
2673 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002674 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002675 example, see include/configs/mpc8349emds.h.
2676
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002677 CONFIG_MXC_SPI
2678
2679 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002680 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002681
Heiko Schocherb77c8882014-07-14 10:22:11 +02002682 CONFIG_SYS_SPI_MXC_WAIT
2683 Timeout for waiting until spi transfer completed.
2684 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2685
Matthias Fuchsa4400872007-12-27 17:12:34 +01002686- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002687
Matthias Fuchsa4400872007-12-27 17:12:34 +01002688 Enables FPGA subsystem.
2689
2690 CONFIG_FPGA_<vendor>
2691
2692 Enables support for specific chip vendors.
2693 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002694
Matthias Fuchsa4400872007-12-27 17:12:34 +01002695 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002696
Matthias Fuchsa4400872007-12-27 17:12:34 +01002697 Enables support for FPGA family.
2698 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2699
2700 CONFIG_FPGA_COUNT
2701
2702 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002703
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302704 CONFIG_CMD_FPGA_LOADMK
2705
2706 Enable support for fpga loadmk command
2707
Michal Simek64c70982014-05-02 13:43:39 +02002708 CONFIG_CMD_FPGA_LOADP
2709
2710 Enable support for fpga loadp command - load partial bitstream
2711
2712 CONFIG_CMD_FPGA_LOADBP
2713
2714 Enable support for fpga loadbp command - load partial bitstream
2715 (Xilinx only)
2716
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002717 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002718
wdenk57b2d802003-06-27 21:31:46 +00002719 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002720
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002721 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002722
wdenk4a5c8a72003-03-06 00:02:04 +00002723 Enable checks on FPGA configuration interface busy
2724 status by the configuration function. This option
2725 will require a board or device specific function to
2726 be written.
wdenkc6097192002-11-03 00:24:07 +00002727
2728 CONFIG_FPGA_DELAY
2729
2730 If defined, a function that provides delays in the FPGA
2731 configuration driver.
2732
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002733 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002734 Allow Control-C to interrupt FPGA configuration
2735
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002736 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002737
wdenk4a5c8a72003-03-06 00:02:04 +00002738 Check for configuration errors during FPGA bitfile
2739 loading. For example, abort during Virtex II
2740 configuration if the INIT_B line goes low (which
2741 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002742
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002743 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002744
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002745 Maximum time to wait for the INIT_B line to de-assert
2746 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002747 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002748 ms.
wdenkc6097192002-11-03 00:24:07 +00002749
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002750 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002751
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002752 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002753 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002754
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002755 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002756
wdenk4a5c8a72003-03-06 00:02:04 +00002757 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002758 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002759
2760- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002761 CONFIG_BUILD_TARGET
2762
2763 Some SoCs need special image types (e.g. U-Boot binary
2764 with a special header) as build targets. By defining
2765 CONFIG_BUILD_TARGET in the SoC / board header, this
2766 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002767 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002768
wdenkc6097192002-11-03 00:24:07 +00002769 CONFIG_IDENT_STRING
2770
wdenk4a5c8a72003-03-06 00:02:04 +00002771 If defined, this string will be added to the U-Boot
2772 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002773
2774- Vendor Parameter Protection:
2775
wdenk4a5c8a72003-03-06 00:02:04 +00002776 U-Boot considers the values of the environment
2777 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002778 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002779 are set once by the board vendor / manufacturer, and
2780 protects these variables from casual modification by
2781 the user. Once set, these variables are read-only,
2782 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002783 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002784
2785 If CONFIG_ENV_OVERWRITE is #defined in your config
2786 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002787 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002788 these parameters.
2789
Joe Hershberger76f353e2015-05-04 14:55:14 -05002790 Alternatively, if you define _both_ an ethaddr in the
2791 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002792 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002793 which can be changed exactly ONCE by the user. [The
2794 serial# is unaffected by this, i. e. it remains
2795 read-only.]
2796
Joe Hershberger71497d02012-12-11 22:16:31 -06002797 The same can be accomplished in a more flexible way
2798 for any variable by configuring the type of access
2799 to allow for those variables in the ".flags" variable
2800 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2801
wdenkc6097192002-11-03 00:24:07 +00002802- Protected RAM:
2803 CONFIG_PRAM
2804
2805 Define this variable to enable the reservation of
2806 "protected RAM", i. e. RAM which is not overwritten
2807 by U-Boot. Define CONFIG_PRAM to hold the number of
2808 kB you want to reserve for pRAM. You can overwrite
2809 this default value by defining an environment
2810 variable "pram" to the number of kB you want to
2811 reserve. Note that the board info structure will
2812 still show the full amount of RAM. If pRAM is
2813 reserved, a new environment variable "mem" will
2814 automatically be defined to hold the amount of
2815 remaining RAM in a form that can be passed as boot
2816 argument to Linux, for instance like that:
2817
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002818 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002819 saveenv
2820
2821 This way you can tell Linux not to use this memory,
2822 either, which results in a memory region that will
2823 not be affected by reboots.
2824
2825 *WARNING* If your board configuration uses automatic
2826 detection of the RAM size, you must make sure that
2827 this memory test is non-destructive. So far, the
2828 following board configurations are known to be
2829 "pRAM-clean":
2830
Wolfgang Denk90326762012-10-24 02:36:15 +00002831 IVMS8, IVML24, SPD8xx, TQM8xxL,
2832 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002833 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002834
Gabe Blacka2f3a932012-12-02 04:55:18 +00002835- Access to physical memory region (> 4GB)
2836 Some basic support is provided for operations on memory not
2837 normally accessible to U-Boot - e.g. some architectures
2838 support access to more than 4GB of memory on 32-bit
2839 machines using physical address extension or similar.
2840 Define CONFIG_PHYSMEM to access this basic support, which
2841 currently only supports clearing the memory.
2842
wdenkc6097192002-11-03 00:24:07 +00002843- Error Recovery:
2844 CONFIG_PANIC_HANG
2845
2846 Define this variable to stop the system in case of a
2847 fatal error, so that you have to reset it manually.
2848 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002849 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002850 automatically as fast as possible, but it may be
2851 useful during development since you can try to debug
2852 the conditions that lead to the situation.
2853
2854 CONFIG_NET_RETRY_COUNT
2855
wdenk4a5c8a72003-03-06 00:02:04 +00002856 This variable defines the number of retries for
2857 network operations like ARP, RARP, TFTP, or BOOTP
2858 before giving up the operation. If not defined, a
2859 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002860
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002861 CONFIG_ARP_TIMEOUT
2862
2863 Timeout waiting for an ARP reply in milliseconds.
2864
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002865 CONFIG_NFS_TIMEOUT
2866
2867 Timeout in milliseconds used in NFS protocol.
2868 If you encounter "ERROR: Cannot umount" in nfs command,
2869 try longer timeout such as
2870 #define CONFIG_NFS_TIMEOUT 10000UL
2871
wdenkc6097192002-11-03 00:24:07 +00002872- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002873 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002874
2875 Enable auto completion of commands using TAB.
2876
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002877 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002878
2879 This defines the secondary prompt string, which is
2880 printed when the command interpreter needs more input
2881 to complete a command. Usually "> ".
2882
2883 Note:
2884
wdenk57b2d802003-06-27 21:31:46 +00002885 In the current implementation, the local variables
2886 space and global environment variables space are
2887 separated. Local variables are those you define by
2888 simply typing `name=value'. To access a local
2889 variable later on, you have write `$name' or
2890 `${name}'; to execute the contents of a variable
2891 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002892
wdenk4a5c8a72003-03-06 00:02:04 +00002893 Global environment variables are those you use
2894 setenv/printenv to work with. To run a command stored
2895 in such a variable, you need to use the run command,
2896 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002897
2898 To store commands and special characters in a
2899 variable, please use double quotation marks
2900 surrounding the whole text of the variable, instead
2901 of the backslashes before semicolons and special
2902 symbols.
2903
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002904- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002905 CONFIG_CMDLINE_EDITING
2906
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002907 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002908 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002909
Marek Vasut734fb042016-01-27 04:47:55 +01002910- Command Line PS1/PS2 support:
2911 CONFIG_CMDLINE_PS_SUPPORT
2912
2913 Enable support for changing the command prompt string
2914 at run-time. Only static string is supported so far.
2915 The string is obtained from environment variables PS1
2916 and PS2.
2917
wdenkc0aa5c52003-12-06 19:49:23 +00002918- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002919 CONFIG_EXTRA_ENV_SETTINGS
2920
wdenk4a5c8a72003-03-06 00:02:04 +00002921 Define this to contain any number of null terminated
2922 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002923 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002924
wdenk4a5c8a72003-03-06 00:02:04 +00002925 For example, place something like this in your
2926 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002927
2928 #define CONFIG_EXTRA_ENV_SETTINGS \
2929 "myvar1=value1\0" \
2930 "myvar2=value2\0"
2931
wdenk4a5c8a72003-03-06 00:02:04 +00002932 Warning: This method is based on knowledge about the
2933 internal format how the environment is stored by the
2934 U-Boot code. This is NOT an official, exported
2935 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002936 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002937 You better know what you are doing here.
2938
wdenk4a5c8a72003-03-06 00:02:04 +00002939 Note: overly (ab)use of the default environment is
2940 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002941 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002942 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002943
Stephen Warren1465d5f2012-05-22 09:21:54 +00002944 CONFIG_ENV_VARS_UBOOT_CONFIG
2945
2946 Define this in order to add variables describing the
2947 U-Boot build configuration to the default environment.
2948 These will be named arch, cpu, board, vendor, and soc.
2949
2950 Enabling this option will cause the following to be defined:
2951
2952 - CONFIG_SYS_ARCH
2953 - CONFIG_SYS_CPU
2954 - CONFIG_SYS_BOARD
2955 - CONFIG_SYS_VENDOR
2956 - CONFIG_SYS_SOC
2957
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002958 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2959
2960 Define this in order to add variables describing certain
2961 run-time determined information about the hardware to the
2962 environment. These will be named board_name, board_rev.
2963
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002964 CONFIG_DELAY_ENVIRONMENT
2965
2966 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002967 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002968 that so that the environment is not available until
2969 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2970 this is instead controlled by the value of
2971 /config/load-environment.
2972
Chris Packham2216ddb2015-06-19 20:25:59 +12002973- Parallel Flash support:
2974 CONFIG_SYS_NO_FLASH
2975
Bin Meng75574052016-02-05 19:30:11 -08002976 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham2216ddb2015-06-19 20:25:59 +12002977 flash. This option is used to disable support for parallel NOR
2978 flash. This option should be defined if the board does not have
2979 parallel flash.
2980
2981 If this option is not defined one of the generic flash drivers
2982 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2983 selected or the board must provide an implementation of the
2984 flash API (see include/flash.h).
2985
wdenkc0aa5c52003-12-06 19:49:23 +00002986- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002987 CONFIG_HAS_DATAFLASH
2988
wdenk57b2d802003-06-27 21:31:46 +00002989 Defining this option enables DataFlash features and
2990 allows to read/write in Dataflash via the standard
2991 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002992
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002993- Serial Flash support
2994 CONFIG_CMD_SF
2995
2996 Defining this option enables SPI flash commands
2997 'sf probe/read/write/erase/update'.
2998
2999 Usage requires an initial 'probe' to define the serial
3000 flash parameters, followed by read/write/erase/update
3001 commands.
3002
3003 The following defaults may be provided by the platform
3004 to handle the common case when only a single serial
3005 flash is present on the system.
3006
3007 CONFIG_SF_DEFAULT_BUS Bus identifier
3008 CONFIG_SF_DEFAULT_CS Chip-select
3009 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3010 CONFIG_SF_DEFAULT_SPEED in Hz
3011
Simon Glass4b5545e2012-10-08 13:16:02 +00003012 CONFIG_CMD_SF_TEST
3013
3014 Define this option to include a destructive SPI flash
3015 test ('sf test').
3016
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303017 CONFIG_SF_DUAL_FLASH Dual flash memories
3018
3019 Define this option to use dual flash support where two flash
3020 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003021 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303022
wdenkef893942004-02-23 16:11:30 +00003023- SystemACE Support:
3024 CONFIG_SYSTEMACE
3025
3026 Adding this option adds support for Xilinx SystemACE
3027 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003028 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003029 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003030
3031 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003032 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003033
3034 When SystemACE support is added, the "ace" device type
3035 becomes available to the fat commands, i.e. fatls.
3036
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003037- TFTP Fixed UDP Port:
3038 CONFIG_TFTP_PORT
3039
Wolfgang Denk227b5192005-09-24 23:25:46 +02003040 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003041 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003042 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003043 number generator is used.
3044
Wolfgang Denk227b5192005-09-24 23:25:46 +02003045 Also, the environment variable tftpdstp is used to supply
3046 the TFTP UDP destination port value. If tftpdstp isn't
3047 defined, the normal port 69 is used.
3048
3049 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003050 blindly start the TFTP transfer using the pre-configured
3051 target IP address and UDP port. This has the effect of
3052 "punching through" the (Windows XP) firewall, allowing
3053 the remainder of the TFTP transfer to proceed normally.
3054 A better solution is to properly configure the firewall,
3055 but sometimes that is not allowed.
3056
Simon Glass058bb8d2012-12-05 14:46:38 +00003057- Hashing support:
3058 CONFIG_CMD_HASH
3059
3060 This enables a generic 'hash' command which can produce
3061 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3062
3063 CONFIG_HASH_VERIFY
3064
3065 Enable the hash verify command (hash -v). This adds to code
3066 size a little.
3067
gaurav ranaef201592015-02-20 12:51:46 +05303068 CONFIG_SHA1 - This option enables support of hashing using SHA1
3069 algorithm. The hash is calculated in software.
3070 CONFIG_SHA256 - This option enables support of hashing using
3071 SHA256 algorithm. The hash is calculated in software.
3072 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3073 for SHA1/SHA256 hashing.
3074 This affects the 'hash' command and also the
3075 hash_lookup_algo() function.
3076 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3077 hardware-acceleration for SHA1/SHA256 progressive hashing.
3078 Data can be streamed in a block at a time and the hashing
3079 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003080
3081 Note: There is also a sha1sum command, which should perhaps
3082 be deprecated in favour of 'hash sha1'.
3083
Robert Winkler765ccf42013-07-24 17:57:06 -07003084- Freescale i.MX specific commands:
3085 CONFIG_CMD_HDMIDETECT
3086 This enables 'hdmidet' command which returns true if an
3087 HDMI monitor is detected. This command is i.MX 6 specific.
3088
3089 CONFIG_CMD_BMODE
3090 This enables the 'bmode' (bootmode) command for forcing
3091 a boot from specific media.
3092
3093 This is useful for forcing the ROM's usb downloader to
3094 activate upon a watchdog reset which is nice when iterating
3095 on U-Boot. Using the reset button or running bmode normal
3096 will set it back to normal. This command currently
3097 supports i.MX53 and i.MX6.
3098
Heiko Schocher443ca402014-01-25 07:27:13 +01003099- bootcount support:
3100 CONFIG_BOOTCOUNT_LIMIT
3101
3102 This enables the bootcounter support, see:
3103 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3104
3105 CONFIG_AT91SAM9XE
3106 enable special bootcounter support on at91sam9xe based boards.
3107 CONFIG_BLACKFIN
3108 enable special bootcounter support on blackfin based boards.
3109 CONFIG_SOC_DA8XX
3110 enable special bootcounter support on da850 based boards.
3111 CONFIG_BOOTCOUNT_RAM
3112 enable support for the bootcounter in RAM
3113 CONFIG_BOOTCOUNT_I2C
3114 enable support for the bootcounter on an i2c (like RTC) device.
3115 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3116 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3117 the bootcounter.
3118 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003119
wdenkc0aa5c52003-12-06 19:49:23 +00003120- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003121 CONFIG_SHOW_BOOT_PROGRESS
3122
wdenk4a5c8a72003-03-06 00:02:04 +00003123 Defining this option allows to add some board-
3124 specific code (calling a user-provided function
3125 "show_boot_progress(int)") that enables you to show
3126 the system's boot progress on some display (for
3127 example, some LED's) on your board. At the moment,
3128 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003129
Simon Glass0fa36a42012-09-28 08:56:37 +00003130
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003131Legacy uImage format:
3132
wdenkc6097192002-11-03 00:24:07 +00003133 Arg Where When
3134 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003135 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003136 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003137 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003138 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003139 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003140 4 common/cmd_bootm.c Image data has correct checksum
3141 -4 common/cmd_bootm.c Image is for unsupported architecture
3142 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003143 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003144 6 common/cmd_bootm.c Image Type check OK
3145 -6 common/cmd_bootm.c gunzip uncompression error
3146 -7 common/cmd_bootm.c Unimplemented compression type
3147 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003148 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003149 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003150
3151 9 common/image.c Start initial ramdisk verification
3152 -10 common/image.c Ramdisk header has bad magic number
3153 -11 common/image.c Ramdisk header has bad checksum
3154 10 common/image.c Ramdisk header is OK
3155 -12 common/image.c Ramdisk data has bad checksum
3156 11 common/image.c Ramdisk data has correct checksum
3157 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003158 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003159 13 common/image.c Start multifile image verification
3160 14 common/image.c No initial ramdisk, no multifile, continue.
3161
Wolfgang Denk092ae952011-10-26 10:21:21 +00003162 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003163
Stefan Roese88fbf932010-04-15 16:07:28 +02003164 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003165 -31 post/post.c POST test failed, detected by post_output_backlog()
3166 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003167
Heiko Schocher633e03a2007-06-22 19:11:54 +02003168 34 common/cmd_doc.c before loading a Image from a DOC device
3169 -35 common/cmd_doc.c Bad usage of "doc" command
3170 35 common/cmd_doc.c correct usage of "doc" command
3171 -36 common/cmd_doc.c No boot device
3172 36 common/cmd_doc.c correct boot device
3173 -37 common/cmd_doc.c Unknown Chip ID on boot device
3174 37 common/cmd_doc.c correct chip ID found, device available
3175 -38 common/cmd_doc.c Read Error on boot device
3176 38 common/cmd_doc.c reading Image header from DOC device OK
3177 -39 common/cmd_doc.c Image header has bad magic number
3178 39 common/cmd_doc.c Image header has correct magic number
3179 -40 common/cmd_doc.c Error reading Image from DOC device
3180 40 common/cmd_doc.c Image header has correct magic number
3181 41 common/cmd_ide.c before loading a Image from a IDE device
3182 -42 common/cmd_ide.c Bad usage of "ide" command
3183 42 common/cmd_ide.c correct usage of "ide" command
3184 -43 common/cmd_ide.c No boot device
3185 43 common/cmd_ide.c boot device found
3186 -44 common/cmd_ide.c Device not available
3187 44 common/cmd_ide.c Device available
3188 -45 common/cmd_ide.c wrong partition selected
3189 45 common/cmd_ide.c partition selected
3190 -46 common/cmd_ide.c Unknown partition table
3191 46 common/cmd_ide.c valid partition table found
3192 -47 common/cmd_ide.c Invalid partition type
3193 47 common/cmd_ide.c correct partition type
3194 -48 common/cmd_ide.c Error reading Image Header on boot device
3195 48 common/cmd_ide.c reading Image Header from IDE device OK
3196 -49 common/cmd_ide.c Image header has bad magic number
3197 49 common/cmd_ide.c Image header has correct magic number
3198 -50 common/cmd_ide.c Image header has bad checksum
3199 50 common/cmd_ide.c Image header has correct checksum
3200 -51 common/cmd_ide.c Error reading Image from IDE device
3201 51 common/cmd_ide.c reading Image from IDE device OK
3202 52 common/cmd_nand.c before loading a Image from a NAND device
3203 -53 common/cmd_nand.c Bad usage of "nand" command
3204 53 common/cmd_nand.c correct usage of "nand" command
3205 -54 common/cmd_nand.c No boot device
3206 54 common/cmd_nand.c boot device found
3207 -55 common/cmd_nand.c Unknown Chip ID on boot device
3208 55 common/cmd_nand.c correct chip ID found, device available
3209 -56 common/cmd_nand.c Error reading Image Header on boot device
3210 56 common/cmd_nand.c reading Image Header from NAND device OK
3211 -57 common/cmd_nand.c Image header has bad magic number
3212 57 common/cmd_nand.c Image header has correct magic number
3213 -58 common/cmd_nand.c Error reading Image from NAND device
3214 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003215
Heiko Schocher633e03a2007-06-22 19:11:54 +02003216 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003217
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003218 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003219 -64 net/eth.c no Ethernet found.
3220 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003221
Heiko Schocher633e03a2007-06-22 19:11:54 +02003222 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003223 80 common/cmd_net.c before calling net_loop()
3224 -81 common/cmd_net.c some error in net_loop() occurred
3225 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003226 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3227 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003228 83 common/cmd_net.c running "source" command
3229 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003230 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003231
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003232FIT uImage format:
3233
3234 Arg Where When
3235 100 common/cmd_bootm.c Kernel FIT Image has correct format
3236 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3237 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3238 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3239 102 common/cmd_bootm.c Kernel unit name specified
3240 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003241 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003242 104 common/cmd_bootm.c Got kernel subimage node offset
3243 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3244 105 common/cmd_bootm.c Kernel subimage hash verification OK
3245 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3246 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003247 -106 common/cmd_bootm.c Kernel subimage has wrong type
3248 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003249 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3250 108 common/cmd_bootm.c Got kernel subimage data/size
3251 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3252 -109 common/cmd_bootm.c Can't get kernel subimage type
3253 -110 common/cmd_bootm.c Can't get kernel subimage comp
3254 -111 common/cmd_bootm.c Can't get kernel subimage os
3255 -112 common/cmd_bootm.c Can't get kernel subimage load address
3256 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3257
3258 120 common/image.c Start initial ramdisk verification
3259 -120 common/image.c Ramdisk FIT image has incorrect format
3260 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003261 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003262 -122 common/image.c Can't get configuration for ramdisk subimage
3263 123 common/image.c Ramdisk unit name specified
3264 -124 common/image.c Can't get ramdisk subimage node offset
3265 125 common/image.c Got ramdisk subimage node offset
3266 -125 common/image.c Ramdisk subimage hash verification failed
3267 126 common/image.c Ramdisk subimage hash verification OK
3268 -126 common/image.c Ramdisk subimage for unsupported architecture
3269 127 common/image.c Architecture check OK
3270 -127 common/image.c Can't get ramdisk subimage data/size
3271 128 common/image.c Got ramdisk subimage data/size
3272 129 common/image.c Can't get ramdisk load address
3273 -129 common/image.c Got ramdisk load address
3274
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003275 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003276 131 common/cmd_doc.c FIT image format OK
3277
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003278 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003279 141 common/cmd_ide.c FIT image format OK
3280
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003281 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003282 151 common/cmd_nand.c FIT image format OK
3283
Heiko Schocher515eb122014-05-28 11:33:33 +02003284- legacy image format:
3285 CONFIG_IMAGE_FORMAT_LEGACY
3286 enables the legacy image format support in U-Boot.
3287
3288 Default:
3289 enabled if CONFIG_FIT_SIGNATURE is not defined.
3290
3291 CONFIG_DISABLE_IMAGE_LEGACY
3292 disable the legacy image format
3293
3294 This define is introduced, as the legacy image format is
3295 enabled per default for backward compatibility.
3296
Gabe Blackd572e162012-10-25 16:31:10 +00003297- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003298 CONFIG_FIT_DISABLE_SHA256
3299 Supporting SHA256 hashes has quite an impact on binary size.
3300 For constrained systems sha256 hash support can be disabled
3301 with this option.
3302
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003303 TODO(sjg@chromium.org): Adjust this option to be positive,
3304 and move it to Kconfig
3305
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003306- Standalone program support:
3307 CONFIG_STANDALONE_LOAD_ADDR
3308
Wolfgang Denk23f78482011-10-09 21:06:34 +02003309 This option defines a board specific value for the
3310 address where standalone program gets loaded, thus
3311 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003312 settings.
3313
3314- Frame Buffer Address:
3315 CONFIG_FB_ADDR
3316
3317 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003318 address for frame buffer. This is typically the case
3319 when using a graphics controller has separate video
3320 memory. U-Boot will then place the frame buffer at
3321 the given address instead of dynamically reserving it
3322 in system RAM by calling lcd_setmem(), which grabs
3323 the memory for the frame buffer depending on the
3324 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003325
3326 Please see board_init_f function.
3327
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003328- Automatic software updates via TFTP server
3329 CONFIG_UPDATE_TFTP
3330 CONFIG_UPDATE_TFTP_CNT_MAX
3331 CONFIG_UPDATE_TFTP_MSEC_MAX
3332
3333 These options enable and control the auto-update feature;
3334 for a more detailed description refer to doc/README.update.
3335
3336- MTD Support (mtdparts command, UBI support)
3337 CONFIG_MTD_DEVICE
3338
3339 Adds the MTD device infrastructure from the Linux kernel.
3340 Needed for mtdparts command support.
3341
3342 CONFIG_MTD_PARTITIONS
3343
3344 Adds the MTD partitioning infrastructure from the Linux
3345 kernel. Needed for UBI support.
3346
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003347- UBI support
3348 CONFIG_CMD_UBI
3349
3350 Adds commands for interacting with MTD partitions formatted
3351 with the UBI flash translation layer
3352
3353 Requires also defining CONFIG_RBTREE
3354
Joe Hershberger47550fc2013-04-08 10:32:49 +00003355 CONFIG_UBI_SILENCE_MSG
3356
3357 Make the verbose messages from UBI stop printing. This leaves
3358 warnings and errors enabled.
3359
Heiko Schocherf5895d12014-06-24 10:10:04 +02003360
3361 CONFIG_MTD_UBI_WL_THRESHOLD
3362 This parameter defines the maximum difference between the highest
3363 erase counter value and the lowest erase counter value of eraseblocks
3364 of UBI devices. When this threshold is exceeded, UBI starts performing
3365 wear leveling by means of moving data from eraseblock with low erase
3366 counter to eraseblocks with high erase counter.
3367
3368 The default value should be OK for SLC NAND flashes, NOR flashes and
3369 other flashes which have eraseblock life-cycle 100000 or more.
3370 However, in case of MLC NAND flashes which typically have eraseblock
3371 life-cycle less than 10000, the threshold should be lessened (e.g.,
3372 to 128 or 256, although it does not have to be power of 2).
3373
3374 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003375
Heiko Schocherf5895d12014-06-24 10:10:04 +02003376 CONFIG_MTD_UBI_BEB_LIMIT
3377 This option specifies the maximum bad physical eraseblocks UBI
3378 expects on the MTD device (per 1024 eraseblocks). If the
3379 underlying flash does not admit of bad eraseblocks (e.g. NOR
3380 flash), this value is ignored.
3381
3382 NAND datasheets often specify the minimum and maximum NVM
3383 (Number of Valid Blocks) for the flashes' endurance lifetime.
3384 The maximum expected bad eraseblocks per 1024 eraseblocks
3385 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3386 which gives 20 for most NANDs (MaxNVB is basically the total
3387 count of eraseblocks on the chip).
3388
3389 To put it differently, if this value is 20, UBI will try to
3390 reserve about 1.9% of physical eraseblocks for bad blocks
3391 handling. And that will be 1.9% of eraseblocks on the entire
3392 NAND chip, not just the MTD partition UBI attaches. This means
3393 that if you have, say, a NAND flash chip admits maximum 40 bad
3394 eraseblocks, and it is split on two MTD partitions of the same
3395 size, UBI will reserve 40 eraseblocks when attaching a
3396 partition.
3397
3398 default: 20
3399
3400 CONFIG_MTD_UBI_FASTMAP
3401 Fastmap is a mechanism which allows attaching an UBI device
3402 in nearly constant time. Instead of scanning the whole MTD device it
3403 only has to locate a checkpoint (called fastmap) on the device.
3404 The on-flash fastmap contains all information needed to attach
3405 the device. Using fastmap makes only sense on large devices where
3406 attaching by scanning takes long. UBI will not automatically install
3407 a fastmap on old images, but you can set the UBI parameter
3408 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3409 that fastmap-enabled images are still usable with UBI implementations
3410 without fastmap support. On typical flash devices the whole fastmap
3411 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3412
3413 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3414 Set this parameter to enable fastmap automatically on images
3415 without a fastmap.
3416 default: 0
3417
Heiko Schocher94b66de2015-10-22 06:19:21 +02003418 CONFIG_MTD_UBI_FM_DEBUG
3419 Enable UBI fastmap debug
3420 default: 0
3421
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003422- UBIFS support
3423 CONFIG_CMD_UBIFS
3424
3425 Adds commands for interacting with UBI volumes formatted as
3426 UBIFS. UBIFS is read-only in u-boot.
3427
3428 Requires UBI support as well as CONFIG_LZO
3429
Joe Hershberger47550fc2013-04-08 10:32:49 +00003430 CONFIG_UBIFS_SILENCE_MSG
3431
3432 Make the verbose messages from UBIFS stop printing. This leaves
3433 warnings and errors enabled.
3434
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003435- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003436 CONFIG_SPL
3437 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003438
Tom Rini36853852012-02-14 07:29:40 +00003439 CONFIG_SPL_LDSCRIPT
3440 LDSCRIPT for linking the SPL binary.
3441
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003442 CONFIG_SPL_MAX_FOOTPRINT
3443 Maximum size in memory allocated to the SPL, BSS included.
3444 When defined, the linker checks that the actual memory
3445 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003446 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003447 must not be both defined at the same time.
3448
Tom Rini36853852012-02-14 07:29:40 +00003449 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003450 Maximum size of the SPL image (text, data, rodata, and
3451 linker lists sections), BSS excluded.
3452 When defined, the linker checks that the actual size does
3453 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003454
Wolfgang Denk825223d2011-09-11 21:24:09 +02003455 CONFIG_SPL_TEXT_BASE
3456 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003457
Scott Woodc4f0d002012-09-20 19:05:12 -05003458 CONFIG_SPL_RELOC_TEXT_BASE
3459 Address to relocate to. If unspecified, this is equal to
3460 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3461
Tom Rini36853852012-02-14 07:29:40 +00003462 CONFIG_SPL_BSS_START_ADDR
3463 Link address for the BSS within the SPL binary.
3464
3465 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003466 Maximum size in memory allocated to the SPL BSS.
3467 When defined, the linker checks that the actual memory used
3468 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003469 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003470 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003471
3472 CONFIG_SPL_STACK
3473 Adress of the start of the stack SPL will use
3474
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003475 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3476 When defined, SPL will panic() if the image it has
3477 loaded does not have a signature.
3478 Defining this is useful when code which loads images
3479 in SPL cannot guarantee that absolutely all read errors
3480 will be caught.
3481 An example is the LPC32XX MLC NAND driver, which will
3482 consider that a completely unreadable NAND block is bad,
3483 and thus should be skipped silently.
3484
Marek Vasutbf541b22016-04-29 00:44:55 +02003485 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3486 When defined, SPL will proceed to another boot method
3487 if the image it has loaded does not have a signature.
3488
Scott Woodc4f0d002012-09-20 19:05:12 -05003489 CONFIG_SPL_RELOC_STACK
3490 Adress of the start of the stack SPL will use after
3491 relocation. If unspecified, this is equal to
3492 CONFIG_SPL_STACK.
3493
Tom Rini36853852012-02-14 07:29:40 +00003494 CONFIG_SYS_SPL_MALLOC_START
3495 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003496 When this option is set the full malloc is used in SPL and
3497 it is set up by spl_init() and before that, the simple malloc()
3498 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003499
3500 CONFIG_SYS_SPL_MALLOC_SIZE
3501 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003502
Tom Rini28591df2012-08-13 12:03:19 -07003503 CONFIG_SPL_FRAMEWORK
3504 Enable the SPL framework under common/. This framework
3505 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3506 NAND loading of the Linux Kernel.
3507
Tom Rinic2b76002014-03-28 12:03:39 -04003508 CONFIG_SPL_OS_BOOT
3509 Enable booting directly to an OS from SPL.
3510 See also: doc/README.falcon
3511
Tom Rinife3b0c72012-08-13 11:37:56 -07003512 CONFIG_SPL_DISPLAY_PRINT
3513 For ARM, enable an optional function to print more information
3514 about the running system.
3515
Scott Wood7c810902012-09-20 16:35:21 -05003516 CONFIG_SPL_INIT_MINIMAL
3517 Arch init code should be built for a very small image
3518
Tom Rini36853852012-02-14 07:29:40 +00003519 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3520 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003521 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003522 when the MMC is being used in raw mode.
3523
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003524 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3525 Partition on the MMC to load U-Boot from when the MMC is being
3526 used in raw mode
3527
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003528 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3529 Sector to load kernel uImage from when MMC is being
3530 used in raw mode (for Falcon mode)
3531
3532 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3533 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3534 Sector and number of sectors to load kernel argument
3535 parameters from when MMC is being used in raw mode
3536 (for falcon mode)
3537
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003538 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3539 Partition on the MMC to load U-Boot from when the MMC is being
3540 used in fs mode
3541
Guillaume GARDET5065b712014-10-15 17:53:13 +02003542 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3543 Filename to read to load U-Boot when reading from filesystem
3544
3545 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003546 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003547 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003548
Guillaume GARDET5065b712014-10-15 17:53:13 +02003549 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003550 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003551 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003552
Scott Wood2b36fbb2012-12-06 13:33:17 +00003553 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3554 Set this for NAND SPL on PPC mpc83xx targets, so that
3555 start.S waits for the rest of the SPL to load before
3556 continuing (the hardware starts execution after just
3557 loading the first page rather than the full 4K).
3558
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303559 CONFIG_SPL_SKIP_RELOCATE
3560 Avoid SPL relocation
3561
Scott Woodc352a0c2012-09-20 19:09:07 -05003562 CONFIG_SPL_NAND_BASE
3563 Include nand_base.c in the SPL. Requires
3564 CONFIG_SPL_NAND_DRIVERS.
3565
3566 CONFIG_SPL_NAND_DRIVERS
3567 SPL uses normal NAND drivers, not minimal drivers.
3568
3569 CONFIG_SPL_NAND_ECC
3570 Include standard software ECC in the SPL
3571
Tom Rini36853852012-02-14 07:29:40 +00003572 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003573 Support for NAND boot using simple NAND drivers that
3574 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003575
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003576 CONFIG_SPL_UBI
3577 Support for a lightweight UBI (fastmap) scanner and
3578 loader
3579
Heiko Schochercf000272014-10-31 08:31:00 +01003580 CONFIG_SPL_NAND_RAW_ONLY
3581 Support to boot only raw u-boot.bin images. Use this only
3582 if you need to save space.
3583
Ying Zhangdfb2b152013-08-16 15:16:12 +08003584 CONFIG_SPL_COMMON_INIT_DDR
3585 Set for common ddr init with serial presence detect in
3586 SPL binary.
3587
Tom Rini36853852012-02-14 07:29:40 +00003588 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3589 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3590 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3591 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3592 CONFIG_SYS_NAND_ECCBYTES
3593 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003594 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003595
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303596 CONFIG_SPL_NAND_BOOT
3597 Add support NAND boot
3598
Tom Rini36853852012-02-14 07:29:40 +00003599 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003600 Location in NAND to read U-Boot from
3601
3602 CONFIG_SYS_NAND_U_BOOT_DST
3603 Location in memory to load U-Boot to
3604
3605 CONFIG_SYS_NAND_U_BOOT_SIZE
3606 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003607
3608 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003609 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003610
3611 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3612 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003613 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003614
3615 CONFIG_SPL_OMAP3_ID_NAND
3616 Support for an OMAP3-specific set of functions to return the
3617 ID and MFR of the first attached NAND chip, if present.
3618
Pavel Machekde997252012-08-30 22:42:11 +02003619 CONFIG_SPL_RAM_DEVICE
3620 Support for running image already present in ram, in SPL binary
3621
Scott Woodeb7bd972012-12-06 13:33:16 +00003622 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003623 Image offset to which the SPL should be padded before appending
3624 the SPL payload. By default, this is defined as
3625 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3626 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3627 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003628
Scott Woodf147eb72012-09-21 16:27:32 -05003629 CONFIG_SPL_TARGET
3630 Final target image containing SPL and payload. Some SPLs
3631 use an arch-specific makefile fragment instead, for
3632 example if more than one image needs to be produced.
3633
Simon Glass82d94532013-05-08 08:05:59 +00003634 CONFIG_FIT_SPL_PRINT
3635 Printing information about a FIT image adds quite a bit of
3636 code to SPL. So this is normally disabled in SPL. Use this
3637 option to re-enable it. This will affect the output of the
3638 bootm command when booting a FIT image.
3639
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003640- TPL framework
3641 CONFIG_TPL
3642 Enable building of TPL globally.
3643
3644 CONFIG_TPL_PAD_TO
3645 Image offset to which the TPL should be padded before appending
3646 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003647 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3648 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3649 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003650
wdenkc0aa5c52003-12-06 19:49:23 +00003651- Interrupt support (PPC):
3652
wdenk1ebf41e2004-01-02 14:00:00 +00003653 There are common interrupt_init() and timer_interrupt()
3654 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003655 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003656 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003657 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003658 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003659 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003660 specific handling. If board has watchdog / status_led
3661 / other_activity_monitor it works automatically from
3662 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003663
wdenkc6097192002-11-03 00:24:07 +00003664
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003665Board initialization settings:
3666------------------------------
3667
3668During Initialization u-boot calls a number of board specific functions
3669to allow the preparation of board specific prerequisites, e.g. pin setup
3670before drivers are initialized. To enable these callbacks the
3671following configuration macros have to be defined. Currently this is
3672architecture specific, so please check arch/your_architecture/lib/board.c
3673typically in board_init_f() and board_init_r().
3674
3675- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3676- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3677- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3678- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003679
wdenkc6097192002-11-03 00:24:07 +00003680Configuration Settings:
3681-----------------------
3682
York Sun6c480012014-02-26 17:03:19 -08003683- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3684 Optionally it can be defined to support 64-bit memory commands.
3685
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003686- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003687 undefine this when you're short of memory.
3688
Peter Tyserdfb72b82009-01-27 18:03:12 -06003689- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3690 width of the commands listed in the 'help' command output.
3691
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003692- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003693 prompt for user input.
3694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003695- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003696
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003697- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003698
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003699- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003700
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003701- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003702 the application (usually a Linux kernel) when it is
3703 booted
3704
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003705- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003706 List of legal baudrate settings for this board.
3707
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003708- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003709 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003710
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003711- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003712 If the board specific function
3713 extern int overwrite_console (void);
3714 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003715 serial port, else the settings in the environment are used.
3716
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003717- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003718 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003719
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003720- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003721 Enable overwrite of previous console environment settings.
3722
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003723- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003724 Begin and End addresses of the area used by the
3725 simple memory test.
3726
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003727- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003728 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003729
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003730- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003731 Scratch address used by the alternate memory test
3732 You only need to set this if address zero isn't writeable
3733
York Sun5d286cd2015-12-04 11:57:07 -08003734- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003735 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003736 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3737 is substracted from total RAM and won't be reported to OS.
3738 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003739 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003740 the RAM base is not zero, or RAM is divided into banks,
3741 this variable needs to be recalcuated to get the address.
3742
York Sun50739372015-12-07 11:05:29 -08003743- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003744 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003745 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003746 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003747 fixing up gd->ram_size the Linux kernel should gets passed
3748 the now "corrected" memory size and won't touch it either.
3749 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003750 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003751 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003752 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003753
3754 This option can be used as a workaround for the 440EPx/GRx
3755 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3756 be touched.
3757
3758 WARNING: Please make sure that this value is a multiple of
3759 the Linux page size (normally 4k). If this is not the case,
3760 then the end address of the Linux memory will be located at a
3761 non page size aligned address and this could cause major
3762 problems.
3763
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003764- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003765 Enable temporary baudrate change while serial download
3766
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003767- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003768 Physical start address of SDRAM. _Must_ be 0 here.
3769
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003770- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003771 Physical start address of Motherboard I/O (if using a
3772 Cogent motherboard)
3773
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003774- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003775 Physical start address of Flash memory.
3776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003777- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003778 Physical start address of boot monitor code (set by
3779 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003780 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003781 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003782
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003783- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003784 Size of memory reserved for monitor code, used to
3785 determine _at_compile_time_ (!) if the environment is
3786 embedded within the U-Boot image, or in a separate
3787 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003788
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003789- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003790 Size of DRAM reserved for malloc() use.
3791
Simon Glass863e4042014-07-10 22:23:28 -06003792- CONFIG_SYS_MALLOC_F_LEN
3793 Size of the malloc() pool for use before relocation. If
3794 this is defined, then a very simple malloc() implementation
3795 will become available before relocation. The address is just
3796 below the global data, and the stack is moved down to make
3797 space.
3798
3799 This feature allocates regions with increasing addresses
3800 within the region. calloc() is supported, but realloc()
3801 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003802 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003803 U-Boot relocates itself.
3804
Simon Glass9fa901b2014-11-10 17:16:54 -07003805- CONFIG_SYS_MALLOC_SIMPLE
3806 Provides a simple and small malloc() and calloc() for those
3807 boards which do not use the full malloc in SPL (which is
3808 enabled with CONFIG_SYS_SPL_MALLOC_START).
3809
Thierry Redingc97d9742014-12-09 22:25:22 -07003810- CONFIG_SYS_NONCACHED_MEMORY:
3811 Size of non-cached memory area. This area of memory will be
3812 typically located right below the malloc() area and mapped
3813 uncached in the MMU. This is useful for drivers that would
3814 otherwise require a lot of explicit cache maintenance. For
3815 some drivers it's also impossible to properly maintain the
3816 cache. For example if the regions that need to be flushed
3817 are not a multiple of the cache-line size, *and* padding
3818 cannot be allocated between the regions to align them (i.e.
3819 if the HW requires a contiguous array of regions, and the
3820 size of each region is not cache-aligned), then a flush of
3821 one region may result in overwriting data that hardware has
3822 written to another region in the same cache-line. This can
3823 happen for example in network drivers where descriptors for
3824 buffers are typically smaller than the CPU cache-line (e.g.
3825 16 bytes vs. 32 or 64 bytes).
3826
3827 Non-cached memory is only supported on 32-bit ARM at present.
3828
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003829- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003830 Normally compressed uImages are limited to an
3831 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003832 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003833 to adjust this setting to your needs.
3834
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003835- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003836 Maximum size of memory mapped by the startup code of
3837 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003838 the Linux kernel (bd_info, boot arguments, FDT blob if
3839 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003840 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003841 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003842 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003843 variable "bootm_mapsize" will override the value of
3844 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3845 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003846
John Rigbyeea8e692010-10-13 13:57:35 -06003847- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3848 Enable initrd_high functionality. If defined then the
3849 initrd_high feature is enabled and the bootm ramdisk subcommand
3850 is enabled.
3851
3852- CONFIG_SYS_BOOT_GET_CMDLINE:
3853 Enables allocating and saving kernel cmdline in space between
3854 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3855
3856- CONFIG_SYS_BOOT_GET_KBD:
3857 Enables allocating and saving a kernel copy of the bd_info in
3858 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3859
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003860- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003861 Max number of Flash memory banks
3862
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003863- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003864 Max number of sectors on a Flash chip
3865
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003866- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003867 Timeout for Flash erase operations (in ms)
3868
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003869- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003870 Timeout for Flash write operations (in ms)
3871
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003872- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003873 Timeout for Flash set sector lock bit operation (in ms)
3874
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003875- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003876 Timeout for Flash clear lock bits operation (in ms)
3877
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003878- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003879 If defined, hardware flash sectors protection is used
3880 instead of U-Boot software protection.
3881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003882- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003883
3884 Enable TFTP transfers directly to flash memory;
3885 without this option such a download has to be
3886 performed in two steps: (1) download to RAM, and (2)
3887 copy from RAM to flash.
3888
3889 The two-step approach is usually more reliable, since
3890 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003891 the flash, but in some situations (when system RAM is
3892 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003893 downloaded image) this option may be very useful.
3894
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003895- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003896 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003897 common flash structure for storing flash geometry.
3898
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003899- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003900 This option also enables the building of the cfi_flash driver
3901 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003902
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003903- CONFIG_FLASH_CFI_MTD
3904 This option enables the building of the cfi_mtd driver
3905 in the drivers directory. The driver exports CFI flash
3906 to the MTD layer.
3907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003908- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003909 Use buffered writes to flash.
3910
3911- CONFIG_FLASH_SPANSION_S29WS_N
3912 s29ws-n MirrorBit flash has non-standard addresses for buffered
3913 write commands.
3914
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003915- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003916 If this option is defined, the common CFI flash doesn't
3917 print it's warning upon not recognized FLASH banks. This
3918 is useful, if some of the configured banks are only
3919 optionally available.
3920
Jerry Van Barenaae73572008-03-08 13:48:01 -05003921- CONFIG_FLASH_SHOW_PROGRESS
3922 If defined (must be an integer), print out countdown
3923 digits and dots. Recommended value: 45 (9..1) for 80
3924 column displays, 15 (3..1) for 40 column displays.
3925
Stefan Roesed20cba52013-04-04 15:53:14 +02003926- CONFIG_FLASH_VERIFY
3927 If defined, the content of the flash (destination) is compared
3928 against the source after the write operation. An error message
3929 will be printed when the contents are not identical.
3930 Please note that this option is useless in nearly all cases,
3931 since such flash programming errors usually are detected earlier
3932 while unprotecting/erasing/programming. Please only enable
3933 this option if you really know what you are doing.
3934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003935- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003936 Defines the number of Ethernet receive buffers. On some
3937 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003938 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3939 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003940 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003941 Defaults to 4 if not defined.
3942
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003943- CONFIG_ENV_MAX_ENTRIES
3944
Wolfgang Denk1136f692010-10-27 22:48:30 +02003945 Maximum number of entries in the hash table that is used
3946 internally to store the environment settings. The default
3947 setting is supposed to be generous and should work in most
3948 cases. This setting can be used to tune behaviour; see
3949 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003950
Joe Hershberger71497d02012-12-11 22:16:31 -06003951- CONFIG_ENV_FLAGS_LIST_DEFAULT
3952- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003953 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003954 calling env set. Variables can be restricted to only decimal,
3955 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3956 the variables can also be restricted to IP address or MAC address.
3957
3958 The format of the list is:
3959 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003960 access_attribute = [a|r|o|c]
3961 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003962 entry = variable_name[:attributes]
3963 list = entry[,list]
3964
3965 The type attributes are:
3966 s - String (default)
3967 d - Decimal
3968 x - Hexadecimal
3969 b - Boolean ([1yYtT|0nNfF])
3970 i - IP address
3971 m - MAC address
3972
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003973 The access attributes are:
3974 a - Any (default)
3975 r - Read-only
3976 o - Write-once
3977 c - Change-default
3978
Joe Hershberger71497d02012-12-11 22:16:31 -06003979 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3980 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003981 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003982
3983 - CONFIG_ENV_FLAGS_LIST_STATIC
3984 Define this to a list (string) to define validation that
3985 should be done if an entry is not found in the ".flags"
3986 environment variable. To override a setting in the static
3987 list, simply add an entry for the same variable name to the
3988 ".flags" variable.
3989
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003990 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3991 regular expression. This allows multiple variables to define the same
3992 flags without explicitly listing them for each variable.
3993
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003994- CONFIG_ENV_ACCESS_IGNORE_FORCE
3995 If defined, don't allow the -f switch to env set override variable
3996 access flags.
3997
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003998- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3999 This is set by OMAP boards for the max time that reset should
4000 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004001 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004002
Gabe Black3687fe42014-10-15 04:38:30 -06004003- CONFIG_USE_STDINT
4004 If stdint.h is available with your toolchain you can define this
4005 option to enable it. You can provide option 'USE_STDINT=1' when
4006 building U-Boot to enable this.
4007
wdenkc6097192002-11-03 00:24:07 +00004008The following definitions that deal with the placement and management
4009of environment data (variable area); in general, we support the
4010following configurations:
4011
Mike Frysinger63b8f122011-07-08 10:44:25 +00004012- CONFIG_BUILD_ENVCRC:
4013
4014 Builds up envcrc with the target environment so that external utils
4015 may easily extract it and embed it in final U-Boot images.
4016
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004017- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004018
4019 Define this if the environment is in flash memory.
4020
4021 a) The environment occupies one whole flash sector, which is
4022 "embedded" in the text segment with the U-Boot code. This
4023 happens usually with "bottom boot sector" or "top boot
4024 sector" type flash chips, which have several smaller
4025 sectors at the start or the end. For instance, such a
4026 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4027 such a case you would place the environment in one of the
4028 4 kB sectors - with U-Boot code before and after it. With
4029 "top boot sector" type flash chips, you would put the
4030 environment in one of the last sectors, leaving a gap
4031 between U-Boot and the environment.
4032
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004033 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004034
4035 Offset of environment data (variable area) to the
4036 beginning of flash memory; for instance, with bottom boot
4037 type flash chips the second sector can be used: the offset
4038 for this sector is given here.
4039
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004040 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004041
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004042 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004043
4044 This is just another way to specify the start address of
4045 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004046 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004047
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004048 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004049
4050 Size of the sector containing the environment.
4051
4052
4053 b) Sometimes flash chips have few, equal sized, BIG sectors.
4054 In such a case you don't want to spend a whole sector for
4055 the environment.
4056
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004057 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004058
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004059 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004060 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004061 of this flash sector for the environment. This saves
4062 memory for the RAM copy of the environment.
4063
4064 It may also save flash memory if you decide to use this
4065 when your environment is "embedded" within U-Boot code,
4066 since then the remainder of the flash sector could be used
4067 for U-Boot code. It should be pointed out that this is
4068 STRONGLY DISCOURAGED from a robustness point of view:
4069 updating the environment in flash makes it always
4070 necessary to erase the WHOLE sector. If something goes
4071 wrong before the contents has been restored from a copy in
4072 RAM, your target system will be dead.
4073
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004074 - CONFIG_ENV_ADDR_REDUND
4075 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004076
wdenk4a5c8a72003-03-06 00:02:04 +00004077 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004078 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004079 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004080 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004081
4082BE CAREFUL! Any changes to the flash layout, and some changes to the
4083source code will make it necessary to adapt <board>/u-boot.lds*
4084accordingly!
4085
4086
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004087- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004088
4089 Define this if you have some non-volatile memory device
4090 (NVRAM, battery buffered SRAM) which you want to use for the
4091 environment.
4092
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004093 - CONFIG_ENV_ADDR:
4094 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004095
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004096 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004097 want to use for environment. It is assumed that this memory
4098 can just be read and written to, without any special
4099 provision.
4100
4101BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004102in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004103console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004104U-Boot will hang.
4105
4106Please note that even with NVRAM we still use a copy of the
4107environment in RAM: we could work on NVRAM directly, but we want to
4108keep settings there always unmodified except somebody uses "saveenv"
4109to save the current settings.
4110
4111
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004112- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004113
4114 Use this if you have an EEPROM or similar serial access
4115 device and a driver for it.
4116
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004117 - CONFIG_ENV_OFFSET:
4118 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004119
4120 These two #defines specify the offset and size of the
4121 environment area within the total memory of your EEPROM.
4122
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004123 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004124 If defined, specified the chip address of the EEPROM device.
4125 The default address is zero.
4126
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004127 - CONFIG_SYS_I2C_EEPROM_BUS:
4128 If defined, specified the i2c bus of the EEPROM device.
4129
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004130 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004131 If defined, the number of bits used to address bytes in a
4132 single page in the EEPROM device. A 64 byte page, for example
4133 would require six bits.
4134
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004135 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004136 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004137 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004138
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004139 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004140 The length in bytes of the EEPROM memory array address. Note
4141 that this is NOT the chip address length!
4142
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004143 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004144 EEPROM chips that implement "address overflow" are ones
4145 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4146 address and the extra bits end up in the "chip address" bit
4147 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4148 byte chips.
4149
4150 Note that we consider the length of the address field to
4151 still be one byte because the extra address bits are hidden
4152 in the chip address.
4153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004154 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004155 The size in bytes of the EEPROM device.
4156
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004157 - CONFIG_ENV_EEPROM_IS_ON_I2C
4158 define this, if you have I2C and SPI activated, and your
4159 EEPROM, which holds the environment, is on the I2C bus.
4160
4161 - CONFIG_I2C_ENV_EEPROM_BUS
4162 if you have an Environment on an EEPROM reached over
4163 I2C muxes, you can define here, how to reach this
4164 EEPROM. For example:
4165
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004166 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004167
4168 EEPROM which holds the environment, is reached over
4169 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004170
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004171- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004172
wdenk1ebf41e2004-01-02 14:00:00 +00004173 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004174 want to use for the environment.
4175
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004176 - CONFIG_ENV_OFFSET:
4177 - CONFIG_ENV_ADDR:
4178 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004179
4180 These three #defines specify the offset and size of the
4181 environment area within the total memory of your DataFlash placed
4182 at the specified address.
4183
Wu, Josh76db7bf2014-07-01 19:30:13 +08004184- CONFIG_ENV_IS_IN_SPI_FLASH:
4185
4186 Define this if you have a SPI Flash memory device which you
4187 want to use for the environment.
4188
4189 - CONFIG_ENV_OFFSET:
4190 - CONFIG_ENV_SIZE:
4191
4192 These two #defines specify the offset and size of the
4193 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4194 aligned to an erase sector boundary.
4195
4196 - CONFIG_ENV_SECT_SIZE:
4197
4198 Define the SPI flash's sector size.
4199
4200 - CONFIG_ENV_OFFSET_REDUND (optional):
4201
4202 This setting describes a second storage area of CONFIG_ENV_SIZE
4203 size used to hold a redundant copy of the environment data, so
4204 that there is a valid backup copy in case there is a power failure
4205 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4206 aligned to an erase sector boundary.
4207
4208 - CONFIG_ENV_SPI_BUS (optional):
4209 - CONFIG_ENV_SPI_CS (optional):
4210
4211 Define the SPI bus and chip select. If not defined they will be 0.
4212
4213 - CONFIG_ENV_SPI_MAX_HZ (optional):
4214
4215 Define the SPI max work clock. If not defined then use 1MHz.
4216
4217 - CONFIG_ENV_SPI_MODE (optional):
4218
4219 Define the SPI work mode. If not defined then use SPI_MODE_3.
4220
Liu Gang85bcd732012-03-08 00:33:20 +00004221- CONFIG_ENV_IS_IN_REMOTE:
4222
4223 Define this if you have a remote memory space which you
4224 want to use for the local device's environment.
4225
4226 - CONFIG_ENV_ADDR:
4227 - CONFIG_ENV_SIZE:
4228
4229 These two #defines specify the address and size of the
4230 environment area within the remote memory space. The
4231 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004232 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004233
4234BE CAREFUL! For some special cases, the local device can not use
4235"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004236environment stored in a remote NOR flash by SRIO or PCIE link,
4237but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004238
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004239- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004240
4241 Define this if you have a NAND device which you want to use
4242 for the environment.
4243
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004244 - CONFIG_ENV_OFFSET:
4245 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004246
4247 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004248 area within the first NAND device. CONFIG_ENV_OFFSET must be
4249 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004250
Scott Wood08239322010-09-17 14:38:37 -05004251 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004252
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004253 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004254 size used to hold a redundant copy of the environment data, so
4255 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004256 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004257 aligned to an erase block boundary.
4258
4259 - CONFIG_ENV_RANGE (optional):
4260
4261 Specifies the length of the region in which the environment
4262 can be written. This should be a multiple of the NAND device's
4263 block size. Specifying a range with more erase blocks than
4264 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4265 the range to be avoided.
4266
4267 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004268
Scott Wood08239322010-09-17 14:38:37 -05004269 Enables support for dynamically retrieving the offset of the
4270 environment from block zero's out-of-band data. The
4271 "nand env.oob" command can be used to record this offset.
4272 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4273 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004274
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004275- CONFIG_NAND_ENV_DST
4276
4277 Defines address in RAM to which the nand_spl code should copy the
4278 environment. If redundant environment is used, it will be copied to
4279 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4280
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004281- CONFIG_ENV_IS_IN_UBI:
4282
4283 Define this if you have an UBI volume that you want to use for the
4284 environment. This has the benefit of wear-leveling the environment
4285 accesses, which is important on NAND.
4286
4287 - CONFIG_ENV_UBI_PART:
4288
4289 Define this to a string that is the mtd partition containing the UBI.
4290
4291 - CONFIG_ENV_UBI_VOLUME:
4292
4293 Define this to the name of the volume that you want to store the
4294 environment in.
4295
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004296 - CONFIG_ENV_UBI_VOLUME_REDUND:
4297
4298 Define this to the name of another volume to store a second copy of
4299 the environment in. This will enable redundant environments in UBI.
4300 It is assumed that both volumes are in the same MTD partition.
4301
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004302 - CONFIG_UBI_SILENCE_MSG
4303 - CONFIG_UBIFS_SILENCE_MSG
4304
4305 You will probably want to define these to avoid a really noisy system
4306 when storing the env in UBI.
4307
Wu, Josha7d0c872014-06-24 17:31:03 +08004308- CONFIG_ENV_IS_IN_FAT:
4309 Define this if you want to use the FAT file system for the environment.
4310
4311 - FAT_ENV_INTERFACE:
4312
4313 Define this to a string that is the name of the block device.
4314
4315 - FAT_ENV_DEV_AND_PART:
4316
4317 Define this to a string to specify the partition of the device. It can
4318 be as following:
4319
4320 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4321 - "D:P": device D partition P. Error occurs if device D has no
4322 partition table.
4323 - "D:0": device D.
4324 - "D" or "D:": device D partition 1 if device D has partition
4325 table, or the whole device D if has no partition
4326 table.
4327 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004328 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004329 partition table then means device D.
4330
4331 - FAT_ENV_FILE:
4332
4333 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004334 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004335
4336 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004337 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004338
Stephen Warreneedcacd2013-06-11 15:14:00 -06004339- CONFIG_ENV_IS_IN_MMC:
4340
4341 Define this if you have an MMC device which you want to use for the
4342 environment.
4343
4344 - CONFIG_SYS_MMC_ENV_DEV:
4345
4346 Specifies which MMC device the environment is stored in.
4347
4348 - CONFIG_SYS_MMC_ENV_PART (optional):
4349
4350 Specifies which MMC partition the environment is stored in. If not
4351 set, defaults to partition 0, the user area. Common values might be
4352 1 (first MMC boot partition), 2 (second MMC boot partition).
4353
4354 - CONFIG_ENV_OFFSET:
4355 - CONFIG_ENV_SIZE:
4356
4357 These two #defines specify the offset and size of the environment
4358 area within the specified MMC device.
4359
Stephen Warren24dc2032013-06-11 15:14:02 -06004360 If offset is positive (the usual case), it is treated as relative to
4361 the start of the MMC partition. If offset is negative, it is treated
4362 as relative to the end of the MMC partition. This can be useful if
4363 your board may be fitted with different MMC devices, which have
4364 different sizes for the MMC partitions, and you always want the
4365 environment placed at the very end of the partition, to leave the
4366 maximum possible space before it, to store other data.
4367
Stephen Warreneedcacd2013-06-11 15:14:00 -06004368 These two values are in units of bytes, but must be aligned to an
4369 MMC sector boundary.
4370
4371 - CONFIG_ENV_OFFSET_REDUND (optional):
4372
4373 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4374 hold a redundant copy of the environment data. This provides a
4375 valid backup copy in case the other copy is corrupted, e.g. due
4376 to a power failure during a "saveenv" operation.
4377
Stephen Warren24dc2032013-06-11 15:14:02 -06004378 This value may also be positive or negative; this is handled in the
4379 same way as CONFIG_ENV_OFFSET.
4380
Stephen Warreneedcacd2013-06-11 15:14:00 -06004381 This value is also in units of bytes, but must also be aligned to
4382 an MMC sector boundary.
4383
4384 - CONFIG_ENV_SIZE_REDUND (optional):
4385
4386 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4387 set. If this value is set, it must be set to the same value as
4388 CONFIG_ENV_SIZE.
4389
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004390- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004391
4392 Defines offset to the initial SPI buffer area in DPRAM. The
4393 area is used at an early stage (ROM part) if the environment
4394 is configured to reside in the SPI EEPROM: We need a 520 byte
4395 scratch DPRAM area. It is used between the two initialization
4396 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4397 to be a good choice since it makes it far enough from the
4398 start of the data area as well as from the stack pointer.
4399
Bruce Adleredecc942007-11-02 13:15:42 -07004400Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004401has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004402created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004403until then to read environment variables.
4404
wdenk8dba0502003-03-31 16:34:49 +00004405The environment is protected by a CRC32 checksum. Before the monitor
4406is relocated into RAM, as a result of a bad CRC you will be working
4407with the compiled-in default environment - *silently*!!! [This is
4408necessary, because the first environment variable we need is the
4409"baudrate" setting for the console - if we have a bad CRC, we don't
4410have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004411
4412Note: once the monitor has been relocated, then it will complain if
4413the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004414use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004415
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004416- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004417 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004418
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004419 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004420 also needs to be defined.
4421
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004422- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004423 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004424
Ron Madriddfa028a2009-02-18 14:30:44 -08004425- CONFIG_NS16550_MIN_FUNCTIONS:
4426 Define this if you desire to only have use of the NS16550_init
4427 and NS16550_putc functions for the serial driver located at
4428 drivers/serial/ns16550.c. This option is useful for saving
4429 space for already greatly restricted images, including but not
4430 limited to NAND_SPL configurations.
4431
Simon Glass28a9e332012-11-30 13:01:18 +00004432- CONFIG_DISPLAY_BOARDINFO
4433 Display information about the board that U-Boot is running on
4434 when U-Boot starts up. The board function checkboard() is called
4435 to do this.
4436
Simon Glasse8822012012-11-30 13:01:19 +00004437- CONFIG_DISPLAY_BOARDINFO_LATE
4438 Similar to the previous option, but display this information
4439 later, once stdio is running and output goes to the LCD, if
4440 present.
4441
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004442- CONFIG_BOARD_SIZE_LIMIT:
4443 Maximum size of the U-Boot image. When defined, the
4444 build system checks that the actual size does not
4445 exceed it.
4446
wdenkc6097192002-11-03 00:24:07 +00004447Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004448---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004449
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004450- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004451 Cache Line Size of the CPU.
4452
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004453- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004454 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004455
wdenk9c53f402003-10-15 23:53:47 +00004456 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4457 and RPXsuper) to be able to adjust the position of
4458 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004459
Timur Tabid8f341c2011-08-04 18:03:41 -05004460- CONFIG_SYS_CCSRBAR_DEFAULT:
4461 Default (power-on reset) physical address of CCSR on Freescale
4462 PowerPC SOCs.
4463
4464- CONFIG_SYS_CCSRBAR:
4465 Virtual address of CCSR. On a 32-bit build, this is typically
4466 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4467
4468 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4469 for cross-platform code that uses that macro instead.
4470
4471- CONFIG_SYS_CCSRBAR_PHYS:
4472 Physical address of CCSR. CCSR can be relocated to a new
4473 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004474 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004475 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4476 is typically relocated on 36-bit builds. It is recommended
4477 that this macro be defined via the _HIGH and _LOW macros:
4478
4479 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4480 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4481
4482- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004483 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4484 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004485 used in assembly code, so it must not contain typecasts or
4486 integer size suffixes (e.g. "ULL").
4487
4488- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4489 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4490 used in assembly code, so it must not contain typecasts or
4491 integer size suffixes (e.g. "ULL").
4492
4493- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4494 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4495 forced to a value that ensures that CCSR is not relocated.
4496
wdenk1272e232002-11-10 22:06:23 +00004497- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004498 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004499
4500 the default drive number (default value 0)
4501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004502 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004503
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004504 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004505 (default value 1)
4506
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004507 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004508
wdenk4a5c8a72003-03-06 00:02:04 +00004509 defines the offset of register from address. It
4510 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004511 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004512
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004513 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4514 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004515 default value.
wdenk1272e232002-11-10 22:06:23 +00004516
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004517 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004518 fdc_hw_init() is called at the beginning of the FDC
4519 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004520 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004521 initializations.
wdenk1272e232002-11-10 22:06:23 +00004522
Macpaul Lind1e49942011-04-11 20:45:32 +00004523- CONFIG_IDE_AHB:
4524 Most IDE controllers were designed to be connected with PCI
4525 interface. Only few of them were designed for AHB interface.
4526 When software is doing ATA command and data transfer to
4527 IDE devices through IDE-AHB controller, some additional
4528 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004529 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004531- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004532 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004533 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004534
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004535- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004536
wdenkeb20ad32003-09-05 23:19:14 +00004537 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004538 initial data and stack; please note that this must be
4539 writable memory that is working WITHOUT special
4540 initialization, i. e. you CANNOT use normal RAM which
4541 will become available only after programming the
4542 memory controller and running certain initialization
4543 sequences.
4544
4545 U-Boot uses the following memory types:
4546 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4547 - MPC824X: data cache
4548 - PPC4xx: data cache
4549
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004550- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004551
4552 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004553 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4554 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004555 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004556 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004557 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4558 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4559 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004560
4561 Note:
4562 On the MPC824X (or other systems that use the data
4563 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004564 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004565 point to an otherwise UNUSED address space between
4566 the top of RAM and the start of the PCI space.
4567
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004568- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004569
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004570- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004571
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004572- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004573
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004574- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004575
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004576- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004577
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004578- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004580- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004581 SDRAM timing
4582
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004583- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004584 periodic timer for refresh
4585
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004586- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004587
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004588- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4589 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4590 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4591 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004592 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4593
4594- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004595 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4596 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004597 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4598
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004599- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4600 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004601 Machine Mode Register and Memory Periodic Timer
4602 Prescaler definitions (SDRAM timing)
4603
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004604- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004605 enable I2C microcode relocation patch (MPC8xx);
4606 define relocation offset in DPRAM [DSP2]
4607
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004608- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004609 enable SMC microcode relocation patch (MPC8xx);
4610 define relocation offset in DPRAM [SMC1]
4611
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004612- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004613 enable SPI microcode relocation patch (MPC8xx);
4614 define relocation offset in DPRAM [SCC4]
4615
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004616- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004617 Use OSCM clock mode on MBX8xx board. Be careful,
4618 wrong setting might damage your board. Read
4619 doc/README.MBX before setting this variable!
4620
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004621- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004622 Offset of the bootmode word in DPRAM used by post
4623 (Power On Self Tests). This definition overrides
4624 #define'd default value in commproc.h resp.
4625 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004627- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4628 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4629 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4630 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4631 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4632 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4633 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4634 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004635 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004636
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004637- CONFIG_PCI_DISABLE_PCIE:
4638 Disable PCI-Express on systems where it is supported but not
4639 required.
4640
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004641- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004642 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004643 Don't do any setup work, presumably because someone or
4644 something has already done it, and we don't need to do it
4645 a second time. Useful for platforms that are pre-booted
4646 by coreboot or similar.
4647
Gabor Juhosb4458732013-05-30 07:06:12 +00004648- CONFIG_PCI_INDIRECT_BRIDGE:
4649 Enable support for indirect PCI bridges.
4650
Kumar Gala8975d7a2010-12-30 12:09:53 -06004651- CONFIG_SYS_SRIO:
4652 Chip has SRIO or not
4653
4654- CONFIG_SRIO1:
4655 Board has SRIO 1 port available
4656
4657- CONFIG_SRIO2:
4658 Board has SRIO 2 port available
4659
Liu Gang27afb9c2013-05-07 16:30:46 +08004660- CONFIG_SRIO_PCIE_BOOT_MASTER
4661 Board can support master function for Boot from SRIO and PCIE
4662
Kumar Gala8975d7a2010-12-30 12:09:53 -06004663- CONFIG_SYS_SRIOn_MEM_VIRT:
4664 Virtual Address of SRIO port 'n' memory region
4665
4666- CONFIG_SYS_SRIOn_MEM_PHYS:
4667 Physical Address of SRIO port 'n' memory region
4668
4669- CONFIG_SYS_SRIOn_MEM_SIZE:
4670 Size of SRIO port 'n' memory region
4671
Fabio Estevamf17e8782013-04-11 09:35:34 +00004672- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4673 Defined to tell the NAND controller that the NAND chip is using
4674 a 16 bit bus.
4675 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004676 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004677 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004678 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004679
4680- CONFIG_SYS_NDFC_EBC0_CFG
4681 Sets the EBC0_CFG register for the NDFC. If not defined
4682 a default value will be used.
4683
Ben Warren45657152006-09-07 16:50:54 -04004684- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004685 Get DDR timing information from an I2C EEPROM. Common
4686 with pluggable memory modules such as SODIMMs
4687
Ben Warren45657152006-09-07 16:50:54 -04004688 SPD_EEPROM_ADDRESS
4689 I2C address of the SPD EEPROM
4690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004691- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004692 If SPD EEPROM is on an I2C bus other than the first
4693 one, specify here. Note that the value must resolve
4694 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004695
York Sune73cc042011-06-07 09:42:16 +08004696- CONFIG_SYS_DDR_RAW_TIMING
4697 Get DDR timing information from other than SPD. Common with
4698 soldered DDR chips onboard without SPD. DDR raw timing
4699 parameters are extracted from datasheet and hard-coded into
4700 header files or board specific files.
4701
York Sunbd495cf2011-09-16 13:21:35 -07004702- CONFIG_FSL_DDR_INTERACTIVE
4703 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4704
York Sun8ced0502015-01-06 13:18:55 -08004705- CONFIG_FSL_DDR_SYNC_REFRESH
4706 Enable sync of refresh for multiple controllers.
4707
York Sunb6a35f82015-03-19 09:30:28 -07004708- CONFIG_FSL_DDR_BIST
4709 Enable built-in memory test for Freescale DDR controllers.
4710
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004711- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004712 Only for 83xx systems. If specified, then DDR should
4713 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004714
wdenk6203e402004-04-18 10:13:26 +00004715- CONFIG_ETHER_ON_FEC[12]
4716 Define to enable FEC[12] on a 8xx series processor.
4717
4718- CONFIG_FEC[12]_PHY
4719 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004720 to the given FEC; i. e.
4721 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004722 means that the PHY with address 4 is connected to FEC1
4723
4724 When set to -1, means to probe for first available.
4725
4726- CONFIG_FEC[12]_PHY_NORXERR
4727 The PHY does not have a RXERR line (RMII only).
4728 (so program the FEC to ignore it).
4729
4730- CONFIG_RMII
4731 Enable RMII mode for all FECs.
4732 Note that this is a global option, we can't
4733 have one FEC in standard MII mode and another in RMII mode.
4734
wdenk20c98a62004-04-23 20:32:05 +00004735- CONFIG_CRC32_VERIFY
4736 Add a verify option to the crc32 command.
4737 The syntax is:
4738
4739 => crc32 -v <address> <count> <crc32>
4740
4741 Where address/count indicate a memory area
4742 and crc32 is the correct crc32 which the
4743 area should have.
4744
wdenk64519362004-07-11 17:40:54 +00004745- CONFIG_LOOPW
4746 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004747 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004748
stroesecc3af832004-12-16 18:46:55 +00004749- CONFIG_MX_CYCLIC
4750 Add the "mdc" and "mwc" memory commands. These are cyclic
4751 "md/mw" commands.
4752 Examples:
4753
wdenk07d7e6b2004-12-16 21:44:03 +00004754 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004755 This command will print 4 bytes (10,11,12,13) each 500 ms.
4756
wdenk07d7e6b2004-12-16 21:44:03 +00004757 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004758 This command will write 12345678 to address 100 all 10 ms.
4759
wdenk07d7e6b2004-12-16 21:44:03 +00004760 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004761 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004762
wdenk3d3d99f2005-04-04 12:44:11 +00004763- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004764 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004765 low level initializations (like setting up the memory
4766 controller) are omitted and/or U-Boot does not
4767 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004768
Wolfgang Denk302141d2010-11-27 23:30:56 +01004769 Normally this variable MUST NOT be defined. The only
4770 exception is when U-Boot is loaded (to RAM) by some
4771 other boot loader or by a debugger which performs
4772 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004773
Simon Glass90844072016-05-05 07:28:06 -06004774- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4775 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004776 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004777 instruction cache) is still performed.
4778
Aneesh V552a3192011-07-13 05:11:07 +00004779- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004780 Modifies the behaviour of start.S when compiling a loader
4781 that is executed before the actual U-Boot. E.g. when
4782 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004783
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004784- CONFIG_TPL_BUILD
4785 Modifies the behaviour of start.S when compiling a loader
4786 that is executed after the SPL and before the actual U-Boot.
4787 It is loaded by the SPL.
4788
Ying Zhang0d4f5442013-05-20 14:07:23 +08004789- CONFIG_SYS_MPC85XX_NO_RESETVEC
4790 Only for 85xx systems. If this variable is specified, the section
4791 .resetvec is not kept and the section .bootpg is placed in the
4792 previous 4k of the .text section.
4793
Simon Glass17dabf02013-02-24 17:33:14 +00004794- CONFIG_ARCH_MAP_SYSMEM
4795 Generally U-Boot (and in particular the md command) uses
4796 effective address. It is therefore not necessary to regard
4797 U-Boot address as virtual addresses that need to be translated
4798 to physical addresses. However, sandbox requires this, since
4799 it maintains its own little RAM buffer which contains all
4800 addressable memory. This option causes some memory accesses
4801 to be mapped through map_sysmem() / unmap_sysmem().
4802
Matthias Weisser93416c12011-03-10 21:36:32 +00004803- CONFIG_USE_ARCH_MEMCPY
4804 CONFIG_USE_ARCH_MEMSET
4805 If these options are used a optimized version of memcpy/memset will
4806 be used if available. These functions may be faster under some
4807 conditions but may increase the binary size.
4808
Simon Glassbfb59802013-02-14 04:18:54 +00004809- CONFIG_X86_RESET_VECTOR
4810 If defined, the x86 reset vector code is included. This is not
4811 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004812
Mark Jackson52b003c2013-03-04 01:27:20 +00004813- CONFIG_SYS_MPUCLK
4814 Defines the MPU clock speed (in MHz).
4815
4816 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004817
Heiko Schocher2233e462013-11-04 14:05:00 +01004818- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4819 Enables the RTC32K OSC on AM33xx based plattforms
4820
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004821- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4822 Option to disable subpage write in NAND driver
4823 driver that uses this:
4824 drivers/mtd/nand/davinci_nand.c
4825
Timur Tabi275f4bb2011-11-22 09:21:25 -06004826Freescale QE/FMAN Firmware Support:
4827-----------------------------------
4828
4829The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4830loading of "firmware", which is encoded in the QE firmware binary format.
4831This firmware often needs to be loaded during U-Boot booting, so macros
4832are used to identify the storage device (NOR flash, SPI, etc) and the address
4833within that device.
4834
Zhao Qiang83a90842014-03-21 16:21:44 +08004835- CONFIG_SYS_FMAN_FW_ADDR
4836 The address in the storage device where the FMAN microcode is located. The
4837 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4838 is also specified.
4839
4840- CONFIG_SYS_QE_FW_ADDR
4841 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004842 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4843 is also specified.
4844
4845- CONFIG_SYS_QE_FMAN_FW_LENGTH
4846 The maximum possible size of the firmware. The firmware binary format
4847 has a field that specifies the actual size of the firmware, but it
4848 might not be possible to read any part of the firmware unless some
4849 local storage is allocated to hold the entire firmware first.
4850
4851- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4852 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4853 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4854 virtual address in NOR flash.
4855
4856- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4857 Specifies that QE/FMAN firmware is located in NAND flash.
4858 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4859
4860- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4861 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4862 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4863
4864- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4865 Specifies that QE/FMAN firmware is located on the primary SPI
4866 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4867
Liu Gang1e084582012-03-08 00:33:18 +00004868- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4869 Specifies that QE/FMAN firmware is located in the remote (master)
4870 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004871 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4872 window->master inbound window->master LAW->the ucode address in
4873 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004874
J. German Rivera8ff14b72014-06-23 15:15:55 -07004875Freescale Layerscape Management Complex Firmware Support:
4876---------------------------------------------------------
4877The Freescale Layerscape Management Complex (MC) supports the loading of
4878"firmware".
4879This firmware often needs to be loaded during U-Boot booting, so macros
4880are used to identify the storage device (NOR flash, SPI, etc) and the address
4881within that device.
4882
4883- CONFIG_FSL_MC_ENET
4884 Enable the MC driver for Layerscape SoCs.
4885
4886- CONFIG_SYS_LS_MC_FW_ADDR
4887 The address in the storage device where the firmware is located. The
4888 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4889 is also specified.
4890
4891- CONFIG_SYS_LS_MC_FW_LENGTH
4892 The maximum possible size of the firmware. The firmware binary format
4893 has a field that specifies the actual size of the firmware, but it
4894 might not be possible to read any part of the firmware unless some
4895 local storage is allocated to hold the entire firmware first.
4896
4897- CONFIG_SYS_LS_MC_FW_IN_NOR
4898 Specifies that MC firmware is located in NOR flash, mapped as
4899 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4900 virtual address in NOR flash.
4901
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304902Freescale Layerscape Debug Server Support:
4903-------------------------------------------
4904The Freescale Layerscape Debug Server Support supports the loading of
4905"Debug Server firmware" and triggering SP boot-rom.
4906This firmware often needs to be loaded during U-Boot booting.
4907
York Sun928b6812015-12-07 11:08:58 -08004908- CONFIG_SYS_MC_RSV_MEM_ALIGN
4909 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304910
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004911Reproducible builds
4912-------------------
4913
4914In order to achieve reproducible builds, timestamps used in the U-Boot build
4915process have to be set to a fixed value.
4916
4917This is done using the SOURCE_DATE_EPOCH environment variable.
4918SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4919option for U-Boot or an environment variable in U-Boot.
4920
4921SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4922
wdenkc6097192002-11-03 00:24:07 +00004923Building the Software:
4924======================
4925
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004926Building U-Boot has been tested in several native build environments
4927and in many different cross environments. Of course we cannot support
4928all possibly existing versions of cross development tools in all
4929(potentially obsolete) versions. In case of tool chain problems we
4930recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4931which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004932
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004933If you are not using a native environment, it is assumed that you
4934have GNU cross compiling tools available in your path. In this case,
4935you must set the environment variable CROSS_COMPILE in your shell.
4936Note that no changes to the Makefile or any other source files are
4937necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004938
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004939 $ CROSS_COMPILE=ppc_4xx-
4940 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004941
Peter Tyserb06976d2009-03-13 18:54:51 -05004942Note: If you wish to generate Windows versions of the utilities in
4943 the tools directory you can use the MinGW toolchain
4944 (http://www.mingw.org). Set your HOST tools to the MinGW
4945 toolchain and execute 'make tools'. For example:
4946
4947 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4948
4949 Binaries such as tools/mkimage.exe will be created which can
4950 be executed on computers running Windows.
4951
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004952U-Boot is intended to be simple to build. After installing the
4953sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004954is done by typing:
4955
Holger Freyther7ba4e572014-08-04 09:26:05 +02004956 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004957
Holger Freyther7ba4e572014-08-04 09:26:05 +02004958where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004959rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004960
wdenk6c59edc2004-05-03 20:45:30 +00004961Note: for some board special configuration names may exist; check if
4962 additional information is available from the board vendor; for
4963 instance, the TQM823L systems are available without (standard)
4964 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004965 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004966
Holger Freyther7ba4e572014-08-04 09:26:05 +02004967 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004968 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004969
Holger Freyther7ba4e572014-08-04 09:26:05 +02004970 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004971 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004972
wdenk6c59edc2004-05-03 20:45:30 +00004973 etc.
wdenkc6097192002-11-03 00:24:07 +00004974
wdenkc6097192002-11-03 00:24:07 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976Finally, type "make all", and you should get some working U-Boot
4977images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004978
wdenk6c59edc2004-05-03 20:45:30 +00004979- "u-boot.bin" is a raw binary image
4980- "u-boot" is an image in ELF binary format
4981- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004982
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004983By default the build is performed locally and the objects are saved
4984in the source directory. One of the two methods can be used to change
4985this behavior and build U-Boot to some external directory:
4986
49871. Add O= to the make command line invocations:
4988
4989 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004990 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004991 make O=/tmp/build all
4992
Timo Ketolac8c67602014-11-06 14:39:05 +020049932. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004994
Timo Ketolac8c67602014-11-06 14:39:05 +02004995 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004996 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004997 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004998 make all
4999
Timo Ketolac8c67602014-11-06 14:39:05 +02005000Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005001variable.
5002
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk6c59edc2004-05-03 20:45:30 +00005004Please be aware that the Makefiles assume you are using GNU make, so
5005for instance on NetBSD you might need to use "gmake" instead of
5006native "make".
wdenkc6097192002-11-03 00:24:07 +00005007
wdenkc6097192002-11-03 00:24:07 +00005008
wdenk6c59edc2004-05-03 20:45:30 +00005009If the system board that you have is not listed, then you will need
5010to port U-Boot to your hardware platform. To do this, follow these
5011steps:
wdenkc6097192002-11-03 00:24:07 +00005012
Phil Sutterc77b4882015-12-25 14:41:18 +010050131. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00005014 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01005015 the "Makefile" and a "<board>.c".
50162. Create a new configuration file "include/configs/<board>.h" for
5017 your board.
wdenk6c59edc2004-05-03 20:45:30 +000050183. If you're porting U-Boot to a new CPU, then also create a new
5019 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020050204. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000050215. Type "make", and you should get a working "u-boot.srec" file
5022 to be installed on your target system.
50236. Debug and solve any problems that might arise.
5024 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005025
wdenkc6097192002-11-03 00:24:07 +00005026
wdenk6c59edc2004-05-03 20:45:30 +00005027Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5028==============================================================
wdenkc6097192002-11-03 00:24:07 +00005029
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005030If you have modified U-Boot sources (for instance added a new board
5031or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005032provide feedback to the other developers. The feedback normally takes
5033the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005034official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005035
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005036But before you submit such a patch, please verify that your modifi-
5037cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005038the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06005039just run the buildman script (tools/buildman/buildman), which will
5040configure and build U-Boot for ALL supported system. Be warned, this
5041will take a while. Please see the buildman README, or run 'buildman -H'
5042for documentation.
wdenkc6097192002-11-03 00:24:07 +00005043
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005044
wdenk6c59edc2004-05-03 20:45:30 +00005045See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005046
wdenkc6097192002-11-03 00:24:07 +00005047
wdenk6c59edc2004-05-03 20:45:30 +00005048Monitor Commands - Overview:
5049============================
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051go - start application at address 'addr'
5052run - run commands in an environment variable
5053bootm - boot application image from memory
5054bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005055bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005056tftpboot- boot image via network using TFTP protocol
5057 and env variables "ipaddr" and "serverip"
5058 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005059tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005060rarpboot- boot image via network using RARP/TFTP protocol
5061diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5062loads - load S-Record file over serial line
5063loadb - load binary file over serial line (kermit mode)
5064md - memory display
5065mm - memory modify (auto-incrementing)
5066nm - memory modify (constant address)
5067mw - memory write (fill)
5068cp - memory copy
5069cmp - memory compare
5070crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005071i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005072sspi - SPI utility commands
5073base - print or set address offset
5074printenv- print environment variables
5075setenv - set environment variables
5076saveenv - save environment variables to persistent storage
5077protect - enable or disable FLASH write protection
5078erase - erase FLASH memory
5079flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005080nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005081bdinfo - print Board Info structure
5082iminfo - print header information for application image
5083coninfo - print console devices and informations
5084ide - IDE sub-system
5085loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005086loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005087mtest - simple RAM test
5088icache - enable or disable instruction cache
5089dcache - enable or disable data cache
5090reset - Perform RESET of the CPU
5091echo - echo args to console
5092version - print monitor version
5093help - print online help
5094? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005095
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk6c59edc2004-05-03 20:45:30 +00005097Monitor Commands - Detailed Description:
5098========================================
wdenkc6097192002-11-03 00:24:07 +00005099
wdenk6c59edc2004-05-03 20:45:30 +00005100TODO.
wdenkc6097192002-11-03 00:24:07 +00005101
wdenk6c59edc2004-05-03 20:45:30 +00005102For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005103
5104
wdenk6c59edc2004-05-03 20:45:30 +00005105Environment Variables:
5106======================
wdenkc6097192002-11-03 00:24:07 +00005107
wdenk6c59edc2004-05-03 20:45:30 +00005108U-Boot supports user configuration using Environment Variables which
5109can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111Environment Variables are set using "setenv", printed using
5112"printenv", and saved to Flash using "saveenv". Using "setenv"
5113without a value can be used to delete a variable from the
5114environment. As long as you don't save the environment you are
5115working with an in-memory copy. In case the Flash area containing the
5116environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005117
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005118Some configuration options can be set using Environment Variables.
5119
5120List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005121
wdenk6c59edc2004-05-03 20:45:30 +00005122 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005123
wdenk6c59edc2004-05-03 20:45:30 +00005124 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005125
wdenk6c59edc2004-05-03 20:45:30 +00005126 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk6c59edc2004-05-03 20:45:30 +00005128 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005129
wdenk6c59edc2004-05-03 20:45:30 +00005130 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005131
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005132 bootm_low - Memory range available for image processing in the bootm
5133 command can be restricted. This variable is given as
5134 a hexadecimal number and defines lowest address allowed
5135 for use by the bootm command. See also "bootm_size"
5136 environment variable. Address defined by "bootm_low" is
5137 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005138 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5139 bootm_mapsize.
5140
Wolfgang Denk092ae952011-10-26 10:21:21 +00005141 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005142 This variable is given as a hexadecimal number and it
5143 defines the size of the memory region starting at base
5144 address bootm_low that is accessible by the Linux kernel
5145 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5146 as the default value if it is defined, and bootm_size is
5147 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005148
5149 bootm_size - Memory range available for image processing in the bootm
5150 command can be restricted. This variable is given as
5151 a hexadecimal number and defines the size of the region
5152 allowed for use by the bootm command. See also "bootm_low"
5153 environment variable.
5154
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005155 updatefile - Location of the software update file on a TFTP server, used
5156 by the automatic software update feature. Please refer to
5157 documentation in doc/README.update for more details.
5158
wdenk6c59edc2004-05-03 20:45:30 +00005159 autoload - if set to "no" (any string beginning with 'n'),
5160 "bootp" will just load perform a lookup of the
5161 configuration from the BOOTP server, but not try to
5162 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk6c59edc2004-05-03 20:45:30 +00005164 autostart - if set to "yes", an image loaded using the "bootp",
5165 "rarpboot", "tftpboot" or "diskboot" commands will
5166 be automatically started (by internally calling
5167 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk6c59edc2004-05-03 20:45:30 +00005169 If set to "no", a standalone image passed to the
5170 "bootm" command will be copied to the load address
5171 (and eventually uncompressed), but NOT be started.
5172 This can be used to load and uncompress arbitrary
5173 data.
wdenkc6097192002-11-03 00:24:07 +00005174
David A. Longd558a4e2011-07-09 16:40:19 -04005175 fdt_high - if set this restricts the maximum address that the
5176 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005177 For example, if you have a system with 1 GB memory
5178 at physical address 0x10000000, while Linux kernel
5179 only recognizes the first 704 MB as low memory, you
5180 may need to set fdt_high as 0x3C000000 to have the
5181 device tree blob be copied to the maximum address
5182 of the 704 MB low memory, so that Linux kernel can
5183 access it during the boot procedure.
5184
David A. Longd558a4e2011-07-09 16:40:19 -04005185 If this is set to the special value 0xFFFFFFFF then
5186 the fdt will not be copied at all on boot. For this
5187 to work it must reside in writable memory, have
5188 sufficient padding on the end of it for u-boot to
5189 add the information it needs into it, and the memory
5190 must be accessible by the kernel.
5191
Simon Glassdc6fa642011-10-24 19:15:34 +00005192 fdtcontroladdr- if set this is the address of the control flattened
5193 device tree used by U-Boot when CONFIG_OF_CONTROL is
5194 defined.
5195
wdenk0e2bd9c2004-06-06 21:51:03 +00005196 i2cfast - (PPC405GP|PPC405EP only)
5197 if set to 'y' configures Linux I2C driver for fast
5198 mode (400kHZ). This environment variable is used in
5199 initialization code. So, for changes to be effective
5200 it must be saved and board must be reset.
5201
wdenk6c59edc2004-05-03 20:45:30 +00005202 initrd_high - restrict positioning of initrd images:
5203 If this variable is not set, initrd images will be
5204 copied to the highest possible address in RAM; this
5205 is usually what you want since it allows for
5206 maximum initrd size. If for some reason you want to
5207 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005208 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005209 variable to a value of "no" or "off" or "0".
5210 Alternatively, you can set it to a maximum upper
5211 address to use (U-Boot will still check that it
5212 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005213
wdenk6c59edc2004-05-03 20:45:30 +00005214 For instance, when you have a system with 16 MB
5215 RAM, and want to reserve 4 MB from use by Linux,
5216 you can do this by adding "mem=12M" to the value of
5217 the "bootargs" variable. However, now you must make
5218 sure that the initrd image is placed in the first
5219 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk6c59edc2004-05-03 20:45:30 +00005221 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223 If you set initrd_high to 0xFFFFFFFF, this is an
5224 indication to U-Boot that all addresses are legal
5225 for the Linux kernel, including addresses in flash
5226 memory. In this case U-Boot will NOT COPY the
5227 ramdisk at all. This may be useful to reduce the
5228 boot time on your system, but requires that this
5229 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005230
wdenk6c59edc2004-05-03 20:45:30 +00005231 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005232
wdenk6c59edc2004-05-03 20:45:30 +00005233 loadaddr - Default load address for commands like "bootp",
5234 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005235
wdenk6c59edc2004-05-03 20:45:30 +00005236 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk6c59edc2004-05-03 20:45:30 +00005238 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005239
wdenk6c59edc2004-05-03 20:45:30 +00005240 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk6c59edc2004-05-03 20:45:30 +00005242 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk6c59edc2004-05-03 20:45:30 +00005244 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005245
Mike Frysingera23230c2011-10-02 10:01:27 +00005246 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005247
Mike Frysingera23230c2011-10-02 10:01:27 +00005248 ethact - controls which interface is currently active.
5249 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005250
Heiko Schocherc5e84052010-07-20 17:45:02 +02005251 => setenv ethact FEC
5252 => ping 192.168.0.1 # traffic sent on FEC
5253 => setenv ethact SCC
5254 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005255
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005256 ethrotate - When set to "no" U-Boot does not go through all
5257 available network interfaces.
5258 It just stays at the currently selected interface.
5259
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005260 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005261 either succeed or fail without retrying.
5262 When set to "once" the network operation will
5263 fail when all the available network interfaces
5264 are tried once without success.
5265 Useful on scripts which control the retry operation
5266 themselves.
wdenkc6097192002-11-03 00:24:07 +00005267
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005268 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005269
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005270 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005271 changing the console to be empty. If "yes" it will be
5272 made silent. If "no" it will not be made silent. If
5273 unset, then it will be made silent if the U-Boot console
5274 is silent.
5275
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005276 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005277 UDP source port.
5278
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005279 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005280 destination port instead of the Well Know Port 69.
5281
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005282 tftpblocksize - Block size to use for TFTP transfers; if not set,
5283 we use the TFTP server's default block size
5284
5285 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5286 seconds, minimum value is 1000 = 1 second). Defines
5287 when a packet is considered to be lost so it has to
5288 be retransmitted. The default is 5000 = 5 seconds.
5289 Lowering this value may make downloads succeed
5290 faster in networks with high packet loss rates or
5291 with unreliable TFTP servers.
5292
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005293 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5294 unit, minimum value = 0). Defines how many timeouts
5295 can happen during a single file transfer before that
5296 transfer is aborted. The default is 10, and 0 means
5297 'no timeouts allowed'. Increasing this value may help
5298 downloads succeed with high packet loss rates, or with
5299 unreliable TFTP servers or client hardware.
5300
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005301 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005302 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005303 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005304
Alexandre Messier15971322016-02-01 17:08:57 -05005305 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5306 Unsigned value, in milliseconds. If not set, the period will
5307 be either the default (28000), or a value based on
5308 CONFIG_NET_RETRY_COUNT, if defined. This value has
5309 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5310
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005311The following image location variables contain the location of images
5312used in booting. The "Image" column gives the role of the image and is
5313not an environment variable name. The other columns are environment
5314variable names. "File Name" gives the name of the file on a TFTP
5315server, "RAM Address" gives the location in RAM the image will be
5316loaded to, and "Flash Location" gives the image's address in NOR
5317flash or offset in NAND flash.
5318
5319*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005320boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005321boards use these variables for other purposes.
5322
Wolfgang Denk092ae952011-10-26 10:21:21 +00005323Image File Name RAM Address Flash Location
5324----- --------- ----------- --------------
5325u-boot u-boot u-boot_addr_r u-boot_addr
5326Linux kernel bootfile kernel_addr_r kernel_addr
5327device tree blob fdtfile fdt_addr_r fdt_addr
5328ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330The following environment variables may be used and automatically
5331updated by the network boot commands ("bootp" and "rarpboot"),
5332depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005333
wdenk6c59edc2004-05-03 20:45:30 +00005334 bootfile - see above
5335 dnsip - IP address of your Domain Name Server
5336 dnsip2 - IP address of your secondary Domain Name Server
5337 gatewayip - IP address of the Gateway (Router) to use
5338 hostname - Target hostname
5339 ipaddr - see above
5340 netmask - Subnet Mask
5341 rootpath - Pathname of the root filesystem on the NFS server
5342 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005343
wdenk145d2c12004-04-15 21:48:45 +00005344
wdenk6c59edc2004-05-03 20:45:30 +00005345There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005346
wdenk6c59edc2004-05-03 20:45:30 +00005347 serial# - contains hardware identification information such
5348 as type string and/or serial number
5349 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351These variables can be set only once (usually during manufacturing of
5352the board). U-Boot refuses to delete or overwrite these variables
5353once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005354
5355
wdenk6c59edc2004-05-03 20:45:30 +00005356Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358 ver - Contains the U-Boot version string as printed
5359 with the "version" command. This variable is
5360 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005361
wdenkc6097192002-11-03 00:24:07 +00005362
wdenk6c59edc2004-05-03 20:45:30 +00005363Please note that changes to some configuration parameters may take
5364only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005365
stroeseb9c17c52003-04-04 15:53:41 +00005366
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005367Callback functions for environment variables:
5368---------------------------------------------
5369
5370For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005371when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005372be associated with arbitrary variables. On creation, overwrite, or
5373deletion, the callback will provide the opportunity for some side
5374effect to happen or for the change to be rejected.
5375
5376The callbacks are named and associated with a function using the
5377U_BOOT_ENV_CALLBACK macro in your board or driver code.
5378
5379These callbacks are associated with variables in one of two ways. The
5380static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5381in the board configuration to a string that defines a list of
5382associations. The list must be in the following format:
5383
5384 entry = variable_name[:callback_name]
5385 list = entry[,list]
5386
5387If the callback name is not specified, then the callback is deleted.
5388Spaces are also allowed anywhere in the list.
5389
5390Callbacks can also be associated by defining the ".callbacks" variable
5391with the same list format above. Any association in ".callbacks" will
5392override any association in the static list. You can define
5393CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005394".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005395
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005396If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5397regular expression. This allows multiple variables to be connected to
5398the same callback without explicitly listing them all out.
5399
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005400
wdenk6c59edc2004-05-03 20:45:30 +00005401Command Line Parsing:
5402=====================
stroeseb9c17c52003-04-04 15:53:41 +00005403
wdenk6c59edc2004-05-03 20:45:30 +00005404There are two different command line parsers available with U-Boot:
5405the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005406
wdenk6c59edc2004-05-03 20:45:30 +00005407Old, simple command line parser:
5408--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410- supports environment variables (through setenv / saveenv commands)
5411- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005412- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005413- special characters ('$', ';') can be escaped by prefixing with '\',
5414 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005415 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005416- You can also escape text by enclosing in single apostrophes, for example:
5417 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005418
wdenk6c59edc2004-05-03 20:45:30 +00005419Hush shell:
5420-----------
wdenkf4688a22003-05-28 08:06:31 +00005421
wdenk6c59edc2004-05-03 20:45:30 +00005422- similar to Bourne shell, with control structures like
5423 if...then...else...fi, for...do...done; while...do...done,
5424 until...do...done, ...
5425- supports environment ("global") variables (through setenv / saveenv
5426 commands) and local shell variables (through standard shell syntax
5427 "name=value"); only environment variables can be used with "run"
5428 command
wdenkf4688a22003-05-28 08:06:31 +00005429
wdenk6c59edc2004-05-03 20:45:30 +00005430General rules:
5431--------------
wdenkf4688a22003-05-28 08:06:31 +00005432
wdenk6c59edc2004-05-03 20:45:30 +00005433(1) If a command line (or an environment variable executed by a "run"
5434 command) contains several commands separated by semicolon, and
5435 one of these commands fails, then the remaining commands will be
5436 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005437
wdenk6c59edc2004-05-03 20:45:30 +00005438(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005439 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005440 command will cause "run" to terminate, i. e. the remaining
5441 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005442
wdenk6c59edc2004-05-03 20:45:30 +00005443Note for Redundant Ethernet Interfaces:
5444=======================================
wdenkf4688a22003-05-28 08:06:31 +00005445
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005446Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005447such configurations and is capable of automatic selection of a
5448"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005449
wdenk6c59edc2004-05-03 20:45:30 +00005450Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5451MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5452"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005453
wdenk6c59edc2004-05-03 20:45:30 +00005454If the network interface stores some valid MAC address (for instance
5455in SROM), this is used as default address if there is NO correspon-
5456ding setting in the environment; if the corresponding environment
5457variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005458
wdenk6c59edc2004-05-03 20:45:30 +00005459o If the SROM has a valid MAC address, and there is no address in the
5460 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005461
wdenk6c59edc2004-05-03 20:45:30 +00005462o If there is no valid address in the SROM, and a definition in the
5463 environment exists, then the value from the environment variable is
5464 used.
wdenkc6097192002-11-03 00:24:07 +00005465
wdenk6c59edc2004-05-03 20:45:30 +00005466o If both the SROM and the environment contain a MAC address, and
5467 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005468
wdenk6c59edc2004-05-03 20:45:30 +00005469o If both the SROM and the environment contain a MAC address, and the
5470 addresses differ, the value from the environment is used and a
5471 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005472
wdenk6c59edc2004-05-03 20:45:30 +00005473o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005474 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5475 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005476
Ben Warren6db991a2010-04-26 11:11:46 -07005477If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005478will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005479may be skipped by setting the appropriate 'ethmacskip' environment variable.
5480The naming convention is as follows:
5481"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005482
wdenk6c59edc2004-05-03 20:45:30 +00005483Image Formats:
5484==============
wdenkc6097192002-11-03 00:24:07 +00005485
Marian Balakowicz18710b82008-03-12 12:13:13 +01005486U-Boot is capable of booting (and performing other auxiliary operations on)
5487images in two formats:
5488
5489New uImage format (FIT)
5490-----------------------
5491
5492Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5493to Flattened Device Tree). It allows the use of images with multiple
5494components (several kernels, ramdisks, etc.), with contents protected by
5495SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5496
5497
5498Old uImage format
5499-----------------
5500
5501Old image format is based on binary files which can be basically anything,
5502preceded by a special header; see the definitions in include/image.h for
5503details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005504
wdenk6c59edc2004-05-03 20:45:30 +00005505* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5506 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005507 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5508 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5509 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005510* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005511 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5512 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005513* Compression Type (uncompressed, gzip, bzip2)
5514* Load Address
5515* Entry Point
5516* Image Name
5517* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005518
wdenk6c59edc2004-05-03 20:45:30 +00005519The header is marked by a special Magic Number, and both the header
5520and the data portions of the image are secured against corruption by
5521CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005522
wdenkc6097192002-11-03 00:24:07 +00005523
wdenk6c59edc2004-05-03 20:45:30 +00005524Linux Support:
5525==============
wdenkc6097192002-11-03 00:24:07 +00005526
wdenk6c59edc2004-05-03 20:45:30 +00005527Although U-Boot should support any OS or standalone application
5528easily, the main focus has always been on Linux during the design of
5529U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk6c59edc2004-05-03 20:45:30 +00005531U-Boot includes many features that so far have been part of some
5532special "boot loader" code within the Linux kernel. Also, any
5533"initrd" images to be used are no longer part of one big Linux image;
5534instead, kernel and "initrd" are separate images. This implementation
5535serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537- the same features can be used for other OS or standalone
5538 applications (for instance: using compressed images to reduce the
5539 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005540
wdenk6c59edc2004-05-03 20:45:30 +00005541- it becomes much easier to port new Linux kernel versions because
5542 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005543
wdenk6c59edc2004-05-03 20:45:30 +00005544- the same Linux kernel image can now be used with different "initrd"
5545 images; of course this also means that different kernel images can
5546 be run with the same "initrd". This makes testing easier (you don't
5547 have to build a new "zImage.initrd" Linux image when you just
5548 change a file in your "initrd"). Also, a field-upgrade of the
5549 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005550
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk6c59edc2004-05-03 20:45:30 +00005552Linux HOWTO:
5553============
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk6c59edc2004-05-03 20:45:30 +00005555Porting Linux to U-Boot based systems:
5556---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005557
wdenk6c59edc2004-05-03 20:45:30 +00005558U-Boot cannot save you from doing all the necessary modifications to
5559configure the Linux device drivers for use with your target hardware
5560(no, we don't intend to provide a full virtual machine interface to
5561Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005562
Stefan Roese88fbf932010-04-15 16:07:28 +02005563But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005564
wdenk6c59edc2004-05-03 20:45:30 +00005565Just make sure your machine specific header file (for instance
5566include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005567Information structure as we define in include/asm-<arch>/u-boot.h,
5568and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005569as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005570
Simon Glassd097e592014-06-11 23:29:46 -06005571Note that U-Boot now has a driver model, a unified model for drivers.
5572If you are adding a new driver, plumb it into driver model. If there
5573is no uclass available, you are encouraged to create one. See
5574doc/driver-model.
5575
wdenkc6097192002-11-03 00:24:07 +00005576
wdenk6c59edc2004-05-03 20:45:30 +00005577Configuring the Linux kernel:
5578-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005579
wdenk6c59edc2004-05-03 20:45:30 +00005580No specific requirements for U-Boot. Make sure you have some root
5581device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005582
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk6c59edc2004-05-03 20:45:30 +00005584Building a Linux Image:
5585-----------------------
wdenkc6097192002-11-03 00:24:07 +00005586
wdenk6c59edc2004-05-03 20:45:30 +00005587With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5588not used. If you use recent kernel source, a new build target
5589"uImage" will exist which automatically builds an image usable by
5590U-Boot. Most older kernels also have support for a "pImage" target,
5591which was introduced for our predecessor project PPCBoot and uses a
5592100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk6c59edc2004-05-03 20:45:30 +00005594Example:
wdenkc6097192002-11-03 00:24:07 +00005595
Holger Freyther7ba4e572014-08-04 09:26:05 +02005596 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005597 make oldconfig
5598 make dep
5599 make uImage
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk6c59edc2004-05-03 20:45:30 +00005601The "uImage" build target uses a special tool (in 'tools/mkimage') to
5602encapsulate a compressed Linux kernel image with header information,
5603CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005604
wdenk6c59edc2004-05-03 20:45:30 +00005605* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005608
wdenk6c59edc2004-05-03 20:45:30 +00005609 ${CROSS_COMPILE}-objcopy -O binary \
5610 -R .note -R .comment \
5611 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005612
wdenk6c59edc2004-05-03 20:45:30 +00005613* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005618
wdenk6c59edc2004-05-03 20:45:30 +00005619 mkimage -A ppc -O linux -T kernel -C gzip \
5620 -a 0 -e 0 -n "Linux Kernel Image" \
5621 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005622
wdenkc6097192002-11-03 00:24:07 +00005623
wdenk6c59edc2004-05-03 20:45:30 +00005624The "mkimage" tool can also be used to create ramdisk images for use
5625with U-Boot, either separated from the Linux kernel image, or
5626combined into one file. "mkimage" encapsulates the images with a 64
5627byte header containing information about target architecture,
5628operating system, image type, compression method, entry points, time
5629stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk6c59edc2004-05-03 20:45:30 +00005631"mkimage" can be called in two ways: to verify existing images and
5632print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005633
wdenk6c59edc2004-05-03 20:45:30 +00005634In the first form (with "-l" option) mkimage lists the information
5635contained in the header of an existing U-Boot image; this includes
5636checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005637
wdenk6c59edc2004-05-03 20:45:30 +00005638 tools/mkimage -l image
5639 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005640
wdenk6c59edc2004-05-03 20:45:30 +00005641The second form (with "-d" option) is used to build a U-Boot image
5642from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005643
wdenk6c59edc2004-05-03 20:45:30 +00005644 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5645 -n name -d data_file image
5646 -A ==> set architecture to 'arch'
5647 -O ==> set operating system to 'os'
5648 -T ==> set image type to 'type'
5649 -C ==> set compression type 'comp'
5650 -a ==> set load address to 'addr' (hex)
5651 -e ==> set entry point to 'ep' (hex)
5652 -n ==> set image name to 'name'
5653 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005654
wdenkcd914452004-05-29 16:53:29 +00005655Right now, all Linux kernels for PowerPC systems use the same load
5656address (0x00000000), but the entry point address depends on the
5657kernel version:
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk6c59edc2004-05-03 20:45:30 +00005659- 2.2.x kernels have the entry point at 0x0000000C,
5660- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk6c59edc2004-05-03 20:45:30 +00005662So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk6c59edc2004-05-03 20:45:30 +00005664 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5665 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005666 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005667 > examples/uImage.TQM850L
5668 Image Name: 2.4.4 kernel for TQM850L
5669 Created: Wed Jul 19 02:34:59 2000
5670 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5671 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5672 Load Address: 0x00000000
5673 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005674
wdenk6c59edc2004-05-03 20:45:30 +00005675To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005676
wdenk6c59edc2004-05-03 20:45:30 +00005677 -> tools/mkimage -l examples/uImage.TQM850L
5678 Image Name: 2.4.4 kernel for TQM850L
5679 Created: Wed Jul 19 02:34:59 2000
5680 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5681 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5682 Load Address: 0x00000000
5683 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005684
wdenk6c59edc2004-05-03 20:45:30 +00005685NOTE: for embedded systems where boot time is critical you can trade
5686speed for memory and install an UNCOMPRESSED image instead: this
5687needs more space in Flash, but boots much faster since it does not
5688need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005689
Stefan Roese88fbf932010-04-15 16:07:28 +02005690 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005691 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5692 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005693 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005694 > examples/uImage.TQM850L-uncompressed
5695 Image Name: 2.4.4 kernel for TQM850L
5696 Created: Wed Jul 19 02:34:59 2000
5697 Image Type: PowerPC Linux Kernel Image (uncompressed)
5698 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5699 Load Address: 0x00000000
5700 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005701
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk6c59edc2004-05-03 20:45:30 +00005703Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5704when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706 -> tools/mkimage -n 'Simple Ramdisk Image' \
5707 > -A ppc -O linux -T ramdisk -C gzip \
5708 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5709 Image Name: Simple Ramdisk Image
5710 Created: Wed Jan 12 14:01:50 2000
5711 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5712 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5713 Load Address: 0x00000000
5714 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005715
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005716The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5717option performs the converse operation of the mkimage's second form (the "-d"
5718option). Given an image built by mkimage, the dumpimage extracts a "data file"
5719from the image:
5720
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005721 tools/dumpimage -i image -T type -p position data_file
5722 -i ==> extract from the 'image' a specific 'data_file'
5723 -T ==> set image type to 'type'
5724 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005725
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727Installing a Linux Image:
5728-------------------------
wdenkc6097192002-11-03 00:24:07 +00005729
wdenk6c59edc2004-05-03 20:45:30 +00005730To downloading a U-Boot image over the serial (console) interface,
5731you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk6c59edc2004-05-03 20:45:30 +00005733 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005734
wdenk6c59edc2004-05-03 20:45:30 +00005735The 'objcopy' does not understand the information in the U-Boot
5736image header, so the resulting S-Record file will be relative to
5737address 0x00000000. To load it to a given address, you need to
5738specify the target address as 'offset' parameter with the 'loads'
5739command.
wdenkc6097192002-11-03 00:24:07 +00005740
wdenk6c59edc2004-05-03 20:45:30 +00005741Example: install the image to address 0x40100000 (which on the
5742TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005743
wdenk6c59edc2004-05-03 20:45:30 +00005744 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk6c59edc2004-05-03 20:45:30 +00005746 .......... done
5747 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005748
wdenk6c59edc2004-05-03 20:45:30 +00005749 => loads 40100000
5750 ## Ready for S-Record download ...
5751 ~>examples/image.srec
5752 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5753 ...
5754 15989 15990 15991 15992
5755 [file transfer complete]
5756 [connected]
5757 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005758
wdenkc6097192002-11-03 00:24:07 +00005759
wdenk6c59edc2004-05-03 20:45:30 +00005760You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005761this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005762corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk6c59edc2004-05-03 20:45:30 +00005764 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005765
wdenk6c59edc2004-05-03 20:45:30 +00005766 ## Checking Image at 40100000 ...
5767 Image Name: 2.2.13 for initrd on TQM850L
5768 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5769 Data Size: 335725 Bytes = 327 kB = 0 MB
5770 Load Address: 00000000
5771 Entry Point: 0000000c
5772 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005773
5774
wdenk6c59edc2004-05-03 20:45:30 +00005775Boot Linux:
5776-----------
wdenkc6097192002-11-03 00:24:07 +00005777
wdenk6c59edc2004-05-03 20:45:30 +00005778The "bootm" command is used to boot an application that is stored in
5779memory (RAM or Flash). In case of a Linux kernel image, the contents
5780of the "bootargs" environment variable is passed to the kernel as
5781parameters. You can check and modify this variable using the
5782"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005783
wdenkc6097192002-11-03 00:24:07 +00005784
wdenk6c59edc2004-05-03 20:45:30 +00005785 => printenv bootargs
5786 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005787
wdenk6c59edc2004-05-03 20:45:30 +00005788 => 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 +00005789
wdenk6c59edc2004-05-03 20:45:30 +00005790 => printenv bootargs
5791 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 +00005792
wdenk6c59edc2004-05-03 20:45:30 +00005793 => bootm 40020000
5794 ## Booting Linux kernel at 40020000 ...
5795 Image Name: 2.2.13 for NFS on TQM850L
5796 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5797 Data Size: 381681 Bytes = 372 kB = 0 MB
5798 Load Address: 00000000
5799 Entry Point: 0000000c
5800 Verifying Checksum ... OK
5801 Uncompressing Kernel Image ... OK
5802 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
5803 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5804 time_init: decrementer frequency = 187500000/60
5805 Calibrating delay loop... 49.77 BogoMIPS
5806 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5807 ...
wdenkc6097192002-11-03 00:24:07 +00005808
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005809If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005810the memory addresses of both the kernel and the initrd image (PPBCOOT
5811format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk6c59edc2004-05-03 20:45:30 +00005813 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005814
wdenk6c59edc2004-05-03 20:45:30 +00005815 ## Checking Image at 40100000 ...
5816 Image Name: 2.2.13 for initrd on TQM850L
5817 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5818 Data Size: 335725 Bytes = 327 kB = 0 MB
5819 Load Address: 00000000
5820 Entry Point: 0000000c
5821 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005822
wdenk6c59edc2004-05-03 20:45:30 +00005823 ## Checking Image at 40200000 ...
5824 Image Name: Simple Ramdisk Image
5825 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5826 Data Size: 566530 Bytes = 553 kB = 0 MB
5827 Load Address: 00000000
5828 Entry Point: 00000000
5829 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk6c59edc2004-05-03 20:45:30 +00005831 => bootm 40100000 40200000
5832 ## Booting Linux kernel at 40100000 ...
5833 Image Name: 2.2.13 for initrd on TQM850L
5834 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5835 Data Size: 335725 Bytes = 327 kB = 0 MB
5836 Load Address: 00000000
5837 Entry Point: 0000000c
5838 Verifying Checksum ... OK
5839 Uncompressing Kernel Image ... OK
5840 ## Loading RAMDisk Image at 40200000 ...
5841 Image Name: Simple Ramdisk Image
5842 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5843 Data Size: 566530 Bytes = 553 kB = 0 MB
5844 Load Address: 00000000
5845 Entry Point: 00000000
5846 Verifying Checksum ... OK
5847 Loading Ramdisk ... OK
5848 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
5849 Boot arguments: root=/dev/ram
5850 time_init: decrementer frequency = 187500000/60
5851 Calibrating delay loop... 49.77 BogoMIPS
5852 ...
5853 RAMDISK: Compressed image found at block 0
5854 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005855
wdenk6c59edc2004-05-03 20:45:30 +00005856 bash#
wdenkc6097192002-11-03 00:24:07 +00005857
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005858Boot Linux and pass a flat device tree:
5859-----------
5860
5861First, U-Boot must be compiled with the appropriate defines. See the section
5862titled "Linux Kernel Interface" above for a more in depth explanation. The
5863following is an example of how to start a kernel and pass an updated
5864flat device tree:
5865
5866=> print oftaddr
5867oftaddr=0x300000
5868=> print oft
5869oft=oftrees/mpc8540ads.dtb
5870=> tftp $oftaddr $oft
5871Speed: 1000, full duplex
5872Using TSEC0 device
5873TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5874Filename 'oftrees/mpc8540ads.dtb'.
5875Load address: 0x300000
5876Loading: #
5877done
5878Bytes transferred = 4106 (100a hex)
5879=> tftp $loadaddr $bootfile
5880Speed: 1000, full duplex
5881Using TSEC0 device
5882TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5883Filename 'uImage'.
5884Load address: 0x200000
5885Loading:############
5886done
5887Bytes transferred = 1029407 (fb51f hex)
5888=> print loadaddr
5889loadaddr=200000
5890=> print oftaddr
5891oftaddr=0x300000
5892=> bootm $loadaddr - $oftaddr
5893## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005894 Image Name: Linux-2.6.17-dirty
5895 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5896 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005897 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005898 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005899 Verifying Checksum ... OK
5900 Uncompressing Kernel Image ... OK
5901Booting using flat device tree at 0x300000
5902Using MPC85xx ADS machine description
5903Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5904[snip]
5905
5906
wdenk6c59edc2004-05-03 20:45:30 +00005907More About U-Boot Image Types:
5908------------------------------
wdenkc6097192002-11-03 00:24:07 +00005909
wdenk6c59edc2004-05-03 20:45:30 +00005910U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005911
wdenk6c59edc2004-05-03 20:45:30 +00005912 "Standalone Programs" are directly runnable in the environment
5913 provided by U-Boot; it is expected that (if they behave
5914 well) you can continue to work in U-Boot after return from
5915 the Standalone Program.
5916 "OS Kernel Images" are usually images of some Embedded OS which
5917 will take over control completely. Usually these programs
5918 will install their own set of exception handlers, device
5919 drivers, set up the MMU, etc. - this means, that you cannot
5920 expect to re-enter U-Boot except by resetting the CPU.
5921 "RAMDisk Images" are more or less just data blocks, and their
5922 parameters (address, size) are passed to an OS kernel that is
5923 being started.
5924 "Multi-File Images" contain several images, typically an OS
5925 (Linux) kernel image and one or more data images like
5926 RAMDisks. This construct is useful for instance when you want
5927 to boot over the network using BOOTP etc., where the boot
5928 server provides just a single image file, but you want to get
5929 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005930
wdenk6c59edc2004-05-03 20:45:30 +00005931 "Multi-File Images" start with a list of image sizes, each
5932 image size (in bytes) specified by an "uint32_t" in network
5933 byte order. This list is terminated by an "(uint32_t)0".
5934 Immediately after the terminating 0 follow the images, one by
5935 one, all aligned on "uint32_t" boundaries (size rounded up to
5936 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005937
wdenk6c59edc2004-05-03 20:45:30 +00005938 "Firmware Images" are binary images containing firmware (like
5939 U-Boot or FPGA images) which usually will be programmed to
5940 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005941
wdenk6c59edc2004-05-03 20:45:30 +00005942 "Script files" are command sequences that will be executed by
5943 U-Boot's command interpreter; this feature is especially
5944 useful when you configure U-Boot to use a real shell (hush)
5945 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005946
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005947Booting the Linux zImage:
5948-------------------------
5949
5950On some platforms, it's possible to boot Linux zImage. This is done
5951using the "bootz" command. The syntax of "bootz" command is the same
5952as the syntax of "bootm" command.
5953
Tom Rini45f46d12013-05-16 11:40:11 -04005954Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005955kernel with raw initrd images. The syntax is slightly different, the
5956address of the initrd must be augmented by it's size, in the following
5957format: "<initrd addres>:<initrd size>".
5958
stroeseb9c17c52003-04-04 15:53:41 +00005959
wdenk6c59edc2004-05-03 20:45:30 +00005960Standalone HOWTO:
5961=================
stroeseb9c17c52003-04-04 15:53:41 +00005962
wdenk6c59edc2004-05-03 20:45:30 +00005963One of the features of U-Boot is that you can dynamically load and
5964run "standalone" applications, which can use some resources of
5965U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005966
wdenk6c59edc2004-05-03 20:45:30 +00005967Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005968
wdenk6c59edc2004-05-03 20:45:30 +00005969"Hello World" Demo:
5970-------------------
wdenkc6097192002-11-03 00:24:07 +00005971
wdenk6c59edc2004-05-03 20:45:30 +00005972'examples/hello_world.c' contains a small "Hello World" Demo
5973application; it is automatically compiled when you build U-Boot.
5974It's configured to run at address 0x00040004, so you can play with it
5975like that:
wdenkc6097192002-11-03 00:24:07 +00005976
wdenk6c59edc2004-05-03 20:45:30 +00005977 => loads
5978 ## Ready for S-Record download ...
5979 ~>examples/hello_world.srec
5980 1 2 3 4 5 6 7 8 9 10 11 ...
5981 [file transfer complete]
5982 [connected]
5983 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005984
wdenk6c59edc2004-05-03 20:45:30 +00005985 => go 40004 Hello World! This is a test.
5986 ## Starting application at 0x00040004 ...
5987 Hello World
5988 argc = 7
5989 argv[0] = "40004"
5990 argv[1] = "Hello"
5991 argv[2] = "World!"
5992 argv[3] = "This"
5993 argv[4] = "is"
5994 argv[5] = "a"
5995 argv[6] = "test."
5996 argv[7] = "<NULL>"
5997 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005998
wdenk6c59edc2004-05-03 20:45:30 +00005999 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006000
wdenk6c59edc2004-05-03 20:45:30 +00006001Another example, which demonstrates how to register a CPM interrupt
6002handler with the U-Boot code, can be found in 'examples/timer.c'.
6003Here, a CPM timer is set up to generate an interrupt every second.
6004The interrupt service routine is trivial, just printing a '.'
6005character, but this is just a demo program. The application can be
6006controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006007
wdenk6c59edc2004-05-03 20:45:30 +00006008 ? - print current values og the CPM Timer registers
6009 b - enable interrupts and start timer
6010 e - stop timer and disable interrupts
6011 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006012
wdenk6c59edc2004-05-03 20:45:30 +00006013 => loads
6014 ## Ready for S-Record download ...
6015 ~>examples/timer.srec
6016 1 2 3 4 5 6 7 8 9 10 11 ...
6017 [file transfer complete]
6018 [connected]
6019 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006020
wdenk6c59edc2004-05-03 20:45:30 +00006021 => go 40004
6022 ## Starting application at 0x00040004 ...
6023 TIMERS=0xfff00980
6024 Using timer 1
6025 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006026
wdenk6c59edc2004-05-03 20:45:30 +00006027Hit 'b':
6028 [q, b, e, ?] Set interval 1000000 us
6029 Enabling timer
6030Hit '?':
6031 [q, b, e, ?] ........
6032 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6033Hit '?':
6034 [q, b, e, ?] .
6035 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6036Hit '?':
6037 [q, b, e, ?] .
6038 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6039Hit '?':
6040 [q, b, e, ?] .
6041 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6042Hit 'e':
6043 [q, b, e, ?] ...Stopping timer
6044Hit 'q':
6045 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006046
wdenkc6097192002-11-03 00:24:07 +00006047
wdenk6c59edc2004-05-03 20:45:30 +00006048Minicom warning:
6049================
wdenkc6097192002-11-03 00:24:07 +00006050
wdenk6c59edc2004-05-03 20:45:30 +00006051Over time, many people have reported problems when trying to use the
6052"minicom" terminal emulation program for serial download. I (wd)
6053consider minicom to be broken, and recommend not to use it. Under
6054Unix, I recommend to use C-Kermit for general purpose use (and
6055especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006056use "cu" for S-Record download ("loads" command). See
6057http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6058for help with kermit.
6059
wdenkc6097192002-11-03 00:24:07 +00006060
wdenk6c59edc2004-05-03 20:45:30 +00006061Nevertheless, if you absolutely want to use it try adding this
6062configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006063
wdenk6c59edc2004-05-03 20:45:30 +00006064 Name Program Name U/D FullScr IO-Red. Multi
6065 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6066 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006067
wdenk8dba0502003-03-31 16:34:49 +00006068
wdenk6c59edc2004-05-03 20:45:30 +00006069NetBSD Notes:
6070=============
wdenkc6097192002-11-03 00:24:07 +00006071
wdenk6c59edc2004-05-03 20:45:30 +00006072Starting at version 0.9.2, U-Boot supports NetBSD both as host
6073(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006074
wdenk6c59edc2004-05-03 20:45:30 +00006075Building requires a cross environment; it is known to work on
6076NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6077need gmake since the Makefiles are not compatible with BSD make).
6078Note that the cross-powerpc package does not install include files;
6079attempting to build U-Boot will fail because <machine/ansi.h> is
6080missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006081
wdenk6c59edc2004-05-03 20:45:30 +00006082 # cd /usr/pkg/cross/powerpc-netbsd/include
6083 # mkdir powerpc
6084 # ln -s powerpc machine
6085 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6086 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006087
wdenk6c59edc2004-05-03 20:45:30 +00006088Native builds *don't* work due to incompatibilities between native
6089and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006090
wdenk6c59edc2004-05-03 20:45:30 +00006091Booting assumes that (the first part of) the image booted is a
6092stage-2 loader which in turn loads and then invokes the kernel
6093proper. Loader sources will eventually appear in the NetBSD source
6094tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006095meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006096
wdenkc6097192002-11-03 00:24:07 +00006097
wdenk6c59edc2004-05-03 20:45:30 +00006098Implementation Internals:
6099=========================
wdenkc6097192002-11-03 00:24:07 +00006100
wdenk6c59edc2004-05-03 20:45:30 +00006101The following is not intended to be a complete description of every
6102implementation detail. However, it should help to understand the
6103inner workings of U-Boot and make it easier to port it to custom
6104hardware.
wdenkc6097192002-11-03 00:24:07 +00006105
wdenkc6097192002-11-03 00:24:07 +00006106
wdenk6c59edc2004-05-03 20:45:30 +00006107Initial Stack, Global Data:
6108---------------------------
wdenkc6097192002-11-03 00:24:07 +00006109
wdenk6c59edc2004-05-03 20:45:30 +00006110The implementation of U-Boot is complicated by the fact that U-Boot
6111starts running out of ROM (flash memory), usually without access to
6112system RAM (because the memory controller is not initialized yet).
6113This means that we don't have writable Data or BSS segments, and BSS
6114is not initialized as zero. To be able to get a C environment working
6115at all, we have to allocate at least a minimal stack. Implementation
6116options for this are defined and restricted by the CPU used: Some CPU
6117models provide on-chip memory (like the IMMR area on MPC8xx and
6118MPC826x processors), on others (parts of) the data cache can be
6119locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006120
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006121 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006122 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006123
wdenk6c59edc2004-05-03 20:45:30 +00006124 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6125 From: "Chris Hallinan" <clh@net1plus.com>
6126 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6127 ...
wdenkc6097192002-11-03 00:24:07 +00006128
wdenk6c59edc2004-05-03 20:45:30 +00006129 Correct me if I'm wrong, folks, but the way I understand it
6130 is this: Using DCACHE as initial RAM for Stack, etc, does not
6131 require any physical RAM backing up the cache. The cleverness
6132 is that the cache is being used as a temporary supply of
6133 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006134 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006135 can see how this works by studying the cache architecture and
6136 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006137
wdenk6c59edc2004-05-03 20:45:30 +00006138 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6139 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006140 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006141 option should work for you. Using CS 4 should be fine if your
6142 board designers haven't used it for something that would
6143 cause you grief during the initial boot! It is frequently not
6144 used.
wdenkc6097192002-11-03 00:24:07 +00006145
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006146 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006147 with your processor/board/system design. The default value
6148 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006149 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006150 than your SDRAM module. If you have a 64MB SDRAM module, set
6151 it above 400_0000. Just make sure your board has no resources
6152 that are supposed to respond to that address! That code in
6153 start.S has been around a while and should work as is when
6154 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006155
wdenk6c59edc2004-05-03 20:45:30 +00006156 -Chris Hallinan
6157 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006158
wdenk6c59edc2004-05-03 20:45:30 +00006159It is essential to remember this, since it has some impact on the C
6160code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006161
wdenk6c59edc2004-05-03 20:45:30 +00006162* Initialized global data (data segment) is read-only. Do not attempt
6163 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006164
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006165* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006166 as zero data - BSS segment) at all - this is undefined, initiali-
6167 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006168
wdenk6c59edc2004-05-03 20:45:30 +00006169* Stack space is very limited. Avoid big data buffers or things like
6170 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006171
wdenk6c59edc2004-05-03 20:45:30 +00006172Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006173normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006174turned out that the implementation of U-Boot can be greatly
6175simplified by making a global data structure (gd_t) available to all
6176functions. We could pass a pointer to this data as argument to _all_
6177functions, but this would bloat the code. Instead we use a feature of
6178the GCC compiler (Global Register Variables) to share the data: we
6179place a pointer (gd) to the global data into a register which we
6180reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006181
wdenk6c59edc2004-05-03 20:45:30 +00006182When choosing a register for such a purpose we are restricted by the
6183relevant (E)ABI specifications for the current architecture, and by
6184GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006185
wdenk6c59edc2004-05-03 20:45:30 +00006186For PowerPC, the following registers have specific use:
6187 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006188 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006189 R3-R4: parameter passing and return values
6190 R5-R10: parameter passing
6191 R13: small data area pointer
6192 R30: GOT pointer
6193 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006194
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006195 (U-Boot also uses R12 as internal GOT pointer. r12
6196 is a volatile register so r12 needs to be reset when
6197 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006198
Wolfgang Denk69c09642008-02-14 22:43:22 +01006199 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006200
wdenk6c59edc2004-05-03 20:45:30 +00006201 Note: on PPC, we could use a static initializer (since the
6202 address of the global data structure is known at compile time),
6203 but it turned out that reserving a register results in somewhat
6204 smaller code - although the code savings are not that big (on
6205 average for all boards 752 bytes for the whole U-Boot image,
6206 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006207
Robin Getz2773d5f2009-08-17 15:23:02 +00006208On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006209 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6210
Robin Getz2773d5f2009-08-17 15:23:02 +00006211 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006212
wdenk6c59edc2004-05-03 20:45:30 +00006213On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006214
wdenk6c59edc2004-05-03 20:45:30 +00006215 R0: function argument word/integer result
6216 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006217 R9: platform specific
6218 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006219 R11: argument (frame) pointer
6220 R12: temporary workspace
6221 R13: stack pointer
6222 R14: link register
6223 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006224
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006225 ==> U-Boot will use R9 to hold a pointer to the global data
6226
6227 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006228
Thomas Chou8fa38582010-05-21 11:08:03 +08006229On Nios II, the ABI is documented here:
6230 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6231
6232 ==> U-Boot will use gp to hold a pointer to the global data
6233
6234 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6235 to access small data sections, so gp is free.
6236
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006237On NDS32, the following registers are used:
6238
6239 R0-R1: argument/return
6240 R2-R5: argument
6241 R15: temporary register for assembler
6242 R16: trampoline register
6243 R28: frame pointer (FP)
6244 R29: global pointer (GP)
6245 R30: link register (LP)
6246 R31: stack pointer (SP)
6247 PC: program counter (PC)
6248
6249 ==> U-Boot will use R10 to hold a pointer to the global data
6250
Wolfgang Denk6405a152006-03-31 18:32:53 +02006251NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6252or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006253
wdenk6c59edc2004-05-03 20:45:30 +00006254Memory Management:
6255------------------
wdenkc6097192002-11-03 00:24:07 +00006256
wdenk6c59edc2004-05-03 20:45:30 +00006257U-Boot runs in system state and uses physical addresses, i.e. the
6258MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006259
wdenk6c59edc2004-05-03 20:45:30 +00006260The available memory is mapped to fixed addresses using the memory
6261controller. In this process, a contiguous block is formed for each
6262memory type (Flash, SDRAM, SRAM), even when it consists of several
6263physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006264
wdenk6c59edc2004-05-03 20:45:30 +00006265U-Boot is installed in the first 128 kB of the first Flash bank (on
6266TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6267booting and sizing and initializing DRAM, the code relocates itself
6268to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006269memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006270configuration setting]. Below that, a structure with global Board
6271Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006272
wdenk6c59edc2004-05-03 20:45:30 +00006273Additionally, some exception handler code is copied to the low 8 kB
6274of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006275
wdenk6c59edc2004-05-03 20:45:30 +00006276So a typical memory configuration with 16 MB of DRAM could look like
6277this:
wdenkc6097192002-11-03 00:24:07 +00006278
wdenk6c59edc2004-05-03 20:45:30 +00006279 0x0000 0000 Exception Vector code
6280 :
6281 0x0000 1FFF
6282 0x0000 2000 Free for Application Use
6283 :
6284 :
wdenkc6097192002-11-03 00:24:07 +00006285
wdenk6c59edc2004-05-03 20:45:30 +00006286 :
6287 :
6288 0x00FB FF20 Monitor Stack (Growing downward)
6289 0x00FB FFAC Board Info Data and permanent copy of global data
6290 0x00FC 0000 Malloc Arena
6291 :
6292 0x00FD FFFF
6293 0x00FE 0000 RAM Copy of Monitor Code
6294 ... eventually: LCD or video framebuffer
6295 ... eventually: pRAM (Protected RAM - unchanged by reset)
6296 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006297
wdenkc6097192002-11-03 00:24:07 +00006298
wdenk6c59edc2004-05-03 20:45:30 +00006299System Initialization:
6300----------------------
wdenkc6097192002-11-03 00:24:07 +00006301
wdenk6c59edc2004-05-03 20:45:30 +00006302In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006303(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006304configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006305To be able to re-map memory U-Boot then jumps to its link address.
6306To be able to implement the initialization code in C, a (small!)
6307initial stack is set up in the internal Dual Ported RAM (in case CPUs
6308which provide such a feature like MPC8xx or MPC8260), or in a locked
6309part of the data cache. After that, U-Boot initializes the CPU core,
6310the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006311
wdenk6c59edc2004-05-03 20:45:30 +00006312Next, all (potentially) available memory banks are mapped using a
6313preliminary mapping. For example, we put them on 512 MB boundaries
6314(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6315on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6316programmed for SDRAM access. Using the temporary configuration, a
6317simple memory test is run that determines the size of the SDRAM
6318banks.
wdenkc6097192002-11-03 00:24:07 +00006319
wdenk6c59edc2004-05-03 20:45:30 +00006320When there is more than one SDRAM bank, and the banks are of
6321different size, the largest is mapped first. For equal size, the first
6322bank (CS2#) is mapped first. The first mapping is always for address
63230x00000000, with any additional banks following immediately to create
6324contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006325
wdenk6c59edc2004-05-03 20:45:30 +00006326Then, the monitor installs itself at the upper end of the SDRAM area
6327and allocates memory for use by malloc() and for the global Board
6328Info data; also, the exception vector code is copied to the low RAM
6329pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006330
wdenk6c59edc2004-05-03 20:45:30 +00006331Only after this relocation will you have a "normal" C environment;
6332until that you are restricted in several ways, mostly because you are
6333running from ROM, and because the code will have to be relocated to a
6334new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006335
wdenkc6097192002-11-03 00:24:07 +00006336
wdenk6c59edc2004-05-03 20:45:30 +00006337U-Boot Porting Guide:
6338----------------------
wdenkc6097192002-11-03 00:24:07 +00006339
wdenk6c59edc2004-05-03 20:45:30 +00006340[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6341list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006342
wdenkc6097192002-11-03 00:24:07 +00006343
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006344int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006345{
6346 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006347
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006348 signal(SIGALRM, no_more_time);
6349 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006350
wdenk6c59edc2004-05-03 20:45:30 +00006351 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006352 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006353 return 0;
6354 }
wdenkc6097192002-11-03 00:24:07 +00006355
wdenk6c59edc2004-05-03 20:45:30 +00006356 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006357
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006358 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006359
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006360 if (clueless)
6361 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006362
wdenk6c59edc2004-05-03 20:45:30 +00006363 while (learning) {
6364 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006365 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6366 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006367 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006368 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006369 }
wdenkc6097192002-11-03 00:24:07 +00006370
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006371 if (available_money > toLocalCurrency ($2500))
6372 Buy a BDI3000;
6373 else
wdenk6c59edc2004-05-03 20:45:30 +00006374 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006375
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006376 if (a similar board exists) { /* hopefully... */
6377 cp -a board/<similar> board/<myboard>
6378 cp include/configs/<similar>.h include/configs/<myboard>.h
6379 } else {
6380 Create your own board support subdirectory;
6381 Create your own board include/configs/<myboard>.h file;
6382 }
6383 Edit new board/<myboard> files
6384 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006385
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006386 while (!accepted) {
6387 while (!running) {
6388 do {
6389 Add / modify source code;
6390 } until (compiles);
6391 Debug;
6392 if (clueless)
6393 email("Hi, I am having problems...");
6394 }
6395 Send patch file to the U-Boot email list;
6396 if (reasonable critiques)
6397 Incorporate improvements from email list code review;
6398 else
6399 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006400 }
wdenkc6097192002-11-03 00:24:07 +00006401
wdenk6c59edc2004-05-03 20:45:30 +00006402 return 0;
6403}
wdenkc6097192002-11-03 00:24:07 +00006404
wdenk6c59edc2004-05-03 20:45:30 +00006405void no_more_time (int sig)
6406{
6407 hire_a_guru();
6408}
wdenkc6097192002-11-03 00:24:07 +00006409
wdenkc6097192002-11-03 00:24:07 +00006410
wdenk6c59edc2004-05-03 20:45:30 +00006411Coding Standards:
6412-----------------
wdenkc6097192002-11-03 00:24:07 +00006413
wdenk6c59edc2004-05-03 20:45:30 +00006414All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006415coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006416"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006417
6418Source files originating from a different project (for example the
6419MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006420reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006421sources.
wdenkc6097192002-11-03 00:24:07 +00006422
Detlev Zundelaa63d482006-09-01 15:39:02 +02006423Please note that U-Boot is implemented in C (and to some small parts in
6424Assembler); no C++ is used, so please do not use C++ style comments (//)
6425in your code.
wdenkad276f22004-01-04 16:28:35 +00006426
wdenk6c59edc2004-05-03 20:45:30 +00006427Please also stick to the following formatting rules:
6428- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006429- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006430- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006431- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006432- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006433
wdenk6c59edc2004-05-03 20:45:30 +00006434Submissions which do not conform to the standards may be returned
6435with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006436
wdenkc6097192002-11-03 00:24:07 +00006437
wdenk6c59edc2004-05-03 20:45:30 +00006438Submitting Patches:
6439-------------------
wdenkc6097192002-11-03 00:24:07 +00006440
wdenk6c59edc2004-05-03 20:45:30 +00006441Since the number of patches for U-Boot is growing, we need to
6442establish some rules. Submissions which do not conform to these rules
6443may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006444
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006445Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006446
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006447Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6448see http://lists.denx.de/mailman/listinfo/u-boot
6449
wdenk6c59edc2004-05-03 20:45:30 +00006450When you send a patch, please include the following information with
6451it:
wdenkc6097192002-11-03 00:24:07 +00006452
wdenk6c59edc2004-05-03 20:45:30 +00006453* For bug fixes: a description of the bug and how your patch fixes
6454 this bug. Please try to include a way of demonstrating that the
6455 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006456
wdenk6c59edc2004-05-03 20:45:30 +00006457* For new features: a description of the feature and your
6458 implementation.
wdenkc6097192002-11-03 00:24:07 +00006459
wdenk6c59edc2004-05-03 20:45:30 +00006460* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006461
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006462* For major contributions, add a MAINTAINERS file with your
6463 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006464
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006465* When you add support for a new board, don't forget to add a
6466 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006467
wdenk6c59edc2004-05-03 20:45:30 +00006468* If your patch adds new configuration options, don't forget to
6469 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006470
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006471* The patch itself. If you are using git (which is *strongly*
6472 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006473 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006474 the U-Boot mailing list, you will avoid most of the common problems
6475 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006476
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006477 If you cannot use git, use "diff -purN OLD NEW". If your version of
6478 diff does not support these options, then get the latest version of
6479 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006480
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006481 The current directory when running this command shall be the parent
6482 directory of the U-Boot source tree (i. e. please make sure that
6483 your patch includes sufficient directory information for the
6484 affected files).
6485
6486 We prefer patches as plain text. MIME attachments are discouraged,
6487 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006488
wdenk6c59edc2004-05-03 20:45:30 +00006489* If one logical set of modifications affects or creates several
6490 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006491
wdenk6c59edc2004-05-03 20:45:30 +00006492* Changesets that contain different, unrelated modifications shall be
6493 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006494
wdenkc6097192002-11-03 00:24:07 +00006495
wdenk6c59edc2004-05-03 20:45:30 +00006496Notes:
wdenkc6097192002-11-03 00:24:07 +00006497
Simon Glassdc27def2016-07-27 20:33:08 -06006498* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006499 source tree and make sure that no errors or warnings are reported
6500 for any of the boards.
6501
6502* Keep your modifications to the necessary minimum: A patch
6503 containing several unrelated changes or arbitrary reformats will be
6504 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006505
wdenk6c59edc2004-05-03 20:45:30 +00006506* If you modify existing code, make sure that your new code does not
6507 add to the memory footprint of the code ;-) Small is beautiful!
6508 When adding new features, these should compile conditionally only
6509 (using #ifdef), and the resulting code with the new feature
6510 disabled must not need more memory than the old code without your
6511 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006512
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006513* Remember that there is a size limit of 100 kB per message on the
6514 u-boot mailing list. Bigger patches will be moderated. If they are
6515 reasonable and not too big, they will be acknowledged. But patches
6516 bigger than the size limit should be avoided.