blob: d916ee77f59486fc65a6ef515aaeab33b498cf73 [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.
1684 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1685
wdenkda04a8b2004-08-02 23:22:59 +00001686- Journaling Flash filesystem support:
1687 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1688 CONFIG_JFFS2_NAND_DEV
1689 Define these for a default partition on a NAND device
1690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001691 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1692 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001693 Define these for a default partition on a NOR device
1694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001695 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001696 Define this to create an own partition. You have to provide a
1697 function struct part_info* jffs2_part_info(int part_num)
1698
1699 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001700 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001701 to disable the command chpart. This is the default when you
1702 have not defined a custom partition
1703
Donggeun Kim8f814002011-10-24 21:15:28 +00001704- FAT(File Allocation Table) filesystem write function support:
1705 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001706
1707 Define this to enable support for saving memory data as a
1708 file in FAT formatted partition.
1709
1710 This will also enable the command "fatwrite" enabling the
1711 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001712
Gabe Black7f8574c2012-10-12 14:26:11 +00001713CBFS (Coreboot Filesystem) support
1714 CONFIG_CMD_CBFS
1715
1716 Define this to enable support for reading from a Coreboot
1717 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1718 and cbfsload.
1719
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301720- FAT(File Allocation Table) filesystem cluster size:
1721 CONFIG_FS_FAT_MAX_CLUSTSIZE
1722
1723 Define the max cluster size for fat operations else
1724 a default value of 65536 will be defined.
1725
wdenkc6097192002-11-03 00:24:07 +00001726- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001727 See Kconfig help for available keyboard drivers.
1728
1729 CONFIG_KEYBOARD
1730
1731 Define this to enable a custom keyboard support.
1732 This simply calls drv_keyboard_init() which must be
1733 defined in your board-specific files. This option is deprecated
1734 and is only used by novena. For new boards, use driver model
1735 instead.
wdenkc6097192002-11-03 00:24:07 +00001736
1737- Video support:
1738 CONFIG_VIDEO
1739
1740 Define this to enable video support (for output to
1741 video).
1742
1743 CONFIG_VIDEO_CT69000
1744
1745 Enable Chips & Technologies 69000 Video chip
1746
1747 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001748 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001749 video output is selected via environment 'videoout'
1750 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1751 assumed.
wdenkc6097192002-11-03 00:24:07 +00001752
wdenkd3602132004-03-25 15:14:43 +00001753 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001754 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001755 are possible:
1756 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001757 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001758
1759 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1760 -------------+---------------------------------------------
1761 8 bits | 0x301* 0x303 0x305 0x161 0x307
1762 15 bits | 0x310 0x313 0x316 0x162 0x319
1763 16 bits | 0x311 0x314 0x317 0x163 0x31A
1764 24 bits | 0x312 0x315 0x318 ? 0x31B
1765 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001766 (i.e. setenv videomode 317; saveenv; reset;)
1767
wdenkd3602132004-03-25 15:14:43 +00001768 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001769 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001770
1771
stroeseb9c17c52003-04-04 15:53:41 +00001772 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001773 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001774 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1775 or CONFIG_VIDEO_SED13806_16BPP
1776
Timur Tabi020edd22011-02-15 17:09:19 -06001777 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001778 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001779 SOCs that have a DIU should define this macro to enable DIU
1780 support, and should also define these other macros:
1781
1782 CONFIG_SYS_DIU_ADDR
1783 CONFIG_VIDEO
1784 CONFIG_CMD_BMP
1785 CONFIG_CFB_CONSOLE
1786 CONFIG_VIDEO_SW_CURSOR
1787 CONFIG_VGA_AS_SINGLE_DEVICE
1788 CONFIG_VIDEO_LOGO
1789 CONFIG_VIDEO_BMP_LOGO
1790
Timur Tabi32f709e2011-04-11 14:18:22 -05001791 The DIU driver will look for the 'video-mode' environment
1792 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001793 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001794 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001795
wdenkc6097192002-11-03 00:24:07 +00001796- LCD Support: CONFIG_LCD
1797
1798 Define this to enable LCD support (for output to LCD
1799 display); also select one of the supported displays
1800 by defining one of these:
1801
Stelian Popf6f86652008-05-09 21:57:18 +02001802 CONFIG_ATMEL_LCD:
1803
1804 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1805
wdenkc0d54ae2003-11-25 16:55:19 +00001806 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001807
wdenkc0d54ae2003-11-25 16:55:19 +00001808 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001809
wdenkc0d54ae2003-11-25 16:55:19 +00001810 CONFIG_NEC_NL6448BC20
1811
1812 NEC NL6448BC20-08. 6.5", 640x480.
1813 Active, color, single scan.
1814
1815 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001816
wdenkc0d54ae2003-11-25 16:55:19 +00001817 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001818 Active, color, single scan.
1819
1820 CONFIG_SHARP_16x9
1821
1822 Sharp 320x240. Active, color, single scan.
1823 It isn't 16x9, and I am not sure what it is.
1824
1825 CONFIG_SHARP_LQ64D341
1826
1827 Sharp LQ64D341 display, 640x480.
1828 Active, color, single scan.
1829
1830 CONFIG_HLD1045
1831
1832 HLD1045 display, 640x480.
1833 Active, color, single scan.
1834
1835 CONFIG_OPTREX_BW
1836
1837 Optrex CBL50840-2 NF-FW 99 22 M5
1838 or
1839 Hitachi LMG6912RPFC-00T
1840 or
1841 Hitachi SP14Q002
1842
1843 320x240. Black & white.
1844
1845 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001846 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001847
Simon Glass599a4df2012-10-17 13:24:54 +00001848 CONFIG_LCD_ALIGNMENT
1849
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001850 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001851 defined then the LCD will be aligned to this value instead.
1852 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1853 here, since it is cheaper to change data cache settings on
1854 a per-section basis.
1855
Simon Glassaf3e2802012-10-17 13:24:59 +00001856 CONFIG_CONSOLE_SCROLL_LINES
1857
1858 When the console need to be scrolled, this is the number of
1859 lines to scroll by. It defaults to 1. Increasing this makes
1860 the console jump but can help speed up operation when scrolling
1861 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001862
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001863 CONFIG_LCD_ROTATION
1864
1865 Sometimes, for example if the display is mounted in portrait
1866 mode or even if it's mounted landscape but rotated by 180degree,
1867 we need to rotate our content of the display relative to the
1868 framebuffer, so that user can read the messages which are
1869 printed out.
1870 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1871 initialized with a given rotation from "vl_rot" out of
1872 "vidinfo_t" which is provided by the board specific code.
1873 The value for vl_rot is coded as following (matching to
1874 fbcon=rotate:<n> linux-kernel commandline):
1875 0 = no rotation respectively 0 degree
1876 1 = 90 degree rotation
1877 2 = 180 degree rotation
1878 3 = 270 degree rotation
1879
1880 If CONFIG_LCD_ROTATION is not defined, the console will be
1881 initialized with 0degree rotation.
1882
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001883 CONFIG_LCD_BMP_RLE8
1884
1885 Support drawing of RLE8-compressed bitmaps on the LCD.
1886
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001887 CONFIG_I2C_EDID
1888
1889 Enables an 'i2c edid' command which can read EDID
1890 information over I2C from an attached LCD display.
1891
wdenkeb20ad32003-09-05 23:19:14 +00001892- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001893
wdenk57b2d802003-06-27 21:31:46 +00001894 If this option is set, the environment is checked for
1895 a variable "splashimage". If found, the usual display
1896 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001897 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001898 specified in "splashimage" is loaded instead. The
1899 console is redirected to the "nulldev", too. This
1900 allows for a "silent" boot where a splash screen is
1901 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001902
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001903 CONFIG_SPLASHIMAGE_GUARD
1904
1905 If this option is set, then U-Boot will prevent the environment
1906 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001907 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001908 This option is useful for targets where, due to alignment
1909 restrictions, an improperly aligned BMP image will cause a data
1910 abort. If you think you will not have problems with unaligned
1911 accesses (for example because your toolchain prevents them)
1912 there is no need to set this option.
1913
Matthias Weisser53884182009-07-09 16:07:30 +02001914 CONFIG_SPLASH_SCREEN_ALIGN
1915
1916 If this option is set the splash image can be freely positioned
1917 on the screen. Environment variable "splashpos" specifies the
1918 position as "x,y". If a positive number is given it is used as
1919 number of pixel from left/top. If a negative number is given it
1920 is used as number of pixel from right/bottom. You can also
1921 specify 'm' for centering the image.
1922
1923 Example:
1924 setenv splashpos m,m
1925 => image at center of screen
1926
1927 setenv splashpos 30,20
1928 => image at x = 30 and y = 20
1929
1930 setenv splashpos -10,m
1931 => vertically centered image
1932 at x = dspWidth - bmpWidth - 9
1933
Stefan Roesed9d97742005-09-22 09:04:17 +02001934- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1935
1936 If this option is set, additionally to standard BMP
1937 images, gzipped BMP images can be displayed via the
1938 splashscreen support or the bmp command.
1939
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001940- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1941
1942 If this option is set, 8-bit RLE compressed BMP images
1943 can be displayed via the splashscreen support or the
1944 bmp command.
1945
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001946- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001947 CONFIG_CMD_ZIP
1948
1949 If this option is set, it would use zlib deflate method
1950 to compress the specified memory at its best effort.
1951
wdenk710e3502003-08-29 20:57:53 +00001952- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001953 CONFIG_GZIP
1954
1955 Enabled by default to support gzip compressed images.
1956
wdenk710e3502003-08-29 20:57:53 +00001957 CONFIG_BZIP2
1958
1959 If this option is set, support for bzip2 compressed
1960 images is included. If not, only uncompressed and gzip
1961 compressed images are supported.
1962
wdenk9c53f402003-10-15 23:53:47 +00001963 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001964 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001965 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001966
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001967 CONFIG_LZMA
1968
1969 If this option is set, support for lzma compressed
1970 images is included.
1971
1972 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1973 requires an amount of dynamic memory that is given by the
1974 formula:
1975
1976 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1977
1978 Where lc and lp stand for, respectively, Literal context bits
1979 and Literal pos bits.
1980
1981 This value is upper-bounded by 14MB in the worst case. Anyway,
1982 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1983 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1984 a very small buffer.
1985
1986 Use the lzmainfo tool to determinate the lc and lp values and
1987 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001988 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001989
Kees Cook5b06e642013-08-16 07:59:12 -07001990 CONFIG_LZO
1991
1992 If this option is set, support for LZO compressed images
1993 is included.
1994
wdenk0e2bd9c2004-06-06 21:51:03 +00001995- MII/PHY support:
1996 CONFIG_PHY_ADDR
1997
1998 The address of PHY on MII bus.
1999
2000 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2001
2002 The clock frequency of the MII bus
2003
2004 CONFIG_PHY_GIGE
2005
2006 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002007 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002008
2009 CONFIG_PHY_RESET_DELAY
2010
2011 Some PHY like Intel LXT971A need extra delay after
2012 reset before any MII register access is possible.
2013 For such PHY, set this option to the usec delay
2014 required. (minimum 300usec for LXT971A)
2015
2016 CONFIG_PHY_CMD_DELAY (ppc4xx)
2017
2018 Some PHY like Intel LXT971A need extra delay after
2019 command issued before MII status register can be read
2020
wdenkc6097192002-11-03 00:24:07 +00002021- IP address:
2022 CONFIG_IPADDR
2023
2024 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002025 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002026 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002027 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002028
2029- Server IP address:
2030 CONFIG_SERVERIP
2031
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002032 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002033 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002034 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002035
Robin Getz470a6d42009-07-21 12:15:28 -04002036 CONFIG_KEEP_SERVERADDR
2037
2038 Keeps the server's MAC address, in the env 'serveraddr'
2039 for passing to bootargs (like Linux's netconsole option)
2040
Wolfgang Denk26da2992011-10-26 10:21:22 +00002041- Gateway IP address:
2042 CONFIG_GATEWAYIP
2043
2044 Defines a default value for the IP address of the
2045 default router where packets to other networks are
2046 sent to.
2047 (Environment variable "gatewayip")
2048
2049- Subnet mask:
2050 CONFIG_NETMASK
2051
2052 Defines a default value for the subnet mask (or
2053 routing prefix) which is used to determine if an IP
2054 address belongs to the local subnet or needs to be
2055 forwarded through a router.
2056 (Environment variable "netmask")
2057
David Updegraff7280da72007-06-11 10:41:07 -05002058- Multicast TFTP Mode:
2059 CONFIG_MCAST_TFTP
2060
2061 Defines whether you want to support multicast TFTP as per
2062 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002063 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002064 driver in use must provide a function: mcast() to join/leave a
2065 multicast group.
2066
wdenkc6097192002-11-03 00:24:07 +00002067- BOOTP Recovery Mode:
2068 CONFIG_BOOTP_RANDOM_DELAY
2069
2070 If you have many targets in a network that try to
2071 boot using BOOTP, you may want to avoid that all
2072 systems send out BOOTP requests at precisely the same
2073 moment (which would happen for instance at recovery
2074 from a power failure, when all systems will try to
2075 boot, thus flooding the BOOTP server. Defining
2076 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2077 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002078 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002079
2080 1st BOOTP request: delay 0 ... 1 sec
2081 2nd BOOTP request: delay 0 ... 2 sec
2082 3rd BOOTP request: delay 0 ... 4 sec
2083 4th and following
2084 BOOTP requests: delay 0 ... 8 sec
2085
Thierry Reding8977cda2014-08-19 10:21:24 +02002086 CONFIG_BOOTP_ID_CACHE_SIZE
2087
2088 BOOTP packets are uniquely identified using a 32-bit ID. The
2089 server will copy the ID from client requests to responses and
2090 U-Boot will use this to determine if it is the destination of
2091 an incoming response. Some servers will check that addresses
2092 aren't in use before handing them out (usually using an ARP
2093 ping) and therefore take up to a few hundred milliseconds to
2094 respond. Network congestion may also influence the time it
2095 takes for a response to make it back to the client. If that
2096 time is too long, U-Boot will retransmit requests. In order
2097 to allow earlier responses to still be accepted after these
2098 retransmissions, U-Boot's BOOTP client keeps a small cache of
2099 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2100 cache. The default is to keep IDs for up to four outstanding
2101 requests. Increasing this will allow U-Boot to accept offers
2102 from a BOOTP client in networks with unusually high latency.
2103
stroesee0aadfb2003-08-28 14:17:32 +00002104- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002105 You can fine tune the DHCP functionality by defining
2106 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002107
Jon Loeliger5336a762007-07-09 22:08:34 -05002108 CONFIG_BOOTP_SUBNETMASK
2109 CONFIG_BOOTP_GATEWAY
2110 CONFIG_BOOTP_HOSTNAME
2111 CONFIG_BOOTP_NISDOMAIN
2112 CONFIG_BOOTP_BOOTPATH
2113 CONFIG_BOOTP_BOOTFILESIZE
2114 CONFIG_BOOTP_DNS
2115 CONFIG_BOOTP_DNS2
2116 CONFIG_BOOTP_SEND_HOSTNAME
2117 CONFIG_BOOTP_NTPSERVER
2118 CONFIG_BOOTP_TIMEOFFSET
2119 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002120 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002121
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002122 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2123 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002124
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002125 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2126 after the configured retry count, the call will fail
2127 instead of starting over. This can be used to fail over
2128 to Link-local IP address configuration if the DHCP server
2129 is not available.
2130
stroesee0aadfb2003-08-28 14:17:32 +00002131 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2132 serverip from a DHCP server, it is possible that more
2133 than one DNS serverip is offered to the client.
2134 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2135 serverip will be stored in the additional environment
2136 variable "dnsip2". The first DNS serverip is always
2137 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002138 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002139
2140 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2141 to do a dynamic update of a DNS server. To do this, they
2142 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002143 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002144 of the "hostname" environment variable is passed as
2145 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002146
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002147 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2148
2149 A 32bit value in microseconds for a delay between
2150 receiving a "DHCP Offer" and sending the "DHCP Request".
2151 This fixes a problem with certain DHCP servers that don't
2152 respond 100% of the time to a "DHCP request". E.g. On an
2153 AT91RM9200 processor running at 180MHz, this delay needed
2154 to be *at least* 15,000 usec before a Windows Server 2003
2155 DHCP server would reply 100% of the time. I recommend at
2156 least 50,000 usec to be safe. The alternative is to hope
2157 that one of the retries will be successful but note that
2158 the DHCP timeout and retry process takes a longer than
2159 this delay.
2160
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002161 - Link-local IP address negotiation:
2162 Negotiate with other link-local clients on the local network
2163 for an address that doesn't require explicit configuration.
2164 This is especially useful if a DHCP server cannot be guaranteed
2165 to exist in all environments that the device must operate.
2166
2167 See doc/README.link-local for more information.
2168
wdenk145d2c12004-04-15 21:48:45 +00002169 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002170 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002171
2172 The device id used in CDP trigger frames.
2173
2174 CONFIG_CDP_DEVICE_ID_PREFIX
2175
2176 A two character string which is prefixed to the MAC address
2177 of the device.
2178
2179 CONFIG_CDP_PORT_ID
2180
2181 A printf format string which contains the ascii name of
2182 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002183 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002184
2185 CONFIG_CDP_CAPABILITIES
2186
2187 A 32bit integer which indicates the device capabilities;
2188 0x00000010 for a normal host which does not forwards.
2189
2190 CONFIG_CDP_VERSION
2191
2192 An ascii string containing the version of the software.
2193
2194 CONFIG_CDP_PLATFORM
2195
2196 An ascii string containing the name of the platform.
2197
2198 CONFIG_CDP_TRIGGER
2199
2200 A 32bit integer sent on the trigger.
2201
2202 CONFIG_CDP_POWER_CONSUMPTION
2203
2204 A 16bit integer containing the power consumption of the
2205 device in .1 of milliwatts.
2206
2207 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2208
2209 A byte containing the id of the VLAN.
2210
wdenkc6097192002-11-03 00:24:07 +00002211- Status LED: CONFIG_STATUS_LED
2212
2213 Several configurations allow to display the current
2214 status using a LED. For instance, the LED will blink
2215 fast while running U-Boot code, stop blinking as
2216 soon as a reply to a BOOTP request was received, and
2217 start blinking slow once the Linux kernel is running
2218 (supported by a status LED driver in the Linux
2219 kernel). Defining CONFIG_STATUS_LED enables this
2220 feature in U-Boot.
2221
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002222 Additional options:
2223
2224 CONFIG_GPIO_LED
2225 The status LED can be connected to a GPIO pin.
2226 In such cases, the gpio_led driver can be used as a
2227 status LED backend implementation. Define CONFIG_GPIO_LED
2228 to include the gpio_led driver in the U-Boot binary.
2229
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002230 CONFIG_GPIO_LED_INVERTED_TABLE
2231 Some GPIO connected LEDs may have inverted polarity in which
2232 case the GPIO high value corresponds to LED off state and
2233 GPIO low value corresponds to LED on state.
2234 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2235 with a list of GPIO LEDs that have inverted polarity.
2236
wdenkc6097192002-11-03 00:24:07 +00002237- CAN Support: CONFIG_CAN_DRIVER
2238
2239 Defining CONFIG_CAN_DRIVER enables CAN driver support
2240 on those systems that support this (optional)
2241 feature, like the TQM8xxL modules.
2242
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002243- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002244
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002245 This enable the NEW i2c subsystem, and will allow you to use
2246 i2c commands at the u-boot command line (as long as you set
2247 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2248 based realtime clock chips or other i2c devices. See
2249 common/cmd_i2c.c for a description of the command line
2250 interface.
2251
2252 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002253 - drivers/i2c/soft_i2c.c:
2254 - activate first bus with CONFIG_SYS_I2C_SOFT define
2255 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2256 for defining speed and slave address
2257 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2258 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2259 for defining speed and slave address
2260 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2261 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2262 for defining speed and slave address
2263 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2264 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2265 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002266
Heiko Schocherf2850742012-10-24 13:48:22 +02002267 - drivers/i2c/fsl_i2c.c:
2268 - activate i2c driver with CONFIG_SYS_I2C_FSL
2269 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2270 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2271 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2272 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002273 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002274 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2275 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2276 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2277 second bus.
2278
Simon Glass026fefb2012-10-30 07:28:53 +00002279 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002280 - activate this driver with CONFIG_SYS_I2C_TEGRA
2281 - This driver adds 4 i2c buses with a fix speed from
2282 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002283
Dirk Eibach42b204f2013-04-25 02:40:01 +00002284 - drivers/i2c/ppc4xx_i2c.c
2285 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2286 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2287 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2288
trema49f40a2013-09-21 18:13:35 +02002289 - drivers/i2c/i2c_mxc.c
2290 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002291 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2292 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2293 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2294 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002295 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2296 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2297 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2298 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2299 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2300 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002301 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2302 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002303 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002304 for speed, and 0 for slave.
2305
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002306 - drivers/i2c/rcar_i2c.c:
2307 - activate this driver with CONFIG_SYS_I2C_RCAR
2308 - This driver adds 4 i2c buses
2309
2310 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2311 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2312 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2313 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2314 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2315 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2316 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2317 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2318 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2319
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002320 - drivers/i2c/sh_i2c.c:
2321 - activate this driver with CONFIG_SYS_I2C_SH
2322 - This driver adds from 2 to 5 i2c buses
2323
2324 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2325 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2326 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2327 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2328 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2329 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2330 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2331 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2332 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2333 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2334 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2335 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002336 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002337
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002338 - drivers/i2c/omap24xx_i2c.c
2339 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2340 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2341 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2342 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2343 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2344 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2345 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2346 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2347 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2348 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2349 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2350
Heiko Schocher465819a2013-11-08 07:30:53 +01002351 - drivers/i2c/zynq_i2c.c
2352 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2353 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2354 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2355
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302356 - drivers/i2c/s3c24x0_i2c.c:
2357 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2358 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2359 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2360 with a fix speed from 100000 and the slave addr 0!
2361
Dirk Eibachb9577432014-07-03 09:28:18 +02002362 - drivers/i2c/ihs_i2c.c
2363 - activate this driver with CONFIG_SYS_I2C_IHS
2364 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2365 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2366 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2367 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2368 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2369 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2370 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2371 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2372 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2373 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2374 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2375 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002376 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2377 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2378 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2379 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2380 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2381 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2382 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2383 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2384 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002385
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002386 additional defines:
2387
2388 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002389 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002390 don't use/have i2c muxes on your i2c bus, this
2391 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2392 omit this define.
2393
2394 CONFIG_SYS_I2C_DIRECT_BUS
2395 define this, if you don't use i2c muxes on your hardware.
2396 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2397 omit this define.
2398
2399 CONFIG_SYS_I2C_MAX_HOPS
2400 define how many muxes are maximal consecutively connected
2401 on one i2c bus. If you not use i2c muxes, omit this
2402 define.
2403
2404 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002405 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002406 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2407 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2408 CONFIG_SYS_NUM_I2C_BUSES = 9:
2409
2410 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2411 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2412 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2413 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2414 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2415 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2416 {1, {I2C_NULL_HOP}}, \
2417 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2418 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2419 }
2420
2421 which defines
2422 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002423 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2424 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2425 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2426 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2427 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002428 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002429 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2430 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002431
2432 If you do not have i2c muxes on your board, omit this define.
2433
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002434- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002435
2436 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2437 provides the following compelling advantages:
2438
2439 - more than one i2c adapter is usable
2440 - approved multibus support
2441 - better i2c mux support
2442
2443 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002444
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002445 These enable legacy I2C serial bus commands. Defining
2446 CONFIG_HARD_I2C will include the appropriate I2C driver
2447 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002448
wdenk21136db2003-07-16 21:53:01 +00002449 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002450 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002451 CONFIG_COMMANDS) and communicate with i2c based realtime
2452 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002453 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002454
Ben Warren45657152006-09-07 16:50:54 -04002455 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002456
wdenk21136db2003-07-16 21:53:01 +00002457 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002458 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002459
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002460 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002461 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002462 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002463 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002464
Peter Tysere4d1abc2010-04-12 22:28:21 -05002465 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002466 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002467 and so its address should therefore be cleared to 0 (See,
2468 eg, MPC823e User's Manual p.16-473). So, set
2469 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002470
Eric Millbrandt12990a42009-09-03 08:09:44 -05002471 CONFIG_SYS_I2C_INIT_MPC5XXX
2472
2473 When a board is reset during an i2c bus transfer
2474 chips might think that the current transfer is still
2475 in progress. Reset the slave devices by sending start
2476 commands until the slave device responds.
2477
wdenk21136db2003-07-16 21:53:01 +00002478 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002479
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002480 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002481 then the following macros need to be defined (examples are
2482 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002483
2484 I2C_INIT
2485
wdenkb9bbd242003-06-30 16:24:52 +00002486 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002487 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002488
wdenk544e9732004-02-06 23:19:44 +00002489 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002490
wdenkc6097192002-11-03 00:24:07 +00002491 I2C_PORT
2492
wdenk4a5c8a72003-03-06 00:02:04 +00002493 (Only for MPC8260 CPU). The I/O port to use (the code
2494 assumes both bits are on the same port). Valid values
2495 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002496
2497 I2C_ACTIVE
2498
2499 The code necessary to make the I2C data line active
2500 (driven). If the data line is open collector, this
2501 define can be null.
2502
wdenkb9bbd242003-06-30 16:24:52 +00002503 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2504
wdenkc6097192002-11-03 00:24:07 +00002505 I2C_TRISTATE
2506
2507 The code necessary to make the I2C data line tri-stated
2508 (inactive). If the data line is open collector, this
2509 define can be null.
2510
wdenkb9bbd242003-06-30 16:24:52 +00002511 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2512
wdenkc6097192002-11-03 00:24:07 +00002513 I2C_READ
2514
York Sun4a598092013-04-01 11:29:11 -07002515 Code that returns true if the I2C data line is high,
2516 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002517
wdenkb9bbd242003-06-30 16:24:52 +00002518 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2519
wdenkc6097192002-11-03 00:24:07 +00002520 I2C_SDA(bit)
2521
York Sun4a598092013-04-01 11:29:11 -07002522 If <bit> is true, sets the I2C data line high. If it
2523 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002524
wdenkb9bbd242003-06-30 16:24:52 +00002525 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002526 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002527 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002528
wdenkc6097192002-11-03 00:24:07 +00002529 I2C_SCL(bit)
2530
York Sun4a598092013-04-01 11:29:11 -07002531 If <bit> is true, sets the I2C clock line high. If it
2532 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002533
wdenkb9bbd242003-06-30 16:24:52 +00002534 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002535 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002536 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002537
wdenkc6097192002-11-03 00:24:07 +00002538 I2C_DELAY
2539
2540 This delay is invoked four times per clock cycle so this
2541 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002542 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002543 like:
2544
wdenkb9bbd242003-06-30 16:24:52 +00002545 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002546
Mike Frysingeree12d542010-07-21 13:38:02 -04002547 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2548
2549 If your arch supports the generic GPIO framework (asm/gpio.h),
2550 then you may alternatively define the two GPIOs that are to be
2551 used as SCL / SDA. Any of the previous I2C_xxx macros will
2552 have GPIO-based defaults assigned to them as appropriate.
2553
2554 You should define these to the GPIO value as given directly to
2555 the generic GPIO functions.
2556
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002557 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002558
wdenk57b2d802003-06-27 21:31:46 +00002559 When a board is reset during an i2c bus transfer
2560 chips might think that the current transfer is still
2561 in progress. On some boards it is possible to access
2562 the i2c SCLK line directly, either by using the
2563 processor pin as a GPIO or by having a second pin
2564 connected to the bus. If this option is defined a
2565 custom i2c_init_board() routine in boards/xxx/board.c
2566 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002567
Richard Retanubundf0149c2010-04-12 15:08:17 -04002568 CONFIG_SYS_I2C_BOARD_LATE_INIT
2569
2570 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2571 defined a custom i2c_board_late_init() routine in
2572 boards/xxx/board.c is run AFTER the operations in i2c_init()
2573 is completed. This callpoint can be used to unreset i2c bus
2574 using CPU i2c controller register accesses for CPUs whose i2c
2575 controller provide such a method. It is called at the end of
2576 i2c_init() to allow i2c_init operations to setup the i2c bus
2577 controller on the CPU (e.g. setting bus speed & slave address).
2578
wdenk0e2bd9c2004-06-06 21:51:03 +00002579 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2580
2581 This option enables configuration of bi_iic_fast[] flags
2582 in u-boot bd_info structure based on u-boot environment
2583 variable "i2cfast". (see also i2cfast)
2584
Ben Warren45657152006-09-07 16:50:54 -04002585 CONFIG_I2C_MULTI_BUS
2586
2587 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002588 must have a controller. At any point in time, only one bus is
2589 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002590 Note that bus numbering is zero-based.
2591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002592 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002593
2594 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002595 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002596 is set, specify a list of bus-device pairs. Otherwise, specify
2597 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002598
2599 e.g.
2600 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002601 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002602
2603 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2604
Wolfgang Denk092ae952011-10-26 10:21:21 +00002605 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002606 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002607
2608 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2609
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002610 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002611
2612 If defined, then this indicates the I2C bus number for DDR SPD.
2613 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2614
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002615 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002616
2617 If defined, then this indicates the I2C bus number for the RTC.
2618 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2619
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002620 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002621
2622 If defined, then this indicates the I2C bus number for the DTT.
2623 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2624
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002625 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002626
2627 If defined, specifies the I2C address of the DTT device.
2628 If not defined, then U-Boot uses predefined value for
2629 specified DTT device.
2630
Andrew Dyer58c41f92008-12-29 17:36:01 -06002631 CONFIG_SOFT_I2C_READ_REPEATED_START
2632
2633 defining this will force the i2c_read() function in
2634 the soft_i2c driver to perform an I2C repeated start
2635 between writing the address pointer and reading the
2636 data. If this define is omitted the default behaviour
2637 of doing a stop-start sequence will be used. Most I2C
2638 devices can use either method, but some require one or
2639 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002640
wdenkc6097192002-11-03 00:24:07 +00002641- SPI Support: CONFIG_SPI
2642
2643 Enables SPI driver (so far only tested with
2644 SPI EEPROM, also an instance works with Crystal A/D and
2645 D/As on the SACSng board)
2646
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002647 CONFIG_SH_SPI
2648
2649 Enables the driver for SPI controller on SuperH. Currently
2650 only SH7757 is supported.
2651
wdenkc6097192002-11-03 00:24:07 +00002652 CONFIG_SOFT_SPI
2653
wdenk4a5c8a72003-03-06 00:02:04 +00002654 Enables a software (bit-bang) SPI driver rather than
2655 using hardware support. This is a general purpose
2656 driver that only requires three general I/O port pins
2657 (two outputs, one input) to function. If this is
2658 defined, the board configuration must define several
2659 SPI configuration items (port pins to use, etc). For
2660 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002661
Ben Warren7efe9272008-01-16 22:37:35 -05002662 CONFIG_HARD_SPI
2663
2664 Enables a hardware SPI driver for general-purpose reads
2665 and writes. As with CONFIG_SOFT_SPI, the board configuration
2666 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002667 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002668 example, see include/configs/mpc8349emds.h.
2669
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002670 CONFIG_MXC_SPI
2671
2672 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002673 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002674
Heiko Schocherb77c8882014-07-14 10:22:11 +02002675 CONFIG_SYS_SPI_MXC_WAIT
2676 Timeout for waiting until spi transfer completed.
2677 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2678
Matthias Fuchsa4400872007-12-27 17:12:34 +01002679- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002680
Matthias Fuchsa4400872007-12-27 17:12:34 +01002681 Enables FPGA subsystem.
2682
2683 CONFIG_FPGA_<vendor>
2684
2685 Enables support for specific chip vendors.
2686 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002687
Matthias Fuchsa4400872007-12-27 17:12:34 +01002688 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002689
Matthias Fuchsa4400872007-12-27 17:12:34 +01002690 Enables support for FPGA family.
2691 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2692
2693 CONFIG_FPGA_COUNT
2694
2695 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002696
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302697 CONFIG_CMD_FPGA_LOADMK
2698
2699 Enable support for fpga loadmk command
2700
Michal Simek64c70982014-05-02 13:43:39 +02002701 CONFIG_CMD_FPGA_LOADP
2702
2703 Enable support for fpga loadp command - load partial bitstream
2704
2705 CONFIG_CMD_FPGA_LOADBP
2706
2707 Enable support for fpga loadbp command - load partial bitstream
2708 (Xilinx only)
2709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002710 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002711
wdenk57b2d802003-06-27 21:31:46 +00002712 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002713
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002714 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002715
wdenk4a5c8a72003-03-06 00:02:04 +00002716 Enable checks on FPGA configuration interface busy
2717 status by the configuration function. This option
2718 will require a board or device specific function to
2719 be written.
wdenkc6097192002-11-03 00:24:07 +00002720
2721 CONFIG_FPGA_DELAY
2722
2723 If defined, a function that provides delays in the FPGA
2724 configuration driver.
2725
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002726 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002727 Allow Control-C to interrupt FPGA configuration
2728
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002729 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002730
wdenk4a5c8a72003-03-06 00:02:04 +00002731 Check for configuration errors during FPGA bitfile
2732 loading. For example, abort during Virtex II
2733 configuration if the INIT_B line goes low (which
2734 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002735
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002736 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002737
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002738 Maximum time to wait for the INIT_B line to de-assert
2739 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002740 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002741 ms.
wdenkc6097192002-11-03 00:24:07 +00002742
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002743 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002744
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002745 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002746 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002747
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002748 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002749
wdenk4a5c8a72003-03-06 00:02:04 +00002750 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002751 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002752
2753- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002754 CONFIG_BUILD_TARGET
2755
2756 Some SoCs need special image types (e.g. U-Boot binary
2757 with a special header) as build targets. By defining
2758 CONFIG_BUILD_TARGET in the SoC / board header, this
2759 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002760 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002761
wdenkc6097192002-11-03 00:24:07 +00002762 CONFIG_IDENT_STRING
2763
wdenk4a5c8a72003-03-06 00:02:04 +00002764 If defined, this string will be added to the U-Boot
2765 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002766
2767- Vendor Parameter Protection:
2768
wdenk4a5c8a72003-03-06 00:02:04 +00002769 U-Boot considers the values of the environment
2770 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002771 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002772 are set once by the board vendor / manufacturer, and
2773 protects these variables from casual modification by
2774 the user. Once set, these variables are read-only,
2775 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002776 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002777
2778 If CONFIG_ENV_OVERWRITE is #defined in your config
2779 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002780 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002781 these parameters.
2782
Joe Hershberger76f353e2015-05-04 14:55:14 -05002783 Alternatively, if you define _both_ an ethaddr in the
2784 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002785 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002786 which can be changed exactly ONCE by the user. [The
2787 serial# is unaffected by this, i. e. it remains
2788 read-only.]
2789
Joe Hershberger71497d02012-12-11 22:16:31 -06002790 The same can be accomplished in a more flexible way
2791 for any variable by configuring the type of access
2792 to allow for those variables in the ".flags" variable
2793 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2794
wdenkc6097192002-11-03 00:24:07 +00002795- Protected RAM:
2796 CONFIG_PRAM
2797
2798 Define this variable to enable the reservation of
2799 "protected RAM", i. e. RAM which is not overwritten
2800 by U-Boot. Define CONFIG_PRAM to hold the number of
2801 kB you want to reserve for pRAM. You can overwrite
2802 this default value by defining an environment
2803 variable "pram" to the number of kB you want to
2804 reserve. Note that the board info structure will
2805 still show the full amount of RAM. If pRAM is
2806 reserved, a new environment variable "mem" will
2807 automatically be defined to hold the amount of
2808 remaining RAM in a form that can be passed as boot
2809 argument to Linux, for instance like that:
2810
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002811 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002812 saveenv
2813
2814 This way you can tell Linux not to use this memory,
2815 either, which results in a memory region that will
2816 not be affected by reboots.
2817
2818 *WARNING* If your board configuration uses automatic
2819 detection of the RAM size, you must make sure that
2820 this memory test is non-destructive. So far, the
2821 following board configurations are known to be
2822 "pRAM-clean":
2823
Wolfgang Denk90326762012-10-24 02:36:15 +00002824 IVMS8, IVML24, SPD8xx, TQM8xxL,
2825 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002826 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002827
Gabe Blacka2f3a932012-12-02 04:55:18 +00002828- Access to physical memory region (> 4GB)
2829 Some basic support is provided for operations on memory not
2830 normally accessible to U-Boot - e.g. some architectures
2831 support access to more than 4GB of memory on 32-bit
2832 machines using physical address extension or similar.
2833 Define CONFIG_PHYSMEM to access this basic support, which
2834 currently only supports clearing the memory.
2835
wdenkc6097192002-11-03 00:24:07 +00002836- Error Recovery:
2837 CONFIG_PANIC_HANG
2838
2839 Define this variable to stop the system in case of a
2840 fatal error, so that you have to reset it manually.
2841 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002842 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002843 automatically as fast as possible, but it may be
2844 useful during development since you can try to debug
2845 the conditions that lead to the situation.
2846
2847 CONFIG_NET_RETRY_COUNT
2848
wdenk4a5c8a72003-03-06 00:02:04 +00002849 This variable defines the number of retries for
2850 network operations like ARP, RARP, TFTP, or BOOTP
2851 before giving up the operation. If not defined, a
2852 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002853
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002854 CONFIG_ARP_TIMEOUT
2855
2856 Timeout waiting for an ARP reply in milliseconds.
2857
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002858 CONFIG_NFS_TIMEOUT
2859
2860 Timeout in milliseconds used in NFS protocol.
2861 If you encounter "ERROR: Cannot umount" in nfs command,
2862 try longer timeout such as
2863 #define CONFIG_NFS_TIMEOUT 10000UL
2864
wdenkc6097192002-11-03 00:24:07 +00002865- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002866 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002867
2868 Enable auto completion of commands using TAB.
2869
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002870 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002871
2872 This defines the secondary prompt string, which is
2873 printed when the command interpreter needs more input
2874 to complete a command. Usually "> ".
2875
2876 Note:
2877
wdenk57b2d802003-06-27 21:31:46 +00002878 In the current implementation, the local variables
2879 space and global environment variables space are
2880 separated. Local variables are those you define by
2881 simply typing `name=value'. To access a local
2882 variable later on, you have write `$name' or
2883 `${name}'; to execute the contents of a variable
2884 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002885
wdenk4a5c8a72003-03-06 00:02:04 +00002886 Global environment variables are those you use
2887 setenv/printenv to work with. To run a command stored
2888 in such a variable, you need to use the run command,
2889 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002890
2891 To store commands and special characters in a
2892 variable, please use double quotation marks
2893 surrounding the whole text of the variable, instead
2894 of the backslashes before semicolons and special
2895 symbols.
2896
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002897- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002898 CONFIG_CMDLINE_EDITING
2899
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002900 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002901 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002902
Marek Vasut734fb042016-01-27 04:47:55 +01002903- Command Line PS1/PS2 support:
2904 CONFIG_CMDLINE_PS_SUPPORT
2905
2906 Enable support for changing the command prompt string
2907 at run-time. Only static string is supported so far.
2908 The string is obtained from environment variables PS1
2909 and PS2.
2910
wdenkc0aa5c52003-12-06 19:49:23 +00002911- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002912 CONFIG_EXTRA_ENV_SETTINGS
2913
wdenk4a5c8a72003-03-06 00:02:04 +00002914 Define this to contain any number of null terminated
2915 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002916 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002917
wdenk4a5c8a72003-03-06 00:02:04 +00002918 For example, place something like this in your
2919 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002920
2921 #define CONFIG_EXTRA_ENV_SETTINGS \
2922 "myvar1=value1\0" \
2923 "myvar2=value2\0"
2924
wdenk4a5c8a72003-03-06 00:02:04 +00002925 Warning: This method is based on knowledge about the
2926 internal format how the environment is stored by the
2927 U-Boot code. This is NOT an official, exported
2928 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002929 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002930 You better know what you are doing here.
2931
wdenk4a5c8a72003-03-06 00:02:04 +00002932 Note: overly (ab)use of the default environment is
2933 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002934 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002935 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002936
Stephen Warren1465d5f2012-05-22 09:21:54 +00002937 CONFIG_ENV_VARS_UBOOT_CONFIG
2938
2939 Define this in order to add variables describing the
2940 U-Boot build configuration to the default environment.
2941 These will be named arch, cpu, board, vendor, and soc.
2942
2943 Enabling this option will cause the following to be defined:
2944
2945 - CONFIG_SYS_ARCH
2946 - CONFIG_SYS_CPU
2947 - CONFIG_SYS_BOARD
2948 - CONFIG_SYS_VENDOR
2949 - CONFIG_SYS_SOC
2950
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002951 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2952
2953 Define this in order to add variables describing certain
2954 run-time determined information about the hardware to the
2955 environment. These will be named board_name, board_rev.
2956
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002957 CONFIG_DELAY_ENVIRONMENT
2958
2959 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002960 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002961 that so that the environment is not available until
2962 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2963 this is instead controlled by the value of
2964 /config/load-environment.
2965
Chris Packham2216ddb2015-06-19 20:25:59 +12002966- Parallel Flash support:
2967 CONFIG_SYS_NO_FLASH
2968
Bin Meng75574052016-02-05 19:30:11 -08002969 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham2216ddb2015-06-19 20:25:59 +12002970 flash. This option is used to disable support for parallel NOR
2971 flash. This option should be defined if the board does not have
2972 parallel flash.
2973
2974 If this option is not defined one of the generic flash drivers
2975 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2976 selected or the board must provide an implementation of the
2977 flash API (see include/flash.h).
2978
wdenkc0aa5c52003-12-06 19:49:23 +00002979- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002980 CONFIG_HAS_DATAFLASH
2981
wdenk57b2d802003-06-27 21:31:46 +00002982 Defining this option enables DataFlash features and
2983 allows to read/write in Dataflash via the standard
2984 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002985
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002986- Serial Flash support
2987 CONFIG_CMD_SF
2988
2989 Defining this option enables SPI flash commands
2990 'sf probe/read/write/erase/update'.
2991
2992 Usage requires an initial 'probe' to define the serial
2993 flash parameters, followed by read/write/erase/update
2994 commands.
2995
2996 The following defaults may be provided by the platform
2997 to handle the common case when only a single serial
2998 flash is present on the system.
2999
3000 CONFIG_SF_DEFAULT_BUS Bus identifier
3001 CONFIG_SF_DEFAULT_CS Chip-select
3002 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3003 CONFIG_SF_DEFAULT_SPEED in Hz
3004
Simon Glass4b5545e2012-10-08 13:16:02 +00003005 CONFIG_CMD_SF_TEST
3006
3007 Define this option to include a destructive SPI flash
3008 test ('sf test').
3009
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303010 CONFIG_SF_DUAL_FLASH Dual flash memories
3011
3012 Define this option to use dual flash support where two flash
3013 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003014 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303015
wdenkef893942004-02-23 16:11:30 +00003016- SystemACE Support:
3017 CONFIG_SYSTEMACE
3018
3019 Adding this option adds support for Xilinx SystemACE
3020 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003021 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003022 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003023
3024 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003025 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003026
3027 When SystemACE support is added, the "ace" device type
3028 becomes available to the fat commands, i.e. fatls.
3029
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003030- TFTP Fixed UDP Port:
3031 CONFIG_TFTP_PORT
3032
Wolfgang Denk227b5192005-09-24 23:25:46 +02003033 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003034 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003035 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003036 number generator is used.
3037
Wolfgang Denk227b5192005-09-24 23:25:46 +02003038 Also, the environment variable tftpdstp is used to supply
3039 the TFTP UDP destination port value. If tftpdstp isn't
3040 defined, the normal port 69 is used.
3041
3042 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003043 blindly start the TFTP transfer using the pre-configured
3044 target IP address and UDP port. This has the effect of
3045 "punching through" the (Windows XP) firewall, allowing
3046 the remainder of the TFTP transfer to proceed normally.
3047 A better solution is to properly configure the firewall,
3048 but sometimes that is not allowed.
3049
Simon Glass058bb8d2012-12-05 14:46:38 +00003050- Hashing support:
3051 CONFIG_CMD_HASH
3052
3053 This enables a generic 'hash' command which can produce
3054 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3055
3056 CONFIG_HASH_VERIFY
3057
3058 Enable the hash verify command (hash -v). This adds to code
3059 size a little.
3060
gaurav ranaef201592015-02-20 12:51:46 +05303061 CONFIG_SHA1 - This option enables support of hashing using SHA1
3062 algorithm. The hash is calculated in software.
3063 CONFIG_SHA256 - This option enables support of hashing using
3064 SHA256 algorithm. The hash is calculated in software.
3065 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3066 for SHA1/SHA256 hashing.
3067 This affects the 'hash' command and also the
3068 hash_lookup_algo() function.
3069 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3070 hardware-acceleration for SHA1/SHA256 progressive hashing.
3071 Data can be streamed in a block at a time and the hashing
3072 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003073
3074 Note: There is also a sha1sum command, which should perhaps
3075 be deprecated in favour of 'hash sha1'.
3076
Robert Winkler765ccf42013-07-24 17:57:06 -07003077- Freescale i.MX specific commands:
3078 CONFIG_CMD_HDMIDETECT
3079 This enables 'hdmidet' command which returns true if an
3080 HDMI monitor is detected. This command is i.MX 6 specific.
3081
3082 CONFIG_CMD_BMODE
3083 This enables the 'bmode' (bootmode) command for forcing
3084 a boot from specific media.
3085
3086 This is useful for forcing the ROM's usb downloader to
3087 activate upon a watchdog reset which is nice when iterating
3088 on U-Boot. Using the reset button or running bmode normal
3089 will set it back to normal. This command currently
3090 supports i.MX53 and i.MX6.
3091
Heiko Schocher443ca402014-01-25 07:27:13 +01003092- bootcount support:
3093 CONFIG_BOOTCOUNT_LIMIT
3094
3095 This enables the bootcounter support, see:
3096 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3097
3098 CONFIG_AT91SAM9XE
3099 enable special bootcounter support on at91sam9xe based boards.
3100 CONFIG_BLACKFIN
3101 enable special bootcounter support on blackfin based boards.
3102 CONFIG_SOC_DA8XX
3103 enable special bootcounter support on da850 based boards.
3104 CONFIG_BOOTCOUNT_RAM
3105 enable support for the bootcounter in RAM
3106 CONFIG_BOOTCOUNT_I2C
3107 enable support for the bootcounter on an i2c (like RTC) device.
3108 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3109 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3110 the bootcounter.
3111 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003112
wdenkc0aa5c52003-12-06 19:49:23 +00003113- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003114 CONFIG_SHOW_BOOT_PROGRESS
3115
wdenk4a5c8a72003-03-06 00:02:04 +00003116 Defining this option allows to add some board-
3117 specific code (calling a user-provided function
3118 "show_boot_progress(int)") that enables you to show
3119 the system's boot progress on some display (for
3120 example, some LED's) on your board. At the moment,
3121 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003122
Simon Glass0fa36a42012-09-28 08:56:37 +00003123
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003124Legacy uImage format:
3125
wdenkc6097192002-11-03 00:24:07 +00003126 Arg Where When
3127 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003128 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003129 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003130 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003131 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003132 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003133 4 common/cmd_bootm.c Image data has correct checksum
3134 -4 common/cmd_bootm.c Image is for unsupported architecture
3135 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003136 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003137 6 common/cmd_bootm.c Image Type check OK
3138 -6 common/cmd_bootm.c gunzip uncompression error
3139 -7 common/cmd_bootm.c Unimplemented compression type
3140 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003141 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003142 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003143
3144 9 common/image.c Start initial ramdisk verification
3145 -10 common/image.c Ramdisk header has bad magic number
3146 -11 common/image.c Ramdisk header has bad checksum
3147 10 common/image.c Ramdisk header is OK
3148 -12 common/image.c Ramdisk data has bad checksum
3149 11 common/image.c Ramdisk data has correct checksum
3150 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003151 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003152 13 common/image.c Start multifile image verification
3153 14 common/image.c No initial ramdisk, no multifile, continue.
3154
Wolfgang Denk092ae952011-10-26 10:21:21 +00003155 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003156
Stefan Roese88fbf932010-04-15 16:07:28 +02003157 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003158 -31 post/post.c POST test failed, detected by post_output_backlog()
3159 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003160
Heiko Schocher633e03a2007-06-22 19:11:54 +02003161 34 common/cmd_doc.c before loading a Image from a DOC device
3162 -35 common/cmd_doc.c Bad usage of "doc" command
3163 35 common/cmd_doc.c correct usage of "doc" command
3164 -36 common/cmd_doc.c No boot device
3165 36 common/cmd_doc.c correct boot device
3166 -37 common/cmd_doc.c Unknown Chip ID on boot device
3167 37 common/cmd_doc.c correct chip ID found, device available
3168 -38 common/cmd_doc.c Read Error on boot device
3169 38 common/cmd_doc.c reading Image header from DOC device OK
3170 -39 common/cmd_doc.c Image header has bad magic number
3171 39 common/cmd_doc.c Image header has correct magic number
3172 -40 common/cmd_doc.c Error reading Image from DOC device
3173 40 common/cmd_doc.c Image header has correct magic number
3174 41 common/cmd_ide.c before loading a Image from a IDE device
3175 -42 common/cmd_ide.c Bad usage of "ide" command
3176 42 common/cmd_ide.c correct usage of "ide" command
3177 -43 common/cmd_ide.c No boot device
3178 43 common/cmd_ide.c boot device found
3179 -44 common/cmd_ide.c Device not available
3180 44 common/cmd_ide.c Device available
3181 -45 common/cmd_ide.c wrong partition selected
3182 45 common/cmd_ide.c partition selected
3183 -46 common/cmd_ide.c Unknown partition table
3184 46 common/cmd_ide.c valid partition table found
3185 -47 common/cmd_ide.c Invalid partition type
3186 47 common/cmd_ide.c correct partition type
3187 -48 common/cmd_ide.c Error reading Image Header on boot device
3188 48 common/cmd_ide.c reading Image Header from IDE device OK
3189 -49 common/cmd_ide.c Image header has bad magic number
3190 49 common/cmd_ide.c Image header has correct magic number
3191 -50 common/cmd_ide.c Image header has bad checksum
3192 50 common/cmd_ide.c Image header has correct checksum
3193 -51 common/cmd_ide.c Error reading Image from IDE device
3194 51 common/cmd_ide.c reading Image from IDE device OK
3195 52 common/cmd_nand.c before loading a Image from a NAND device
3196 -53 common/cmd_nand.c Bad usage of "nand" command
3197 53 common/cmd_nand.c correct usage of "nand" command
3198 -54 common/cmd_nand.c No boot device
3199 54 common/cmd_nand.c boot device found
3200 -55 common/cmd_nand.c Unknown Chip ID on boot device
3201 55 common/cmd_nand.c correct chip ID found, device available
3202 -56 common/cmd_nand.c Error reading Image Header on boot device
3203 56 common/cmd_nand.c reading Image Header from NAND device OK
3204 -57 common/cmd_nand.c Image header has bad magic number
3205 57 common/cmd_nand.c Image header has correct magic number
3206 -58 common/cmd_nand.c Error reading Image from NAND device
3207 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003208
Heiko Schocher633e03a2007-06-22 19:11:54 +02003209 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003210
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003211 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003212 -64 net/eth.c no Ethernet found.
3213 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003214
Heiko Schocher633e03a2007-06-22 19:11:54 +02003215 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003216 80 common/cmd_net.c before calling net_loop()
3217 -81 common/cmd_net.c some error in net_loop() occurred
3218 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003219 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3220 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003221 83 common/cmd_net.c running "source" command
3222 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003223 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003224
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003225FIT uImage format:
3226
3227 Arg Where When
3228 100 common/cmd_bootm.c Kernel FIT Image has correct format
3229 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3230 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3231 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3232 102 common/cmd_bootm.c Kernel unit name specified
3233 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003234 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003235 104 common/cmd_bootm.c Got kernel subimage node offset
3236 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3237 105 common/cmd_bootm.c Kernel subimage hash verification OK
3238 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3239 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003240 -106 common/cmd_bootm.c Kernel subimage has wrong type
3241 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003242 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3243 108 common/cmd_bootm.c Got kernel subimage data/size
3244 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3245 -109 common/cmd_bootm.c Can't get kernel subimage type
3246 -110 common/cmd_bootm.c Can't get kernel subimage comp
3247 -111 common/cmd_bootm.c Can't get kernel subimage os
3248 -112 common/cmd_bootm.c Can't get kernel subimage load address
3249 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3250
3251 120 common/image.c Start initial ramdisk verification
3252 -120 common/image.c Ramdisk FIT image has incorrect format
3253 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003254 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003255 -122 common/image.c Can't get configuration for ramdisk subimage
3256 123 common/image.c Ramdisk unit name specified
3257 -124 common/image.c Can't get ramdisk subimage node offset
3258 125 common/image.c Got ramdisk subimage node offset
3259 -125 common/image.c Ramdisk subimage hash verification failed
3260 126 common/image.c Ramdisk subimage hash verification OK
3261 -126 common/image.c Ramdisk subimage for unsupported architecture
3262 127 common/image.c Architecture check OK
3263 -127 common/image.c Can't get ramdisk subimage data/size
3264 128 common/image.c Got ramdisk subimage data/size
3265 129 common/image.c Can't get ramdisk load address
3266 -129 common/image.c Got ramdisk load address
3267
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003268 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003269 131 common/cmd_doc.c FIT image format OK
3270
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003271 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003272 141 common/cmd_ide.c FIT image format OK
3273
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003274 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003275 151 common/cmd_nand.c FIT image format OK
3276
Heiko Schocher515eb122014-05-28 11:33:33 +02003277- legacy image format:
3278 CONFIG_IMAGE_FORMAT_LEGACY
3279 enables the legacy image format support in U-Boot.
3280
3281 Default:
3282 enabled if CONFIG_FIT_SIGNATURE is not defined.
3283
3284 CONFIG_DISABLE_IMAGE_LEGACY
3285 disable the legacy image format
3286
3287 This define is introduced, as the legacy image format is
3288 enabled per default for backward compatibility.
3289
Gabe Blackd572e162012-10-25 16:31:10 +00003290- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003291 CONFIG_FIT_DISABLE_SHA256
3292 Supporting SHA256 hashes has quite an impact on binary size.
3293 For constrained systems sha256 hash support can be disabled
3294 with this option.
3295
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003296 TODO(sjg@chromium.org): Adjust this option to be positive,
3297 and move it to Kconfig
3298
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003299- Standalone program support:
3300 CONFIG_STANDALONE_LOAD_ADDR
3301
Wolfgang Denk23f78482011-10-09 21:06:34 +02003302 This option defines a board specific value for the
3303 address where standalone program gets loaded, thus
3304 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003305 settings.
3306
3307- Frame Buffer Address:
3308 CONFIG_FB_ADDR
3309
3310 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003311 address for frame buffer. This is typically the case
3312 when using a graphics controller has separate video
3313 memory. U-Boot will then place the frame buffer at
3314 the given address instead of dynamically reserving it
3315 in system RAM by calling lcd_setmem(), which grabs
3316 the memory for the frame buffer depending on the
3317 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003318
3319 Please see board_init_f function.
3320
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003321- Automatic software updates via TFTP server
3322 CONFIG_UPDATE_TFTP
3323 CONFIG_UPDATE_TFTP_CNT_MAX
3324 CONFIG_UPDATE_TFTP_MSEC_MAX
3325
3326 These options enable and control the auto-update feature;
3327 for a more detailed description refer to doc/README.update.
3328
3329- MTD Support (mtdparts command, UBI support)
3330 CONFIG_MTD_DEVICE
3331
3332 Adds the MTD device infrastructure from the Linux kernel.
3333 Needed for mtdparts command support.
3334
3335 CONFIG_MTD_PARTITIONS
3336
3337 Adds the MTD partitioning infrastructure from the Linux
3338 kernel. Needed for UBI support.
3339
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003340- UBI support
3341 CONFIG_CMD_UBI
3342
3343 Adds commands for interacting with MTD partitions formatted
3344 with the UBI flash translation layer
3345
3346 Requires also defining CONFIG_RBTREE
3347
Joe Hershberger47550fc2013-04-08 10:32:49 +00003348 CONFIG_UBI_SILENCE_MSG
3349
3350 Make the verbose messages from UBI stop printing. This leaves
3351 warnings and errors enabled.
3352
Heiko Schocherf5895d12014-06-24 10:10:04 +02003353
3354 CONFIG_MTD_UBI_WL_THRESHOLD
3355 This parameter defines the maximum difference between the highest
3356 erase counter value and the lowest erase counter value of eraseblocks
3357 of UBI devices. When this threshold is exceeded, UBI starts performing
3358 wear leveling by means of moving data from eraseblock with low erase
3359 counter to eraseblocks with high erase counter.
3360
3361 The default value should be OK for SLC NAND flashes, NOR flashes and
3362 other flashes which have eraseblock life-cycle 100000 or more.
3363 However, in case of MLC NAND flashes which typically have eraseblock
3364 life-cycle less than 10000, the threshold should be lessened (e.g.,
3365 to 128 or 256, although it does not have to be power of 2).
3366
3367 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003368
Heiko Schocherf5895d12014-06-24 10:10:04 +02003369 CONFIG_MTD_UBI_BEB_LIMIT
3370 This option specifies the maximum bad physical eraseblocks UBI
3371 expects on the MTD device (per 1024 eraseblocks). If the
3372 underlying flash does not admit of bad eraseblocks (e.g. NOR
3373 flash), this value is ignored.
3374
3375 NAND datasheets often specify the minimum and maximum NVM
3376 (Number of Valid Blocks) for the flashes' endurance lifetime.
3377 The maximum expected bad eraseblocks per 1024 eraseblocks
3378 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3379 which gives 20 for most NANDs (MaxNVB is basically the total
3380 count of eraseblocks on the chip).
3381
3382 To put it differently, if this value is 20, UBI will try to
3383 reserve about 1.9% of physical eraseblocks for bad blocks
3384 handling. And that will be 1.9% of eraseblocks on the entire
3385 NAND chip, not just the MTD partition UBI attaches. This means
3386 that if you have, say, a NAND flash chip admits maximum 40 bad
3387 eraseblocks, and it is split on two MTD partitions of the same
3388 size, UBI will reserve 40 eraseblocks when attaching a
3389 partition.
3390
3391 default: 20
3392
3393 CONFIG_MTD_UBI_FASTMAP
3394 Fastmap is a mechanism which allows attaching an UBI device
3395 in nearly constant time. Instead of scanning the whole MTD device it
3396 only has to locate a checkpoint (called fastmap) on the device.
3397 The on-flash fastmap contains all information needed to attach
3398 the device. Using fastmap makes only sense on large devices where
3399 attaching by scanning takes long. UBI will not automatically install
3400 a fastmap on old images, but you can set the UBI parameter
3401 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3402 that fastmap-enabled images are still usable with UBI implementations
3403 without fastmap support. On typical flash devices the whole fastmap
3404 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3405
3406 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3407 Set this parameter to enable fastmap automatically on images
3408 without a fastmap.
3409 default: 0
3410
Heiko Schocher94b66de2015-10-22 06:19:21 +02003411 CONFIG_MTD_UBI_FM_DEBUG
3412 Enable UBI fastmap debug
3413 default: 0
3414
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003415- UBIFS support
3416 CONFIG_CMD_UBIFS
3417
3418 Adds commands for interacting with UBI volumes formatted as
3419 UBIFS. UBIFS is read-only in u-boot.
3420
3421 Requires UBI support as well as CONFIG_LZO
3422
Joe Hershberger47550fc2013-04-08 10:32:49 +00003423 CONFIG_UBIFS_SILENCE_MSG
3424
3425 Make the verbose messages from UBIFS stop printing. This leaves
3426 warnings and errors enabled.
3427
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003428- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003429 CONFIG_SPL
3430 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003431
Tom Rini36853852012-02-14 07:29:40 +00003432 CONFIG_SPL_LDSCRIPT
3433 LDSCRIPT for linking the SPL binary.
3434
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003435 CONFIG_SPL_MAX_FOOTPRINT
3436 Maximum size in memory allocated to the SPL, BSS included.
3437 When defined, the linker checks that the actual memory
3438 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003439 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003440 must not be both defined at the same time.
3441
Tom Rini36853852012-02-14 07:29:40 +00003442 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003443 Maximum size of the SPL image (text, data, rodata, and
3444 linker lists sections), BSS excluded.
3445 When defined, the linker checks that the actual size does
3446 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003447
Wolfgang Denk825223d2011-09-11 21:24:09 +02003448 CONFIG_SPL_TEXT_BASE
3449 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003450
Scott Woodc4f0d002012-09-20 19:05:12 -05003451 CONFIG_SPL_RELOC_TEXT_BASE
3452 Address to relocate to. If unspecified, this is equal to
3453 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3454
Tom Rini36853852012-02-14 07:29:40 +00003455 CONFIG_SPL_BSS_START_ADDR
3456 Link address for the BSS within the SPL binary.
3457
3458 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003459 Maximum size in memory allocated to the SPL BSS.
3460 When defined, the linker checks that the actual memory used
3461 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003462 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003463 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003464
3465 CONFIG_SPL_STACK
3466 Adress of the start of the stack SPL will use
3467
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003468 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3469 When defined, SPL will panic() if the image it has
3470 loaded does not have a signature.
3471 Defining this is useful when code which loads images
3472 in SPL cannot guarantee that absolutely all read errors
3473 will be caught.
3474 An example is the LPC32XX MLC NAND driver, which will
3475 consider that a completely unreadable NAND block is bad,
3476 and thus should be skipped silently.
3477
Marek Vasutbf541b22016-04-29 00:44:55 +02003478 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3479 When defined, SPL will proceed to another boot method
3480 if the image it has loaded does not have a signature.
3481
Scott Woodc4f0d002012-09-20 19:05:12 -05003482 CONFIG_SPL_RELOC_STACK
3483 Adress of the start of the stack SPL will use after
3484 relocation. If unspecified, this is equal to
3485 CONFIG_SPL_STACK.
3486
Tom Rini36853852012-02-14 07:29:40 +00003487 CONFIG_SYS_SPL_MALLOC_START
3488 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003489 When this option is set the full malloc is used in SPL and
3490 it is set up by spl_init() and before that, the simple malloc()
3491 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003492
3493 CONFIG_SYS_SPL_MALLOC_SIZE
3494 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003495
Tom Rini28591df2012-08-13 12:03:19 -07003496 CONFIG_SPL_FRAMEWORK
3497 Enable the SPL framework under common/. This framework
3498 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3499 NAND loading of the Linux Kernel.
3500
Tom Rinic2b76002014-03-28 12:03:39 -04003501 CONFIG_SPL_OS_BOOT
3502 Enable booting directly to an OS from SPL.
3503 See also: doc/README.falcon
3504
Tom Rinife3b0c72012-08-13 11:37:56 -07003505 CONFIG_SPL_DISPLAY_PRINT
3506 For ARM, enable an optional function to print more information
3507 about the running system.
3508
Scott Wood7c810902012-09-20 16:35:21 -05003509 CONFIG_SPL_INIT_MINIMAL
3510 Arch init code should be built for a very small image
3511
Tom Rini36853852012-02-14 07:29:40 +00003512 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3513 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003514 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003515 when the MMC is being used in raw mode.
3516
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003517 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3518 Partition on the MMC to load U-Boot from when the MMC is being
3519 used in raw mode
3520
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003521 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3522 Sector to load kernel uImage from when MMC is being
3523 used in raw mode (for Falcon mode)
3524
3525 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3526 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3527 Sector and number of sectors to load kernel argument
3528 parameters from when MMC is being used in raw mode
3529 (for falcon mode)
3530
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003531 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3532 Partition on the MMC to load U-Boot from when the MMC is being
3533 used in fs mode
3534
Guillaume GARDET5065b712014-10-15 17:53:13 +02003535 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3536 Filename to read to load U-Boot when reading from filesystem
3537
3538 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003539 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003540 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003541
Guillaume GARDET5065b712014-10-15 17:53:13 +02003542 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003543 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003544 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003545
Scott Wood2b36fbb2012-12-06 13:33:17 +00003546 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3547 Set this for NAND SPL on PPC mpc83xx targets, so that
3548 start.S waits for the rest of the SPL to load before
3549 continuing (the hardware starts execution after just
3550 loading the first page rather than the full 4K).
3551
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303552 CONFIG_SPL_SKIP_RELOCATE
3553 Avoid SPL relocation
3554
Scott Woodc352a0c2012-09-20 19:09:07 -05003555 CONFIG_SPL_NAND_BASE
3556 Include nand_base.c in the SPL. Requires
3557 CONFIG_SPL_NAND_DRIVERS.
3558
3559 CONFIG_SPL_NAND_DRIVERS
3560 SPL uses normal NAND drivers, not minimal drivers.
3561
3562 CONFIG_SPL_NAND_ECC
3563 Include standard software ECC in the SPL
3564
Tom Rini36853852012-02-14 07:29:40 +00003565 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003566 Support for NAND boot using simple NAND drivers that
3567 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003568
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003569 CONFIG_SPL_UBI
3570 Support for a lightweight UBI (fastmap) scanner and
3571 loader
3572
Heiko Schochercf000272014-10-31 08:31:00 +01003573 CONFIG_SPL_NAND_RAW_ONLY
3574 Support to boot only raw u-boot.bin images. Use this only
3575 if you need to save space.
3576
Ying Zhangdfb2b152013-08-16 15:16:12 +08003577 CONFIG_SPL_COMMON_INIT_DDR
3578 Set for common ddr init with serial presence detect in
3579 SPL binary.
3580
Tom Rini36853852012-02-14 07:29:40 +00003581 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3582 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3583 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3584 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3585 CONFIG_SYS_NAND_ECCBYTES
3586 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003587 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003588
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303589 CONFIG_SPL_NAND_BOOT
3590 Add support NAND boot
3591
Tom Rini36853852012-02-14 07:29:40 +00003592 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003593 Location in NAND to read U-Boot from
3594
3595 CONFIG_SYS_NAND_U_BOOT_DST
3596 Location in memory to load U-Boot to
3597
3598 CONFIG_SYS_NAND_U_BOOT_SIZE
3599 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003600
3601 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003602 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003603
3604 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3605 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003606 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003607
3608 CONFIG_SPL_OMAP3_ID_NAND
3609 Support for an OMAP3-specific set of functions to return the
3610 ID and MFR of the first attached NAND chip, if present.
3611
Pavel Machekde997252012-08-30 22:42:11 +02003612 CONFIG_SPL_RAM_DEVICE
3613 Support for running image already present in ram, in SPL binary
3614
Scott Woodeb7bd972012-12-06 13:33:16 +00003615 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003616 Image offset to which the SPL should be padded before appending
3617 the SPL payload. By default, this is defined as
3618 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3619 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3620 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003621
Scott Woodf147eb72012-09-21 16:27:32 -05003622 CONFIG_SPL_TARGET
3623 Final target image containing SPL and payload. Some SPLs
3624 use an arch-specific makefile fragment instead, for
3625 example if more than one image needs to be produced.
3626
Simon Glass82d94532013-05-08 08:05:59 +00003627 CONFIG_FIT_SPL_PRINT
3628 Printing information about a FIT image adds quite a bit of
3629 code to SPL. So this is normally disabled in SPL. Use this
3630 option to re-enable it. This will affect the output of the
3631 bootm command when booting a FIT image.
3632
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003633- TPL framework
3634 CONFIG_TPL
3635 Enable building of TPL globally.
3636
3637 CONFIG_TPL_PAD_TO
3638 Image offset to which the TPL should be padded before appending
3639 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003640 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3641 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3642 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003643
wdenkc0aa5c52003-12-06 19:49:23 +00003644- Interrupt support (PPC):
3645
wdenk1ebf41e2004-01-02 14:00:00 +00003646 There are common interrupt_init() and timer_interrupt()
3647 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003648 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003649 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003650 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003651 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003652 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003653 specific handling. If board has watchdog / status_led
3654 / other_activity_monitor it works automatically from
3655 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003656
wdenkc6097192002-11-03 00:24:07 +00003657
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003658Board initialization settings:
3659------------------------------
3660
3661During Initialization u-boot calls a number of board specific functions
3662to allow the preparation of board specific prerequisites, e.g. pin setup
3663before drivers are initialized. To enable these callbacks the
3664following configuration macros have to be defined. Currently this is
3665architecture specific, so please check arch/your_architecture/lib/board.c
3666typically in board_init_f() and board_init_r().
3667
3668- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3669- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3670- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3671- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003672
wdenkc6097192002-11-03 00:24:07 +00003673Configuration Settings:
3674-----------------------
3675
York Sun6c480012014-02-26 17:03:19 -08003676- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3677 Optionally it can be defined to support 64-bit memory commands.
3678
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003679- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003680 undefine this when you're short of memory.
3681
Peter Tyserdfb72b82009-01-27 18:03:12 -06003682- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3683 width of the commands listed in the 'help' command output.
3684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003685- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003686 prompt for user input.
3687
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003688- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003689
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003690- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003691
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003692- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003693
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003694- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003695 the application (usually a Linux kernel) when it is
3696 booted
3697
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003698- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003699 List of legal baudrate settings for this board.
3700
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003701- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003702 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003704- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003705 If the board specific function
3706 extern int overwrite_console (void);
3707 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003708 serial port, else the settings in the environment are used.
3709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003710- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003711 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003712
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003713- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003714 Enable overwrite of previous console environment settings.
3715
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003716- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003717 Begin and End addresses of the area used by the
3718 simple memory test.
3719
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003720- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003721 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003722
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003723- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003724 Scratch address used by the alternate memory test
3725 You only need to set this if address zero isn't writeable
3726
York Sun5d286cd2015-12-04 11:57:07 -08003727- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003728 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003729 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3730 is substracted from total RAM and won't be reported to OS.
3731 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003732 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003733 the RAM base is not zero, or RAM is divided into banks,
3734 this variable needs to be recalcuated to get the address.
3735
York Sun50739372015-12-07 11:05:29 -08003736- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003737 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003738 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003739 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003740 fixing up gd->ram_size the Linux kernel should gets passed
3741 the now "corrected" memory size and won't touch it either.
3742 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003743 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003744 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003745 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003746
3747 This option can be used as a workaround for the 440EPx/GRx
3748 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3749 be touched.
3750
3751 WARNING: Please make sure that this value is a multiple of
3752 the Linux page size (normally 4k). If this is not the case,
3753 then the end address of the Linux memory will be located at a
3754 non page size aligned address and this could cause major
3755 problems.
3756
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003757- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003758 Enable temporary baudrate change while serial download
3759
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003760- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003761 Physical start address of SDRAM. _Must_ be 0 here.
3762
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003763- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003764 Physical start address of Motherboard I/O (if using a
3765 Cogent motherboard)
3766
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003767- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003768 Physical start address of Flash memory.
3769
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003770- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003771 Physical start address of boot monitor code (set by
3772 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003773 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003774 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003775
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003776- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003777 Size of memory reserved for monitor code, used to
3778 determine _at_compile_time_ (!) if the environment is
3779 embedded within the U-Boot image, or in a separate
3780 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003781
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003782- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003783 Size of DRAM reserved for malloc() use.
3784
Simon Glass863e4042014-07-10 22:23:28 -06003785- CONFIG_SYS_MALLOC_F_LEN
3786 Size of the malloc() pool for use before relocation. If
3787 this is defined, then a very simple malloc() implementation
3788 will become available before relocation. The address is just
3789 below the global data, and the stack is moved down to make
3790 space.
3791
3792 This feature allocates regions with increasing addresses
3793 within the region. calloc() is supported, but realloc()
3794 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003795 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003796 U-Boot relocates itself.
3797
Simon Glass9fa901b2014-11-10 17:16:54 -07003798- CONFIG_SYS_MALLOC_SIMPLE
3799 Provides a simple and small malloc() and calloc() for those
3800 boards which do not use the full malloc in SPL (which is
3801 enabled with CONFIG_SYS_SPL_MALLOC_START).
3802
Thierry Redingc97d9742014-12-09 22:25:22 -07003803- CONFIG_SYS_NONCACHED_MEMORY:
3804 Size of non-cached memory area. This area of memory will be
3805 typically located right below the malloc() area and mapped
3806 uncached in the MMU. This is useful for drivers that would
3807 otherwise require a lot of explicit cache maintenance. For
3808 some drivers it's also impossible to properly maintain the
3809 cache. For example if the regions that need to be flushed
3810 are not a multiple of the cache-line size, *and* padding
3811 cannot be allocated between the regions to align them (i.e.
3812 if the HW requires a contiguous array of regions, and the
3813 size of each region is not cache-aligned), then a flush of
3814 one region may result in overwriting data that hardware has
3815 written to another region in the same cache-line. This can
3816 happen for example in network drivers where descriptors for
3817 buffers are typically smaller than the CPU cache-line (e.g.
3818 16 bytes vs. 32 or 64 bytes).
3819
3820 Non-cached memory is only supported on 32-bit ARM at present.
3821
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003822- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003823 Normally compressed uImages are limited to an
3824 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003825 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003826 to adjust this setting to your needs.
3827
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003828- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003829 Maximum size of memory mapped by the startup code of
3830 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003831 the Linux kernel (bd_info, boot arguments, FDT blob if
3832 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003833 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003834 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003835 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003836 variable "bootm_mapsize" will override the value of
3837 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3838 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003839
John Rigbyeea8e692010-10-13 13:57:35 -06003840- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3841 Enable initrd_high functionality. If defined then the
3842 initrd_high feature is enabled and the bootm ramdisk subcommand
3843 is enabled.
3844
3845- CONFIG_SYS_BOOT_GET_CMDLINE:
3846 Enables allocating and saving kernel cmdline in space between
3847 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3848
3849- CONFIG_SYS_BOOT_GET_KBD:
3850 Enables allocating and saving a kernel copy of the bd_info in
3851 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3852
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003853- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003854 Max number of Flash memory banks
3855
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003856- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003857 Max number of sectors on a Flash chip
3858
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003859- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003860 Timeout for Flash erase operations (in ms)
3861
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003862- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003863 Timeout for Flash write operations (in ms)
3864
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003865- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003866 Timeout for Flash set sector lock bit operation (in ms)
3867
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003868- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003869 Timeout for Flash clear lock bits operation (in ms)
3870
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003871- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003872 If defined, hardware flash sectors protection is used
3873 instead of U-Boot software protection.
3874
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003875- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003876
3877 Enable TFTP transfers directly to flash memory;
3878 without this option such a download has to be
3879 performed in two steps: (1) download to RAM, and (2)
3880 copy from RAM to flash.
3881
3882 The two-step approach is usually more reliable, since
3883 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003884 the flash, but in some situations (when system RAM is
3885 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003886 downloaded image) this option may be very useful.
3887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003888- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003889 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003890 common flash structure for storing flash geometry.
3891
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003892- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003893 This option also enables the building of the cfi_flash driver
3894 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003895
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003896- CONFIG_FLASH_CFI_MTD
3897 This option enables the building of the cfi_mtd driver
3898 in the drivers directory. The driver exports CFI flash
3899 to the MTD layer.
3900
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003901- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003902 Use buffered writes to flash.
3903
3904- CONFIG_FLASH_SPANSION_S29WS_N
3905 s29ws-n MirrorBit flash has non-standard addresses for buffered
3906 write commands.
3907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003908- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003909 If this option is defined, the common CFI flash doesn't
3910 print it's warning upon not recognized FLASH banks. This
3911 is useful, if some of the configured banks are only
3912 optionally available.
3913
Jerry Van Barenaae73572008-03-08 13:48:01 -05003914- CONFIG_FLASH_SHOW_PROGRESS
3915 If defined (must be an integer), print out countdown
3916 digits and dots. Recommended value: 45 (9..1) for 80
3917 column displays, 15 (3..1) for 40 column displays.
3918
Stefan Roesed20cba52013-04-04 15:53:14 +02003919- CONFIG_FLASH_VERIFY
3920 If defined, the content of the flash (destination) is compared
3921 against the source after the write operation. An error message
3922 will be printed when the contents are not identical.
3923 Please note that this option is useless in nearly all cases,
3924 since such flash programming errors usually are detected earlier
3925 while unprotecting/erasing/programming. Please only enable
3926 this option if you really know what you are doing.
3927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003928- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003929 Defines the number of Ethernet receive buffers. On some
3930 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003931 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3932 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003933 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003934 Defaults to 4 if not defined.
3935
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003936- CONFIG_ENV_MAX_ENTRIES
3937
Wolfgang Denk1136f692010-10-27 22:48:30 +02003938 Maximum number of entries in the hash table that is used
3939 internally to store the environment settings. The default
3940 setting is supposed to be generous and should work in most
3941 cases. This setting can be used to tune behaviour; see
3942 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003943
Joe Hershberger71497d02012-12-11 22:16:31 -06003944- CONFIG_ENV_FLAGS_LIST_DEFAULT
3945- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003946 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003947 calling env set. Variables can be restricted to only decimal,
3948 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3949 the variables can also be restricted to IP address or MAC address.
3950
3951 The format of the list is:
3952 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003953 access_attribute = [a|r|o|c]
3954 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003955 entry = variable_name[:attributes]
3956 list = entry[,list]
3957
3958 The type attributes are:
3959 s - String (default)
3960 d - Decimal
3961 x - Hexadecimal
3962 b - Boolean ([1yYtT|0nNfF])
3963 i - IP address
3964 m - MAC address
3965
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003966 The access attributes are:
3967 a - Any (default)
3968 r - Read-only
3969 o - Write-once
3970 c - Change-default
3971
Joe Hershberger71497d02012-12-11 22:16:31 -06003972 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3973 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003974 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003975
3976 - CONFIG_ENV_FLAGS_LIST_STATIC
3977 Define this to a list (string) to define validation that
3978 should be done if an entry is not found in the ".flags"
3979 environment variable. To override a setting in the static
3980 list, simply add an entry for the same variable name to the
3981 ".flags" variable.
3982
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003983 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3984 regular expression. This allows multiple variables to define the same
3985 flags without explicitly listing them for each variable.
3986
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003987- CONFIG_ENV_ACCESS_IGNORE_FORCE
3988 If defined, don't allow the -f switch to env set override variable
3989 access flags.
3990
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003991- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3992 This is set by OMAP boards for the max time that reset should
3993 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003994 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003995
Gabe Black3687fe42014-10-15 04:38:30 -06003996- CONFIG_USE_STDINT
3997 If stdint.h is available with your toolchain you can define this
3998 option to enable it. You can provide option 'USE_STDINT=1' when
3999 building U-Boot to enable this.
4000
wdenkc6097192002-11-03 00:24:07 +00004001The following definitions that deal with the placement and management
4002of environment data (variable area); in general, we support the
4003following configurations:
4004
Mike Frysinger63b8f122011-07-08 10:44:25 +00004005- CONFIG_BUILD_ENVCRC:
4006
4007 Builds up envcrc with the target environment so that external utils
4008 may easily extract it and embed it in final U-Boot images.
4009
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004010- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004011
4012 Define this if the environment is in flash memory.
4013
4014 a) The environment occupies one whole flash sector, which is
4015 "embedded" in the text segment with the U-Boot code. This
4016 happens usually with "bottom boot sector" or "top boot
4017 sector" type flash chips, which have several smaller
4018 sectors at the start or the end. For instance, such a
4019 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4020 such a case you would place the environment in one of the
4021 4 kB sectors - with U-Boot code before and after it. With
4022 "top boot sector" type flash chips, you would put the
4023 environment in one of the last sectors, leaving a gap
4024 between U-Boot and the environment.
4025
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004026 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004027
4028 Offset of environment data (variable area) to the
4029 beginning of flash memory; for instance, with bottom boot
4030 type flash chips the second sector can be used: the offset
4031 for this sector is given here.
4032
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004033 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004034
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004035 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004036
4037 This is just another way to specify the start address of
4038 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004039 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004040
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004041 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004042
4043 Size of the sector containing the environment.
4044
4045
4046 b) Sometimes flash chips have few, equal sized, BIG sectors.
4047 In such a case you don't want to spend a whole sector for
4048 the environment.
4049
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004050 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004051
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004052 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004053 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004054 of this flash sector for the environment. This saves
4055 memory for the RAM copy of the environment.
4056
4057 It may also save flash memory if you decide to use this
4058 when your environment is "embedded" within U-Boot code,
4059 since then the remainder of the flash sector could be used
4060 for U-Boot code. It should be pointed out that this is
4061 STRONGLY DISCOURAGED from a robustness point of view:
4062 updating the environment in flash makes it always
4063 necessary to erase the WHOLE sector. If something goes
4064 wrong before the contents has been restored from a copy in
4065 RAM, your target system will be dead.
4066
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004067 - CONFIG_ENV_ADDR_REDUND
4068 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004069
wdenk4a5c8a72003-03-06 00:02:04 +00004070 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004071 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004072 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004073 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004074
4075BE CAREFUL! Any changes to the flash layout, and some changes to the
4076source code will make it necessary to adapt <board>/u-boot.lds*
4077accordingly!
4078
4079
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004080- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004081
4082 Define this if you have some non-volatile memory device
4083 (NVRAM, battery buffered SRAM) which you want to use for the
4084 environment.
4085
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004086 - CONFIG_ENV_ADDR:
4087 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004088
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004089 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004090 want to use for environment. It is assumed that this memory
4091 can just be read and written to, without any special
4092 provision.
4093
4094BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004095in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004096console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004097U-Boot will hang.
4098
4099Please note that even with NVRAM we still use a copy of the
4100environment in RAM: we could work on NVRAM directly, but we want to
4101keep settings there always unmodified except somebody uses "saveenv"
4102to save the current settings.
4103
4104
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004105- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004106
4107 Use this if you have an EEPROM or similar serial access
4108 device and a driver for it.
4109
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004110 - CONFIG_ENV_OFFSET:
4111 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004112
4113 These two #defines specify the offset and size of the
4114 environment area within the total memory of your EEPROM.
4115
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004116 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004117 If defined, specified the chip address of the EEPROM device.
4118 The default address is zero.
4119
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004120 - CONFIG_SYS_I2C_EEPROM_BUS:
4121 If defined, specified the i2c bus of the EEPROM device.
4122
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004123 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004124 If defined, the number of bits used to address bytes in a
4125 single page in the EEPROM device. A 64 byte page, for example
4126 would require six bits.
4127
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004128 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004129 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004130 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004131
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004132 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004133 The length in bytes of the EEPROM memory array address. Note
4134 that this is NOT the chip address length!
4135
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004136 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004137 EEPROM chips that implement "address overflow" are ones
4138 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4139 address and the extra bits end up in the "chip address" bit
4140 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4141 byte chips.
4142
4143 Note that we consider the length of the address field to
4144 still be one byte because the extra address bits are hidden
4145 in the chip address.
4146
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004147 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004148 The size in bytes of the EEPROM device.
4149
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004150 - CONFIG_ENV_EEPROM_IS_ON_I2C
4151 define this, if you have I2C and SPI activated, and your
4152 EEPROM, which holds the environment, is on the I2C bus.
4153
4154 - CONFIG_I2C_ENV_EEPROM_BUS
4155 if you have an Environment on an EEPROM reached over
4156 I2C muxes, you can define here, how to reach this
4157 EEPROM. For example:
4158
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004159 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004160
4161 EEPROM which holds the environment, is reached over
4162 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004163
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004164- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004165
wdenk1ebf41e2004-01-02 14:00:00 +00004166 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004167 want to use for the environment.
4168
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004169 - CONFIG_ENV_OFFSET:
4170 - CONFIG_ENV_ADDR:
4171 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004172
4173 These three #defines specify the offset and size of the
4174 environment area within the total memory of your DataFlash placed
4175 at the specified address.
4176
Wu, Josh76db7bf2014-07-01 19:30:13 +08004177- CONFIG_ENV_IS_IN_SPI_FLASH:
4178
4179 Define this if you have a SPI Flash memory device which you
4180 want to use for the environment.
4181
4182 - CONFIG_ENV_OFFSET:
4183 - CONFIG_ENV_SIZE:
4184
4185 These two #defines specify the offset and size of the
4186 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4187 aligned to an erase sector boundary.
4188
4189 - CONFIG_ENV_SECT_SIZE:
4190
4191 Define the SPI flash's sector size.
4192
4193 - CONFIG_ENV_OFFSET_REDUND (optional):
4194
4195 This setting describes a second storage area of CONFIG_ENV_SIZE
4196 size used to hold a redundant copy of the environment data, so
4197 that there is a valid backup copy in case there is a power failure
4198 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4199 aligned to an erase sector boundary.
4200
4201 - CONFIG_ENV_SPI_BUS (optional):
4202 - CONFIG_ENV_SPI_CS (optional):
4203
4204 Define the SPI bus and chip select. If not defined they will be 0.
4205
4206 - CONFIG_ENV_SPI_MAX_HZ (optional):
4207
4208 Define the SPI max work clock. If not defined then use 1MHz.
4209
4210 - CONFIG_ENV_SPI_MODE (optional):
4211
4212 Define the SPI work mode. If not defined then use SPI_MODE_3.
4213
Liu Gang85bcd732012-03-08 00:33:20 +00004214- CONFIG_ENV_IS_IN_REMOTE:
4215
4216 Define this if you have a remote memory space which you
4217 want to use for the local device's environment.
4218
4219 - CONFIG_ENV_ADDR:
4220 - CONFIG_ENV_SIZE:
4221
4222 These two #defines specify the address and size of the
4223 environment area within the remote memory space. The
4224 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004225 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004226
4227BE CAREFUL! For some special cases, the local device can not use
4228"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004229environment stored in a remote NOR flash by SRIO or PCIE link,
4230but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004231
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004232- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004233
4234 Define this if you have a NAND device which you want to use
4235 for the environment.
4236
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004237 - CONFIG_ENV_OFFSET:
4238 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004239
4240 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004241 area within the first NAND device. CONFIG_ENV_OFFSET must be
4242 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004243
Scott Wood08239322010-09-17 14:38:37 -05004244 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004245
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004246 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004247 size used to hold a redundant copy of the environment data, so
4248 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004249 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004250 aligned to an erase block boundary.
4251
4252 - CONFIG_ENV_RANGE (optional):
4253
4254 Specifies the length of the region in which the environment
4255 can be written. This should be a multiple of the NAND device's
4256 block size. Specifying a range with more erase blocks than
4257 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4258 the range to be avoided.
4259
4260 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004261
Scott Wood08239322010-09-17 14:38:37 -05004262 Enables support for dynamically retrieving the offset of the
4263 environment from block zero's out-of-band data. The
4264 "nand env.oob" command can be used to record this offset.
4265 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4266 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004267
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004268- CONFIG_NAND_ENV_DST
4269
4270 Defines address in RAM to which the nand_spl code should copy the
4271 environment. If redundant environment is used, it will be copied to
4272 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4273
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004274- CONFIG_ENV_IS_IN_UBI:
4275
4276 Define this if you have an UBI volume that you want to use for the
4277 environment. This has the benefit of wear-leveling the environment
4278 accesses, which is important on NAND.
4279
4280 - CONFIG_ENV_UBI_PART:
4281
4282 Define this to a string that is the mtd partition containing the UBI.
4283
4284 - CONFIG_ENV_UBI_VOLUME:
4285
4286 Define this to the name of the volume that you want to store the
4287 environment in.
4288
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004289 - CONFIG_ENV_UBI_VOLUME_REDUND:
4290
4291 Define this to the name of another volume to store a second copy of
4292 the environment in. This will enable redundant environments in UBI.
4293 It is assumed that both volumes are in the same MTD partition.
4294
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004295 - CONFIG_UBI_SILENCE_MSG
4296 - CONFIG_UBIFS_SILENCE_MSG
4297
4298 You will probably want to define these to avoid a really noisy system
4299 when storing the env in UBI.
4300
Wu, Josha7d0c872014-06-24 17:31:03 +08004301- CONFIG_ENV_IS_IN_FAT:
4302 Define this if you want to use the FAT file system for the environment.
4303
4304 - FAT_ENV_INTERFACE:
4305
4306 Define this to a string that is the name of the block device.
4307
4308 - FAT_ENV_DEV_AND_PART:
4309
4310 Define this to a string to specify the partition of the device. It can
4311 be as following:
4312
4313 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4314 - "D:P": device D partition P. Error occurs if device D has no
4315 partition table.
4316 - "D:0": device D.
4317 - "D" or "D:": device D partition 1 if device D has partition
4318 table, or the whole device D if has no partition
4319 table.
4320 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004321 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004322 partition table then means device D.
4323
4324 - FAT_ENV_FILE:
4325
4326 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004327 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004328
4329 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004330 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004331
Stephen Warreneedcacd2013-06-11 15:14:00 -06004332- CONFIG_ENV_IS_IN_MMC:
4333
4334 Define this if you have an MMC device which you want to use for the
4335 environment.
4336
4337 - CONFIG_SYS_MMC_ENV_DEV:
4338
4339 Specifies which MMC device the environment is stored in.
4340
4341 - CONFIG_SYS_MMC_ENV_PART (optional):
4342
4343 Specifies which MMC partition the environment is stored in. If not
4344 set, defaults to partition 0, the user area. Common values might be
4345 1 (first MMC boot partition), 2 (second MMC boot partition).
4346
4347 - CONFIG_ENV_OFFSET:
4348 - CONFIG_ENV_SIZE:
4349
4350 These two #defines specify the offset and size of the environment
4351 area within the specified MMC device.
4352
Stephen Warren24dc2032013-06-11 15:14:02 -06004353 If offset is positive (the usual case), it is treated as relative to
4354 the start of the MMC partition. If offset is negative, it is treated
4355 as relative to the end of the MMC partition. This can be useful if
4356 your board may be fitted with different MMC devices, which have
4357 different sizes for the MMC partitions, and you always want the
4358 environment placed at the very end of the partition, to leave the
4359 maximum possible space before it, to store other data.
4360
Stephen Warreneedcacd2013-06-11 15:14:00 -06004361 These two values are in units of bytes, but must be aligned to an
4362 MMC sector boundary.
4363
4364 - CONFIG_ENV_OFFSET_REDUND (optional):
4365
4366 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4367 hold a redundant copy of the environment data. This provides a
4368 valid backup copy in case the other copy is corrupted, e.g. due
4369 to a power failure during a "saveenv" operation.
4370
Stephen Warren24dc2032013-06-11 15:14:02 -06004371 This value may also be positive or negative; this is handled in the
4372 same way as CONFIG_ENV_OFFSET.
4373
Stephen Warreneedcacd2013-06-11 15:14:00 -06004374 This value is also in units of bytes, but must also be aligned to
4375 an MMC sector boundary.
4376
4377 - CONFIG_ENV_SIZE_REDUND (optional):
4378
4379 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4380 set. If this value is set, it must be set to the same value as
4381 CONFIG_ENV_SIZE.
4382
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004383- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004384
4385 Defines offset to the initial SPI buffer area in DPRAM. The
4386 area is used at an early stage (ROM part) if the environment
4387 is configured to reside in the SPI EEPROM: We need a 520 byte
4388 scratch DPRAM area. It is used between the two initialization
4389 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4390 to be a good choice since it makes it far enough from the
4391 start of the data area as well as from the stack pointer.
4392
Bruce Adleredecc942007-11-02 13:15:42 -07004393Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004394has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004395created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004396until then to read environment variables.
4397
wdenk8dba0502003-03-31 16:34:49 +00004398The environment is protected by a CRC32 checksum. Before the monitor
4399is relocated into RAM, as a result of a bad CRC you will be working
4400with the compiled-in default environment - *silently*!!! [This is
4401necessary, because the first environment variable we need is the
4402"baudrate" setting for the console - if we have a bad CRC, we don't
4403have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004404
4405Note: once the monitor has been relocated, then it will complain if
4406the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004407use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004408
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004409- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004410 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004411
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004412 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004413 also needs to be defined.
4414
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004415- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004416 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004417
Ron Madriddfa028a2009-02-18 14:30:44 -08004418- CONFIG_NS16550_MIN_FUNCTIONS:
4419 Define this if you desire to only have use of the NS16550_init
4420 and NS16550_putc functions for the serial driver located at
4421 drivers/serial/ns16550.c. This option is useful for saving
4422 space for already greatly restricted images, including but not
4423 limited to NAND_SPL configurations.
4424
Simon Glass28a9e332012-11-30 13:01:18 +00004425- CONFIG_DISPLAY_BOARDINFO
4426 Display information about the board that U-Boot is running on
4427 when U-Boot starts up. The board function checkboard() is called
4428 to do this.
4429
Simon Glasse8822012012-11-30 13:01:19 +00004430- CONFIG_DISPLAY_BOARDINFO_LATE
4431 Similar to the previous option, but display this information
4432 later, once stdio is running and output goes to the LCD, if
4433 present.
4434
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004435- CONFIG_BOARD_SIZE_LIMIT:
4436 Maximum size of the U-Boot image. When defined, the
4437 build system checks that the actual size does not
4438 exceed it.
4439
wdenkc6097192002-11-03 00:24:07 +00004440Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004441---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004442
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004443- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004444 Cache Line Size of the CPU.
4445
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004446- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004447 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004448
wdenk9c53f402003-10-15 23:53:47 +00004449 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4450 and RPXsuper) to be able to adjust the position of
4451 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004452
Timur Tabid8f341c2011-08-04 18:03:41 -05004453- CONFIG_SYS_CCSRBAR_DEFAULT:
4454 Default (power-on reset) physical address of CCSR on Freescale
4455 PowerPC SOCs.
4456
4457- CONFIG_SYS_CCSRBAR:
4458 Virtual address of CCSR. On a 32-bit build, this is typically
4459 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4460
4461 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4462 for cross-platform code that uses that macro instead.
4463
4464- CONFIG_SYS_CCSRBAR_PHYS:
4465 Physical address of CCSR. CCSR can be relocated to a new
4466 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004467 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004468 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4469 is typically relocated on 36-bit builds. It is recommended
4470 that this macro be defined via the _HIGH and _LOW macros:
4471
4472 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4473 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4474
4475- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004476 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4477 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004478 used in assembly code, so it must not contain typecasts or
4479 integer size suffixes (e.g. "ULL").
4480
4481- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4482 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4483 used in assembly code, so it must not contain typecasts or
4484 integer size suffixes (e.g. "ULL").
4485
4486- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4487 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4488 forced to a value that ensures that CCSR is not relocated.
4489
wdenk1272e232002-11-10 22:06:23 +00004490- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004491 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004492
4493 the default drive number (default value 0)
4494
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004495 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004496
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004497 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004498 (default value 1)
4499
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004500 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004501
wdenk4a5c8a72003-03-06 00:02:04 +00004502 defines the offset of register from address. It
4503 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004504 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004505
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004506 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4507 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004508 default value.
wdenk1272e232002-11-10 22:06:23 +00004509
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004510 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004511 fdc_hw_init() is called at the beginning of the FDC
4512 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004513 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004514 initializations.
wdenk1272e232002-11-10 22:06:23 +00004515
Macpaul Lind1e49942011-04-11 20:45:32 +00004516- CONFIG_IDE_AHB:
4517 Most IDE controllers were designed to be connected with PCI
4518 interface. Only few of them were designed for AHB interface.
4519 When software is doing ATA command and data transfer to
4520 IDE devices through IDE-AHB controller, some additional
4521 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004522 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004523
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004524- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004525 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004526 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004527
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004528- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004529
wdenkeb20ad32003-09-05 23:19:14 +00004530 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004531 initial data and stack; please note that this must be
4532 writable memory that is working WITHOUT special
4533 initialization, i. e. you CANNOT use normal RAM which
4534 will become available only after programming the
4535 memory controller and running certain initialization
4536 sequences.
4537
4538 U-Boot uses the following memory types:
4539 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4540 - MPC824X: data cache
4541 - PPC4xx: data cache
4542
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004543- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004544
4545 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004546 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4547 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004548 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004549 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004550 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4551 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4552 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004553
4554 Note:
4555 On the MPC824X (or other systems that use the data
4556 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004557 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004558 point to an otherwise UNUSED address space between
4559 the top of RAM and the start of the PCI space.
4560
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004561- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004563- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004565- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004566
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004567- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004568
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004569- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004570
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004571- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004572
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004573- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004574 SDRAM timing
4575
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004576- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004577 periodic timer for refresh
4578
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004579- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004580
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004581- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4582 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4583 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4584 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004585 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4586
4587- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004588 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4589 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004590 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004592- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4593 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004594 Machine Mode Register and Memory Periodic Timer
4595 Prescaler definitions (SDRAM timing)
4596
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004597- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004598 enable I2C microcode relocation patch (MPC8xx);
4599 define relocation offset in DPRAM [DSP2]
4600
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004601- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004602 enable SMC microcode relocation patch (MPC8xx);
4603 define relocation offset in DPRAM [SMC1]
4604
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004605- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004606 enable SPI microcode relocation patch (MPC8xx);
4607 define relocation offset in DPRAM [SCC4]
4608
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004609- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004610 Use OSCM clock mode on MBX8xx board. Be careful,
4611 wrong setting might damage your board. Read
4612 doc/README.MBX before setting this variable!
4613
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004614- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004615 Offset of the bootmode word in DPRAM used by post
4616 (Power On Self Tests). This definition overrides
4617 #define'd default value in commproc.h resp.
4618 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004619
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004620- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4621 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4622 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4623 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4624 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4625 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4626 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4627 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004628 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004629
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004630- CONFIG_PCI_DISABLE_PCIE:
4631 Disable PCI-Express on systems where it is supported but not
4632 required.
4633
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004634- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004635 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004636 Don't do any setup work, presumably because someone or
4637 something has already done it, and we don't need to do it
4638 a second time. Useful for platforms that are pre-booted
4639 by coreboot or similar.
4640
Gabor Juhosb4458732013-05-30 07:06:12 +00004641- CONFIG_PCI_INDIRECT_BRIDGE:
4642 Enable support for indirect PCI bridges.
4643
Kumar Gala8975d7a2010-12-30 12:09:53 -06004644- CONFIG_SYS_SRIO:
4645 Chip has SRIO or not
4646
4647- CONFIG_SRIO1:
4648 Board has SRIO 1 port available
4649
4650- CONFIG_SRIO2:
4651 Board has SRIO 2 port available
4652
Liu Gang27afb9c2013-05-07 16:30:46 +08004653- CONFIG_SRIO_PCIE_BOOT_MASTER
4654 Board can support master function for Boot from SRIO and PCIE
4655
Kumar Gala8975d7a2010-12-30 12:09:53 -06004656- CONFIG_SYS_SRIOn_MEM_VIRT:
4657 Virtual Address of SRIO port 'n' memory region
4658
4659- CONFIG_SYS_SRIOn_MEM_PHYS:
4660 Physical Address of SRIO port 'n' memory region
4661
4662- CONFIG_SYS_SRIOn_MEM_SIZE:
4663 Size of SRIO port 'n' memory region
4664
Fabio Estevamf17e8782013-04-11 09:35:34 +00004665- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4666 Defined to tell the NAND controller that the NAND chip is using
4667 a 16 bit bus.
4668 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004669 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004670 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004671 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004672
4673- CONFIG_SYS_NDFC_EBC0_CFG
4674 Sets the EBC0_CFG register for the NDFC. If not defined
4675 a default value will be used.
4676
Ben Warren45657152006-09-07 16:50:54 -04004677- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004678 Get DDR timing information from an I2C EEPROM. Common
4679 with pluggable memory modules such as SODIMMs
4680
Ben Warren45657152006-09-07 16:50:54 -04004681 SPD_EEPROM_ADDRESS
4682 I2C address of the SPD EEPROM
4683
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004684- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004685 If SPD EEPROM is on an I2C bus other than the first
4686 one, specify here. Note that the value must resolve
4687 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004688
York Sune73cc042011-06-07 09:42:16 +08004689- CONFIG_SYS_DDR_RAW_TIMING
4690 Get DDR timing information from other than SPD. Common with
4691 soldered DDR chips onboard without SPD. DDR raw timing
4692 parameters are extracted from datasheet and hard-coded into
4693 header files or board specific files.
4694
York Sunbd495cf2011-09-16 13:21:35 -07004695- CONFIG_FSL_DDR_INTERACTIVE
4696 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4697
York Sun8ced0502015-01-06 13:18:55 -08004698- CONFIG_FSL_DDR_SYNC_REFRESH
4699 Enable sync of refresh for multiple controllers.
4700
York Sunb6a35f82015-03-19 09:30:28 -07004701- CONFIG_FSL_DDR_BIST
4702 Enable built-in memory test for Freescale DDR controllers.
4703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004705 Only for 83xx systems. If specified, then DDR should
4706 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004707
wdenk6203e402004-04-18 10:13:26 +00004708- CONFIG_ETHER_ON_FEC[12]
4709 Define to enable FEC[12] on a 8xx series processor.
4710
4711- CONFIG_FEC[12]_PHY
4712 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004713 to the given FEC; i. e.
4714 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004715 means that the PHY with address 4 is connected to FEC1
4716
4717 When set to -1, means to probe for first available.
4718
4719- CONFIG_FEC[12]_PHY_NORXERR
4720 The PHY does not have a RXERR line (RMII only).
4721 (so program the FEC to ignore it).
4722
4723- CONFIG_RMII
4724 Enable RMII mode for all FECs.
4725 Note that this is a global option, we can't
4726 have one FEC in standard MII mode and another in RMII mode.
4727
wdenk20c98a62004-04-23 20:32:05 +00004728- CONFIG_CRC32_VERIFY
4729 Add a verify option to the crc32 command.
4730 The syntax is:
4731
4732 => crc32 -v <address> <count> <crc32>
4733
4734 Where address/count indicate a memory area
4735 and crc32 is the correct crc32 which the
4736 area should have.
4737
wdenk64519362004-07-11 17:40:54 +00004738- CONFIG_LOOPW
4739 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004740 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004741
stroesecc3af832004-12-16 18:46:55 +00004742- CONFIG_MX_CYCLIC
4743 Add the "mdc" and "mwc" memory commands. These are cyclic
4744 "md/mw" commands.
4745 Examples:
4746
wdenk07d7e6b2004-12-16 21:44:03 +00004747 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004748 This command will print 4 bytes (10,11,12,13) each 500 ms.
4749
wdenk07d7e6b2004-12-16 21:44:03 +00004750 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004751 This command will write 12345678 to address 100 all 10 ms.
4752
wdenk07d7e6b2004-12-16 21:44:03 +00004753 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004754 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004755
wdenk3d3d99f2005-04-04 12:44:11 +00004756- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004757 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004758 low level initializations (like setting up the memory
4759 controller) are omitted and/or U-Boot does not
4760 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004761
Wolfgang Denk302141d2010-11-27 23:30:56 +01004762 Normally this variable MUST NOT be defined. The only
4763 exception is when U-Boot is loaded (to RAM) by some
4764 other boot loader or by a debugger which performs
4765 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004766
Simon Glass90844072016-05-05 07:28:06 -06004767- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4768 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004769 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004770 instruction cache) is still performed.
4771
Aneesh V552a3192011-07-13 05:11:07 +00004772- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004773 Modifies the behaviour of start.S when compiling a loader
4774 that is executed before the actual U-Boot. E.g. when
4775 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004776
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004777- CONFIG_TPL_BUILD
4778 Modifies the behaviour of start.S when compiling a loader
4779 that is executed after the SPL and before the actual U-Boot.
4780 It is loaded by the SPL.
4781
Ying Zhang0d4f5442013-05-20 14:07:23 +08004782- CONFIG_SYS_MPC85XX_NO_RESETVEC
4783 Only for 85xx systems. If this variable is specified, the section
4784 .resetvec is not kept and the section .bootpg is placed in the
4785 previous 4k of the .text section.
4786
Simon Glass17dabf02013-02-24 17:33:14 +00004787- CONFIG_ARCH_MAP_SYSMEM
4788 Generally U-Boot (and in particular the md command) uses
4789 effective address. It is therefore not necessary to regard
4790 U-Boot address as virtual addresses that need to be translated
4791 to physical addresses. However, sandbox requires this, since
4792 it maintains its own little RAM buffer which contains all
4793 addressable memory. This option causes some memory accesses
4794 to be mapped through map_sysmem() / unmap_sysmem().
4795
Matthias Weisser93416c12011-03-10 21:36:32 +00004796- CONFIG_USE_ARCH_MEMCPY
4797 CONFIG_USE_ARCH_MEMSET
4798 If these options are used a optimized version of memcpy/memset will
4799 be used if available. These functions may be faster under some
4800 conditions but may increase the binary size.
4801
Simon Glassbfb59802013-02-14 04:18:54 +00004802- CONFIG_X86_RESET_VECTOR
4803 If defined, the x86 reset vector code is included. This is not
4804 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004805
Mark Jackson52b003c2013-03-04 01:27:20 +00004806- CONFIG_SYS_MPUCLK
4807 Defines the MPU clock speed (in MHz).
4808
4809 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004810
Heiko Schocher2233e462013-11-04 14:05:00 +01004811- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4812 Enables the RTC32K OSC on AM33xx based plattforms
4813
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004814- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4815 Option to disable subpage write in NAND driver
4816 driver that uses this:
4817 drivers/mtd/nand/davinci_nand.c
4818
Timur Tabi275f4bb2011-11-22 09:21:25 -06004819Freescale QE/FMAN Firmware Support:
4820-----------------------------------
4821
4822The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4823loading of "firmware", which is encoded in the QE firmware binary format.
4824This firmware often needs to be loaded during U-Boot booting, so macros
4825are used to identify the storage device (NOR flash, SPI, etc) and the address
4826within that device.
4827
Zhao Qiang83a90842014-03-21 16:21:44 +08004828- CONFIG_SYS_FMAN_FW_ADDR
4829 The address in the storage device where the FMAN microcode is located. The
4830 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4831 is also specified.
4832
4833- CONFIG_SYS_QE_FW_ADDR
4834 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004835 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4836 is also specified.
4837
4838- CONFIG_SYS_QE_FMAN_FW_LENGTH
4839 The maximum possible size of the firmware. The firmware binary format
4840 has a field that specifies the actual size of the firmware, but it
4841 might not be possible to read any part of the firmware unless some
4842 local storage is allocated to hold the entire firmware first.
4843
4844- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4845 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4846 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4847 virtual address in NOR flash.
4848
4849- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4850 Specifies that QE/FMAN firmware is located in NAND flash.
4851 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4852
4853- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4854 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4855 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4856
4857- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4858 Specifies that QE/FMAN firmware is located on the primary SPI
4859 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4860
Liu Gang1e084582012-03-08 00:33:18 +00004861- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4862 Specifies that QE/FMAN firmware is located in the remote (master)
4863 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004864 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4865 window->master inbound window->master LAW->the ucode address in
4866 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004867
J. German Rivera8ff14b72014-06-23 15:15:55 -07004868Freescale Layerscape Management Complex Firmware Support:
4869---------------------------------------------------------
4870The Freescale Layerscape Management Complex (MC) supports the loading of
4871"firmware".
4872This firmware often needs to be loaded during U-Boot booting, so macros
4873are used to identify the storage device (NOR flash, SPI, etc) and the address
4874within that device.
4875
4876- CONFIG_FSL_MC_ENET
4877 Enable the MC driver for Layerscape SoCs.
4878
4879- CONFIG_SYS_LS_MC_FW_ADDR
4880 The address in the storage device where the firmware is located. The
4881 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4882 is also specified.
4883
4884- CONFIG_SYS_LS_MC_FW_LENGTH
4885 The maximum possible size of the firmware. The firmware binary format
4886 has a field that specifies the actual size of the firmware, but it
4887 might not be possible to read any part of the firmware unless some
4888 local storage is allocated to hold the entire firmware first.
4889
4890- CONFIG_SYS_LS_MC_FW_IN_NOR
4891 Specifies that MC firmware is located in NOR flash, mapped as
4892 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4893 virtual address in NOR flash.
4894
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304895Freescale Layerscape Debug Server Support:
4896-------------------------------------------
4897The Freescale Layerscape Debug Server Support supports the loading of
4898"Debug Server firmware" and triggering SP boot-rom.
4899This firmware often needs to be loaded during U-Boot booting.
4900
4901- CONFIG_FSL_DEBUG_SERVER
4902 Enable the Debug Server for Layerscape SoCs.
4903
4904- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
4905 Define minimum DDR size required for debug server image
4906
York Sun928b6812015-12-07 11:08:58 -08004907- CONFIG_SYS_MC_RSV_MEM_ALIGN
4908 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304909
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004910Reproducible builds
4911-------------------
4912
4913In order to achieve reproducible builds, timestamps used in the U-Boot build
4914process have to be set to a fixed value.
4915
4916This is done using the SOURCE_DATE_EPOCH environment variable.
4917SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4918option for U-Boot or an environment variable in U-Boot.
4919
4920SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4921
wdenkc6097192002-11-03 00:24:07 +00004922Building the Software:
4923======================
4924
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004925Building U-Boot has been tested in several native build environments
4926and in many different cross environments. Of course we cannot support
4927all possibly existing versions of cross development tools in all
4928(potentially obsolete) versions. In case of tool chain problems we
4929recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4930which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004931
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004932If you are not using a native environment, it is assumed that you
4933have GNU cross compiling tools available in your path. In this case,
4934you must set the environment variable CROSS_COMPILE in your shell.
4935Note that no changes to the Makefile or any other source files are
4936necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004937
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004938 $ CROSS_COMPILE=ppc_4xx-
4939 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004940
Peter Tyserb06976d2009-03-13 18:54:51 -05004941Note: If you wish to generate Windows versions of the utilities in
4942 the tools directory you can use the MinGW toolchain
4943 (http://www.mingw.org). Set your HOST tools to the MinGW
4944 toolchain and execute 'make tools'. For example:
4945
4946 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4947
4948 Binaries such as tools/mkimage.exe will be created which can
4949 be executed on computers running Windows.
4950
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004951U-Boot is intended to be simple to build. After installing the
4952sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004953is done by typing:
4954
Holger Freyther7ba4e572014-08-04 09:26:05 +02004955 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004956
Holger Freyther7ba4e572014-08-04 09:26:05 +02004957where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004958rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004959
wdenk6c59edc2004-05-03 20:45:30 +00004960Note: for some board special configuration names may exist; check if
4961 additional information is available from the board vendor; for
4962 instance, the TQM823L systems are available without (standard)
4963 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004964 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004965
Holger Freyther7ba4e572014-08-04 09:26:05 +02004966 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004967 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004968
Holger Freyther7ba4e572014-08-04 09:26:05 +02004969 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004970 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004971
wdenk6c59edc2004-05-03 20:45:30 +00004972 etc.
wdenkc6097192002-11-03 00:24:07 +00004973
wdenkc6097192002-11-03 00:24:07 +00004974
wdenk6c59edc2004-05-03 20:45:30 +00004975Finally, type "make all", and you should get some working U-Boot
4976images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004977
wdenk6c59edc2004-05-03 20:45:30 +00004978- "u-boot.bin" is a raw binary image
4979- "u-boot" is an image in ELF binary format
4980- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004981
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004982By default the build is performed locally and the objects are saved
4983in the source directory. One of the two methods can be used to change
4984this behavior and build U-Boot to some external directory:
4985
49861. Add O= to the make command line invocations:
4987
4988 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004989 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004990 make O=/tmp/build all
4991
Timo Ketolac8c67602014-11-06 14:39:05 +020049922. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004993
Timo Ketolac8c67602014-11-06 14:39:05 +02004994 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004995 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004996 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004997 make all
4998
Timo Ketolac8c67602014-11-06 14:39:05 +02004999Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005000variable.
5001
wdenkc6097192002-11-03 00:24:07 +00005002
wdenk6c59edc2004-05-03 20:45:30 +00005003Please be aware that the Makefiles assume you are using GNU make, so
5004for instance on NetBSD you might need to use "gmake" instead of
5005native "make".
wdenkc6097192002-11-03 00:24:07 +00005006
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +00005008If the system board that you have is not listed, then you will need
5009to port U-Boot to your hardware platform. To do this, follow these
5010steps:
wdenkc6097192002-11-03 00:24:07 +00005011
Phil Sutterc77b4882015-12-25 14:41:18 +010050121. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00005013 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01005014 the "Makefile" and a "<board>.c".
50152. Create a new configuration file "include/configs/<board>.h" for
5016 your board.
wdenk6c59edc2004-05-03 20:45:30 +000050173. If you're porting U-Boot to a new CPU, then also create a new
5018 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020050194. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000050205. Type "make", and you should get a working "u-boot.srec" file
5021 to be installed on your target system.
50226. Debug and solve any problems that might arise.
5023 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005024
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5027==============================================================
wdenkc6097192002-11-03 00:24:07 +00005028
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005029If you have modified U-Boot sources (for instance added a new board
5030or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005031provide feedback to the other developers. The feedback normally takes
5032the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005033official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005034
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005035But before you submit such a patch, please verify that your modifi-
5036cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005037the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06005038just run the buildman script (tools/buildman/buildman), which will
5039configure and build U-Boot for ALL supported system. Be warned, this
5040will take a while. Please see the buildman README, or run 'buildman -H'
5041for documentation.
wdenkc6097192002-11-03 00:24:07 +00005042
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005043
wdenk6c59edc2004-05-03 20:45:30 +00005044See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005045
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk6c59edc2004-05-03 20:45:30 +00005047Monitor Commands - Overview:
5048============================
wdenkc6097192002-11-03 00:24:07 +00005049
wdenk6c59edc2004-05-03 20:45:30 +00005050go - start application at address 'addr'
5051run - run commands in an environment variable
5052bootm - boot application image from memory
5053bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005054bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005055tftpboot- boot image via network using TFTP protocol
5056 and env variables "ipaddr" and "serverip"
5057 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005058tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005059rarpboot- boot image via network using RARP/TFTP protocol
5060diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5061loads - load S-Record file over serial line
5062loadb - load binary file over serial line (kermit mode)
5063md - memory display
5064mm - memory modify (auto-incrementing)
5065nm - memory modify (constant address)
5066mw - memory write (fill)
5067cp - memory copy
5068cmp - memory compare
5069crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005070i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005071sspi - SPI utility commands
5072base - print or set address offset
5073printenv- print environment variables
5074setenv - set environment variables
5075saveenv - save environment variables to persistent storage
5076protect - enable or disable FLASH write protection
5077erase - erase FLASH memory
5078flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005079nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005080bdinfo - print Board Info structure
5081iminfo - print header information for application image
5082coninfo - print console devices and informations
5083ide - IDE sub-system
5084loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005085loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005086mtest - simple RAM test
5087icache - enable or disable instruction cache
5088dcache - enable or disable data cache
5089reset - Perform RESET of the CPU
5090echo - echo args to console
5091version - print monitor version
5092help - print online help
5093? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005094
wdenkc6097192002-11-03 00:24:07 +00005095
wdenk6c59edc2004-05-03 20:45:30 +00005096Monitor Commands - Detailed Description:
5097========================================
wdenkc6097192002-11-03 00:24:07 +00005098
wdenk6c59edc2004-05-03 20:45:30 +00005099TODO.
wdenkc6097192002-11-03 00:24:07 +00005100
wdenk6c59edc2004-05-03 20:45:30 +00005101For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005102
5103
wdenk6c59edc2004-05-03 20:45:30 +00005104Environment Variables:
5105======================
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk6c59edc2004-05-03 20:45:30 +00005107U-Boot supports user configuration using Environment Variables which
5108can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005109
wdenk6c59edc2004-05-03 20:45:30 +00005110Environment Variables are set using "setenv", printed using
5111"printenv", and saved to Flash using "saveenv". Using "setenv"
5112without a value can be used to delete a variable from the
5113environment. As long as you don't save the environment you are
5114working with an in-memory copy. In case the Flash area containing the
5115environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005116
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005117Some configuration options can be set using Environment Variables.
5118
5119List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk6c59edc2004-05-03 20:45:30 +00005121 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk6c59edc2004-05-03 20:45:30 +00005123 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk6c59edc2004-05-03 20:45:30 +00005125 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005126
wdenk6c59edc2004-05-03 20:45:30 +00005127 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005128
wdenk6c59edc2004-05-03 20:45:30 +00005129 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005130
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005131 bootm_low - Memory range available for image processing in the bootm
5132 command can be restricted. This variable is given as
5133 a hexadecimal number and defines lowest address allowed
5134 for use by the bootm command. See also "bootm_size"
5135 environment variable. Address defined by "bootm_low" is
5136 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005137 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5138 bootm_mapsize.
5139
Wolfgang Denk092ae952011-10-26 10:21:21 +00005140 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005141 This variable is given as a hexadecimal number and it
5142 defines the size of the memory region starting at base
5143 address bootm_low that is accessible by the Linux kernel
5144 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5145 as the default value if it is defined, and bootm_size is
5146 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005147
5148 bootm_size - Memory range available for image processing in the bootm
5149 command can be restricted. This variable is given as
5150 a hexadecimal number and defines the size of the region
5151 allowed for use by the bootm command. See also "bootm_low"
5152 environment variable.
5153
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005154 updatefile - Location of the software update file on a TFTP server, used
5155 by the automatic software update feature. Please refer to
5156 documentation in doc/README.update for more details.
5157
wdenk6c59edc2004-05-03 20:45:30 +00005158 autoload - if set to "no" (any string beginning with 'n'),
5159 "bootp" will just load perform a lookup of the
5160 configuration from the BOOTP server, but not try to
5161 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005162
wdenk6c59edc2004-05-03 20:45:30 +00005163 autostart - if set to "yes", an image loaded using the "bootp",
5164 "rarpboot", "tftpboot" or "diskboot" commands will
5165 be automatically started (by internally calling
5166 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005167
wdenk6c59edc2004-05-03 20:45:30 +00005168 If set to "no", a standalone image passed to the
5169 "bootm" command will be copied to the load address
5170 (and eventually uncompressed), but NOT be started.
5171 This can be used to load and uncompress arbitrary
5172 data.
wdenkc6097192002-11-03 00:24:07 +00005173
David A. Longd558a4e2011-07-09 16:40:19 -04005174 fdt_high - if set this restricts the maximum address that the
5175 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005176 For example, if you have a system with 1 GB memory
5177 at physical address 0x10000000, while Linux kernel
5178 only recognizes the first 704 MB as low memory, you
5179 may need to set fdt_high as 0x3C000000 to have the
5180 device tree blob be copied to the maximum address
5181 of the 704 MB low memory, so that Linux kernel can
5182 access it during the boot procedure.
5183
David A. Longd558a4e2011-07-09 16:40:19 -04005184 If this is set to the special value 0xFFFFFFFF then
5185 the fdt will not be copied at all on boot. For this
5186 to work it must reside in writable memory, have
5187 sufficient padding on the end of it for u-boot to
5188 add the information it needs into it, and the memory
5189 must be accessible by the kernel.
5190
Simon Glassdc6fa642011-10-24 19:15:34 +00005191 fdtcontroladdr- if set this is the address of the control flattened
5192 device tree used by U-Boot when CONFIG_OF_CONTROL is
5193 defined.
5194
wdenk0e2bd9c2004-06-06 21:51:03 +00005195 i2cfast - (PPC405GP|PPC405EP only)
5196 if set to 'y' configures Linux I2C driver for fast
5197 mode (400kHZ). This environment variable is used in
5198 initialization code. So, for changes to be effective
5199 it must be saved and board must be reset.
5200
wdenk6c59edc2004-05-03 20:45:30 +00005201 initrd_high - restrict positioning of initrd images:
5202 If this variable is not set, initrd images will be
5203 copied to the highest possible address in RAM; this
5204 is usually what you want since it allows for
5205 maximum initrd size. If for some reason you want to
5206 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005207 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005208 variable to a value of "no" or "off" or "0".
5209 Alternatively, you can set it to a maximum upper
5210 address to use (U-Boot will still check that it
5211 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk6c59edc2004-05-03 20:45:30 +00005213 For instance, when you have a system with 16 MB
5214 RAM, and want to reserve 4 MB from use by Linux,
5215 you can do this by adding "mem=12M" to the value of
5216 the "bootargs" variable. However, now you must make
5217 sure that the initrd image is placed in the first
5218 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk6c59edc2004-05-03 20:45:30 +00005220 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005221
wdenk6c59edc2004-05-03 20:45:30 +00005222 If you set initrd_high to 0xFFFFFFFF, this is an
5223 indication to U-Boot that all addresses are legal
5224 for the Linux kernel, including addresses in flash
5225 memory. In this case U-Boot will NOT COPY the
5226 ramdisk at all. This may be useful to reduce the
5227 boot time on your system, but requires that this
5228 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005229
wdenk6c59edc2004-05-03 20:45:30 +00005230 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk6c59edc2004-05-03 20:45:30 +00005232 loadaddr - Default load address for commands like "bootp",
5233 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk6c59edc2004-05-03 20:45:30 +00005235 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005236
wdenk6c59edc2004-05-03 20:45:30 +00005237 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005238
wdenk6c59edc2004-05-03 20:45:30 +00005239 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk6c59edc2004-05-03 20:45:30 +00005241 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005242
wdenk6c59edc2004-05-03 20:45:30 +00005243 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005244
Mike Frysingera23230c2011-10-02 10:01:27 +00005245 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005246
Mike Frysingera23230c2011-10-02 10:01:27 +00005247 ethact - controls which interface is currently active.
5248 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005249
Heiko Schocherc5e84052010-07-20 17:45:02 +02005250 => setenv ethact FEC
5251 => ping 192.168.0.1 # traffic sent on FEC
5252 => setenv ethact SCC
5253 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005254
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005255 ethrotate - When set to "no" U-Boot does not go through all
5256 available network interfaces.
5257 It just stays at the currently selected interface.
5258
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005259 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005260 either succeed or fail without retrying.
5261 When set to "once" the network operation will
5262 fail when all the available network interfaces
5263 are tried once without success.
5264 Useful on scripts which control the retry operation
5265 themselves.
wdenkc6097192002-11-03 00:24:07 +00005266
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005267 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005268
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005269 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005270 changing the console to be empty. If "yes" it will be
5271 made silent. If "no" it will not be made silent. If
5272 unset, then it will be made silent if the U-Boot console
5273 is silent.
5274
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005275 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005276 UDP source port.
5277
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005278 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005279 destination port instead of the Well Know Port 69.
5280
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005281 tftpblocksize - Block size to use for TFTP transfers; if not set,
5282 we use the TFTP server's default block size
5283
5284 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5285 seconds, minimum value is 1000 = 1 second). Defines
5286 when a packet is considered to be lost so it has to
5287 be retransmitted. The default is 5000 = 5 seconds.
5288 Lowering this value may make downloads succeed
5289 faster in networks with high packet loss rates or
5290 with unreliable TFTP servers.
5291
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005292 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5293 unit, minimum value = 0). Defines how many timeouts
5294 can happen during a single file transfer before that
5295 transfer is aborted. The default is 10, and 0 means
5296 'no timeouts allowed'. Increasing this value may help
5297 downloads succeed with high packet loss rates, or with
5298 unreliable TFTP servers or client hardware.
5299
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005300 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005301 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005302 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005303
Alexandre Messier15971322016-02-01 17:08:57 -05005304 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5305 Unsigned value, in milliseconds. If not set, the period will
5306 be either the default (28000), or a value based on
5307 CONFIG_NET_RETRY_COUNT, if defined. This value has
5308 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5309
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005310The following image location variables contain the location of images
5311used in booting. The "Image" column gives the role of the image and is
5312not an environment variable name. The other columns are environment
5313variable names. "File Name" gives the name of the file on a TFTP
5314server, "RAM Address" gives the location in RAM the image will be
5315loaded to, and "Flash Location" gives the image's address in NOR
5316flash or offset in NAND flash.
5317
5318*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005319boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005320boards use these variables for other purposes.
5321
Wolfgang Denk092ae952011-10-26 10:21:21 +00005322Image File Name RAM Address Flash Location
5323----- --------- ----------- --------------
5324u-boot u-boot u-boot_addr_r u-boot_addr
5325Linux kernel bootfile kernel_addr_r kernel_addr
5326device tree blob fdtfile fdt_addr_r fdt_addr
5327ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005328
wdenk6c59edc2004-05-03 20:45:30 +00005329The following environment variables may be used and automatically
5330updated by the network boot commands ("bootp" and "rarpboot"),
5331depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005332
wdenk6c59edc2004-05-03 20:45:30 +00005333 bootfile - see above
5334 dnsip - IP address of your Domain Name Server
5335 dnsip2 - IP address of your secondary Domain Name Server
5336 gatewayip - IP address of the Gateway (Router) to use
5337 hostname - Target hostname
5338 ipaddr - see above
5339 netmask - Subnet Mask
5340 rootpath - Pathname of the root filesystem on the NFS server
5341 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005342
wdenk145d2c12004-04-15 21:48:45 +00005343
wdenk6c59edc2004-05-03 20:45:30 +00005344There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005345
wdenk6c59edc2004-05-03 20:45:30 +00005346 serial# - contains hardware identification information such
5347 as type string and/or serial number
5348 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005349
wdenk6c59edc2004-05-03 20:45:30 +00005350These variables can be set only once (usually during manufacturing of
5351the board). U-Boot refuses to delete or overwrite these variables
5352once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005353
5354
wdenk6c59edc2004-05-03 20:45:30 +00005355Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005356
wdenk6c59edc2004-05-03 20:45:30 +00005357 ver - Contains the U-Boot version string as printed
5358 with the "version" command. This variable is
5359 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005360
wdenkc6097192002-11-03 00:24:07 +00005361
wdenk6c59edc2004-05-03 20:45:30 +00005362Please note that changes to some configuration parameters may take
5363only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005364
stroeseb9c17c52003-04-04 15:53:41 +00005365
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005366Callback functions for environment variables:
5367---------------------------------------------
5368
5369For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005370when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005371be associated with arbitrary variables. On creation, overwrite, or
5372deletion, the callback will provide the opportunity for some side
5373effect to happen or for the change to be rejected.
5374
5375The callbacks are named and associated with a function using the
5376U_BOOT_ENV_CALLBACK macro in your board or driver code.
5377
5378These callbacks are associated with variables in one of two ways. The
5379static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5380in the board configuration to a string that defines a list of
5381associations. The list must be in the following format:
5382
5383 entry = variable_name[:callback_name]
5384 list = entry[,list]
5385
5386If the callback name is not specified, then the callback is deleted.
5387Spaces are also allowed anywhere in the list.
5388
5389Callbacks can also be associated by defining the ".callbacks" variable
5390with the same list format above. Any association in ".callbacks" will
5391override any association in the static list. You can define
5392CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005393".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005394
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005395If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5396regular expression. This allows multiple variables to be connected to
5397the same callback without explicitly listing them all out.
5398
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005399
wdenk6c59edc2004-05-03 20:45:30 +00005400Command Line Parsing:
5401=====================
stroeseb9c17c52003-04-04 15:53:41 +00005402
wdenk6c59edc2004-05-03 20:45:30 +00005403There are two different command line parsers available with U-Boot:
5404the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005405
wdenk6c59edc2004-05-03 20:45:30 +00005406Old, simple command line parser:
5407--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409- supports environment variables (through setenv / saveenv commands)
5410- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005411- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005412- special characters ('$', ';') can be escaped by prefixing with '\',
5413 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005414 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005415- You can also escape text by enclosing in single apostrophes, for example:
5416 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005417
wdenk6c59edc2004-05-03 20:45:30 +00005418Hush shell:
5419-----------
wdenkf4688a22003-05-28 08:06:31 +00005420
wdenk6c59edc2004-05-03 20:45:30 +00005421- similar to Bourne shell, with control structures like
5422 if...then...else...fi, for...do...done; while...do...done,
5423 until...do...done, ...
5424- supports environment ("global") variables (through setenv / saveenv
5425 commands) and local shell variables (through standard shell syntax
5426 "name=value"); only environment variables can be used with "run"
5427 command
wdenkf4688a22003-05-28 08:06:31 +00005428
wdenk6c59edc2004-05-03 20:45:30 +00005429General rules:
5430--------------
wdenkf4688a22003-05-28 08:06:31 +00005431
wdenk6c59edc2004-05-03 20:45:30 +00005432(1) If a command line (or an environment variable executed by a "run"
5433 command) contains several commands separated by semicolon, and
5434 one of these commands fails, then the remaining commands will be
5435 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005436
wdenk6c59edc2004-05-03 20:45:30 +00005437(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005438 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005439 command will cause "run" to terminate, i. e. the remaining
5440 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005441
wdenk6c59edc2004-05-03 20:45:30 +00005442Note for Redundant Ethernet Interfaces:
5443=======================================
wdenkf4688a22003-05-28 08:06:31 +00005444
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005445Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005446such configurations and is capable of automatic selection of a
5447"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005448
wdenk6c59edc2004-05-03 20:45:30 +00005449Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5450MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5451"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005452
wdenk6c59edc2004-05-03 20:45:30 +00005453If the network interface stores some valid MAC address (for instance
5454in SROM), this is used as default address if there is NO correspon-
5455ding setting in the environment; if the corresponding environment
5456variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005457
wdenk6c59edc2004-05-03 20:45:30 +00005458o If the SROM has a valid MAC address, and there is no address in the
5459 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk6c59edc2004-05-03 20:45:30 +00005461o If there is no valid address in the SROM, and a definition in the
5462 environment exists, then the value from the environment variable is
5463 used.
wdenkc6097192002-11-03 00:24:07 +00005464
wdenk6c59edc2004-05-03 20:45:30 +00005465o If both the SROM and the environment contain a MAC address, and
5466 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk6c59edc2004-05-03 20:45:30 +00005468o If both the SROM and the environment contain a MAC address, and the
5469 addresses differ, the value from the environment is used and a
5470 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005471
wdenk6c59edc2004-05-03 20:45:30 +00005472o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005473 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5474 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005475
Ben Warren6db991a2010-04-26 11:11:46 -07005476If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005477will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005478may be skipped by setting the appropriate 'ethmacskip' environment variable.
5479The naming convention is as follows:
5480"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk6c59edc2004-05-03 20:45:30 +00005482Image Formats:
5483==============
wdenkc6097192002-11-03 00:24:07 +00005484
Marian Balakowicz18710b82008-03-12 12:13:13 +01005485U-Boot is capable of booting (and performing other auxiliary operations on)
5486images in two formats:
5487
5488New uImage format (FIT)
5489-----------------------
5490
5491Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5492to Flattened Device Tree). It allows the use of images with multiple
5493components (several kernels, ramdisks, etc.), with contents protected by
5494SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5495
5496
5497Old uImage format
5498-----------------
5499
5500Old image format is based on binary files which can be basically anything,
5501preceded by a special header; see the definitions in include/image.h for
5502details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005503
wdenk6c59edc2004-05-03 20:45:30 +00005504* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5505 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005506 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5507 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5508 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005509* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005510 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5511 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005512* Compression Type (uncompressed, gzip, bzip2)
5513* Load Address
5514* Entry Point
5515* Image Name
5516* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005517
wdenk6c59edc2004-05-03 20:45:30 +00005518The header is marked by a special Magic Number, and both the header
5519and the data portions of the image are secured against corruption by
5520CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005521
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523Linux Support:
5524==============
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk6c59edc2004-05-03 20:45:30 +00005526Although U-Boot should support any OS or standalone application
5527easily, the main focus has always been on Linux during the design of
5528U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk6c59edc2004-05-03 20:45:30 +00005530U-Boot includes many features that so far have been part of some
5531special "boot loader" code within the Linux kernel. Also, any
5532"initrd" images to be used are no longer part of one big Linux image;
5533instead, kernel and "initrd" are separate images. This implementation
5534serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005535
wdenk6c59edc2004-05-03 20:45:30 +00005536- the same features can be used for other OS or standalone
5537 applications (for instance: using compressed images to reduce the
5538 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005539
wdenk6c59edc2004-05-03 20:45:30 +00005540- it becomes much easier to port new Linux kernel versions because
5541 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543- the same Linux kernel image can now be used with different "initrd"
5544 images; of course this also means that different kernel images can
5545 be run with the same "initrd". This makes testing easier (you don't
5546 have to build a new "zImage.initrd" Linux image when you just
5547 change a file in your "initrd"). Also, a field-upgrade of the
5548 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005549
wdenkc6097192002-11-03 00:24:07 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551Linux HOWTO:
5552============
wdenkc6097192002-11-03 00:24:07 +00005553
wdenk6c59edc2004-05-03 20:45:30 +00005554Porting Linux to U-Boot based systems:
5555---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005556
wdenk6c59edc2004-05-03 20:45:30 +00005557U-Boot cannot save you from doing all the necessary modifications to
5558configure the Linux device drivers for use with your target hardware
5559(no, we don't intend to provide a full virtual machine interface to
5560Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005561
Stefan Roese88fbf932010-04-15 16:07:28 +02005562But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005563
wdenk6c59edc2004-05-03 20:45:30 +00005564Just make sure your machine specific header file (for instance
5565include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005566Information structure as we define in include/asm-<arch>/u-boot.h,
5567and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005568as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005569
Simon Glassd097e592014-06-11 23:29:46 -06005570Note that U-Boot now has a driver model, a unified model for drivers.
5571If you are adding a new driver, plumb it into driver model. If there
5572is no uclass available, you are encouraged to create one. See
5573doc/driver-model.
5574
wdenkc6097192002-11-03 00:24:07 +00005575
wdenk6c59edc2004-05-03 20:45:30 +00005576Configuring the Linux kernel:
5577-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579No specific requirements for U-Boot. Make sure you have some root
5580device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005581
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk6c59edc2004-05-03 20:45:30 +00005583Building a Linux Image:
5584-----------------------
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5587not used. If you use recent kernel source, a new build target
5588"uImage" will exist which automatically builds an image usable by
5589U-Boot. Most older kernels also have support for a "pImage" target,
5590which was introduced for our predecessor project PPCBoot and uses a
5591100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005592
wdenk6c59edc2004-05-03 20:45:30 +00005593Example:
wdenkc6097192002-11-03 00:24:07 +00005594
Holger Freyther7ba4e572014-08-04 09:26:05 +02005595 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005596 make oldconfig
5597 make dep
5598 make uImage
wdenkc6097192002-11-03 00:24:07 +00005599
wdenk6c59edc2004-05-03 20:45:30 +00005600The "uImage" build target uses a special tool (in 'tools/mkimage') to
5601encapsulate a compressed Linux kernel image with header information,
5602CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005603
wdenk6c59edc2004-05-03 20:45:30 +00005604* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk6c59edc2004-05-03 20:45:30 +00005606* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608 ${CROSS_COMPILE}-objcopy -O binary \
5609 -R .note -R .comment \
5610 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005611
wdenk6c59edc2004-05-03 20:45:30 +00005612* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005613
wdenk6c59edc2004-05-03 20:45:30 +00005614 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005615
wdenk6c59edc2004-05-03 20:45:30 +00005616* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618 mkimage -A ppc -O linux -T kernel -C gzip \
5619 -a 0 -e 0 -n "Linux Kernel Image" \
5620 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005621
wdenkc6097192002-11-03 00:24:07 +00005622
wdenk6c59edc2004-05-03 20:45:30 +00005623The "mkimage" tool can also be used to create ramdisk images for use
5624with U-Boot, either separated from the Linux kernel image, or
5625combined into one file. "mkimage" encapsulates the images with a 64
5626byte header containing information about target architecture,
5627operating system, image type, compression method, entry points, time
5628stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005629
wdenk6c59edc2004-05-03 20:45:30 +00005630"mkimage" can be called in two ways: to verify existing images and
5631print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005632
wdenk6c59edc2004-05-03 20:45:30 +00005633In the first form (with "-l" option) mkimage lists the information
5634contained in the header of an existing U-Boot image; this includes
5635checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005636
wdenk6c59edc2004-05-03 20:45:30 +00005637 tools/mkimage -l image
5638 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005639
wdenk6c59edc2004-05-03 20:45:30 +00005640The second form (with "-d" option) is used to build a U-Boot image
5641from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005642
wdenk6c59edc2004-05-03 20:45:30 +00005643 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5644 -n name -d data_file image
5645 -A ==> set architecture to 'arch'
5646 -O ==> set operating system to 'os'
5647 -T ==> set image type to 'type'
5648 -C ==> set compression type 'comp'
5649 -a ==> set load address to 'addr' (hex)
5650 -e ==> set entry point to 'ep' (hex)
5651 -n ==> set image name to 'name'
5652 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005653
wdenkcd914452004-05-29 16:53:29 +00005654Right now, all Linux kernels for PowerPC systems use the same load
5655address (0x00000000), but the entry point address depends on the
5656kernel version:
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk6c59edc2004-05-03 20:45:30 +00005658- 2.2.x kernels have the entry point at 0x0000000C,
5659- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005660
wdenk6c59edc2004-05-03 20:45:30 +00005661So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005662
wdenk6c59edc2004-05-03 20:45:30 +00005663 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5664 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005665 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005666 > examples/uImage.TQM850L
5667 Image Name: 2.4.4 kernel for TQM850L
5668 Created: Wed Jul 19 02:34:59 2000
5669 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5670 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5671 Load Address: 0x00000000
5672 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005673
wdenk6c59edc2004-05-03 20:45:30 +00005674To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005675
wdenk6c59edc2004-05-03 20:45:30 +00005676 -> tools/mkimage -l examples/uImage.TQM850L
5677 Image Name: 2.4.4 kernel for TQM850L
5678 Created: Wed Jul 19 02:34:59 2000
5679 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5680 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5681 Load Address: 0x00000000
5682 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk6c59edc2004-05-03 20:45:30 +00005684NOTE: for embedded systems where boot time is critical you can trade
5685speed for memory and install an UNCOMPRESSED image instead: this
5686needs more space in Flash, but boots much faster since it does not
5687need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005688
Stefan Roese88fbf932010-04-15 16:07:28 +02005689 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005690 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5691 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005692 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005693 > examples/uImage.TQM850L-uncompressed
5694 Image Name: 2.4.4 kernel for TQM850L
5695 Created: Wed Jul 19 02:34:59 2000
5696 Image Type: PowerPC Linux Kernel Image (uncompressed)
5697 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5698 Load Address: 0x00000000
5699 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005700
wdenkc6097192002-11-03 00:24:07 +00005701
wdenk6c59edc2004-05-03 20:45:30 +00005702Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5703when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk6c59edc2004-05-03 20:45:30 +00005705 -> tools/mkimage -n 'Simple Ramdisk Image' \
5706 > -A ppc -O linux -T ramdisk -C gzip \
5707 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5708 Image Name: Simple Ramdisk Image
5709 Created: Wed Jan 12 14:01:50 2000
5710 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5711 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5712 Load Address: 0x00000000
5713 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005714
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005715The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5716option performs the converse operation of the mkimage's second form (the "-d"
5717option). Given an image built by mkimage, the dumpimage extracts a "data file"
5718from the image:
5719
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005720 tools/dumpimage -i image -T type -p position data_file
5721 -i ==> extract from the 'image' a specific 'data_file'
5722 -T ==> set image type to 'type'
5723 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005724
wdenkc6097192002-11-03 00:24:07 +00005725
wdenk6c59edc2004-05-03 20:45:30 +00005726Installing a Linux Image:
5727-------------------------
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk6c59edc2004-05-03 20:45:30 +00005729To downloading a U-Boot image over the serial (console) interface,
5730you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk6c59edc2004-05-03 20:45:30 +00005732 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005733
wdenk6c59edc2004-05-03 20:45:30 +00005734The 'objcopy' does not understand the information in the U-Boot
5735image header, so the resulting S-Record file will be relative to
5736address 0x00000000. To load it to a given address, you need to
5737specify the target address as 'offset' parameter with the 'loads'
5738command.
wdenkc6097192002-11-03 00:24:07 +00005739
wdenk6c59edc2004-05-03 20:45:30 +00005740Example: install the image to address 0x40100000 (which on the
5741TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk6c59edc2004-05-03 20:45:30 +00005743 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk6c59edc2004-05-03 20:45:30 +00005745 .......... done
5746 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005747
wdenk6c59edc2004-05-03 20:45:30 +00005748 => loads 40100000
5749 ## Ready for S-Record download ...
5750 ~>examples/image.srec
5751 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5752 ...
5753 15989 15990 15991 15992
5754 [file transfer complete]
5755 [connected]
5756 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005757
wdenkc6097192002-11-03 00:24:07 +00005758
wdenk6c59edc2004-05-03 20:45:30 +00005759You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005760this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005761corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005762
wdenk6c59edc2004-05-03 20:45:30 +00005763 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005764
wdenk6c59edc2004-05-03 20:45:30 +00005765 ## Checking Image at 40100000 ...
5766 Image Name: 2.2.13 for initrd on TQM850L
5767 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5768 Data Size: 335725 Bytes = 327 kB = 0 MB
5769 Load Address: 00000000
5770 Entry Point: 0000000c
5771 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005772
5773
wdenk6c59edc2004-05-03 20:45:30 +00005774Boot Linux:
5775-----------
wdenkc6097192002-11-03 00:24:07 +00005776
wdenk6c59edc2004-05-03 20:45:30 +00005777The "bootm" command is used to boot an application that is stored in
5778memory (RAM or Flash). In case of a Linux kernel image, the contents
5779of the "bootargs" environment variable is passed to the kernel as
5780parameters. You can check and modify this variable using the
5781"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005782
wdenkc6097192002-11-03 00:24:07 +00005783
wdenk6c59edc2004-05-03 20:45:30 +00005784 => printenv bootargs
5785 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787 => 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 +00005788
wdenk6c59edc2004-05-03 20:45:30 +00005789 => printenv bootargs
5790 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 +00005791
wdenk6c59edc2004-05-03 20:45:30 +00005792 => bootm 40020000
5793 ## Booting Linux kernel at 40020000 ...
5794 Image Name: 2.2.13 for NFS on TQM850L
5795 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5796 Data Size: 381681 Bytes = 372 kB = 0 MB
5797 Load Address: 00000000
5798 Entry Point: 0000000c
5799 Verifying Checksum ... OK
5800 Uncompressing Kernel Image ... OK
5801 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
5802 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5803 time_init: decrementer frequency = 187500000/60
5804 Calibrating delay loop... 49.77 BogoMIPS
5805 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5806 ...
wdenkc6097192002-11-03 00:24:07 +00005807
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005808If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005809the memory addresses of both the kernel and the initrd image (PPBCOOT
5810format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005811
wdenk6c59edc2004-05-03 20:45:30 +00005812 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814 ## Checking Image at 40100000 ...
5815 Image Name: 2.2.13 for initrd on TQM850L
5816 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5817 Data Size: 335725 Bytes = 327 kB = 0 MB
5818 Load Address: 00000000
5819 Entry Point: 0000000c
5820 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005821
wdenk6c59edc2004-05-03 20:45:30 +00005822 ## Checking Image at 40200000 ...
5823 Image Name: Simple Ramdisk Image
5824 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5825 Data Size: 566530 Bytes = 553 kB = 0 MB
5826 Load Address: 00000000
5827 Entry Point: 00000000
5828 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005829
wdenk6c59edc2004-05-03 20:45:30 +00005830 => bootm 40100000 40200000
5831 ## Booting Linux kernel at 40100000 ...
5832 Image Name: 2.2.13 for initrd on TQM850L
5833 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5834 Data Size: 335725 Bytes = 327 kB = 0 MB
5835 Load Address: 00000000
5836 Entry Point: 0000000c
5837 Verifying Checksum ... OK
5838 Uncompressing Kernel Image ... OK
5839 ## Loading RAMDisk Image at 40200000 ...
5840 Image Name: Simple Ramdisk Image
5841 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5842 Data Size: 566530 Bytes = 553 kB = 0 MB
5843 Load Address: 00000000
5844 Entry Point: 00000000
5845 Verifying Checksum ... OK
5846 Loading Ramdisk ... OK
5847 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
5848 Boot arguments: root=/dev/ram
5849 time_init: decrementer frequency = 187500000/60
5850 Calibrating delay loop... 49.77 BogoMIPS
5851 ...
5852 RAMDISK: Compressed image found at block 0
5853 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005854
wdenk6c59edc2004-05-03 20:45:30 +00005855 bash#
wdenkc6097192002-11-03 00:24:07 +00005856
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005857Boot Linux and pass a flat device tree:
5858-----------
5859
5860First, U-Boot must be compiled with the appropriate defines. See the section
5861titled "Linux Kernel Interface" above for a more in depth explanation. The
5862following is an example of how to start a kernel and pass an updated
5863flat device tree:
5864
5865=> print oftaddr
5866oftaddr=0x300000
5867=> print oft
5868oft=oftrees/mpc8540ads.dtb
5869=> tftp $oftaddr $oft
5870Speed: 1000, full duplex
5871Using TSEC0 device
5872TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5873Filename 'oftrees/mpc8540ads.dtb'.
5874Load address: 0x300000
5875Loading: #
5876done
5877Bytes transferred = 4106 (100a hex)
5878=> tftp $loadaddr $bootfile
5879Speed: 1000, full duplex
5880Using TSEC0 device
5881TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5882Filename 'uImage'.
5883Load address: 0x200000
5884Loading:############
5885done
5886Bytes transferred = 1029407 (fb51f hex)
5887=> print loadaddr
5888loadaddr=200000
5889=> print oftaddr
5890oftaddr=0x300000
5891=> bootm $loadaddr - $oftaddr
5892## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005893 Image Name: Linux-2.6.17-dirty
5894 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5895 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005896 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005897 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005898 Verifying Checksum ... OK
5899 Uncompressing Kernel Image ... OK
5900Booting using flat device tree at 0x300000
5901Using MPC85xx ADS machine description
5902Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5903[snip]
5904
5905
wdenk6c59edc2004-05-03 20:45:30 +00005906More About U-Boot Image Types:
5907------------------------------
wdenkc6097192002-11-03 00:24:07 +00005908
wdenk6c59edc2004-05-03 20:45:30 +00005909U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005910
wdenk6c59edc2004-05-03 20:45:30 +00005911 "Standalone Programs" are directly runnable in the environment
5912 provided by U-Boot; it is expected that (if they behave
5913 well) you can continue to work in U-Boot after return from
5914 the Standalone Program.
5915 "OS Kernel Images" are usually images of some Embedded OS which
5916 will take over control completely. Usually these programs
5917 will install their own set of exception handlers, device
5918 drivers, set up the MMU, etc. - this means, that you cannot
5919 expect to re-enter U-Boot except by resetting the CPU.
5920 "RAMDisk Images" are more or less just data blocks, and their
5921 parameters (address, size) are passed to an OS kernel that is
5922 being started.
5923 "Multi-File Images" contain several images, typically an OS
5924 (Linux) kernel image and one or more data images like
5925 RAMDisks. This construct is useful for instance when you want
5926 to boot over the network using BOOTP etc., where the boot
5927 server provides just a single image file, but you want to get
5928 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005929
wdenk6c59edc2004-05-03 20:45:30 +00005930 "Multi-File Images" start with a list of image sizes, each
5931 image size (in bytes) specified by an "uint32_t" in network
5932 byte order. This list is terminated by an "(uint32_t)0".
5933 Immediately after the terminating 0 follow the images, one by
5934 one, all aligned on "uint32_t" boundaries (size rounded up to
5935 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005936
wdenk6c59edc2004-05-03 20:45:30 +00005937 "Firmware Images" are binary images containing firmware (like
5938 U-Boot or FPGA images) which usually will be programmed to
5939 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005940
wdenk6c59edc2004-05-03 20:45:30 +00005941 "Script files" are command sequences that will be executed by
5942 U-Boot's command interpreter; this feature is especially
5943 useful when you configure U-Boot to use a real shell (hush)
5944 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005945
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005946Booting the Linux zImage:
5947-------------------------
5948
5949On some platforms, it's possible to boot Linux zImage. This is done
5950using the "bootz" command. The syntax of "bootz" command is the same
5951as the syntax of "bootm" command.
5952
Tom Rini45f46d12013-05-16 11:40:11 -04005953Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005954kernel with raw initrd images. The syntax is slightly different, the
5955address of the initrd must be augmented by it's size, in the following
5956format: "<initrd addres>:<initrd size>".
5957
stroeseb9c17c52003-04-04 15:53:41 +00005958
wdenk6c59edc2004-05-03 20:45:30 +00005959Standalone HOWTO:
5960=================
stroeseb9c17c52003-04-04 15:53:41 +00005961
wdenk6c59edc2004-05-03 20:45:30 +00005962One of the features of U-Boot is that you can dynamically load and
5963run "standalone" applications, which can use some resources of
5964U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005965
wdenk6c59edc2004-05-03 20:45:30 +00005966Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005967
wdenk6c59edc2004-05-03 20:45:30 +00005968"Hello World" Demo:
5969-------------------
wdenkc6097192002-11-03 00:24:07 +00005970
wdenk6c59edc2004-05-03 20:45:30 +00005971'examples/hello_world.c' contains a small "Hello World" Demo
5972application; it is automatically compiled when you build U-Boot.
5973It's configured to run at address 0x00040004, so you can play with it
5974like that:
wdenkc6097192002-11-03 00:24:07 +00005975
wdenk6c59edc2004-05-03 20:45:30 +00005976 => loads
5977 ## Ready for S-Record download ...
5978 ~>examples/hello_world.srec
5979 1 2 3 4 5 6 7 8 9 10 11 ...
5980 [file transfer complete]
5981 [connected]
5982 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005983
wdenk6c59edc2004-05-03 20:45:30 +00005984 => go 40004 Hello World! This is a test.
5985 ## Starting application at 0x00040004 ...
5986 Hello World
5987 argc = 7
5988 argv[0] = "40004"
5989 argv[1] = "Hello"
5990 argv[2] = "World!"
5991 argv[3] = "This"
5992 argv[4] = "is"
5993 argv[5] = "a"
5994 argv[6] = "test."
5995 argv[7] = "<NULL>"
5996 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005997
wdenk6c59edc2004-05-03 20:45:30 +00005998 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005999
wdenk6c59edc2004-05-03 20:45:30 +00006000Another example, which demonstrates how to register a CPM interrupt
6001handler with the U-Boot code, can be found in 'examples/timer.c'.
6002Here, a CPM timer is set up to generate an interrupt every second.
6003The interrupt service routine is trivial, just printing a '.'
6004character, but this is just a demo program. The application can be
6005controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006006
wdenk6c59edc2004-05-03 20:45:30 +00006007 ? - print current values og the CPM Timer registers
6008 b - enable interrupts and start timer
6009 e - stop timer and disable interrupts
6010 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006011
wdenk6c59edc2004-05-03 20:45:30 +00006012 => loads
6013 ## Ready for S-Record download ...
6014 ~>examples/timer.srec
6015 1 2 3 4 5 6 7 8 9 10 11 ...
6016 [file transfer complete]
6017 [connected]
6018 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006019
wdenk6c59edc2004-05-03 20:45:30 +00006020 => go 40004
6021 ## Starting application at 0x00040004 ...
6022 TIMERS=0xfff00980
6023 Using timer 1
6024 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006025
wdenk6c59edc2004-05-03 20:45:30 +00006026Hit 'b':
6027 [q, b, e, ?] Set interval 1000000 us
6028 Enabling timer
6029Hit '?':
6030 [q, b, e, ?] ........
6031 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6032Hit '?':
6033 [q, b, e, ?] .
6034 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6035Hit '?':
6036 [q, b, e, ?] .
6037 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6038Hit '?':
6039 [q, b, e, ?] .
6040 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6041Hit 'e':
6042 [q, b, e, ?] ...Stopping timer
6043Hit 'q':
6044 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006045
wdenkc6097192002-11-03 00:24:07 +00006046
wdenk6c59edc2004-05-03 20:45:30 +00006047Minicom warning:
6048================
wdenkc6097192002-11-03 00:24:07 +00006049
wdenk6c59edc2004-05-03 20:45:30 +00006050Over time, many people have reported problems when trying to use the
6051"minicom" terminal emulation program for serial download. I (wd)
6052consider minicom to be broken, and recommend not to use it. Under
6053Unix, I recommend to use C-Kermit for general purpose use (and
6054especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006055use "cu" for S-Record download ("loads" command). See
6056http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6057for help with kermit.
6058
wdenkc6097192002-11-03 00:24:07 +00006059
wdenk6c59edc2004-05-03 20:45:30 +00006060Nevertheless, if you absolutely want to use it try adding this
6061configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006062
wdenk6c59edc2004-05-03 20:45:30 +00006063 Name Program Name U/D FullScr IO-Red. Multi
6064 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6065 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006066
wdenk8dba0502003-03-31 16:34:49 +00006067
wdenk6c59edc2004-05-03 20:45:30 +00006068NetBSD Notes:
6069=============
wdenkc6097192002-11-03 00:24:07 +00006070
wdenk6c59edc2004-05-03 20:45:30 +00006071Starting at version 0.9.2, U-Boot supports NetBSD both as host
6072(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006073
wdenk6c59edc2004-05-03 20:45:30 +00006074Building requires a cross environment; it is known to work on
6075NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6076need gmake since the Makefiles are not compatible with BSD make).
6077Note that the cross-powerpc package does not install include files;
6078attempting to build U-Boot will fail because <machine/ansi.h> is
6079missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006080
wdenk6c59edc2004-05-03 20:45:30 +00006081 # cd /usr/pkg/cross/powerpc-netbsd/include
6082 # mkdir powerpc
6083 # ln -s powerpc machine
6084 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6085 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006086
wdenk6c59edc2004-05-03 20:45:30 +00006087Native builds *don't* work due to incompatibilities between native
6088and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006089
wdenk6c59edc2004-05-03 20:45:30 +00006090Booting assumes that (the first part of) the image booted is a
6091stage-2 loader which in turn loads and then invokes the kernel
6092proper. Loader sources will eventually appear in the NetBSD source
6093tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006094meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006095
wdenkc6097192002-11-03 00:24:07 +00006096
wdenk6c59edc2004-05-03 20:45:30 +00006097Implementation Internals:
6098=========================
wdenkc6097192002-11-03 00:24:07 +00006099
wdenk6c59edc2004-05-03 20:45:30 +00006100The following is not intended to be a complete description of every
6101implementation detail. However, it should help to understand the
6102inner workings of U-Boot and make it easier to port it to custom
6103hardware.
wdenkc6097192002-11-03 00:24:07 +00006104
wdenkc6097192002-11-03 00:24:07 +00006105
wdenk6c59edc2004-05-03 20:45:30 +00006106Initial Stack, Global Data:
6107---------------------------
wdenkc6097192002-11-03 00:24:07 +00006108
wdenk6c59edc2004-05-03 20:45:30 +00006109The implementation of U-Boot is complicated by the fact that U-Boot
6110starts running out of ROM (flash memory), usually without access to
6111system RAM (because the memory controller is not initialized yet).
6112This means that we don't have writable Data or BSS segments, and BSS
6113is not initialized as zero. To be able to get a C environment working
6114at all, we have to allocate at least a minimal stack. Implementation
6115options for this are defined and restricted by the CPU used: Some CPU
6116models provide on-chip memory (like the IMMR area on MPC8xx and
6117MPC826x processors), on others (parts of) the data cache can be
6118locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006119
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006120 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006121 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006122
wdenk6c59edc2004-05-03 20:45:30 +00006123 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6124 From: "Chris Hallinan" <clh@net1plus.com>
6125 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6126 ...
wdenkc6097192002-11-03 00:24:07 +00006127
wdenk6c59edc2004-05-03 20:45:30 +00006128 Correct me if I'm wrong, folks, but the way I understand it
6129 is this: Using DCACHE as initial RAM for Stack, etc, does not
6130 require any physical RAM backing up the cache. The cleverness
6131 is that the cache is being used as a temporary supply of
6132 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006133 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006134 can see how this works by studying the cache architecture and
6135 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006136
wdenk6c59edc2004-05-03 20:45:30 +00006137 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6138 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006139 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006140 option should work for you. Using CS 4 should be fine if your
6141 board designers haven't used it for something that would
6142 cause you grief during the initial boot! It is frequently not
6143 used.
wdenkc6097192002-11-03 00:24:07 +00006144
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006145 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006146 with your processor/board/system design. The default value
6147 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006148 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006149 than your SDRAM module. If you have a 64MB SDRAM module, set
6150 it above 400_0000. Just make sure your board has no resources
6151 that are supposed to respond to that address! That code in
6152 start.S has been around a while and should work as is when
6153 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006154
wdenk6c59edc2004-05-03 20:45:30 +00006155 -Chris Hallinan
6156 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006157
wdenk6c59edc2004-05-03 20:45:30 +00006158It is essential to remember this, since it has some impact on the C
6159code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006160
wdenk6c59edc2004-05-03 20:45:30 +00006161* Initialized global data (data segment) is read-only. Do not attempt
6162 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006163
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006164* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006165 as zero data - BSS segment) at all - this is undefined, initiali-
6166 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006167
wdenk6c59edc2004-05-03 20:45:30 +00006168* Stack space is very limited. Avoid big data buffers or things like
6169 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006170
wdenk6c59edc2004-05-03 20:45:30 +00006171Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006172normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006173turned out that the implementation of U-Boot can be greatly
6174simplified by making a global data structure (gd_t) available to all
6175functions. We could pass a pointer to this data as argument to _all_
6176functions, but this would bloat the code. Instead we use a feature of
6177the GCC compiler (Global Register Variables) to share the data: we
6178place a pointer (gd) to the global data into a register which we
6179reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006180
wdenk6c59edc2004-05-03 20:45:30 +00006181When choosing a register for such a purpose we are restricted by the
6182relevant (E)ABI specifications for the current architecture, and by
6183GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006184
wdenk6c59edc2004-05-03 20:45:30 +00006185For PowerPC, the following registers have specific use:
6186 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006187 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006188 R3-R4: parameter passing and return values
6189 R5-R10: parameter passing
6190 R13: small data area pointer
6191 R30: GOT pointer
6192 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006193
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006194 (U-Boot also uses R12 as internal GOT pointer. r12
6195 is a volatile register so r12 needs to be reset when
6196 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006197
Wolfgang Denk69c09642008-02-14 22:43:22 +01006198 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006199
wdenk6c59edc2004-05-03 20:45:30 +00006200 Note: on PPC, we could use a static initializer (since the
6201 address of the global data structure is known at compile time),
6202 but it turned out that reserving a register results in somewhat
6203 smaller code - although the code savings are not that big (on
6204 average for all boards 752 bytes for the whole U-Boot image,
6205 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006206
Robin Getz2773d5f2009-08-17 15:23:02 +00006207On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006208 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6209
Robin Getz2773d5f2009-08-17 15:23:02 +00006210 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006211
wdenk6c59edc2004-05-03 20:45:30 +00006212On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006213
wdenk6c59edc2004-05-03 20:45:30 +00006214 R0: function argument word/integer result
6215 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006216 R9: platform specific
6217 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006218 R11: argument (frame) pointer
6219 R12: temporary workspace
6220 R13: stack pointer
6221 R14: link register
6222 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006223
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006224 ==> U-Boot will use R9 to hold a pointer to the global data
6225
6226 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006227
Thomas Chou8fa38582010-05-21 11:08:03 +08006228On Nios II, the ABI is documented here:
6229 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6230
6231 ==> U-Boot will use gp to hold a pointer to the global data
6232
6233 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6234 to access small data sections, so gp is free.
6235
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006236On NDS32, the following registers are used:
6237
6238 R0-R1: argument/return
6239 R2-R5: argument
6240 R15: temporary register for assembler
6241 R16: trampoline register
6242 R28: frame pointer (FP)
6243 R29: global pointer (GP)
6244 R30: link register (LP)
6245 R31: stack pointer (SP)
6246 PC: program counter (PC)
6247
6248 ==> U-Boot will use R10 to hold a pointer to the global data
6249
Wolfgang Denk6405a152006-03-31 18:32:53 +02006250NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6251or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006252
wdenk6c59edc2004-05-03 20:45:30 +00006253Memory Management:
6254------------------
wdenkc6097192002-11-03 00:24:07 +00006255
wdenk6c59edc2004-05-03 20:45:30 +00006256U-Boot runs in system state and uses physical addresses, i.e. the
6257MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006258
wdenk6c59edc2004-05-03 20:45:30 +00006259The available memory is mapped to fixed addresses using the memory
6260controller. In this process, a contiguous block is formed for each
6261memory type (Flash, SDRAM, SRAM), even when it consists of several
6262physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006263
wdenk6c59edc2004-05-03 20:45:30 +00006264U-Boot is installed in the first 128 kB of the first Flash bank (on
6265TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6266booting and sizing and initializing DRAM, the code relocates itself
6267to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006268memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006269configuration setting]. Below that, a structure with global Board
6270Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006271
wdenk6c59edc2004-05-03 20:45:30 +00006272Additionally, some exception handler code is copied to the low 8 kB
6273of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006274
wdenk6c59edc2004-05-03 20:45:30 +00006275So a typical memory configuration with 16 MB of DRAM could look like
6276this:
wdenkc6097192002-11-03 00:24:07 +00006277
wdenk6c59edc2004-05-03 20:45:30 +00006278 0x0000 0000 Exception Vector code
6279 :
6280 0x0000 1FFF
6281 0x0000 2000 Free for Application Use
6282 :
6283 :
wdenkc6097192002-11-03 00:24:07 +00006284
wdenk6c59edc2004-05-03 20:45:30 +00006285 :
6286 :
6287 0x00FB FF20 Monitor Stack (Growing downward)
6288 0x00FB FFAC Board Info Data and permanent copy of global data
6289 0x00FC 0000 Malloc Arena
6290 :
6291 0x00FD FFFF
6292 0x00FE 0000 RAM Copy of Monitor Code
6293 ... eventually: LCD or video framebuffer
6294 ... eventually: pRAM (Protected RAM - unchanged by reset)
6295 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006296
wdenkc6097192002-11-03 00:24:07 +00006297
wdenk6c59edc2004-05-03 20:45:30 +00006298System Initialization:
6299----------------------
wdenkc6097192002-11-03 00:24:07 +00006300
wdenk6c59edc2004-05-03 20:45:30 +00006301In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006302(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006303configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006304To be able to re-map memory U-Boot then jumps to its link address.
6305To be able to implement the initialization code in C, a (small!)
6306initial stack is set up in the internal Dual Ported RAM (in case CPUs
6307which provide such a feature like MPC8xx or MPC8260), or in a locked
6308part of the data cache. After that, U-Boot initializes the CPU core,
6309the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006310
wdenk6c59edc2004-05-03 20:45:30 +00006311Next, all (potentially) available memory banks are mapped using a
6312preliminary mapping. For example, we put them on 512 MB boundaries
6313(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6314on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6315programmed for SDRAM access. Using the temporary configuration, a
6316simple memory test is run that determines the size of the SDRAM
6317banks.
wdenkc6097192002-11-03 00:24:07 +00006318
wdenk6c59edc2004-05-03 20:45:30 +00006319When there is more than one SDRAM bank, and the banks are of
6320different size, the largest is mapped first. For equal size, the first
6321bank (CS2#) is mapped first. The first mapping is always for address
63220x00000000, with any additional banks following immediately to create
6323contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006324
wdenk6c59edc2004-05-03 20:45:30 +00006325Then, the monitor installs itself at the upper end of the SDRAM area
6326and allocates memory for use by malloc() and for the global Board
6327Info data; also, the exception vector code is copied to the low RAM
6328pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006329
wdenk6c59edc2004-05-03 20:45:30 +00006330Only after this relocation will you have a "normal" C environment;
6331until that you are restricted in several ways, mostly because you are
6332running from ROM, and because the code will have to be relocated to a
6333new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006334
wdenkc6097192002-11-03 00:24:07 +00006335
wdenk6c59edc2004-05-03 20:45:30 +00006336U-Boot Porting Guide:
6337----------------------
wdenkc6097192002-11-03 00:24:07 +00006338
wdenk6c59edc2004-05-03 20:45:30 +00006339[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6340list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006341
wdenkc6097192002-11-03 00:24:07 +00006342
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006343int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006344{
6345 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006346
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006347 signal(SIGALRM, no_more_time);
6348 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006349
wdenk6c59edc2004-05-03 20:45:30 +00006350 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006351 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006352 return 0;
6353 }
wdenkc6097192002-11-03 00:24:07 +00006354
wdenk6c59edc2004-05-03 20:45:30 +00006355 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006356
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006357 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006358
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006359 if (clueless)
6360 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006361
wdenk6c59edc2004-05-03 20:45:30 +00006362 while (learning) {
6363 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006364 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6365 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006366 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006367 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006368 }
wdenkc6097192002-11-03 00:24:07 +00006369
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006370 if (available_money > toLocalCurrency ($2500))
6371 Buy a BDI3000;
6372 else
wdenk6c59edc2004-05-03 20:45:30 +00006373 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006374
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006375 if (a similar board exists) { /* hopefully... */
6376 cp -a board/<similar> board/<myboard>
6377 cp include/configs/<similar>.h include/configs/<myboard>.h
6378 } else {
6379 Create your own board support subdirectory;
6380 Create your own board include/configs/<myboard>.h file;
6381 }
6382 Edit new board/<myboard> files
6383 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006384
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006385 while (!accepted) {
6386 while (!running) {
6387 do {
6388 Add / modify source code;
6389 } until (compiles);
6390 Debug;
6391 if (clueless)
6392 email("Hi, I am having problems...");
6393 }
6394 Send patch file to the U-Boot email list;
6395 if (reasonable critiques)
6396 Incorporate improvements from email list code review;
6397 else
6398 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006399 }
wdenkc6097192002-11-03 00:24:07 +00006400
wdenk6c59edc2004-05-03 20:45:30 +00006401 return 0;
6402}
wdenkc6097192002-11-03 00:24:07 +00006403
wdenk6c59edc2004-05-03 20:45:30 +00006404void no_more_time (int sig)
6405{
6406 hire_a_guru();
6407}
wdenkc6097192002-11-03 00:24:07 +00006408
wdenkc6097192002-11-03 00:24:07 +00006409
wdenk6c59edc2004-05-03 20:45:30 +00006410Coding Standards:
6411-----------------
wdenkc6097192002-11-03 00:24:07 +00006412
wdenk6c59edc2004-05-03 20:45:30 +00006413All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006414coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006415"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006416
6417Source files originating from a different project (for example the
6418MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006419reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006420sources.
wdenkc6097192002-11-03 00:24:07 +00006421
Detlev Zundelaa63d482006-09-01 15:39:02 +02006422Please note that U-Boot is implemented in C (and to some small parts in
6423Assembler); no C++ is used, so please do not use C++ style comments (//)
6424in your code.
wdenkad276f22004-01-04 16:28:35 +00006425
wdenk6c59edc2004-05-03 20:45:30 +00006426Please also stick to the following formatting rules:
6427- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006428- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006429- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006430- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006431- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006432
wdenk6c59edc2004-05-03 20:45:30 +00006433Submissions which do not conform to the standards may be returned
6434with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006435
wdenkc6097192002-11-03 00:24:07 +00006436
wdenk6c59edc2004-05-03 20:45:30 +00006437Submitting Patches:
6438-------------------
wdenkc6097192002-11-03 00:24:07 +00006439
wdenk6c59edc2004-05-03 20:45:30 +00006440Since the number of patches for U-Boot is growing, we need to
6441establish some rules. Submissions which do not conform to these rules
6442may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006443
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006444Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006445
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006446Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6447see http://lists.denx.de/mailman/listinfo/u-boot
6448
wdenk6c59edc2004-05-03 20:45:30 +00006449When you send a patch, please include the following information with
6450it:
wdenkc6097192002-11-03 00:24:07 +00006451
wdenk6c59edc2004-05-03 20:45:30 +00006452* For bug fixes: a description of the bug and how your patch fixes
6453 this bug. Please try to include a way of demonstrating that the
6454 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006455
wdenk6c59edc2004-05-03 20:45:30 +00006456* For new features: a description of the feature and your
6457 implementation.
wdenkc6097192002-11-03 00:24:07 +00006458
wdenk6c59edc2004-05-03 20:45:30 +00006459* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006460
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006461* For major contributions, add a MAINTAINERS file with your
6462 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006463
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006464* When you add support for a new board, don't forget to add a
6465 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006466
wdenk6c59edc2004-05-03 20:45:30 +00006467* If your patch adds new configuration options, don't forget to
6468 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006469
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006470* The patch itself. If you are using git (which is *strongly*
6471 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006472 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006473 the U-Boot mailing list, you will avoid most of the common problems
6474 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006475
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006476 If you cannot use git, use "diff -purN OLD NEW". If your version of
6477 diff does not support these options, then get the latest version of
6478 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006479
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006480 The current directory when running this command shall be the parent
6481 directory of the U-Boot source tree (i. e. please make sure that
6482 your patch includes sufficient directory information for the
6483 affected files).
6484
6485 We prefer patches as plain text. MIME attachments are discouraged,
6486 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006487
wdenk6c59edc2004-05-03 20:45:30 +00006488* If one logical set of modifications affects or creates several
6489 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006490
wdenk6c59edc2004-05-03 20:45:30 +00006491* Changesets that contain different, unrelated modifications shall be
6492 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006493
wdenkc6097192002-11-03 00:24:07 +00006494
wdenk6c59edc2004-05-03 20:45:30 +00006495Notes:
wdenkc6097192002-11-03 00:24:07 +00006496
Simon Glassdc27def2016-07-27 20:33:08 -06006497* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006498 source tree and make sure that no errors or warnings are reported
6499 for any of the boards.
6500
6501* Keep your modifications to the necessary minimum: A patch
6502 containing several unrelated changes or arbitrary reformats will be
6503 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006504
wdenk6c59edc2004-05-03 20:45:30 +00006505* If you modify existing code, make sure that your new code does not
6506 add to the memory footprint of the code ;-) Small is beautiful!
6507 When adding new features, these should compile conditionally only
6508 (using #ifdef), and the resulting code with the new feature
6509 disabled must not need more memory than the old code without your
6510 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006511
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006512* Remember that there is a size limit of 100 kB per message on the
6513 u-boot mailing list. Bigger patches will be moderated. If they are
6514 reasonable and not too big, they will be acknowledged. But patches
6515 bigger than the size limit should be avoided.