blob: f5857052091b31a077bc505ee627a7606e0161f0 [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
Lei Wen20014762011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala179b1b22011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood80806962012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800410 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530411
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530412 CONFIG_A008044_WORKAROUND
413 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800414 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530415
Scott Wood80806962012-08-14 10:14:53 +0000416 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418 This is the value to write into CCSR offset 0x18600
419 according to the A004510 workaround.
420
Priyanka Jainc73b9032013-07-02 09:21:04 +0530421 CONFIG_SYS_FSL_DSP_DDR_ADDR
422 This value denotes start offset of DDR memory which is
423 connected exclusively to the DSP cores.
424
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530425 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426 This value denotes start offset of M2 memory
427 which is directly connected to the DSP core.
428
Priyanka Jainc73b9032013-07-02 09:21:04 +0530429 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
430 This value denotes start offset of M3 memory which is directly
431 connected to the DSP core.
432
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530433 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
434 This value denotes start offset of DSP CCSR space.
435
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530436 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
437 Single Source Clock is clocking mode present in some of FSL SoC's.
438 In this mode, a single differential clock is used to supply
439 clocks to the sysclock, ddrclock and usbclock.
440
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530441 CONFIG_SYS_CPC_REINIT_F
442 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800443 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530444
Tang Yuantiana7364af2014-04-17 15:33:46 +0800445 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800446 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800447 supported, core will start to execute uboot when wakes up.
448
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000449- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700450 CONFIG_SYS_GENERIC_GLOBAL_DATA
451 Defines global data is initialized in generic board board_init_f().
452 If this macro is defined, global data is created and cleared in
453 generic board board_init_f(). Without this macro, architecture/board
454 should initialize global data before calling board_init_f().
455
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000456 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
457
458 Defines the endianess of the CPU. Implementation of those
459 values is arch specific.
460
York Sunf0626592013-09-30 09:22:09 -0700461 CONFIG_SYS_FSL_DDR
462 Freescale DDR driver in use. This type of DDR controller is
463 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
464 SoCs.
465
466 CONFIG_SYS_FSL_DDR_ADDR
467 Freescale DDR memory-mapped register base.
468
469 CONFIG_SYS_FSL_DDR_EMU
470 Specify emulator support for DDR. Some DDR features such as
471 deskew training are not available.
472
473 CONFIG_SYS_FSL_DDRC_GEN1
474 Freescale DDR1 controller.
475
476 CONFIG_SYS_FSL_DDRC_GEN2
477 Freescale DDR2 controller.
478
479 CONFIG_SYS_FSL_DDRC_GEN3
480 Freescale DDR3 controller.
481
York Sun2896cb72014-03-27 17:54:47 -0700482 CONFIG_SYS_FSL_DDRC_GEN4
483 Freescale DDR4 controller.
484
York Sun461c9392013-09-30 14:20:51 -0700485 CONFIG_SYS_FSL_DDRC_ARM_GEN3
486 Freescale DDR3 controller for ARM-based SoCs.
487
York Sunf0626592013-09-30 09:22:09 -0700488 CONFIG_SYS_FSL_DDR1
489 Board config to use DDR1. It can be enabled for SoCs with
490 Freescale DDR1 or DDR2 controllers, depending on the board
491 implemetation.
492
493 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400494 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700495 Freescale DDR2 or DDR3 controllers, depending on the board
496 implementation.
497
498 CONFIG_SYS_FSL_DDR3
499 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700500 Freescale DDR3 or DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR3L
503 Board config to use DDR3L. It can be enabled for SoCs with
504 DDR3L controllers.
505
506 CONFIG_SYS_FSL_DDR4
507 Board config to use DDR4. It can be enabled for SoCs with
508 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700509
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530510 CONFIG_SYS_FSL_IFC_BE
511 Defines the IFC controller register space as Big Endian
512
513 CONFIG_SYS_FSL_IFC_LE
514 Defines the IFC controller register space as Little Endian
515
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530516 CONFIG_SYS_FSL_PBL_PBI
517 It enables addition of RCW (Power on reset configuration) in built image.
518 Please refer doc/README.pblimage for more details
519
520 CONFIG_SYS_FSL_PBL_RCW
521 It adds PBI(pre-boot instructions) commands in u-boot build image.
522 PBI commands can be used to configure SoC before it starts the execution.
523 Please refer doc/README.pblimage for more details
524
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530525 CONFIG_SPL_FSL_PBL
526 It adds a target to create boot binary having SPL binary in PBI format
527 concatenated with u-boot binary.
528
York Sun29647ab2014-02-10 13:59:42 -0800529 CONFIG_SYS_FSL_DDR_BE
530 Defines the DDR controller register space as Big Endian
531
532 CONFIG_SYS_FSL_DDR_LE
533 Defines the DDR controller register space as Little Endian
534
York Sun3a0916d2014-02-10 13:59:43 -0800535 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
536 Physical address from the view of DDR controllers. It is the
537 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
538 it could be different for ARM SoCs.
539
York Sunc459ae62014-02-10 13:59:44 -0800540 CONFIG_SYS_FSL_DDR_INTLV_256B
541 DDR controller interleaving on 256-byte. This is a special
542 interleaving mode, handled by Dickens for Freescale layerscape
543 SoCs with ARM core.
544
York Sun79a779b2014-08-01 15:51:00 -0700545 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
546 Number of controllers used as main memory.
547
548 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
549 Number of controllers used for other than main memory.
550
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530551 CONFIG_SYS_FSL_HAS_DP_DDR
552 Defines the SoC has DP-DDR used for DPAA.
553
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530554 CONFIG_SYS_FSL_SEC_BE
555 Defines the SEC controller register space as Big Endian
556
557 CONFIG_SYS_FSL_SEC_LE
558 Defines the SEC controller register space as Little Endian
559
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200560- MIPS CPU options:
561 CONFIG_SYS_INIT_SP_OFFSET
562
563 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
564 pointer. This is needed for the temporary stack before
565 relocation.
566
567 CONFIG_SYS_MIPS_CACHE_MODE
568
569 Cache operation mode for the MIPS CPU.
570 See also arch/mips/include/asm/mipsregs.h.
571 Possible values are:
572 CONF_CM_CACHABLE_NO_WA
573 CONF_CM_CACHABLE_WA
574 CONF_CM_UNCACHED
575 CONF_CM_CACHABLE_NONCOHERENT
576 CONF_CM_CACHABLE_CE
577 CONF_CM_CACHABLE_COW
578 CONF_CM_CACHABLE_CUW
579 CONF_CM_CACHABLE_ACCELERATED
580
581 CONFIG_SYS_XWAY_EBU_BOOTCFG
582
583 Special option for Lantiq XWAY SoCs for booting from NOR flash.
584 See also arch/mips/cpu/mips32/start.S.
585
586 CONFIG_XWAY_SWAP_BYTES
587
588 Enable compilation of tools/xway-swap-bytes needed for Lantiq
589 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
590 be swapped if a flash programmer is used.
591
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000592- ARM options:
593 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
594
595 Select high exception vectors of the ARM core, e.g., do not
596 clear the V bit of the c1 register of CP15.
597
Aneesh Vb8e40802012-03-08 07:20:19 +0000598 CONFIG_SYS_THUMB_BUILD
599
600 Use this flag to build U-Boot using the Thumb instruction
601 set for ARM architectures. Thumb instruction set provides
602 better code density. For ARM architectures that support
603 Thumb2 this flag will result in Thumb2 code generated by
604 GCC.
605
Stephen Warrenc63c3502013-03-04 13:29:40 +0000606 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000607 CONFIG_ARM_ERRATA_742230
608 CONFIG_ARM_ERRATA_743622
609 CONFIG_ARM_ERRATA_751472
Nitin Garg245defa2014-04-02 08:55:02 -0500610 CONFIG_ARM_ERRATA_761320
Ian Campbell363e4242015-09-29 10:27:09 +0100611 CONFIG_ARM_ERRATA_773022
612 CONFIG_ARM_ERRATA_774769
613 CONFIG_ARM_ERRATA_794072
Stephen Warrene9d59c92013-02-26 12:28:27 +0000614
615 If set, the workarounds for these ARM errata are applied early
616 during U-Boot startup. Note that these options force the
617 workarounds to be applied; no CPU-type/version detection
618 exists, unlike the similar options in the Linux kernel. Do not
619 set these options unless they apply!
620
York Sun77a10972015-03-20 19:28:08 -0700621 COUNTER_FREQUENCY
622 Generic timer clock source frequency.
623
624 COUNTER_FREQUENCY_REAL
625 Generic timer clock source frequency if the real clock is
626 different from COUNTER_FREQUENCY, and can only be determined
627 at run time.
628
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500629 NOTE: The following can be machine specific errata. These
630 do have ability to provide rudimentary version and machine
631 specific checks, but expect no product checks.
Nishanth Menon3f445112015-03-09 17:12:01 -0500632 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500633 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500634 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500635 CONFIG_ARM_ERRATA_798870
Nishanth Menon6e2bd2e2015-07-27 16:26:05 -0500636 CONFIG_ARM_ERRATA_801819
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500637
Stephen Warren8d1fb312015-01-19 16:25:52 -0700638- Tegra SoC options:
639 CONFIG_TEGRA_SUPPORT_NON_SECURE
640
641 Support executing U-Boot in non-secure (NS) mode. Certain
642 impossible actions will be skipped if the CPU is in NS mode,
643 such as ARM architectural timer initialization.
644
wdenk9b7f3842003-10-09 20:09:04 +0000645- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000646 CONFIG_CLOCKS_IN_MHZ
647
648 U-Boot stores all clock information in Hz
649 internally. For binary compatibility with older Linux
650 kernels (which expect the clocks passed in the
651 bd_info data to be in MHz) the environment variable
652 "clocks_in_mhz" can be defined so that U-Boot
653 converts clock data to MHZ before passing it to the
654 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000655 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100656 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000657 default environment.
658
wdenk9b7f3842003-10-09 20:09:04 +0000659 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
660
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800661 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000662 expect it to be in bytes, others in MB.
663 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
664
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400665 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200666
667 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400668 passed using flattened device trees (based on open firmware
669 concepts).
670
671 CONFIG_OF_LIBFDT
672 * New libfdt-based support
673 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500674 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400675
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200676 OF_CPU - The proper name of the cpus node (only required for
677 MPC512X and MPC5xxx based boards).
678 OF_SOC - The proper name of the soc node (only required for
679 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200680 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600681 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200682
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200683 boards with QUICC Engines require OF_QE to set UCC MAC
684 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500685
Kumar Gala1e26aa52006-01-11 13:54:17 -0600686 CONFIG_OF_BOARD_SETUP
687
688 Board code has addition modification that it wants to make
689 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000690
Simon Glass6c0be912014-10-23 18:58:54 -0600691 CONFIG_OF_SYSTEM_SETUP
692
693 Other code has addition modification that it wants to make
694 to the flat device tree before handing it off to the kernel.
695 This causes ft_system_setup() to be called before booting
696 the kernel.
697
Heiko Schocherffb293a2009-09-23 07:56:08 +0200698 CONFIG_OF_IDE_FIXUP
699
700 U-Boot can detect if an IDE device is present or not.
701 If not, and this new config option is activated, U-Boot
702 removes the ATA node from the DTS before booting Linux,
703 so the Linux IDE driver does not probe the device and
704 crash. This is needed for buggy hardware (uc101) where
705 no pull down resistor is connected to the signal IDE5V_DD7.
706
Igor Grinberg06890672011-07-14 05:45:07 +0000707 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
708
709 This setting is mandatory for all boards that have only one
710 machine type and must be used to specify the machine type
711 number as it appears in the ARM machine registry
712 (see http://www.arm.linux.org.uk/developer/machines/).
713 Only boards that have multiple machine types supported
714 in a single configuration file and the machine type is
715 runtime discoverable, do not have to use this setting.
716
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100717- vxWorks boot parameters:
718
719 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700720 environments variables: bootdev, bootfile, ipaddr, netmask,
721 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100722 It loads the vxWorks image pointed bootfile.
723
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100724 Note: If a "bootargs" environment is defined, it will overwride
725 the defaults discussed just above.
726
Aneesh V960f5c02011-06-16 23:30:47 +0000727- Cache Configuration:
728 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
729 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
730 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
731
Aneesh V686a0752011-06-16 23:30:51 +0000732- Cache Configuration for ARM:
733 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
734 controller
735 CONFIG_SYS_PL310_BASE - Physical base address of PL310
736 controller register space
737
wdenkda04a8b2004-08-02 23:22:59 +0000738- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200739 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000740
741 Define this if you want support for Amba PrimeCell PL010 UARTs.
742
Andreas Engel0813b122008-09-08 14:30:53 +0200743 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000744
745 Define this if you want support for Amba PrimeCell PL011 UARTs.
746
747 CONFIG_PL011_CLOCK
748
749 If you have Amba PrimeCell PL011 UARTs, set this variable to
750 the clock speed of the UARTs.
751
752 CONFIG_PL01x_PORTS
753
754 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
755 define this to a list of base addresses for each (supported)
756 port. See e.g. include/configs/versatile.h
757
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400758 CONFIG_SERIAL_HW_FLOW_CONTROL
759
760 Define this variable to enable hw flow control in serial driver.
761 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000762
wdenkc6097192002-11-03 00:24:07 +0000763- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000764 Depending on board, define exactly one serial port
765 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
766 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
767 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000768
769 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
770 port routines must be defined elsewhere
771 (i.e. serial_init(), serial_getc(), ...)
772
wdenkc6097192002-11-03 00:24:07 +0000773- Console Baudrate:
774 CONFIG_BAUDRATE - in bps
775 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200776 CONFIG_SYS_BAUDRATE_TABLE, see below.
777 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000778
Heiko Schocher327480a2009-01-30 12:55:38 +0100779- Console Rx buffer length
780 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
781 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100782 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100783 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
784 must be defined, to setup the maximum idle timeout for
785 the SMC.
786
wdenkc6097192002-11-03 00:24:07 +0000787- Autoboot Command:
788 CONFIG_BOOTCOMMAND
789 Only needed when CONFIG_BOOTDELAY is enabled;
790 define a command string that is automatically executed
791 when no character is read on the console interface
792 within "Boot Delay" after reset.
793
794 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000795 This can be used to pass arguments to the bootm
796 command. The value of CONFIG_BOOTARGS goes into the
797 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000798
799 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000800 The value of these goes into the environment as
801 "ramboot" and "nfsboot" respectively, and can be used
802 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200803 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000804
Heiko Schocher040c5c32013-11-04 14:04:59 +0100805- Bootcount:
806 CONFIG_BOOTCOUNT_LIMIT
807 Implements a mechanism for detecting a repeating reboot
808 cycle, see:
809 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
810
811 CONFIG_BOOTCOUNT_ENV
812 If no softreset save registers are found on the hardware
813 "bootcount" is stored in the environment. To prevent a
814 saveenv on all reboots, the environment variable
815 "upgrade_available" is used. If "upgrade_available" is
816 0, "bootcount" is always 0, if "upgrade_available" is
817 1 "bootcount" is incremented in the environment.
818 So the Userspace Applikation must set the "upgrade_available"
819 and "bootcount" variable to 0, if a boot was successfully.
820
wdenkc6097192002-11-03 00:24:07 +0000821- Pre-Boot Commands:
822 CONFIG_PREBOOT
823
824 When this option is #defined, the existence of the
825 environment variable "preboot" will be checked
826 immediately before starting the CONFIG_BOOTDELAY
827 countdown and/or running the auto-boot command resp.
828 entering interactive mode.
829
830 This feature is especially useful when "preboot" is
831 automatically generated or modified. For an example
832 see the LWMON board specific code: here "preboot" is
833 modified when the user holds down a certain
834 combination of keys on the (special) keyboard when
835 booting the systems
836
837- Serial Download Echo Mode:
838 CONFIG_LOADS_ECHO
839 If defined to 1, all characters received during a
840 serial download (using the "loads" command) are
841 echoed back. This might be needed by some terminal
842 emulations (like "cu"), but may as well just take
843 time on others. This setting #define's the initial
844 value of the "loads_echo" environment variable.
845
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500846- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000847 CONFIG_KGDB_BAUDRATE
848 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200849 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000850
851- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500852 Monitor commands can be included or excluded
853 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000854 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500855 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000856
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500857 The default command configuration includes all commands
858 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000859
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100860 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500861 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_BDI bdinfo
863 CONFIG_CMD_BEDBUG * Include BedBug Debugger
864 CONFIG_CMD_BMP * BMP support
865 CONFIG_CMD_BSP * Board specific commands
866 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400867 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500868 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800869 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500870 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500871 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500872 CONFIG_CMD_DATE * support for RTC, date/time...
873 CONFIG_CMD_DHCP * DHCP support
874 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600875 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
876 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
877 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
878 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500879 CONFIG_CMD_DTT * Digital Therm and Thermostat
880 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500881 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500882 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanov37dda1c2016-04-16 17:55:03 +0300883 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500884 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600885 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600886 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500887 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500888 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000889 CONFIG_CMD_EXT2 * ext2 command support
890 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700891 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
892 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100893 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500894 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500895 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000896 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500897 CONFIG_CMD_FLASH flinfo, erase, protect
898 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200899 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000900 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500901 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000902 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000903 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500904 CONFIG_CMD_I2C * I2C serial bus support
905 CONFIG_CMD_IDE * IDE harddisk support
906 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000907 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200908 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500909 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -0600910 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500911 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000912 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500913 CONFIG_CMD_IRQ * irqinfo
914 CONFIG_CMD_ITEST Integer/string test of 2 values
915 CONFIG_CMD_JFFS2 * JFFS2 Support
916 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200917 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000918 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
919 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500920 CONFIG_CMD_LOADB loadb
921 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200922 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400923 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000924 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500925 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000926 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200927 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500928 CONFIG_CMD_MISC Misc functions like sleep etc
929 CONFIG_CMD_MMC * MMC memory mapped support
930 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100931 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500932 CONFIG_CMD_NAND * NAND support
933 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200934 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600935 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000936 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500937 CONFIG_CMD_PCI * pciinfo
938 CONFIG_CMD_PCMCIA * PCMCIA support
939 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
940 host
941 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000942 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500943 CONFIG_CMD_REGINFO * Register dump
944 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000945 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500946 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600947 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500948 CONFIG_CMD_SDRAM * print SDRAM configuration information
949 (requires CONFIG_CMD_I2C)
950 CONFIG_CMD_SETGETDCR Support for DCR Register access
951 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700952 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200953 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400954 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800955 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200956 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500957 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000958 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000959 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000960 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
961 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500962 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500963 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000964 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200965 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200966 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000967
968 EXAMPLE: If you want all functions except of network
969 support you can write:
970
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500971 #include "config_cmd_all.h"
972 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000973
Gerald Van Barend6abef42007-03-31 12:23:51 -0400974 Other Commands:
975 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000976
977 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500978 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000979 what you (and your U-Boot users) are doing. Data
980 cache cannot be enabled on systems like the 8xx or
981 8260 (where accesses to the IMMR region must be
982 uncached), and it cannot be disabled on all other
983 systems where we (mis-) use the data cache to hold an
984 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000985
986
987 XXX - this list needs to get updated!
988
Simon Glassaa34ef22016-03-13 19:07:28 -0600989- Removal of commands
990 If no commands are needed to boot, you can disable
991 CONFIG_CMDLINE to remove them. In this case, the command line
992 will not be available, and when U-Boot wants to execute the
993 boot command (on start-up) it will call board_run_command()
994 instead. This can reduce image size significantly for very
995 simple boot procedures.
996
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000997- Regular expression support:
998 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200999 If this variable is defined, U-Boot is linked against
1000 the SLRE (Super Light Regular Expression) library,
1001 which adds regex support to some commands, as for
1002 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001003
Simon Glass3d686442011-10-15 05:48:20 +00001004- Device tree:
1005 CONFIG_OF_CONTROL
1006 If this variable is defined, U-Boot will use a device tree
1007 to configure its devices, instead of relying on statically
1008 compiled #defines in the board file. This option is
1009 experimental and only available on a few boards. The device
1010 tree is available in the global data as gd->fdt_blob.
1011
Simon Glass5cb34db2011-10-24 19:15:31 +00001012 U-Boot needs to get its device tree from somewhere. This can
1013 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001014
1015 CONFIG_OF_EMBED
1016 If this variable is defined, U-Boot will embed a device tree
1017 binary in its image. This device tree file should be in the
1018 board directory and called <soc>-<board>.dts. The binary file
1019 is then picked up in board_init_f() and made available through
1020 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001021
Simon Glass5cb34db2011-10-24 19:15:31 +00001022 CONFIG_OF_SEPARATE
1023 If this variable is defined, U-Boot will build a device tree
1024 binary. It will be called u-boot.dtb. Architecture-specific
1025 code will locate it at run-time. Generally this works by:
1026
1027 cat u-boot.bin u-boot.dtb >image.bin
1028
1029 and in fact, U-Boot does this for you, creating a file called
1030 u-boot-dtb.bin which is useful in the common case. You can
1031 still use the individual files if you need something more
1032 exotic.
1033
wdenkc6097192002-11-03 00:24:07 +00001034- Watchdog:
1035 CONFIG_WATCHDOG
1036 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001037 support for the SoC. There must be support in the SoC
1038 specific code for a watchdog. For the 8xx and 8260
1039 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1040 register. When supported for a specific SoC is
1041 available, then no further board specific code should
1042 be needed to use it.
1043
1044 CONFIG_HW_WATCHDOG
1045 When using a watchdog circuitry external to the used
1046 SoC, then define this variable and provide board
1047 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001048
Heiko Schocher735326c2015-01-21 08:38:22 +01001049 CONFIG_AT91_HW_WDT_TIMEOUT
1050 specify the timeout in seconds. default 2 seconds.
1051
stroeseb9c17c52003-04-04 15:53:41 +00001052- U-Boot Version:
1053 CONFIG_VERSION_VARIABLE
1054 If this variable is defined, an environment variable
1055 named "ver" is created by U-Boot showing the U-Boot
1056 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001057 Any change to this variable will be reverted at the
1058 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001059
wdenkc6097192002-11-03 00:24:07 +00001060- Real-Time Clock:
1061
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001062 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001063 has to be selected, too. Define exactly one of the
1064 following options:
1065
1066 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1067 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001068 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001069 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001070 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001071 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001072 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001073 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001074 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001075 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001076 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001077 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001078 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1079 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001080
wdenkb9bbd242003-06-30 16:24:52 +00001081 Note that if the RTC uses I2C, then the I2C interface
1082 must also be configured. See I2C Support, below.
1083
Peter Tyser9902e422008-12-17 16:36:21 -06001084- GPIO Support:
1085 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001086
Chris Packham9b383202010-12-19 10:12:13 +00001087 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1088 chip-ngpio pairs that tell the PCA953X driver the number of
1089 pins supported by a particular chip.
1090
Peter Tyser9902e422008-12-17 16:36:21 -06001091 Note that if the GPIO device uses I2C, then the I2C interface
1092 must also be configured. See I2C Support, below.
1093
Simon Glass4dc47ca2014-06-11 23:29:41 -06001094- I/O tracing:
1095 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1096 accesses and can checksum them or write a list of them out
1097 to memory. See the 'iotrace' command for details. This is
1098 useful for testing device drivers since it can confirm that
1099 the driver behaves the same way before and after a code
1100 change. Currently this is supported on sandbox and arm. To
1101 add support for your architecture, add '#include <iotrace.h>'
1102 to the bottom of arch/<arch>/include/asm/io.h and test.
1103
1104 Example output from the 'iotrace stats' command is below.
1105 Note that if the trace buffer is exhausted, the checksum will
1106 still continue to operate.
1107
1108 iotrace is enabled
1109 Start: 10000000 (buffer start address)
1110 Size: 00010000 (buffer size)
1111 Offset: 00000120 (current buffer offset)
1112 Output: 10000120 (start + offset)
1113 Count: 00000018 (number of trace records)
1114 CRC32: 9526fb66 (CRC32 of all trace records)
1115
wdenkc6097192002-11-03 00:24:07 +00001116- Timestamp Support:
1117
wdenk4a5c8a72003-03-06 00:02:04 +00001118 When CONFIG_TIMESTAMP is selected, the timestamp
1119 (date and time) of an image is printed by image
1120 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001121 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001122
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001123- Partition Labels (disklabels) Supported:
1124 Zero or more of the following:
1125 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1126 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1127 Intel architecture, USB sticks, etc.
1128 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1129 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1130 bootloader. Note 2TB partition limit; see
1131 disk/part_efi.c
1132 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001133
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001134 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001135 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001136 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001137
1138- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001139 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1140 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001141
wdenk369d43d2004-03-14 14:09:05 +00001142 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1143 be performed by calling the function
1144 ide_set_reset(int reset)
1145 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001146
1147- ATAPI Support:
1148 CONFIG_ATAPI
1149
1150 Set this to enable ATAPI support.
1151
wdenkf602aa02004-03-13 23:29:43 +00001152- LBA48 Support
1153 CONFIG_LBA48
1154
1155 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001156 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001157 Whithout these , LBA48 support uses 32bit variables and will 'only'
1158 support disks up to 2.1TB.
1159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001160 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001161 When enabled, makes the IDE subsystem use 64bit sector addresses.
1162 Default is 32bit.
1163
wdenkc6097192002-11-03 00:24:07 +00001164- SCSI Support:
1165 At the moment only there is only support for the
1166 SYM53C8XX SCSI controller; define
1167 CONFIG_SCSI_SYM53C8XX to enable it.
1168
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001169 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1170 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1171 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001172 maximum numbers of LUNs, SCSI ID's and target
1173 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001174 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001175
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001176 The environment variable 'scsidevs' is set to the number of
1177 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001178
wdenkc6097192002-11-03 00:24:07 +00001179- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001180 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001181 Support for Intel 8254x/8257x gigabit chips.
1182
1183 CONFIG_E1000_SPI
1184 Utility code for direct access to the SPI bus on Intel 8257x.
1185 This does not do anything useful unless you set at least one
1186 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1187
1188 CONFIG_E1000_SPI_GENERIC
1189 Allow generic access to the SPI bus on the Intel 8257x, for
1190 example with the "sspi" command.
1191
1192 CONFIG_CMD_E1000
1193 Management command for E1000 devices. When used on devices
1194 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001195
wdenkc6097192002-11-03 00:24:07 +00001196 CONFIG_EEPRO100
1197 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001198 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001199 write routine for first time initialisation.
1200
1201 CONFIG_TULIP
1202 Support for Digital 2114x chips.
1203 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1204 modem chip initialisation (KS8761/QS6611).
1205
1206 CONFIG_NATSEMI
1207 Support for National dp83815 chips.
1208
1209 CONFIG_NS8382X
1210 Support for National dp8382[01] gigabit chips.
1211
wdenkaa603362003-05-12 21:50:16 +00001212- NETWORK Support (other):
1213
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001214 CONFIG_DRIVER_AT91EMAC
1215 Support for AT91RM9200 EMAC.
1216
1217 CONFIG_RMII
1218 Define this to use reduced MII inteface
1219
1220 CONFIG_DRIVER_AT91EMAC_QUIET
1221 If this defined, the driver is quiet.
1222 The driver doen't show link status messages.
1223
Rob Herringc9830dc2011-12-15 11:15:49 +00001224 CONFIG_CALXEDA_XGMAC
1225 Support for the Calxeda XGMAC device
1226
Ashok93fb8722012-10-15 06:20:47 +00001227 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001228 Support for SMSC's LAN91C96 chips.
1229
wdenkaa603362003-05-12 21:50:16 +00001230 CONFIG_LAN91C96_USE_32_BIT
1231 Define this to enable 32 bit addressing
1232
Ashok93fb8722012-10-15 06:20:47 +00001233 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001234 Support for SMSC's LAN91C111 chip
1235
1236 CONFIG_SMC91111_BASE
1237 Define this to hold the physical address
1238 of the device (I/O space)
1239
1240 CONFIG_SMC_USE_32_BIT
1241 Define this if data bus is 32 bits
1242
1243 CONFIG_SMC_USE_IOFUNCS
1244 Define this to use i/o functions instead of macros
1245 (some hardware wont work with macros)
1246
Heiko Schocher7d037f72011-11-15 10:00:04 -05001247 CONFIG_DRIVER_TI_EMAC
1248 Support for davinci emac
1249
1250 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1251 Define this if you have more then 3 PHYs.
1252
Macpaul Lin199c6252010-12-21 16:59:46 +08001253 CONFIG_FTGMAC100
1254 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1255
1256 CONFIG_FTGMAC100_EGIGA
1257 Define this to use GE link update with gigabit PHY.
1258 Define this if FTGMAC100 is connected to gigabit PHY.
1259 If your system has 10/100 PHY only, it might not occur
1260 wrong behavior. Because PHY usually return timeout or
1261 useless data when polling gigabit status and gigabit
1262 control registers. This behavior won't affect the
1263 correctnessof 10/100 link speed update.
1264
Mike Rapoportf4761af2009-11-11 10:03:03 +02001265 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001266 Support for SMSC's LAN911x and LAN921x chips
1267
Mike Rapoportf4761af2009-11-11 10:03:03 +02001268 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001269 Define this to hold the physical address
1270 of the device (I/O space)
1271
Mike Rapoportf4761af2009-11-11 10:03:03 +02001272 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001273 Define this if data bus is 32 bits
1274
Mike Rapoportf4761af2009-11-11 10:03:03 +02001275 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001276 Define this if data bus is 16 bits. If your processor
1277 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001278 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001279
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001280 CONFIG_SH_ETHER
1281 Support for Renesas on-chip Ethernet controller
1282
1283 CONFIG_SH_ETHER_USE_PORT
1284 Define the number of ports to be used
1285
1286 CONFIG_SH_ETHER_PHY_ADDR
1287 Define the ETH PHY's address
1288
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001289 CONFIG_SH_ETHER_CACHE_WRITEBACK
1290 If this option is set, the driver enables cache flush.
1291
Heiko Schocher2b387762014-07-18 06:07:19 +02001292- PWM Support:
1293 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001294 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001295
Vadim Bendeburydac69642011-10-17 08:36:14 +00001296- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001297 CONFIG_TPM
1298 Support TPM devices.
1299
Christophe Ricard8759ff82015-10-06 22:54:41 +02001300 CONFIG_TPM_TIS_INFINEON
1301 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001302 per system is supported at this time.
1303
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001304 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1305 Define the burst count bytes upper limit
1306
Christophe Ricard88249232016-01-21 23:27:13 +01001307 CONFIG_TPM_ST33ZP24
1308 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1309
1310 CONFIG_TPM_ST33ZP24_I2C
1311 Support for STMicroelectronics ST33ZP24 I2C devices.
1312 Requires TPM_ST33ZP24 and I2C.
1313
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001314 CONFIG_TPM_ST33ZP24_SPI
1315 Support for STMicroelectronics ST33ZP24 SPI devices.
1316 Requires TPM_ST33ZP24 and SPI.
1317
Dirk Eibach20489092013-06-26 15:55:15 +02001318 CONFIG_TPM_ATMEL_TWI
1319 Support for Atmel TWI TPM device. Requires I2C support.
1320
Che-liang Chiouacea5702013-04-12 11:04:34 +00001321 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001322 Support for generic parallel port TPM devices. Only one device
1323 per system is supported at this time.
1324
1325 CONFIG_TPM_TIS_BASE_ADDRESS
1326 Base address where the generic TPM device is mapped
1327 to. Contemporary x86 systems usually map it at
1328 0xfed40000.
1329
Reinhard Pfau4fece432013-06-26 15:55:13 +02001330 CONFIG_CMD_TPM
1331 Add tpm monitor functions.
1332 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1333 provides monitor access to authorized functions.
1334
1335 CONFIG_TPM
1336 Define this to enable the TPM support library which provides
1337 functional interfaces to some TPM commands.
1338 Requires support for a TPM device.
1339
1340 CONFIG_TPM_AUTH_SESSIONS
1341 Define this to enable authorized functions in the TPM library.
1342 Requires CONFIG_TPM and CONFIG_SHA1.
1343
wdenkc6097192002-11-03 00:24:07 +00001344- USB Support:
1345 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001346 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001347 CONFIG_USB_UHCI to enable it.
1348 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001349 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001350 storage devices.
1351 Note:
1352 Supported are USB Keyboards and USB Floppy drives
1353 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001354 MPC5200 USB requires additional defines:
1355 CONFIG_USB_CLOCK
1356 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001357 CONFIG_PSC3_USB
1358 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001359 CONFIG_USB_CONFIG
1360 for differential drivers: 0x00001000
1361 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001362 for differential drivers on PSC3: 0x00000100
1363 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001364 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001365 May be defined to allow interrupt polling
1366 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001367
Simon Glass5978cdb2012-02-27 10:52:47 +00001368 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1369 txfilltuning field in the EHCI controller on reset.
1370
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001371 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1372 HW module registers.
1373
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001374- USB Device:
1375 Define the below if you wish to use the USB console.
1376 Once firmware is rebuilt from a serial console issue the
1377 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001378 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001379 it has found a new device. The environment variable usbtty
1380 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001381 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001382 Common Device Class Abstract Control Model serial device.
1383 If you select usbtty = gserial you should be able to enumerate
1384 a Linux host by
1385 # modprobe usbserial vendor=0xVendorID product=0xProductID
1386 else if using cdc_acm, simply setting the environment
1387 variable usbtty to be cdc_acm should suffice. The following
1388 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001389
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001390 CONFIG_USB_DEVICE
1391 Define this to build a UDC device
1392
1393 CONFIG_USB_TTY
1394 Define this to have a tty type of device available to
1395 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001396
Vipin KUMARbdb17702012-03-26 15:38:06 +05301397 CONFIG_USBD_HS
1398 Define this to enable the high speed support for usb
1399 device and usbtty. If this feature is enabled, a routine
1400 int is_usbd_high_speed(void)
1401 also needs to be defined by the driver to dynamically poll
1402 whether the enumeration has succeded at high speed or full
1403 speed.
1404
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001405 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001406 Define this if you want stdin, stdout &/or stderr to
1407 be set to usbtty.
1408
1409 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001410 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001411 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001412 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001413
Wolfgang Denke2601822006-06-14 18:14:56 +02001414 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001415 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001416 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001417 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1418 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1419 should pretend to be a Linux device to it's target host.
1420
1421 CONFIG_USBD_MANUFACTURER
1422 Define this string as the name of your company for
1423 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001424
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001425 CONFIG_USBD_PRODUCT_NAME
1426 Define this string as the name of your product
1427 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001428
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001429 CONFIG_USBD_VENDORID
1430 Define this as your assigned Vendor ID from the USB
1431 Implementors Forum. This *must* be a genuine Vendor ID
1432 to avoid polluting the USB namespace.
1433 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001434
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001435 CONFIG_USBD_PRODUCTID
1436 Define this as the unique Product ID
1437 for your device
1438 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001439
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001440- ULPI Layer Support:
1441 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1442 the generic ULPI layer. The generic layer accesses the ULPI PHY
1443 via the platform viewport, so you need both the genric layer and
1444 the viewport enabled. Currently only Chipidea/ARC based
1445 viewport is supported.
1446 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1447 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001448 If your ULPI phy needs a different reference clock than the
1449 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1450 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001451
wdenk7a428cc2003-06-15 22:40:42 +00001452- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001453 The MMC controller on the Intel PXA is supported. To
1454 enable this define CONFIG_MMC. The MMC can be
1455 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001456 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001457 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1458 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001459
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001460 CONFIG_SH_MMCIF
1461 Support for Renesas on-chip MMCIF controller
1462
1463 CONFIG_SH_MMCIF_ADDR
1464 Define the base address of MMCIF registers
1465
1466 CONFIG_SH_MMCIF_CLK
1467 Define the clock frequency for MMCIF
1468
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001469 CONFIG_GENERIC_MMC
1470 Enable the generic MMC driver
1471
1472 CONFIG_SUPPORT_EMMC_BOOT
1473 Enable some additional features of the eMMC boot partitions.
1474
1475 CONFIG_SUPPORT_EMMC_RPMB
1476 Enable the commands for reading, writing and programming the
1477 key for the Replay Protection Memory Block partition in eMMC.
1478
Tom Rini58a8d322013-03-14 05:32:47 +00001479- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001480 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001481 This enables the USB portion of the DFU USB class
1482
1483 CONFIG_CMD_DFU
1484 This enables the command "dfu" which is used to have
1485 U-Boot create a DFU class device via USB. This command
1486 requires that the "dfu_alt_info" environment variable be
1487 set and define the alt settings to expose to the host.
1488
1489 CONFIG_DFU_MMC
1490 This enables support for exposing (e)MMC devices via DFU.
1491
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001492 CONFIG_DFU_NAND
1493 This enables support for exposing NAND devices via DFU.
1494
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301495 CONFIG_DFU_RAM
1496 This enables support for exposing RAM via DFU.
1497 Note: DFU spec refer to non-volatile memory usage, but
1498 allow usages beyond the scope of spec - here RAM usage,
1499 one that would help mostly the developer.
1500
Heiko Schochera2f831e2013-06-12 06:05:51 +02001501 CONFIG_SYS_DFU_DATA_BUF_SIZE
1502 Dfu transfer uses a buffer before writing data to the
1503 raw storage device. Make the size (in bytes) of this buffer
1504 configurable. The size of this buffer is also configurable
1505 through the "dfu_bufsiz" environment variable.
1506
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001507 CONFIG_SYS_DFU_MAX_FILE_SIZE
1508 When updating files rather than the raw storage device,
1509 we use a static buffer to copy the file into and then write
1510 the buffer once we've been given the whole file. Define
1511 this to the maximum filesize (in bytes) for the buffer.
1512 Default is 4 MiB if undefined.
1513
Heiko Schochere1ba1512014-03-18 08:09:56 +01001514 DFU_DEFAULT_POLL_TIMEOUT
1515 Poll timeout [ms], is the timeout a device can send to the
1516 host. The host must wait for this timeout before sending
1517 a subsequent DFU_GET_STATUS request to the device.
1518
1519 DFU_MANIFEST_POLL_TIMEOUT
1520 Poll timeout [ms], which the device sends to the host when
1521 entering dfuMANIFEST state. Host waits this timeout, before
1522 sending again an USB request to the device.
1523
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001524- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001525 CONFIG_USB_FUNCTION_FASTBOOT
1526 This enables the USB part of the fastboot gadget
1527
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001528 CONFIG_CMD_FASTBOOT
1529 This enables the command "fastboot" which enables the Android
1530 fastboot mode for the platform's USB device. Fastboot is a USB
1531 protocol for downloading images, flashing and device control
1532 used on Android devices.
1533 See doc/README.android-fastboot for more information.
1534
1535 CONFIG_ANDROID_BOOT_IMAGE
1536 This enables support for booting images which use the Android
1537 image format header.
1538
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001539 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001540 The fastboot protocol requires a large memory buffer for
1541 downloads. Define this to the starting RAM address to use for
1542 downloaded images.
1543
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001544 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001545 The fastboot protocol requires a large memory buffer for
1546 downloads. This buffer should be as large as possible for a
1547 platform. Define this to the size available RAM for fastboot.
1548
Steve Raebfb9ba42014-08-26 11:47:28 -07001549 CONFIG_FASTBOOT_FLASH
1550 The fastboot protocol includes a "flash" command for writing
1551 the downloaded image to a non-volatile storage device. Define
1552 this to enable the "fastboot flash" command.
1553
1554 CONFIG_FASTBOOT_FLASH_MMC_DEV
1555 The fastboot "flash" command requires additional information
1556 regarding the non-volatile storage device. Define this to
1557 the eMMC device that fastboot should use to store the image.
1558
Steve Rae7d059342014-12-12 15:51:54 -08001559 CONFIG_FASTBOOT_GPT_NAME
1560 The fastboot "flash" command supports writing the downloaded
1561 image to the Protective MBR and the Primary GUID Partition
1562 Table. (Additionally, this downloaded image is post-processed
1563 to generate and write the Backup GUID Partition Table.)
1564 This occurs when the specified "partition name" on the
1565 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001566 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001567
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001568 CONFIG_FASTBOOT_MBR_NAME
1569 The fastboot "flash" command supports writing the downloaded
1570 image to DOS MBR.
1571 This occurs when the "partition name" specified on the
1572 "fastboot flash" command line matches this value.
1573 If not defined the default value "mbr" is used.
1574
wdenkda04a8b2004-08-02 23:22:59 +00001575- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001576 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001577 Define these for a default partition on a NAND device
1578
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001579 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1580 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001581 Define these for a default partition on a NOR device
1582
Donggeun Kim8f814002011-10-24 21:15:28 +00001583- FAT(File Allocation Table) filesystem write function support:
1584 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001585
1586 Define this to enable support for saving memory data as a
1587 file in FAT formatted partition.
1588
1589 This will also enable the command "fatwrite" enabling the
1590 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001591
Gabe Black7f8574c2012-10-12 14:26:11 +00001592CBFS (Coreboot Filesystem) support
1593 CONFIG_CMD_CBFS
1594
1595 Define this to enable support for reading from a Coreboot
1596 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1597 and cbfsload.
1598
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301599- FAT(File Allocation Table) filesystem cluster size:
1600 CONFIG_FS_FAT_MAX_CLUSTSIZE
1601
1602 Define the max cluster size for fat operations else
1603 a default value of 65536 will be defined.
1604
wdenkc6097192002-11-03 00:24:07 +00001605- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001606 See Kconfig help for available keyboard drivers.
1607
1608 CONFIG_KEYBOARD
1609
1610 Define this to enable a custom keyboard support.
1611 This simply calls drv_keyboard_init() which must be
1612 defined in your board-specific files. This option is deprecated
1613 and is only used by novena. For new boards, use driver model
1614 instead.
wdenkc6097192002-11-03 00:24:07 +00001615
1616- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001617 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001618 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001619 SOCs that have a DIU should define this macro to enable DIU
1620 support, and should also define these other macros:
1621
1622 CONFIG_SYS_DIU_ADDR
1623 CONFIG_VIDEO
1624 CONFIG_CMD_BMP
1625 CONFIG_CFB_CONSOLE
1626 CONFIG_VIDEO_SW_CURSOR
1627 CONFIG_VGA_AS_SINGLE_DEVICE
1628 CONFIG_VIDEO_LOGO
1629 CONFIG_VIDEO_BMP_LOGO
1630
Timur Tabi32f709e2011-04-11 14:18:22 -05001631 The DIU driver will look for the 'video-mode' environment
1632 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001633 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001634 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001635
wdenkc6097192002-11-03 00:24:07 +00001636- LCD Support: CONFIG_LCD
1637
1638 Define this to enable LCD support (for output to LCD
1639 display); also select one of the supported displays
1640 by defining one of these:
1641
Stelian Popf6f86652008-05-09 21:57:18 +02001642 CONFIG_ATMEL_LCD:
1643
1644 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1645
wdenkc0d54ae2003-11-25 16:55:19 +00001646 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001647
wdenkc0d54ae2003-11-25 16:55:19 +00001648 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001649
wdenkc0d54ae2003-11-25 16:55:19 +00001650 CONFIG_NEC_NL6448BC20
1651
1652 NEC NL6448BC20-08. 6.5", 640x480.
1653 Active, color, single scan.
1654
1655 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001656
wdenkc0d54ae2003-11-25 16:55:19 +00001657 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001658 Active, color, single scan.
1659
1660 CONFIG_SHARP_16x9
1661
1662 Sharp 320x240. Active, color, single scan.
1663 It isn't 16x9, and I am not sure what it is.
1664
1665 CONFIG_SHARP_LQ64D341
1666
1667 Sharp LQ64D341 display, 640x480.
1668 Active, color, single scan.
1669
1670 CONFIG_HLD1045
1671
1672 HLD1045 display, 640x480.
1673 Active, color, single scan.
1674
1675 CONFIG_OPTREX_BW
1676
1677 Optrex CBL50840-2 NF-FW 99 22 M5
1678 or
1679 Hitachi LMG6912RPFC-00T
1680 or
1681 Hitachi SP14Q002
1682
1683 320x240. Black & white.
1684
1685 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001686 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001687
Simon Glass599a4df2012-10-17 13:24:54 +00001688 CONFIG_LCD_ALIGNMENT
1689
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001690 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001691 defined then the LCD will be aligned to this value instead.
1692 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1693 here, since it is cheaper to change data cache settings on
1694 a per-section basis.
1695
Simon Glassaf3e2802012-10-17 13:24:59 +00001696 CONFIG_CONSOLE_SCROLL_LINES
1697
1698 When the console need to be scrolled, this is the number of
1699 lines to scroll by. It defaults to 1. Increasing this makes
1700 the console jump but can help speed up operation when scrolling
1701 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001702
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001703 CONFIG_LCD_ROTATION
1704
1705 Sometimes, for example if the display is mounted in portrait
1706 mode or even if it's mounted landscape but rotated by 180degree,
1707 we need to rotate our content of the display relative to the
1708 framebuffer, so that user can read the messages which are
1709 printed out.
1710 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1711 initialized with a given rotation from "vl_rot" out of
1712 "vidinfo_t" which is provided by the board specific code.
1713 The value for vl_rot is coded as following (matching to
1714 fbcon=rotate:<n> linux-kernel commandline):
1715 0 = no rotation respectively 0 degree
1716 1 = 90 degree rotation
1717 2 = 180 degree rotation
1718 3 = 270 degree rotation
1719
1720 If CONFIG_LCD_ROTATION is not defined, the console will be
1721 initialized with 0degree rotation.
1722
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001723 CONFIG_LCD_BMP_RLE8
1724
1725 Support drawing of RLE8-compressed bitmaps on the LCD.
1726
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001727 CONFIG_I2C_EDID
1728
1729 Enables an 'i2c edid' command which can read EDID
1730 information over I2C from an attached LCD display.
1731
wdenkeb20ad32003-09-05 23:19:14 +00001732- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001733
wdenk57b2d802003-06-27 21:31:46 +00001734 If this option is set, the environment is checked for
1735 a variable "splashimage". If found, the usual display
1736 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001737 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001738 specified in "splashimage" is loaded instead. The
1739 console is redirected to the "nulldev", too. This
1740 allows for a "silent" boot where a splash screen is
1741 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001742
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001743 CONFIG_SPLASHIMAGE_GUARD
1744
1745 If this option is set, then U-Boot will prevent the environment
1746 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001747 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001748 This option is useful for targets where, due to alignment
1749 restrictions, an improperly aligned BMP image will cause a data
1750 abort. If you think you will not have problems with unaligned
1751 accesses (for example because your toolchain prevents them)
1752 there is no need to set this option.
1753
Matthias Weisser53884182009-07-09 16:07:30 +02001754 CONFIG_SPLASH_SCREEN_ALIGN
1755
1756 If this option is set the splash image can be freely positioned
1757 on the screen. Environment variable "splashpos" specifies the
1758 position as "x,y". If a positive number is given it is used as
1759 number of pixel from left/top. If a negative number is given it
1760 is used as number of pixel from right/bottom. You can also
1761 specify 'm' for centering the image.
1762
1763 Example:
1764 setenv splashpos m,m
1765 => image at center of screen
1766
1767 setenv splashpos 30,20
1768 => image at x = 30 and y = 20
1769
1770 setenv splashpos -10,m
1771 => vertically centered image
1772 at x = dspWidth - bmpWidth - 9
1773
Stefan Roesed9d97742005-09-22 09:04:17 +02001774- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1775
1776 If this option is set, additionally to standard BMP
1777 images, gzipped BMP images can be displayed via the
1778 splashscreen support or the bmp command.
1779
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001780- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1781
1782 If this option is set, 8-bit RLE compressed BMP images
1783 can be displayed via the splashscreen support or the
1784 bmp command.
1785
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001786- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001787 CONFIG_CMD_ZIP
1788
1789 If this option is set, it would use zlib deflate method
1790 to compress the specified memory at its best effort.
1791
wdenk710e3502003-08-29 20:57:53 +00001792- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001793 CONFIG_GZIP
1794
1795 Enabled by default to support gzip compressed images.
1796
wdenk710e3502003-08-29 20:57:53 +00001797 CONFIG_BZIP2
1798
1799 If this option is set, support for bzip2 compressed
1800 images is included. If not, only uncompressed and gzip
1801 compressed images are supported.
1802
wdenk9c53f402003-10-15 23:53:47 +00001803 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001804 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001805 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001806
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001807 CONFIG_LZMA
1808
1809 If this option is set, support for lzma compressed
1810 images is included.
1811
1812 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1813 requires an amount of dynamic memory that is given by the
1814 formula:
1815
1816 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1817
1818 Where lc and lp stand for, respectively, Literal context bits
1819 and Literal pos bits.
1820
1821 This value is upper-bounded by 14MB in the worst case. Anyway,
1822 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1823 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1824 a very small buffer.
1825
1826 Use the lzmainfo tool to determinate the lc and lp values and
1827 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001828 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001829
Kees Cook5b06e642013-08-16 07:59:12 -07001830 CONFIG_LZO
1831
1832 If this option is set, support for LZO compressed images
1833 is included.
1834
wdenk0e2bd9c2004-06-06 21:51:03 +00001835- MII/PHY support:
1836 CONFIG_PHY_ADDR
1837
1838 The address of PHY on MII bus.
1839
1840 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1841
1842 The clock frequency of the MII bus
1843
1844 CONFIG_PHY_GIGE
1845
1846 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001847 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001848
1849 CONFIG_PHY_RESET_DELAY
1850
1851 Some PHY like Intel LXT971A need extra delay after
1852 reset before any MII register access is possible.
1853 For such PHY, set this option to the usec delay
1854 required. (minimum 300usec for LXT971A)
1855
1856 CONFIG_PHY_CMD_DELAY (ppc4xx)
1857
1858 Some PHY like Intel LXT971A need extra delay after
1859 command issued before MII status register can be read
1860
wdenkc6097192002-11-03 00:24:07 +00001861- IP address:
1862 CONFIG_IPADDR
1863
1864 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001865 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001866 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001867 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001868
1869- Server IP address:
1870 CONFIG_SERVERIP
1871
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001872 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001873 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001874 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001875
Robin Getz470a6d42009-07-21 12:15:28 -04001876 CONFIG_KEEP_SERVERADDR
1877
1878 Keeps the server's MAC address, in the env 'serveraddr'
1879 for passing to bootargs (like Linux's netconsole option)
1880
Wolfgang Denk26da2992011-10-26 10:21:22 +00001881- Gateway IP address:
1882 CONFIG_GATEWAYIP
1883
1884 Defines a default value for the IP address of the
1885 default router where packets to other networks are
1886 sent to.
1887 (Environment variable "gatewayip")
1888
1889- Subnet mask:
1890 CONFIG_NETMASK
1891
1892 Defines a default value for the subnet mask (or
1893 routing prefix) which is used to determine if an IP
1894 address belongs to the local subnet or needs to be
1895 forwarded through a router.
1896 (Environment variable "netmask")
1897
David Updegraff7280da72007-06-11 10:41:07 -05001898- Multicast TFTP Mode:
1899 CONFIG_MCAST_TFTP
1900
1901 Defines whether you want to support multicast TFTP as per
1902 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001903 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001904 driver in use must provide a function: mcast() to join/leave a
1905 multicast group.
1906
wdenkc6097192002-11-03 00:24:07 +00001907- BOOTP Recovery Mode:
1908 CONFIG_BOOTP_RANDOM_DELAY
1909
1910 If you have many targets in a network that try to
1911 boot using BOOTP, you may want to avoid that all
1912 systems send out BOOTP requests at precisely the same
1913 moment (which would happen for instance at recovery
1914 from a power failure, when all systems will try to
1915 boot, thus flooding the BOOTP server. Defining
1916 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1917 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001918 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001919
1920 1st BOOTP request: delay 0 ... 1 sec
1921 2nd BOOTP request: delay 0 ... 2 sec
1922 3rd BOOTP request: delay 0 ... 4 sec
1923 4th and following
1924 BOOTP requests: delay 0 ... 8 sec
1925
Thierry Reding8977cda2014-08-19 10:21:24 +02001926 CONFIG_BOOTP_ID_CACHE_SIZE
1927
1928 BOOTP packets are uniquely identified using a 32-bit ID. The
1929 server will copy the ID from client requests to responses and
1930 U-Boot will use this to determine if it is the destination of
1931 an incoming response. Some servers will check that addresses
1932 aren't in use before handing them out (usually using an ARP
1933 ping) and therefore take up to a few hundred milliseconds to
1934 respond. Network congestion may also influence the time it
1935 takes for a response to make it back to the client. If that
1936 time is too long, U-Boot will retransmit requests. In order
1937 to allow earlier responses to still be accepted after these
1938 retransmissions, U-Boot's BOOTP client keeps a small cache of
1939 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1940 cache. The default is to keep IDs for up to four outstanding
1941 requests. Increasing this will allow U-Boot to accept offers
1942 from a BOOTP client in networks with unusually high latency.
1943
stroesee0aadfb2003-08-28 14:17:32 +00001944- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001945 You can fine tune the DHCP functionality by defining
1946 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001947
Jon Loeliger5336a762007-07-09 22:08:34 -05001948 CONFIG_BOOTP_SUBNETMASK
1949 CONFIG_BOOTP_GATEWAY
1950 CONFIG_BOOTP_HOSTNAME
1951 CONFIG_BOOTP_NISDOMAIN
1952 CONFIG_BOOTP_BOOTPATH
1953 CONFIG_BOOTP_BOOTFILESIZE
1954 CONFIG_BOOTP_DNS
1955 CONFIG_BOOTP_DNS2
1956 CONFIG_BOOTP_SEND_HOSTNAME
1957 CONFIG_BOOTP_NTPSERVER
1958 CONFIG_BOOTP_TIMEOFFSET
1959 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001960 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001961
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001962 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1963 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001964
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001965 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1966 after the configured retry count, the call will fail
1967 instead of starting over. This can be used to fail over
1968 to Link-local IP address configuration if the DHCP server
1969 is not available.
1970
stroesee0aadfb2003-08-28 14:17:32 +00001971 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1972 serverip from a DHCP server, it is possible that more
1973 than one DNS serverip is offered to the client.
1974 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1975 serverip will be stored in the additional environment
1976 variable "dnsip2". The first DNS serverip is always
1977 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001978 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001979
1980 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1981 to do a dynamic update of a DNS server. To do this, they
1982 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001983 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001984 of the "hostname" environment variable is passed as
1985 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001986
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001987 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1988
1989 A 32bit value in microseconds for a delay between
1990 receiving a "DHCP Offer" and sending the "DHCP Request".
1991 This fixes a problem with certain DHCP servers that don't
1992 respond 100% of the time to a "DHCP request". E.g. On an
1993 AT91RM9200 processor running at 180MHz, this delay needed
1994 to be *at least* 15,000 usec before a Windows Server 2003
1995 DHCP server would reply 100% of the time. I recommend at
1996 least 50,000 usec to be safe. The alternative is to hope
1997 that one of the retries will be successful but note that
1998 the DHCP timeout and retry process takes a longer than
1999 this delay.
2000
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002001 - Link-local IP address negotiation:
2002 Negotiate with other link-local clients on the local network
2003 for an address that doesn't require explicit configuration.
2004 This is especially useful if a DHCP server cannot be guaranteed
2005 to exist in all environments that the device must operate.
2006
2007 See doc/README.link-local for more information.
2008
wdenk145d2c12004-04-15 21:48:45 +00002009 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002010 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002011
2012 The device id used in CDP trigger frames.
2013
2014 CONFIG_CDP_DEVICE_ID_PREFIX
2015
2016 A two character string which is prefixed to the MAC address
2017 of the device.
2018
2019 CONFIG_CDP_PORT_ID
2020
2021 A printf format string which contains the ascii name of
2022 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002023 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002024
2025 CONFIG_CDP_CAPABILITIES
2026
2027 A 32bit integer which indicates the device capabilities;
2028 0x00000010 for a normal host which does not forwards.
2029
2030 CONFIG_CDP_VERSION
2031
2032 An ascii string containing the version of the software.
2033
2034 CONFIG_CDP_PLATFORM
2035
2036 An ascii string containing the name of the platform.
2037
2038 CONFIG_CDP_TRIGGER
2039
2040 A 32bit integer sent on the trigger.
2041
2042 CONFIG_CDP_POWER_CONSUMPTION
2043
2044 A 16bit integer containing the power consumption of the
2045 device in .1 of milliwatts.
2046
2047 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2048
2049 A byte containing the id of the VLAN.
2050
wdenkc6097192002-11-03 00:24:07 +00002051- Status LED: CONFIG_STATUS_LED
2052
2053 Several configurations allow to display the current
2054 status using a LED. For instance, the LED will blink
2055 fast while running U-Boot code, stop blinking as
2056 soon as a reply to a BOOTP request was received, and
2057 start blinking slow once the Linux kernel is running
2058 (supported by a status LED driver in the Linux
2059 kernel). Defining CONFIG_STATUS_LED enables this
2060 feature in U-Boot.
2061
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002062 Additional options:
2063
2064 CONFIG_GPIO_LED
2065 The status LED can be connected to a GPIO pin.
2066 In such cases, the gpio_led driver can be used as a
2067 status LED backend implementation. Define CONFIG_GPIO_LED
2068 to include the gpio_led driver in the U-Boot binary.
2069
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002070 CONFIG_GPIO_LED_INVERTED_TABLE
2071 Some GPIO connected LEDs may have inverted polarity in which
2072 case the GPIO high value corresponds to LED off state and
2073 GPIO low value corresponds to LED on state.
2074 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2075 with a list of GPIO LEDs that have inverted polarity.
2076
wdenkc6097192002-11-03 00:24:07 +00002077- CAN Support: CONFIG_CAN_DRIVER
2078
2079 Defining CONFIG_CAN_DRIVER enables CAN driver support
2080 on those systems that support this (optional)
2081 feature, like the TQM8xxL modules.
2082
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002083- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002084
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002085 This enable the NEW i2c subsystem, and will allow you to use
2086 i2c commands at the u-boot command line (as long as you set
2087 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2088 based realtime clock chips or other i2c devices. See
2089 common/cmd_i2c.c for a description of the command line
2090 interface.
2091
2092 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002093 - drivers/i2c/soft_i2c.c:
2094 - activate first bus with CONFIG_SYS_I2C_SOFT define
2095 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2096 for defining speed and slave address
2097 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2098 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2099 for defining speed and slave address
2100 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2101 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2102 for defining speed and slave address
2103 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2104 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2105 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002106
Heiko Schocherf2850742012-10-24 13:48:22 +02002107 - drivers/i2c/fsl_i2c.c:
2108 - activate i2c driver with CONFIG_SYS_I2C_FSL
2109 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2110 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2111 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2112 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002113 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002114 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2115 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2116 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2117 second bus.
2118
Simon Glass026fefb2012-10-30 07:28:53 +00002119 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002120 - activate this driver with CONFIG_SYS_I2C_TEGRA
2121 - This driver adds 4 i2c buses with a fix speed from
2122 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002123
Dirk Eibach42b204f2013-04-25 02:40:01 +00002124 - drivers/i2c/ppc4xx_i2c.c
2125 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2126 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2127 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2128
trema49f40a2013-09-21 18:13:35 +02002129 - drivers/i2c/i2c_mxc.c
2130 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002131 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2132 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2133 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2134 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002135 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2136 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2137 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2138 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2139 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2140 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002141 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2142 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002143 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002144 for speed, and 0 for slave.
2145
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002146 - drivers/i2c/rcar_i2c.c:
2147 - activate this driver with CONFIG_SYS_I2C_RCAR
2148 - This driver adds 4 i2c buses
2149
2150 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2151 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2152 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2153 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2154 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2155 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2156 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2157 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2158 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2159
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002160 - drivers/i2c/sh_i2c.c:
2161 - activate this driver with CONFIG_SYS_I2C_SH
2162 - This driver adds from 2 to 5 i2c buses
2163
2164 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2165 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2166 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2167 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2168 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2169 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2170 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2171 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2172 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2173 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002174 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002175
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002176 - drivers/i2c/omap24xx_i2c.c
2177 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2178 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2179 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2180 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2181 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2182 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2183 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2184 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2185 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2186 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2187 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2188
Heiko Schocher465819a2013-11-08 07:30:53 +01002189 - drivers/i2c/zynq_i2c.c
2190 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2191 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2192 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2193
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302194 - drivers/i2c/s3c24x0_i2c.c:
2195 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2196 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2197 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2198 with a fix speed from 100000 and the slave addr 0!
2199
Dirk Eibachb9577432014-07-03 09:28:18 +02002200 - drivers/i2c/ihs_i2c.c
2201 - activate this driver with CONFIG_SYS_I2C_IHS
2202 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2203 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2204 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2205 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2206 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2207 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2208 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2209 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2210 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2211 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2212 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2213 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002214 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2215 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2216 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2217 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2218 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2219 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2220 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2221 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2222 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002223
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002224 additional defines:
2225
2226 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002227 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002228
2229 CONFIG_SYS_I2C_DIRECT_BUS
2230 define this, if you don't use i2c muxes on your hardware.
2231 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2232 omit this define.
2233
2234 CONFIG_SYS_I2C_MAX_HOPS
2235 define how many muxes are maximal consecutively connected
2236 on one i2c bus. If you not use i2c muxes, omit this
2237 define.
2238
2239 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002240 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002241 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2242 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2243 CONFIG_SYS_NUM_I2C_BUSES = 9:
2244
2245 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2246 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2247 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2248 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2249 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2250 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2251 {1, {I2C_NULL_HOP}}, \
2252 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2253 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2254 }
2255
2256 which defines
2257 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002258 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2259 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2260 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2261 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2262 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002263 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002264 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2265 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002266
2267 If you do not have i2c muxes on your board, omit this define.
2268
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002269- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002270
2271 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2272 provides the following compelling advantages:
2273
2274 - more than one i2c adapter is usable
2275 - approved multibus support
2276 - better i2c mux support
2277
2278 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002279
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002280 These enable legacy I2C serial bus commands. Defining
2281 CONFIG_HARD_I2C will include the appropriate I2C driver
2282 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002283
wdenk21136db2003-07-16 21:53:01 +00002284 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002285 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002286 CONFIG_COMMANDS) and communicate with i2c based realtime
2287 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002288 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002289
Ben Warren45657152006-09-07 16:50:54 -04002290 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002291
wdenk21136db2003-07-16 21:53:01 +00002292 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002293 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002294
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002295 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002296 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002297 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002298 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002299
Peter Tysere4d1abc2010-04-12 22:28:21 -05002300 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002301 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002302 and so its address should therefore be cleared to 0 (See,
2303 eg, MPC823e User's Manual p.16-473). So, set
2304 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002305
Eric Millbrandt12990a42009-09-03 08:09:44 -05002306 CONFIG_SYS_I2C_INIT_MPC5XXX
2307
2308 When a board is reset during an i2c bus transfer
2309 chips might think that the current transfer is still
2310 in progress. Reset the slave devices by sending start
2311 commands until the slave device responds.
2312
wdenk21136db2003-07-16 21:53:01 +00002313 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002314
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002315 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002316 then the following macros need to be defined (examples are
2317 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002318
2319 I2C_INIT
2320
wdenkb9bbd242003-06-30 16:24:52 +00002321 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002322 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002323
wdenk544e9732004-02-06 23:19:44 +00002324 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002325
wdenkc6097192002-11-03 00:24:07 +00002326 I2C_PORT
2327
wdenk4a5c8a72003-03-06 00:02:04 +00002328 (Only for MPC8260 CPU). The I/O port to use (the code
2329 assumes both bits are on the same port). Valid values
2330 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002331
2332 I2C_ACTIVE
2333
2334 The code necessary to make the I2C data line active
2335 (driven). If the data line is open collector, this
2336 define can be null.
2337
wdenkb9bbd242003-06-30 16:24:52 +00002338 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2339
wdenkc6097192002-11-03 00:24:07 +00002340 I2C_TRISTATE
2341
2342 The code necessary to make the I2C data line tri-stated
2343 (inactive). If the data line is open collector, this
2344 define can be null.
2345
wdenkb9bbd242003-06-30 16:24:52 +00002346 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2347
wdenkc6097192002-11-03 00:24:07 +00002348 I2C_READ
2349
York Sun4a598092013-04-01 11:29:11 -07002350 Code that returns true if the I2C data line is high,
2351 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002352
wdenkb9bbd242003-06-30 16:24:52 +00002353 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2354
wdenkc6097192002-11-03 00:24:07 +00002355 I2C_SDA(bit)
2356
York Sun4a598092013-04-01 11:29:11 -07002357 If <bit> is true, sets the I2C data line high. If it
2358 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002359
wdenkb9bbd242003-06-30 16:24:52 +00002360 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002361 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002362 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002363
wdenkc6097192002-11-03 00:24:07 +00002364 I2C_SCL(bit)
2365
York Sun4a598092013-04-01 11:29:11 -07002366 If <bit> is true, sets the I2C clock line high. If it
2367 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002368
wdenkb9bbd242003-06-30 16:24:52 +00002369 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002370 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002371 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002372
wdenkc6097192002-11-03 00:24:07 +00002373 I2C_DELAY
2374
2375 This delay is invoked four times per clock cycle so this
2376 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002377 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002378 like:
2379
wdenkb9bbd242003-06-30 16:24:52 +00002380 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002381
Mike Frysingeree12d542010-07-21 13:38:02 -04002382 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2383
2384 If your arch supports the generic GPIO framework (asm/gpio.h),
2385 then you may alternatively define the two GPIOs that are to be
2386 used as SCL / SDA. Any of the previous I2C_xxx macros will
2387 have GPIO-based defaults assigned to them as appropriate.
2388
2389 You should define these to the GPIO value as given directly to
2390 the generic GPIO functions.
2391
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002392 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002393
wdenk57b2d802003-06-27 21:31:46 +00002394 When a board is reset during an i2c bus transfer
2395 chips might think that the current transfer is still
2396 in progress. On some boards it is possible to access
2397 the i2c SCLK line directly, either by using the
2398 processor pin as a GPIO or by having a second pin
2399 connected to the bus. If this option is defined a
2400 custom i2c_init_board() routine in boards/xxx/board.c
2401 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002402
Richard Retanubundf0149c2010-04-12 15:08:17 -04002403 CONFIG_SYS_I2C_BOARD_LATE_INIT
2404
2405 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2406 defined a custom i2c_board_late_init() routine in
2407 boards/xxx/board.c is run AFTER the operations in i2c_init()
2408 is completed. This callpoint can be used to unreset i2c bus
2409 using CPU i2c controller register accesses for CPUs whose i2c
2410 controller provide such a method. It is called at the end of
2411 i2c_init() to allow i2c_init operations to setup the i2c bus
2412 controller on the CPU (e.g. setting bus speed & slave address).
2413
wdenk0e2bd9c2004-06-06 21:51:03 +00002414 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2415
2416 This option enables configuration of bi_iic_fast[] flags
2417 in u-boot bd_info structure based on u-boot environment
2418 variable "i2cfast". (see also i2cfast)
2419
Ben Warren45657152006-09-07 16:50:54 -04002420 CONFIG_I2C_MULTI_BUS
2421
2422 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002423 must have a controller. At any point in time, only one bus is
2424 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002425 Note that bus numbering is zero-based.
2426
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002427 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002428
2429 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002430 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002431 is set, specify a list of bus-device pairs. Otherwise, specify
2432 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002433
2434 e.g.
2435 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002436 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002437
2438 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2439
Wolfgang Denk092ae952011-10-26 10:21:21 +00002440 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002441 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002442
2443 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2444
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002445 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002446
2447 If defined, then this indicates the I2C bus number for DDR SPD.
2448 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2449
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002450 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002451
2452 If defined, then this indicates the I2C bus number for the RTC.
2453 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2454
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002455 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002456
2457 If defined, then this indicates the I2C bus number for the DTT.
2458 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2459
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002460 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002461
2462 If defined, specifies the I2C address of the DTT device.
2463 If not defined, then U-Boot uses predefined value for
2464 specified DTT device.
2465
Andrew Dyer58c41f92008-12-29 17:36:01 -06002466 CONFIG_SOFT_I2C_READ_REPEATED_START
2467
2468 defining this will force the i2c_read() function in
2469 the soft_i2c driver to perform an I2C repeated start
2470 between writing the address pointer and reading the
2471 data. If this define is omitted the default behaviour
2472 of doing a stop-start sequence will be used. Most I2C
2473 devices can use either method, but some require one or
2474 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002475
wdenkc6097192002-11-03 00:24:07 +00002476- SPI Support: CONFIG_SPI
2477
2478 Enables SPI driver (so far only tested with
2479 SPI EEPROM, also an instance works with Crystal A/D and
2480 D/As on the SACSng board)
2481
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002482 CONFIG_SH_SPI
2483
2484 Enables the driver for SPI controller on SuperH. Currently
2485 only SH7757 is supported.
2486
wdenkc6097192002-11-03 00:24:07 +00002487 CONFIG_SOFT_SPI
2488
wdenk4a5c8a72003-03-06 00:02:04 +00002489 Enables a software (bit-bang) SPI driver rather than
2490 using hardware support. This is a general purpose
2491 driver that only requires three general I/O port pins
2492 (two outputs, one input) to function. If this is
2493 defined, the board configuration must define several
2494 SPI configuration items (port pins to use, etc). For
2495 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002496
Ben Warren7efe9272008-01-16 22:37:35 -05002497 CONFIG_HARD_SPI
2498
2499 Enables a hardware SPI driver for general-purpose reads
2500 and writes. As with CONFIG_SOFT_SPI, the board configuration
2501 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002502 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002503 example, see include/configs/mpc8349emds.h.
2504
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002505 CONFIG_MXC_SPI
2506
2507 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002508 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002509
Heiko Schocherb77c8882014-07-14 10:22:11 +02002510 CONFIG_SYS_SPI_MXC_WAIT
2511 Timeout for waiting until spi transfer completed.
2512 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2513
Matthias Fuchsa4400872007-12-27 17:12:34 +01002514- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002515
Matthias Fuchsa4400872007-12-27 17:12:34 +01002516 Enables FPGA subsystem.
2517
2518 CONFIG_FPGA_<vendor>
2519
2520 Enables support for specific chip vendors.
2521 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002522
Matthias Fuchsa4400872007-12-27 17:12:34 +01002523 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002524
Matthias Fuchsa4400872007-12-27 17:12:34 +01002525 Enables support for FPGA family.
2526 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2527
2528 CONFIG_FPGA_COUNT
2529
2530 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002531
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302532 CONFIG_CMD_FPGA_LOADMK
2533
2534 Enable support for fpga loadmk command
2535
Michal Simek64c70982014-05-02 13:43:39 +02002536 CONFIG_CMD_FPGA_LOADP
2537
2538 Enable support for fpga loadp command - load partial bitstream
2539
2540 CONFIG_CMD_FPGA_LOADBP
2541
2542 Enable support for fpga loadbp command - load partial bitstream
2543 (Xilinx only)
2544
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002545 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002546
wdenk57b2d802003-06-27 21:31:46 +00002547 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002548
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002549 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002550
wdenk4a5c8a72003-03-06 00:02:04 +00002551 Enable checks on FPGA configuration interface busy
2552 status by the configuration function. This option
2553 will require a board or device specific function to
2554 be written.
wdenkc6097192002-11-03 00:24:07 +00002555
2556 CONFIG_FPGA_DELAY
2557
2558 If defined, a function that provides delays in the FPGA
2559 configuration driver.
2560
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002561 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002562 Allow Control-C to interrupt FPGA configuration
2563
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002564 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002565
wdenk4a5c8a72003-03-06 00:02:04 +00002566 Check for configuration errors during FPGA bitfile
2567 loading. For example, abort during Virtex II
2568 configuration if the INIT_B line goes low (which
2569 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002570
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002571 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002572
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002573 Maximum time to wait for the INIT_B line to de-assert
2574 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002575 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002576 ms.
wdenkc6097192002-11-03 00:24:07 +00002577
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002578 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002579
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002580 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002581 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002582
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002583 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002584
wdenk4a5c8a72003-03-06 00:02:04 +00002585 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002586 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002587
2588- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002589 CONFIG_BUILD_TARGET
2590
2591 Some SoCs need special image types (e.g. U-Boot binary
2592 with a special header) as build targets. By defining
2593 CONFIG_BUILD_TARGET in the SoC / board header, this
2594 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002595 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002596
wdenkc6097192002-11-03 00:24:07 +00002597 CONFIG_IDENT_STRING
2598
wdenk4a5c8a72003-03-06 00:02:04 +00002599 If defined, this string will be added to the U-Boot
2600 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002601
2602- Vendor Parameter Protection:
2603
wdenk4a5c8a72003-03-06 00:02:04 +00002604 U-Boot considers the values of the environment
2605 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002606 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002607 are set once by the board vendor / manufacturer, and
2608 protects these variables from casual modification by
2609 the user. Once set, these variables are read-only,
2610 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002611 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002612
2613 If CONFIG_ENV_OVERWRITE is #defined in your config
2614 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002615 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002616 these parameters.
2617
Joe Hershberger76f353e2015-05-04 14:55:14 -05002618 Alternatively, if you define _both_ an ethaddr in the
2619 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002620 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002621 which can be changed exactly ONCE by the user. [The
2622 serial# is unaffected by this, i. e. it remains
2623 read-only.]
2624
Joe Hershberger71497d02012-12-11 22:16:31 -06002625 The same can be accomplished in a more flexible way
2626 for any variable by configuring the type of access
2627 to allow for those variables in the ".flags" variable
2628 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2629
wdenkc6097192002-11-03 00:24:07 +00002630- Protected RAM:
2631 CONFIG_PRAM
2632
2633 Define this variable to enable the reservation of
2634 "protected RAM", i. e. RAM which is not overwritten
2635 by U-Boot. Define CONFIG_PRAM to hold the number of
2636 kB you want to reserve for pRAM. You can overwrite
2637 this default value by defining an environment
2638 variable "pram" to the number of kB you want to
2639 reserve. Note that the board info structure will
2640 still show the full amount of RAM. If pRAM is
2641 reserved, a new environment variable "mem" will
2642 automatically be defined to hold the amount of
2643 remaining RAM in a form that can be passed as boot
2644 argument to Linux, for instance like that:
2645
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002646 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002647 saveenv
2648
2649 This way you can tell Linux not to use this memory,
2650 either, which results in a memory region that will
2651 not be affected by reboots.
2652
2653 *WARNING* If your board configuration uses automatic
2654 detection of the RAM size, you must make sure that
2655 this memory test is non-destructive. So far, the
2656 following board configurations are known to be
2657 "pRAM-clean":
2658
Wolfgang Denk90326762012-10-24 02:36:15 +00002659 IVMS8, IVML24, SPD8xx, TQM8xxL,
2660 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002661 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002662
Gabe Blacka2f3a932012-12-02 04:55:18 +00002663- Access to physical memory region (> 4GB)
2664 Some basic support is provided for operations on memory not
2665 normally accessible to U-Boot - e.g. some architectures
2666 support access to more than 4GB of memory on 32-bit
2667 machines using physical address extension or similar.
2668 Define CONFIG_PHYSMEM to access this basic support, which
2669 currently only supports clearing the memory.
2670
wdenkc6097192002-11-03 00:24:07 +00002671- Error Recovery:
2672 CONFIG_PANIC_HANG
2673
2674 Define this variable to stop the system in case of a
2675 fatal error, so that you have to reset it manually.
2676 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002677 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002678 automatically as fast as possible, but it may be
2679 useful during development since you can try to debug
2680 the conditions that lead to the situation.
2681
2682 CONFIG_NET_RETRY_COUNT
2683
wdenk4a5c8a72003-03-06 00:02:04 +00002684 This variable defines the number of retries for
2685 network operations like ARP, RARP, TFTP, or BOOTP
2686 before giving up the operation. If not defined, a
2687 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002688
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002689 CONFIG_ARP_TIMEOUT
2690
2691 Timeout waiting for an ARP reply in milliseconds.
2692
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002693 CONFIG_NFS_TIMEOUT
2694
2695 Timeout in milliseconds used in NFS protocol.
2696 If you encounter "ERROR: Cannot umount" in nfs command,
2697 try longer timeout such as
2698 #define CONFIG_NFS_TIMEOUT 10000UL
2699
wdenkc6097192002-11-03 00:24:07 +00002700- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002701 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002702
2703 Enable auto completion of commands using TAB.
2704
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002705 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002706
2707 This defines the secondary prompt string, which is
2708 printed when the command interpreter needs more input
2709 to complete a command. Usually "> ".
2710
2711 Note:
2712
wdenk57b2d802003-06-27 21:31:46 +00002713 In the current implementation, the local variables
2714 space and global environment variables space are
2715 separated. Local variables are those you define by
2716 simply typing `name=value'. To access a local
2717 variable later on, you have write `$name' or
2718 `${name}'; to execute the contents of a variable
2719 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002720
wdenk4a5c8a72003-03-06 00:02:04 +00002721 Global environment variables are those you use
2722 setenv/printenv to work with. To run a command stored
2723 in such a variable, you need to use the run command,
2724 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002725
2726 To store commands and special characters in a
2727 variable, please use double quotation marks
2728 surrounding the whole text of the variable, instead
2729 of the backslashes before semicolons and special
2730 symbols.
2731
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002732- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002733 CONFIG_CMDLINE_EDITING
2734
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002735 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002736 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002737
Marek Vasut734fb042016-01-27 04:47:55 +01002738- Command Line PS1/PS2 support:
2739 CONFIG_CMDLINE_PS_SUPPORT
2740
2741 Enable support for changing the command prompt string
2742 at run-time. Only static string is supported so far.
2743 The string is obtained from environment variables PS1
2744 and PS2.
2745
wdenkc0aa5c52003-12-06 19:49:23 +00002746- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002747 CONFIG_EXTRA_ENV_SETTINGS
2748
wdenk4a5c8a72003-03-06 00:02:04 +00002749 Define this to contain any number of null terminated
2750 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002751 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002752
wdenk4a5c8a72003-03-06 00:02:04 +00002753 For example, place something like this in your
2754 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002755
2756 #define CONFIG_EXTRA_ENV_SETTINGS \
2757 "myvar1=value1\0" \
2758 "myvar2=value2\0"
2759
wdenk4a5c8a72003-03-06 00:02:04 +00002760 Warning: This method is based on knowledge about the
2761 internal format how the environment is stored by the
2762 U-Boot code. This is NOT an official, exported
2763 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002764 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002765 You better know what you are doing here.
2766
wdenk4a5c8a72003-03-06 00:02:04 +00002767 Note: overly (ab)use of the default environment is
2768 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002769 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002770 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002771
Stephen Warren1465d5f2012-05-22 09:21:54 +00002772 CONFIG_ENV_VARS_UBOOT_CONFIG
2773
2774 Define this in order to add variables describing the
2775 U-Boot build configuration to the default environment.
2776 These will be named arch, cpu, board, vendor, and soc.
2777
2778 Enabling this option will cause the following to be defined:
2779
2780 - CONFIG_SYS_ARCH
2781 - CONFIG_SYS_CPU
2782 - CONFIG_SYS_BOARD
2783 - CONFIG_SYS_VENDOR
2784 - CONFIG_SYS_SOC
2785
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002786 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2787
2788 Define this in order to add variables describing certain
2789 run-time determined information about the hardware to the
2790 environment. These will be named board_name, board_rev.
2791
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002792 CONFIG_DELAY_ENVIRONMENT
2793
2794 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002795 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002796 that so that the environment is not available until
2797 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2798 this is instead controlled by the value of
2799 /config/load-environment.
2800
Chris Packham2216ddb2015-06-19 20:25:59 +12002801- Parallel Flash support:
2802 CONFIG_SYS_NO_FLASH
2803
Bin Meng75574052016-02-05 19:30:11 -08002804 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham2216ddb2015-06-19 20:25:59 +12002805 flash. This option is used to disable support for parallel NOR
2806 flash. This option should be defined if the board does not have
2807 parallel flash.
2808
2809 If this option is not defined one of the generic flash drivers
2810 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2811 selected or the board must provide an implementation of the
2812 flash API (see include/flash.h).
2813
wdenkc0aa5c52003-12-06 19:49:23 +00002814- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002815 CONFIG_HAS_DATAFLASH
2816
wdenk57b2d802003-06-27 21:31:46 +00002817 Defining this option enables DataFlash features and
2818 allows to read/write in Dataflash via the standard
2819 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002820
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002821- Serial Flash support
2822 CONFIG_CMD_SF
2823
2824 Defining this option enables SPI flash commands
2825 'sf probe/read/write/erase/update'.
2826
2827 Usage requires an initial 'probe' to define the serial
2828 flash parameters, followed by read/write/erase/update
2829 commands.
2830
2831 The following defaults may be provided by the platform
2832 to handle the common case when only a single serial
2833 flash is present on the system.
2834
2835 CONFIG_SF_DEFAULT_BUS Bus identifier
2836 CONFIG_SF_DEFAULT_CS Chip-select
2837 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2838 CONFIG_SF_DEFAULT_SPEED in Hz
2839
Simon Glass4b5545e2012-10-08 13:16:02 +00002840 CONFIG_CMD_SF_TEST
2841
2842 Define this option to include a destructive SPI flash
2843 test ('sf test').
2844
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302845 CONFIG_SF_DUAL_FLASH Dual flash memories
2846
2847 Define this option to use dual flash support where two flash
2848 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002849 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302850
wdenkef893942004-02-23 16:11:30 +00002851- SystemACE Support:
2852 CONFIG_SYSTEMACE
2853
2854 Adding this option adds support for Xilinx SystemACE
2855 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002856 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002857 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002858
2859 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002860 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002861
2862 When SystemACE support is added, the "ace" device type
2863 becomes available to the fat commands, i.e. fatls.
2864
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002865- TFTP Fixed UDP Port:
2866 CONFIG_TFTP_PORT
2867
Wolfgang Denk227b5192005-09-24 23:25:46 +02002868 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002869 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002870 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002871 number generator is used.
2872
Wolfgang Denk227b5192005-09-24 23:25:46 +02002873 Also, the environment variable tftpdstp is used to supply
2874 the TFTP UDP destination port value. If tftpdstp isn't
2875 defined, the normal port 69 is used.
2876
2877 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002878 blindly start the TFTP transfer using the pre-configured
2879 target IP address and UDP port. This has the effect of
2880 "punching through" the (Windows XP) firewall, allowing
2881 the remainder of the TFTP transfer to proceed normally.
2882 A better solution is to properly configure the firewall,
2883 but sometimes that is not allowed.
2884
Simon Glass058bb8d2012-12-05 14:46:38 +00002885- Hashing support:
2886 CONFIG_CMD_HASH
2887
2888 This enables a generic 'hash' command which can produce
2889 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2890
2891 CONFIG_HASH_VERIFY
2892
2893 Enable the hash verify command (hash -v). This adds to code
2894 size a little.
2895
gaurav ranaef201592015-02-20 12:51:46 +05302896 CONFIG_SHA1 - This option enables support of hashing using SHA1
2897 algorithm. The hash is calculated in software.
2898 CONFIG_SHA256 - This option enables support of hashing using
2899 SHA256 algorithm. The hash is calculated in software.
2900 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
2901 for SHA1/SHA256 hashing.
2902 This affects the 'hash' command and also the
2903 hash_lookup_algo() function.
2904 CONFIG_SHA_PROG_HW_ACCEL - This option enables
2905 hardware-acceleration for SHA1/SHA256 progressive hashing.
2906 Data can be streamed in a block at a time and the hashing
2907 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00002908
2909 Note: There is also a sha1sum command, which should perhaps
2910 be deprecated in favour of 'hash sha1'.
2911
Robert Winkler765ccf42013-07-24 17:57:06 -07002912- Freescale i.MX specific commands:
2913 CONFIG_CMD_HDMIDETECT
2914 This enables 'hdmidet' command which returns true if an
2915 HDMI monitor is detected. This command is i.MX 6 specific.
2916
2917 CONFIG_CMD_BMODE
2918 This enables the 'bmode' (bootmode) command for forcing
2919 a boot from specific media.
2920
2921 This is useful for forcing the ROM's usb downloader to
2922 activate upon a watchdog reset which is nice when iterating
2923 on U-Boot. Using the reset button or running bmode normal
2924 will set it back to normal. This command currently
2925 supports i.MX53 and i.MX6.
2926
Heiko Schocher443ca402014-01-25 07:27:13 +01002927- bootcount support:
2928 CONFIG_BOOTCOUNT_LIMIT
2929
2930 This enables the bootcounter support, see:
2931 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2932
2933 CONFIG_AT91SAM9XE
2934 enable special bootcounter support on at91sam9xe based boards.
2935 CONFIG_BLACKFIN
2936 enable special bootcounter support on blackfin based boards.
2937 CONFIG_SOC_DA8XX
2938 enable special bootcounter support on da850 based boards.
2939 CONFIG_BOOTCOUNT_RAM
2940 enable support for the bootcounter in RAM
2941 CONFIG_BOOTCOUNT_I2C
2942 enable support for the bootcounter on an i2c (like RTC) device.
2943 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2944 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2945 the bootcounter.
2946 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002947
wdenkc0aa5c52003-12-06 19:49:23 +00002948- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002949 CONFIG_SHOW_BOOT_PROGRESS
2950
wdenk4a5c8a72003-03-06 00:02:04 +00002951 Defining this option allows to add some board-
2952 specific code (calling a user-provided function
2953 "show_boot_progress(int)") that enables you to show
2954 the system's boot progress on some display (for
2955 example, some LED's) on your board. At the moment,
2956 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002957
Simon Glass0fa36a42012-09-28 08:56:37 +00002958
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002959Legacy uImage format:
2960
wdenkc6097192002-11-03 00:24:07 +00002961 Arg Where When
2962 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002963 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002964 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002965 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002966 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002967 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002968 4 common/cmd_bootm.c Image data has correct checksum
2969 -4 common/cmd_bootm.c Image is for unsupported architecture
2970 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002971 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002972 6 common/cmd_bootm.c Image Type check OK
2973 -6 common/cmd_bootm.c gunzip uncompression error
2974 -7 common/cmd_bootm.c Unimplemented compression type
2975 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002976 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002977 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002978
2979 9 common/image.c Start initial ramdisk verification
2980 -10 common/image.c Ramdisk header has bad magic number
2981 -11 common/image.c Ramdisk header has bad checksum
2982 10 common/image.c Ramdisk header is OK
2983 -12 common/image.c Ramdisk data has bad checksum
2984 11 common/image.c Ramdisk data has correct checksum
2985 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002986 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002987 13 common/image.c Start multifile image verification
2988 14 common/image.c No initial ramdisk, no multifile, continue.
2989
Wolfgang Denk092ae952011-10-26 10:21:21 +00002990 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002991
Stefan Roese88fbf932010-04-15 16:07:28 +02002992 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002993 -31 post/post.c POST test failed, detected by post_output_backlog()
2994 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002995
Heiko Schocher633e03a2007-06-22 19:11:54 +02002996 34 common/cmd_doc.c before loading a Image from a DOC device
2997 -35 common/cmd_doc.c Bad usage of "doc" command
2998 35 common/cmd_doc.c correct usage of "doc" command
2999 -36 common/cmd_doc.c No boot device
3000 36 common/cmd_doc.c correct boot device
3001 -37 common/cmd_doc.c Unknown Chip ID on boot device
3002 37 common/cmd_doc.c correct chip ID found, device available
3003 -38 common/cmd_doc.c Read Error on boot device
3004 38 common/cmd_doc.c reading Image header from DOC device OK
3005 -39 common/cmd_doc.c Image header has bad magic number
3006 39 common/cmd_doc.c Image header has correct magic number
3007 -40 common/cmd_doc.c Error reading Image from DOC device
3008 40 common/cmd_doc.c Image header has correct magic number
3009 41 common/cmd_ide.c before loading a Image from a IDE device
3010 -42 common/cmd_ide.c Bad usage of "ide" command
3011 42 common/cmd_ide.c correct usage of "ide" command
3012 -43 common/cmd_ide.c No boot device
3013 43 common/cmd_ide.c boot device found
3014 -44 common/cmd_ide.c Device not available
3015 44 common/cmd_ide.c Device available
3016 -45 common/cmd_ide.c wrong partition selected
3017 45 common/cmd_ide.c partition selected
3018 -46 common/cmd_ide.c Unknown partition table
3019 46 common/cmd_ide.c valid partition table found
3020 -47 common/cmd_ide.c Invalid partition type
3021 47 common/cmd_ide.c correct partition type
3022 -48 common/cmd_ide.c Error reading Image Header on boot device
3023 48 common/cmd_ide.c reading Image Header from IDE device OK
3024 -49 common/cmd_ide.c Image header has bad magic number
3025 49 common/cmd_ide.c Image header has correct magic number
3026 -50 common/cmd_ide.c Image header has bad checksum
3027 50 common/cmd_ide.c Image header has correct checksum
3028 -51 common/cmd_ide.c Error reading Image from IDE device
3029 51 common/cmd_ide.c reading Image from IDE device OK
3030 52 common/cmd_nand.c before loading a Image from a NAND device
3031 -53 common/cmd_nand.c Bad usage of "nand" command
3032 53 common/cmd_nand.c correct usage of "nand" command
3033 -54 common/cmd_nand.c No boot device
3034 54 common/cmd_nand.c boot device found
3035 -55 common/cmd_nand.c Unknown Chip ID on boot device
3036 55 common/cmd_nand.c correct chip ID found, device available
3037 -56 common/cmd_nand.c Error reading Image Header on boot device
3038 56 common/cmd_nand.c reading Image Header from NAND device OK
3039 -57 common/cmd_nand.c Image header has bad magic number
3040 57 common/cmd_nand.c Image header has correct magic number
3041 -58 common/cmd_nand.c Error reading Image from NAND device
3042 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003043
Heiko Schocher633e03a2007-06-22 19:11:54 +02003044 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003045
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003046 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003047 -64 net/eth.c no Ethernet found.
3048 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003049
Heiko Schocher633e03a2007-06-22 19:11:54 +02003050 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003051 80 common/cmd_net.c before calling net_loop()
3052 -81 common/cmd_net.c some error in net_loop() occurred
3053 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003054 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3055 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003056 83 common/cmd_net.c running "source" command
3057 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003058 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003059
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003060FIT uImage format:
3061
3062 Arg Where When
3063 100 common/cmd_bootm.c Kernel FIT Image has correct format
3064 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3065 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3066 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3067 102 common/cmd_bootm.c Kernel unit name specified
3068 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003069 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003070 104 common/cmd_bootm.c Got kernel subimage node offset
3071 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3072 105 common/cmd_bootm.c Kernel subimage hash verification OK
3073 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3074 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003075 -106 common/cmd_bootm.c Kernel subimage has wrong type
3076 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003077 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3078 108 common/cmd_bootm.c Got kernel subimage data/size
3079 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3080 -109 common/cmd_bootm.c Can't get kernel subimage type
3081 -110 common/cmd_bootm.c Can't get kernel subimage comp
3082 -111 common/cmd_bootm.c Can't get kernel subimage os
3083 -112 common/cmd_bootm.c Can't get kernel subimage load address
3084 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3085
3086 120 common/image.c Start initial ramdisk verification
3087 -120 common/image.c Ramdisk FIT image has incorrect format
3088 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003089 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003090 -122 common/image.c Can't get configuration for ramdisk subimage
3091 123 common/image.c Ramdisk unit name specified
3092 -124 common/image.c Can't get ramdisk subimage node offset
3093 125 common/image.c Got ramdisk subimage node offset
3094 -125 common/image.c Ramdisk subimage hash verification failed
3095 126 common/image.c Ramdisk subimage hash verification OK
3096 -126 common/image.c Ramdisk subimage for unsupported architecture
3097 127 common/image.c Architecture check OK
3098 -127 common/image.c Can't get ramdisk subimage data/size
3099 128 common/image.c Got ramdisk subimage data/size
3100 129 common/image.c Can't get ramdisk load address
3101 -129 common/image.c Got ramdisk load address
3102
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003103 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003104 131 common/cmd_doc.c FIT image format OK
3105
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003106 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003107 141 common/cmd_ide.c FIT image format OK
3108
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003109 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003110 151 common/cmd_nand.c FIT image format OK
3111
Heiko Schocher515eb122014-05-28 11:33:33 +02003112- legacy image format:
3113 CONFIG_IMAGE_FORMAT_LEGACY
3114 enables the legacy image format support in U-Boot.
3115
3116 Default:
3117 enabled if CONFIG_FIT_SIGNATURE is not defined.
3118
3119 CONFIG_DISABLE_IMAGE_LEGACY
3120 disable the legacy image format
3121
3122 This define is introduced, as the legacy image format is
3123 enabled per default for backward compatibility.
3124
Gabe Blackd572e162012-10-25 16:31:10 +00003125- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003126 CONFIG_FIT_DISABLE_SHA256
3127 Supporting SHA256 hashes has quite an impact on binary size.
3128 For constrained systems sha256 hash support can be disabled
3129 with this option.
3130
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003131 TODO(sjg@chromium.org): Adjust this option to be positive,
3132 and move it to Kconfig
3133
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003134- Standalone program support:
3135 CONFIG_STANDALONE_LOAD_ADDR
3136
Wolfgang Denk23f78482011-10-09 21:06:34 +02003137 This option defines a board specific value for the
3138 address where standalone program gets loaded, thus
3139 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003140 settings.
3141
3142- Frame Buffer Address:
3143 CONFIG_FB_ADDR
3144
3145 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003146 address for frame buffer. This is typically the case
3147 when using a graphics controller has separate video
3148 memory. U-Boot will then place the frame buffer at
3149 the given address instead of dynamically reserving it
3150 in system RAM by calling lcd_setmem(), which grabs
3151 the memory for the frame buffer depending on the
3152 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003153
3154 Please see board_init_f function.
3155
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003156- Automatic software updates via TFTP server
3157 CONFIG_UPDATE_TFTP
3158 CONFIG_UPDATE_TFTP_CNT_MAX
3159 CONFIG_UPDATE_TFTP_MSEC_MAX
3160
3161 These options enable and control the auto-update feature;
3162 for a more detailed description refer to doc/README.update.
3163
3164- MTD Support (mtdparts command, UBI support)
3165 CONFIG_MTD_DEVICE
3166
3167 Adds the MTD device infrastructure from the Linux kernel.
3168 Needed for mtdparts command support.
3169
3170 CONFIG_MTD_PARTITIONS
3171
3172 Adds the MTD partitioning infrastructure from the Linux
3173 kernel. Needed for UBI support.
3174
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003175- UBI support
3176 CONFIG_CMD_UBI
3177
3178 Adds commands for interacting with MTD partitions formatted
3179 with the UBI flash translation layer
3180
3181 Requires also defining CONFIG_RBTREE
3182
Joe Hershberger47550fc2013-04-08 10:32:49 +00003183 CONFIG_UBI_SILENCE_MSG
3184
3185 Make the verbose messages from UBI stop printing. This leaves
3186 warnings and errors enabled.
3187
Heiko Schocherf5895d12014-06-24 10:10:04 +02003188
3189 CONFIG_MTD_UBI_WL_THRESHOLD
3190 This parameter defines the maximum difference between the highest
3191 erase counter value and the lowest erase counter value of eraseblocks
3192 of UBI devices. When this threshold is exceeded, UBI starts performing
3193 wear leveling by means of moving data from eraseblock with low erase
3194 counter to eraseblocks with high erase counter.
3195
3196 The default value should be OK for SLC NAND flashes, NOR flashes and
3197 other flashes which have eraseblock life-cycle 100000 or more.
3198 However, in case of MLC NAND flashes which typically have eraseblock
3199 life-cycle less than 10000, the threshold should be lessened (e.g.,
3200 to 128 or 256, although it does not have to be power of 2).
3201
3202 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003203
Heiko Schocherf5895d12014-06-24 10:10:04 +02003204 CONFIG_MTD_UBI_BEB_LIMIT
3205 This option specifies the maximum bad physical eraseblocks UBI
3206 expects on the MTD device (per 1024 eraseblocks). If the
3207 underlying flash does not admit of bad eraseblocks (e.g. NOR
3208 flash), this value is ignored.
3209
3210 NAND datasheets often specify the minimum and maximum NVM
3211 (Number of Valid Blocks) for the flashes' endurance lifetime.
3212 The maximum expected bad eraseblocks per 1024 eraseblocks
3213 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3214 which gives 20 for most NANDs (MaxNVB is basically the total
3215 count of eraseblocks on the chip).
3216
3217 To put it differently, if this value is 20, UBI will try to
3218 reserve about 1.9% of physical eraseblocks for bad blocks
3219 handling. And that will be 1.9% of eraseblocks on the entire
3220 NAND chip, not just the MTD partition UBI attaches. This means
3221 that if you have, say, a NAND flash chip admits maximum 40 bad
3222 eraseblocks, and it is split on two MTD partitions of the same
3223 size, UBI will reserve 40 eraseblocks when attaching a
3224 partition.
3225
3226 default: 20
3227
3228 CONFIG_MTD_UBI_FASTMAP
3229 Fastmap is a mechanism which allows attaching an UBI device
3230 in nearly constant time. Instead of scanning the whole MTD device it
3231 only has to locate a checkpoint (called fastmap) on the device.
3232 The on-flash fastmap contains all information needed to attach
3233 the device. Using fastmap makes only sense on large devices where
3234 attaching by scanning takes long. UBI will not automatically install
3235 a fastmap on old images, but you can set the UBI parameter
3236 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3237 that fastmap-enabled images are still usable with UBI implementations
3238 without fastmap support. On typical flash devices the whole fastmap
3239 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3240
3241 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3242 Set this parameter to enable fastmap automatically on images
3243 without a fastmap.
3244 default: 0
3245
Heiko Schocher94b66de2015-10-22 06:19:21 +02003246 CONFIG_MTD_UBI_FM_DEBUG
3247 Enable UBI fastmap debug
3248 default: 0
3249
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003250- UBIFS support
3251 CONFIG_CMD_UBIFS
3252
3253 Adds commands for interacting with UBI volumes formatted as
3254 UBIFS. UBIFS is read-only in u-boot.
3255
3256 Requires UBI support as well as CONFIG_LZO
3257
Joe Hershberger47550fc2013-04-08 10:32:49 +00003258 CONFIG_UBIFS_SILENCE_MSG
3259
3260 Make the verbose messages from UBIFS stop printing. This leaves
3261 warnings and errors enabled.
3262
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003263- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003264 CONFIG_SPL
3265 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003266
Tom Rini36853852012-02-14 07:29:40 +00003267 CONFIG_SPL_LDSCRIPT
3268 LDSCRIPT for linking the SPL binary.
3269
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003270 CONFIG_SPL_MAX_FOOTPRINT
3271 Maximum size in memory allocated to the SPL, BSS included.
3272 When defined, the linker checks that the actual memory
3273 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003274 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003275 must not be both defined at the same time.
3276
Tom Rini36853852012-02-14 07:29:40 +00003277 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003278 Maximum size of the SPL image (text, data, rodata, and
3279 linker lists sections), BSS excluded.
3280 When defined, the linker checks that the actual size does
3281 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003282
Wolfgang Denk825223d2011-09-11 21:24:09 +02003283 CONFIG_SPL_TEXT_BASE
3284 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003285
Scott Woodc4f0d002012-09-20 19:05:12 -05003286 CONFIG_SPL_RELOC_TEXT_BASE
3287 Address to relocate to. If unspecified, this is equal to
3288 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3289
Tom Rini36853852012-02-14 07:29:40 +00003290 CONFIG_SPL_BSS_START_ADDR
3291 Link address for the BSS within the SPL binary.
3292
3293 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003294 Maximum size in memory allocated to the SPL BSS.
3295 When defined, the linker checks that the actual memory used
3296 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003297 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003298 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003299
3300 CONFIG_SPL_STACK
3301 Adress of the start of the stack SPL will use
3302
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003303 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3304 When defined, SPL will panic() if the image it has
3305 loaded does not have a signature.
3306 Defining this is useful when code which loads images
3307 in SPL cannot guarantee that absolutely all read errors
3308 will be caught.
3309 An example is the LPC32XX MLC NAND driver, which will
3310 consider that a completely unreadable NAND block is bad,
3311 and thus should be skipped silently.
3312
Marek Vasutbf541b22016-04-29 00:44:55 +02003313 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3314 When defined, SPL will proceed to another boot method
3315 if the image it has loaded does not have a signature.
3316
Scott Woodc4f0d002012-09-20 19:05:12 -05003317 CONFIG_SPL_RELOC_STACK
3318 Adress of the start of the stack SPL will use after
3319 relocation. If unspecified, this is equal to
3320 CONFIG_SPL_STACK.
3321
Tom Rini36853852012-02-14 07:29:40 +00003322 CONFIG_SYS_SPL_MALLOC_START
3323 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003324 When this option is set the full malloc is used in SPL and
3325 it is set up by spl_init() and before that, the simple malloc()
3326 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003327
3328 CONFIG_SYS_SPL_MALLOC_SIZE
3329 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003330
Tom Rini28591df2012-08-13 12:03:19 -07003331 CONFIG_SPL_FRAMEWORK
3332 Enable the SPL framework under common/. This framework
3333 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3334 NAND loading of the Linux Kernel.
3335
Tom Rinic2b76002014-03-28 12:03:39 -04003336 CONFIG_SPL_OS_BOOT
3337 Enable booting directly to an OS from SPL.
3338 See also: doc/README.falcon
3339
Tom Rinife3b0c72012-08-13 11:37:56 -07003340 CONFIG_SPL_DISPLAY_PRINT
3341 For ARM, enable an optional function to print more information
3342 about the running system.
3343
Scott Wood7c810902012-09-20 16:35:21 -05003344 CONFIG_SPL_INIT_MINIMAL
3345 Arch init code should be built for a very small image
3346
Tom Rini36853852012-02-14 07:29:40 +00003347 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3348 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003349 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003350 when the MMC is being used in raw mode.
3351
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003352 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3353 Partition on the MMC to load U-Boot from when the MMC is being
3354 used in raw mode
3355
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003356 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3357 Sector to load kernel uImage from when MMC is being
3358 used in raw mode (for Falcon mode)
3359
3360 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3361 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3362 Sector and number of sectors to load kernel argument
3363 parameters from when MMC is being used in raw mode
3364 (for falcon mode)
3365
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003366 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3367 Partition on the MMC to load U-Boot from when the MMC is being
3368 used in fs mode
3369
Guillaume GARDET5065b712014-10-15 17:53:13 +02003370 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3371 Filename to read to load U-Boot when reading from filesystem
3372
3373 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003374 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003375 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003376
Guillaume GARDET5065b712014-10-15 17:53:13 +02003377 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003378 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003379 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003380
Scott Wood2b36fbb2012-12-06 13:33:17 +00003381 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3382 Set this for NAND SPL on PPC mpc83xx targets, so that
3383 start.S waits for the rest of the SPL to load before
3384 continuing (the hardware starts execution after just
3385 loading the first page rather than the full 4K).
3386
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303387 CONFIG_SPL_SKIP_RELOCATE
3388 Avoid SPL relocation
3389
Scott Woodc352a0c2012-09-20 19:09:07 -05003390 CONFIG_SPL_NAND_BASE
3391 Include nand_base.c in the SPL. Requires
3392 CONFIG_SPL_NAND_DRIVERS.
3393
3394 CONFIG_SPL_NAND_DRIVERS
3395 SPL uses normal NAND drivers, not minimal drivers.
3396
3397 CONFIG_SPL_NAND_ECC
3398 Include standard software ECC in the SPL
3399
Tom Rini36853852012-02-14 07:29:40 +00003400 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003401 Support for NAND boot using simple NAND drivers that
3402 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003403
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003404 CONFIG_SPL_UBI
3405 Support for a lightweight UBI (fastmap) scanner and
3406 loader
3407
Heiko Schochercf000272014-10-31 08:31:00 +01003408 CONFIG_SPL_NAND_RAW_ONLY
3409 Support to boot only raw u-boot.bin images. Use this only
3410 if you need to save space.
3411
Ying Zhangdfb2b152013-08-16 15:16:12 +08003412 CONFIG_SPL_COMMON_INIT_DDR
3413 Set for common ddr init with serial presence detect in
3414 SPL binary.
3415
Tom Rini36853852012-02-14 07:29:40 +00003416 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3417 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3418 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3419 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3420 CONFIG_SYS_NAND_ECCBYTES
3421 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003422 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003423
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303424 CONFIG_SPL_NAND_BOOT
3425 Add support NAND boot
3426
Tom Rini36853852012-02-14 07:29:40 +00003427 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003428 Location in NAND to read U-Boot from
3429
3430 CONFIG_SYS_NAND_U_BOOT_DST
3431 Location in memory to load U-Boot to
3432
3433 CONFIG_SYS_NAND_U_BOOT_SIZE
3434 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003435
3436 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003437 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003438
3439 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3440 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003441 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003442
3443 CONFIG_SPL_OMAP3_ID_NAND
3444 Support for an OMAP3-specific set of functions to return the
3445 ID and MFR of the first attached NAND chip, if present.
3446
Pavel Machekde997252012-08-30 22:42:11 +02003447 CONFIG_SPL_RAM_DEVICE
3448 Support for running image already present in ram, in SPL binary
3449
Scott Woodeb7bd972012-12-06 13:33:16 +00003450 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003451 Image offset to which the SPL should be padded before appending
3452 the SPL payload. By default, this is defined as
3453 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3454 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3455 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003456
Scott Woodf147eb72012-09-21 16:27:32 -05003457 CONFIG_SPL_TARGET
3458 Final target image containing SPL and payload. Some SPLs
3459 use an arch-specific makefile fragment instead, for
3460 example if more than one image needs to be produced.
3461
Simon Glass82d94532013-05-08 08:05:59 +00003462 CONFIG_FIT_SPL_PRINT
3463 Printing information about a FIT image adds quite a bit of
3464 code to SPL. So this is normally disabled in SPL. Use this
3465 option to re-enable it. This will affect the output of the
3466 bootm command when booting a FIT image.
3467
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003468- TPL framework
3469 CONFIG_TPL
3470 Enable building of TPL globally.
3471
3472 CONFIG_TPL_PAD_TO
3473 Image offset to which the TPL should be padded before appending
3474 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003475 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3476 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3477 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003478
wdenkc0aa5c52003-12-06 19:49:23 +00003479- Interrupt support (PPC):
3480
wdenk1ebf41e2004-01-02 14:00:00 +00003481 There are common interrupt_init() and timer_interrupt()
3482 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003483 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003484 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003485 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003486 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003487 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003488 specific handling. If board has watchdog / status_led
3489 / other_activity_monitor it works automatically from
3490 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003491
wdenkc6097192002-11-03 00:24:07 +00003492
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003493Board initialization settings:
3494------------------------------
3495
3496During Initialization u-boot calls a number of board specific functions
3497to allow the preparation of board specific prerequisites, e.g. pin setup
3498before drivers are initialized. To enable these callbacks the
3499following configuration macros have to be defined. Currently this is
3500architecture specific, so please check arch/your_architecture/lib/board.c
3501typically in board_init_f() and board_init_r().
3502
3503- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3504- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3505- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3506- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003507
wdenkc6097192002-11-03 00:24:07 +00003508Configuration Settings:
3509-----------------------
3510
York Sun6c480012014-02-26 17:03:19 -08003511- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3512 Optionally it can be defined to support 64-bit memory commands.
3513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003514- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003515 undefine this when you're short of memory.
3516
Peter Tyserdfb72b82009-01-27 18:03:12 -06003517- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3518 width of the commands listed in the 'help' command output.
3519
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003520- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003521 prompt for user input.
3522
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003523- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003524
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003525- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003526
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003527- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003528
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003529- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003530 the application (usually a Linux kernel) when it is
3531 booted
3532
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003533- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003534 List of legal baudrate settings for this board.
3535
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003536- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003537 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003538
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003539- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003540 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003541
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003542- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003543 Enable overwrite of previous console environment settings.
3544
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003545- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003546 Begin and End addresses of the area used by the
3547 simple memory test.
3548
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003549- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003550 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003551
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003552- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003553 Scratch address used by the alternate memory test
3554 You only need to set this if address zero isn't writeable
3555
York Sun5d286cd2015-12-04 11:57:07 -08003556- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003557 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003558 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3559 is substracted from total RAM and won't be reported to OS.
3560 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003561 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003562 the RAM base is not zero, or RAM is divided into banks,
3563 this variable needs to be recalcuated to get the address.
3564
York Sun50739372015-12-07 11:05:29 -08003565- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003566 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003567 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003568 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003569 fixing up gd->ram_size the Linux kernel should gets passed
3570 the now "corrected" memory size and won't touch it either.
3571 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003572 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003573 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003574 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003575
3576 This option can be used as a workaround for the 440EPx/GRx
3577 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3578 be touched.
3579
3580 WARNING: Please make sure that this value is a multiple of
3581 the Linux page size (normally 4k). If this is not the case,
3582 then the end address of the Linux memory will be located at a
3583 non page size aligned address and this could cause major
3584 problems.
3585
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003586- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003587 Enable temporary baudrate change while serial download
3588
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003589- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003590 Physical start address of SDRAM. _Must_ be 0 here.
3591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003592- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003593 Physical start address of Flash memory.
3594
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003595- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003596 Physical start address of boot monitor code (set by
3597 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003598 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003599 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003600
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003601- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003602 Size of memory reserved for monitor code, used to
3603 determine _at_compile_time_ (!) if the environment is
3604 embedded within the U-Boot image, or in a separate
3605 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003606
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003607- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003608 Size of DRAM reserved for malloc() use.
3609
Simon Glass863e4042014-07-10 22:23:28 -06003610- CONFIG_SYS_MALLOC_F_LEN
3611 Size of the malloc() pool for use before relocation. If
3612 this is defined, then a very simple malloc() implementation
3613 will become available before relocation. The address is just
3614 below the global data, and the stack is moved down to make
3615 space.
3616
3617 This feature allocates regions with increasing addresses
3618 within the region. calloc() is supported, but realloc()
3619 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003620 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003621 U-Boot relocates itself.
3622
Simon Glass9fa901b2014-11-10 17:16:54 -07003623- CONFIG_SYS_MALLOC_SIMPLE
3624 Provides a simple and small malloc() and calloc() for those
3625 boards which do not use the full malloc in SPL (which is
3626 enabled with CONFIG_SYS_SPL_MALLOC_START).
3627
Thierry Redingc97d9742014-12-09 22:25:22 -07003628- CONFIG_SYS_NONCACHED_MEMORY:
3629 Size of non-cached memory area. This area of memory will be
3630 typically located right below the malloc() area and mapped
3631 uncached in the MMU. This is useful for drivers that would
3632 otherwise require a lot of explicit cache maintenance. For
3633 some drivers it's also impossible to properly maintain the
3634 cache. For example if the regions that need to be flushed
3635 are not a multiple of the cache-line size, *and* padding
3636 cannot be allocated between the regions to align them (i.e.
3637 if the HW requires a contiguous array of regions, and the
3638 size of each region is not cache-aligned), then a flush of
3639 one region may result in overwriting data that hardware has
3640 written to another region in the same cache-line. This can
3641 happen for example in network drivers where descriptors for
3642 buffers are typically smaller than the CPU cache-line (e.g.
3643 16 bytes vs. 32 or 64 bytes).
3644
3645 Non-cached memory is only supported on 32-bit ARM at present.
3646
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003647- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003648 Normally compressed uImages are limited to an
3649 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003650 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003651 to adjust this setting to your needs.
3652
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003653- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003654 Maximum size of memory mapped by the startup code of
3655 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003656 the Linux kernel (bd_info, boot arguments, FDT blob if
3657 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003658 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003659 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003660 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003661 variable "bootm_mapsize" will override the value of
3662 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3663 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003664
John Rigbyeea8e692010-10-13 13:57:35 -06003665- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3666 Enable initrd_high functionality. If defined then the
3667 initrd_high feature is enabled and the bootm ramdisk subcommand
3668 is enabled.
3669
3670- CONFIG_SYS_BOOT_GET_CMDLINE:
3671 Enables allocating and saving kernel cmdline in space between
3672 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3673
3674- CONFIG_SYS_BOOT_GET_KBD:
3675 Enables allocating and saving a kernel copy of the bd_info in
3676 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003678- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003679 Max number of Flash memory banks
3680
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003681- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003682 Max number of sectors on a Flash chip
3683
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003684- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003685 Timeout for Flash erase operations (in ms)
3686
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003687- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003688 Timeout for Flash write operations (in ms)
3689
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003690- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003691 Timeout for Flash set sector lock bit operation (in ms)
3692
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003693- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003694 Timeout for Flash clear lock bits operation (in ms)
3695
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003696- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003697 If defined, hardware flash sectors protection is used
3698 instead of U-Boot software protection.
3699
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003700- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003701
3702 Enable TFTP transfers directly to flash memory;
3703 without this option such a download has to be
3704 performed in two steps: (1) download to RAM, and (2)
3705 copy from RAM to flash.
3706
3707 The two-step approach is usually more reliable, since
3708 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003709 the flash, but in some situations (when system RAM is
3710 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003711 downloaded image) this option may be very useful.
3712
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003713- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003714 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003715 common flash structure for storing flash geometry.
3716
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003717- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003718 This option also enables the building of the cfi_flash driver
3719 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003720
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003721- CONFIG_FLASH_CFI_MTD
3722 This option enables the building of the cfi_mtd driver
3723 in the drivers directory. The driver exports CFI flash
3724 to the MTD layer.
3725
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003726- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003727 Use buffered writes to flash.
3728
3729- CONFIG_FLASH_SPANSION_S29WS_N
3730 s29ws-n MirrorBit flash has non-standard addresses for buffered
3731 write commands.
3732
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003733- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003734 If this option is defined, the common CFI flash doesn't
3735 print it's warning upon not recognized FLASH banks. This
3736 is useful, if some of the configured banks are only
3737 optionally available.
3738
Jerry Van Barenaae73572008-03-08 13:48:01 -05003739- CONFIG_FLASH_SHOW_PROGRESS
3740 If defined (must be an integer), print out countdown
3741 digits and dots. Recommended value: 45 (9..1) for 80
3742 column displays, 15 (3..1) for 40 column displays.
3743
Stefan Roesed20cba52013-04-04 15:53:14 +02003744- CONFIG_FLASH_VERIFY
3745 If defined, the content of the flash (destination) is compared
3746 against the source after the write operation. An error message
3747 will be printed when the contents are not identical.
3748 Please note that this option is useless in nearly all cases,
3749 since such flash programming errors usually are detected earlier
3750 while unprotecting/erasing/programming. Please only enable
3751 this option if you really know what you are doing.
3752
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003753- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003754 Defines the number of Ethernet receive buffers. On some
3755 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003756 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3757 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003758 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003759 Defaults to 4 if not defined.
3760
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003761- CONFIG_ENV_MAX_ENTRIES
3762
Wolfgang Denk1136f692010-10-27 22:48:30 +02003763 Maximum number of entries in the hash table that is used
3764 internally to store the environment settings. The default
3765 setting is supposed to be generous and should work in most
3766 cases. This setting can be used to tune behaviour; see
3767 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003768
Joe Hershberger71497d02012-12-11 22:16:31 -06003769- CONFIG_ENV_FLAGS_LIST_DEFAULT
3770- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003771 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003772 calling env set. Variables can be restricted to only decimal,
3773 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3774 the variables can also be restricted to IP address or MAC address.
3775
3776 The format of the list is:
3777 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003778 access_attribute = [a|r|o|c]
3779 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003780 entry = variable_name[:attributes]
3781 list = entry[,list]
3782
3783 The type attributes are:
3784 s - String (default)
3785 d - Decimal
3786 x - Hexadecimal
3787 b - Boolean ([1yYtT|0nNfF])
3788 i - IP address
3789 m - MAC address
3790
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003791 The access attributes are:
3792 a - Any (default)
3793 r - Read-only
3794 o - Write-once
3795 c - Change-default
3796
Joe Hershberger71497d02012-12-11 22:16:31 -06003797 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3798 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003799 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003800
3801 - CONFIG_ENV_FLAGS_LIST_STATIC
3802 Define this to a list (string) to define validation that
3803 should be done if an entry is not found in the ".flags"
3804 environment variable. To override a setting in the static
3805 list, simply add an entry for the same variable name to the
3806 ".flags" variable.
3807
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003808 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3809 regular expression. This allows multiple variables to define the same
3810 flags without explicitly listing them for each variable.
3811
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003812- CONFIG_ENV_ACCESS_IGNORE_FORCE
3813 If defined, don't allow the -f switch to env set override variable
3814 access flags.
3815
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003816- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3817 This is set by OMAP boards for the max time that reset should
3818 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003819 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003820
Gabe Black3687fe42014-10-15 04:38:30 -06003821- CONFIG_USE_STDINT
3822 If stdint.h is available with your toolchain you can define this
3823 option to enable it. You can provide option 'USE_STDINT=1' when
3824 building U-Boot to enable this.
3825
wdenkc6097192002-11-03 00:24:07 +00003826The following definitions that deal with the placement and management
3827of environment data (variable area); in general, we support the
3828following configurations:
3829
Mike Frysinger63b8f122011-07-08 10:44:25 +00003830- CONFIG_BUILD_ENVCRC:
3831
3832 Builds up envcrc with the target environment so that external utils
3833 may easily extract it and embed it in final U-Boot images.
3834
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003835- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003836
3837 Define this if the environment is in flash memory.
3838
3839 a) The environment occupies one whole flash sector, which is
3840 "embedded" in the text segment with the U-Boot code. This
3841 happens usually with "bottom boot sector" or "top boot
3842 sector" type flash chips, which have several smaller
3843 sectors at the start or the end. For instance, such a
3844 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3845 such a case you would place the environment in one of the
3846 4 kB sectors - with U-Boot code before and after it. With
3847 "top boot sector" type flash chips, you would put the
3848 environment in one of the last sectors, leaving a gap
3849 between U-Boot and the environment.
3850
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003851 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003852
3853 Offset of environment data (variable area) to the
3854 beginning of flash memory; for instance, with bottom boot
3855 type flash chips the second sector can be used: the offset
3856 for this sector is given here.
3857
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003858 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003859
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003860 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003861
3862 This is just another way to specify the start address of
3863 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003864 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003865
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003866 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003867
3868 Size of the sector containing the environment.
3869
3870
3871 b) Sometimes flash chips have few, equal sized, BIG sectors.
3872 In such a case you don't want to spend a whole sector for
3873 the environment.
3874
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003875 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003876
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003877 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003878 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003879 of this flash sector for the environment. This saves
3880 memory for the RAM copy of the environment.
3881
3882 It may also save flash memory if you decide to use this
3883 when your environment is "embedded" within U-Boot code,
3884 since then the remainder of the flash sector could be used
3885 for U-Boot code. It should be pointed out that this is
3886 STRONGLY DISCOURAGED from a robustness point of view:
3887 updating the environment in flash makes it always
3888 necessary to erase the WHOLE sector. If something goes
3889 wrong before the contents has been restored from a copy in
3890 RAM, your target system will be dead.
3891
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003892 - CONFIG_ENV_ADDR_REDUND
3893 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003894
wdenk4a5c8a72003-03-06 00:02:04 +00003895 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003896 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003897 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003898 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003899
3900BE CAREFUL! Any changes to the flash layout, and some changes to the
3901source code will make it necessary to adapt <board>/u-boot.lds*
3902accordingly!
3903
3904
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003905- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003906
3907 Define this if you have some non-volatile memory device
3908 (NVRAM, battery buffered SRAM) which you want to use for the
3909 environment.
3910
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003911 - CONFIG_ENV_ADDR:
3912 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003913
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003914 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003915 want to use for environment. It is assumed that this memory
3916 can just be read and written to, without any special
3917 provision.
3918
3919BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003920in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003921console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003922U-Boot will hang.
3923
3924Please note that even with NVRAM we still use a copy of the
3925environment in RAM: we could work on NVRAM directly, but we want to
3926keep settings there always unmodified except somebody uses "saveenv"
3927to save the current settings.
3928
3929
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003930- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003931
3932 Use this if you have an EEPROM or similar serial access
3933 device and a driver for it.
3934
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003935 - CONFIG_ENV_OFFSET:
3936 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003937
3938 These two #defines specify the offset and size of the
3939 environment area within the total memory of your EEPROM.
3940
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003941 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003942 If defined, specified the chip address of the EEPROM device.
3943 The default address is zero.
3944
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003945 - CONFIG_SYS_I2C_EEPROM_BUS:
3946 If defined, specified the i2c bus of the EEPROM device.
3947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003948 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003949 If defined, the number of bits used to address bytes in a
3950 single page in the EEPROM device. A 64 byte page, for example
3951 would require six bits.
3952
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003953 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003954 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003955 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003956
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003957 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003958 The length in bytes of the EEPROM memory array address. Note
3959 that this is NOT the chip address length!
3960
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003961 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003962 EEPROM chips that implement "address overflow" are ones
3963 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3964 address and the extra bits end up in the "chip address" bit
3965 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3966 byte chips.
3967
3968 Note that we consider the length of the address field to
3969 still be one byte because the extra address bits are hidden
3970 in the chip address.
3971
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003972 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003973 The size in bytes of the EEPROM device.
3974
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003975 - CONFIG_ENV_EEPROM_IS_ON_I2C
3976 define this, if you have I2C and SPI activated, and your
3977 EEPROM, which holds the environment, is on the I2C bus.
3978
3979 - CONFIG_I2C_ENV_EEPROM_BUS
3980 if you have an Environment on an EEPROM reached over
3981 I2C muxes, you can define here, how to reach this
3982 EEPROM. For example:
3983
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003984 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003985
3986 EEPROM which holds the environment, is reached over
3987 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003988
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003989- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003990
wdenk1ebf41e2004-01-02 14:00:00 +00003991 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003992 want to use for the environment.
3993
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003994 - CONFIG_ENV_OFFSET:
3995 - CONFIG_ENV_ADDR:
3996 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003997
3998 These three #defines specify the offset and size of the
3999 environment area within the total memory of your DataFlash placed
4000 at the specified address.
4001
Wu, Josh76db7bf2014-07-01 19:30:13 +08004002- CONFIG_ENV_IS_IN_SPI_FLASH:
4003
4004 Define this if you have a SPI Flash memory device which you
4005 want to use for the environment.
4006
4007 - CONFIG_ENV_OFFSET:
4008 - CONFIG_ENV_SIZE:
4009
4010 These two #defines specify the offset and size of the
4011 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4012 aligned to an erase sector boundary.
4013
4014 - CONFIG_ENV_SECT_SIZE:
4015
4016 Define the SPI flash's sector size.
4017
4018 - CONFIG_ENV_OFFSET_REDUND (optional):
4019
4020 This setting describes a second storage area of CONFIG_ENV_SIZE
4021 size used to hold a redundant copy of the environment data, so
4022 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06004023 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08004024 aligned to an erase sector boundary.
4025
4026 - CONFIG_ENV_SPI_BUS (optional):
4027 - CONFIG_ENV_SPI_CS (optional):
4028
4029 Define the SPI bus and chip select. If not defined they will be 0.
4030
4031 - CONFIG_ENV_SPI_MAX_HZ (optional):
4032
4033 Define the SPI max work clock. If not defined then use 1MHz.
4034
4035 - CONFIG_ENV_SPI_MODE (optional):
4036
4037 Define the SPI work mode. If not defined then use SPI_MODE_3.
4038
Liu Gang85bcd732012-03-08 00:33:20 +00004039- CONFIG_ENV_IS_IN_REMOTE:
4040
4041 Define this if you have a remote memory space which you
4042 want to use for the local device's environment.
4043
4044 - CONFIG_ENV_ADDR:
4045 - CONFIG_ENV_SIZE:
4046
4047 These two #defines specify the address and size of the
4048 environment area within the remote memory space. The
4049 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004050 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004051
4052BE CAREFUL! For some special cases, the local device can not use
4053"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004054environment stored in a remote NOR flash by SRIO or PCIE link,
4055but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004056
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004057- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004058
4059 Define this if you have a NAND device which you want to use
4060 for the environment.
4061
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004062 - CONFIG_ENV_OFFSET:
4063 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004064
4065 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004066 area within the first NAND device. CONFIG_ENV_OFFSET must be
4067 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004068
Scott Wood08239322010-09-17 14:38:37 -05004069 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004070
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004071 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004072 size used to hold a redundant copy of the environment data, so
4073 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06004074 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004075 aligned to an erase block boundary.
4076
4077 - CONFIG_ENV_RANGE (optional):
4078
4079 Specifies the length of the region in which the environment
4080 can be written. This should be a multiple of the NAND device's
4081 block size. Specifying a range with more erase blocks than
4082 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4083 the range to be avoided.
4084
4085 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004086
Scott Wood08239322010-09-17 14:38:37 -05004087 Enables support for dynamically retrieving the offset of the
4088 environment from block zero's out-of-band data. The
4089 "nand env.oob" command can be used to record this offset.
4090 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4091 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004092
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004093- CONFIG_NAND_ENV_DST
4094
4095 Defines address in RAM to which the nand_spl code should copy the
4096 environment. If redundant environment is used, it will be copied to
4097 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4098
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004099- CONFIG_ENV_IS_IN_UBI:
4100
4101 Define this if you have an UBI volume that you want to use for the
4102 environment. This has the benefit of wear-leveling the environment
4103 accesses, which is important on NAND.
4104
4105 - CONFIG_ENV_UBI_PART:
4106
4107 Define this to a string that is the mtd partition containing the UBI.
4108
4109 - CONFIG_ENV_UBI_VOLUME:
4110
4111 Define this to the name of the volume that you want to store the
4112 environment in.
4113
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004114 - CONFIG_ENV_UBI_VOLUME_REDUND:
4115
4116 Define this to the name of another volume to store a second copy of
4117 the environment in. This will enable redundant environments in UBI.
4118 It is assumed that both volumes are in the same MTD partition.
4119
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004120 - CONFIG_UBI_SILENCE_MSG
4121 - CONFIG_UBIFS_SILENCE_MSG
4122
4123 You will probably want to define these to avoid a really noisy system
4124 when storing the env in UBI.
4125
Wu, Josha7d0c872014-06-24 17:31:03 +08004126- CONFIG_ENV_IS_IN_FAT:
4127 Define this if you want to use the FAT file system for the environment.
4128
4129 - FAT_ENV_INTERFACE:
4130
4131 Define this to a string that is the name of the block device.
4132
4133 - FAT_ENV_DEV_AND_PART:
4134
4135 Define this to a string to specify the partition of the device. It can
4136 be as following:
4137
4138 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4139 - "D:P": device D partition P. Error occurs if device D has no
4140 partition table.
4141 - "D:0": device D.
4142 - "D" or "D:": device D partition 1 if device D has partition
4143 table, or the whole device D if has no partition
4144 table.
4145 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004146 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004147 partition table then means device D.
4148
4149 - FAT_ENV_FILE:
4150
4151 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004152 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004153
4154 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004155 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004156
Stephen Warreneedcacd2013-06-11 15:14:00 -06004157- CONFIG_ENV_IS_IN_MMC:
4158
4159 Define this if you have an MMC device which you want to use for the
4160 environment.
4161
4162 - CONFIG_SYS_MMC_ENV_DEV:
4163
4164 Specifies which MMC device the environment is stored in.
4165
4166 - CONFIG_SYS_MMC_ENV_PART (optional):
4167
4168 Specifies which MMC partition the environment is stored in. If not
4169 set, defaults to partition 0, the user area. Common values might be
4170 1 (first MMC boot partition), 2 (second MMC boot partition).
4171
4172 - CONFIG_ENV_OFFSET:
4173 - CONFIG_ENV_SIZE:
4174
4175 These two #defines specify the offset and size of the environment
4176 area within the specified MMC device.
4177
Stephen Warren24dc2032013-06-11 15:14:02 -06004178 If offset is positive (the usual case), it is treated as relative to
4179 the start of the MMC partition. If offset is negative, it is treated
4180 as relative to the end of the MMC partition. This can be useful if
4181 your board may be fitted with different MMC devices, which have
4182 different sizes for the MMC partitions, and you always want the
4183 environment placed at the very end of the partition, to leave the
4184 maximum possible space before it, to store other data.
4185
Stephen Warreneedcacd2013-06-11 15:14:00 -06004186 These two values are in units of bytes, but must be aligned to an
4187 MMC sector boundary.
4188
4189 - CONFIG_ENV_OFFSET_REDUND (optional):
4190
4191 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4192 hold a redundant copy of the environment data. This provides a
4193 valid backup copy in case the other copy is corrupted, e.g. due
4194 to a power failure during a "saveenv" operation.
4195
Stephen Warren24dc2032013-06-11 15:14:02 -06004196 This value may also be positive or negative; this is handled in the
4197 same way as CONFIG_ENV_OFFSET.
4198
Stephen Warreneedcacd2013-06-11 15:14:00 -06004199 This value is also in units of bytes, but must also be aligned to
4200 an MMC sector boundary.
4201
4202 - CONFIG_ENV_SIZE_REDUND (optional):
4203
4204 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4205 set. If this value is set, it must be set to the same value as
4206 CONFIG_ENV_SIZE.
4207
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004208- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004209
4210 Defines offset to the initial SPI buffer area in DPRAM. The
4211 area is used at an early stage (ROM part) if the environment
4212 is configured to reside in the SPI EEPROM: We need a 520 byte
4213 scratch DPRAM area. It is used between the two initialization
4214 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4215 to be a good choice since it makes it far enough from the
4216 start of the data area as well as from the stack pointer.
4217
Bruce Adleredecc942007-11-02 13:15:42 -07004218Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004219has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004220created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004221until then to read environment variables.
4222
wdenk8dba0502003-03-31 16:34:49 +00004223The environment is protected by a CRC32 checksum. Before the monitor
4224is relocated into RAM, as a result of a bad CRC you will be working
4225with the compiled-in default environment - *silently*!!! [This is
4226necessary, because the first environment variable we need is the
4227"baudrate" setting for the console - if we have a bad CRC, we don't
4228have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004229
4230Note: once the monitor has been relocated, then it will complain if
4231the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004232use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004233
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004234- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004235 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004237 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004238 also needs to be defined.
4239
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004240- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004241 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004242
Ron Madriddfa028a2009-02-18 14:30:44 -08004243- CONFIG_NS16550_MIN_FUNCTIONS:
4244 Define this if you desire to only have use of the NS16550_init
4245 and NS16550_putc functions for the serial driver located at
4246 drivers/serial/ns16550.c. This option is useful for saving
4247 space for already greatly restricted images, including but not
4248 limited to NAND_SPL configurations.
4249
Simon Glass28a9e332012-11-30 13:01:18 +00004250- CONFIG_DISPLAY_BOARDINFO
4251 Display information about the board that U-Boot is running on
4252 when U-Boot starts up. The board function checkboard() is called
4253 to do this.
4254
Simon Glasse8822012012-11-30 13:01:19 +00004255- CONFIG_DISPLAY_BOARDINFO_LATE
4256 Similar to the previous option, but display this information
4257 later, once stdio is running and output goes to the LCD, if
4258 present.
4259
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004260- CONFIG_BOARD_SIZE_LIMIT:
4261 Maximum size of the U-Boot image. When defined, the
4262 build system checks that the actual size does not
4263 exceed it.
4264
wdenkc6097192002-11-03 00:24:07 +00004265Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004266---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004267
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004268- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004269 Cache Line Size of the CPU.
4270
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004271- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004272 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004273
wdenk9c53f402003-10-15 23:53:47 +00004274 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4275 and RPXsuper) to be able to adjust the position of
4276 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004277
Timur Tabid8f341c2011-08-04 18:03:41 -05004278- CONFIG_SYS_CCSRBAR_DEFAULT:
4279 Default (power-on reset) physical address of CCSR on Freescale
4280 PowerPC SOCs.
4281
4282- CONFIG_SYS_CCSRBAR:
4283 Virtual address of CCSR. On a 32-bit build, this is typically
4284 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4285
4286 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4287 for cross-platform code that uses that macro instead.
4288
4289- CONFIG_SYS_CCSRBAR_PHYS:
4290 Physical address of CCSR. CCSR can be relocated to a new
4291 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004292 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004293 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4294 is typically relocated on 36-bit builds. It is recommended
4295 that this macro be defined via the _HIGH and _LOW macros:
4296
4297 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4298 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4299
4300- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004301 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4302 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004303 used in assembly code, so it must not contain typecasts or
4304 integer size suffixes (e.g. "ULL").
4305
4306- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4307 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4308 used in assembly code, so it must not contain typecasts or
4309 integer size suffixes (e.g. "ULL").
4310
4311- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4312 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4313 forced to a value that ensures that CCSR is not relocated.
4314
wdenk1272e232002-11-10 22:06:23 +00004315- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004316 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004317
4318 the default drive number (default value 0)
4319
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004320 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004321
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004322 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004323 (default value 1)
4324
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004325 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004326
wdenk4a5c8a72003-03-06 00:02:04 +00004327 defines the offset of register from address. It
4328 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004329 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004330
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004331 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4332 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004333 default value.
wdenk1272e232002-11-10 22:06:23 +00004334
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004335 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004336 fdc_hw_init() is called at the beginning of the FDC
4337 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004338 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004339 initializations.
wdenk1272e232002-11-10 22:06:23 +00004340
Macpaul Lind1e49942011-04-11 20:45:32 +00004341- CONFIG_IDE_AHB:
4342 Most IDE controllers were designed to be connected with PCI
4343 interface. Only few of them were designed for AHB interface.
4344 When software is doing ATA command and data transfer to
4345 IDE devices through IDE-AHB controller, some additional
4346 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004347 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004348
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004349- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004350 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004351 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004352
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004353- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004354
wdenkeb20ad32003-09-05 23:19:14 +00004355 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004356 initial data and stack; please note that this must be
4357 writable memory that is working WITHOUT special
4358 initialization, i. e. you CANNOT use normal RAM which
4359 will become available only after programming the
4360 memory controller and running certain initialization
4361 sequences.
4362
4363 U-Boot uses the following memory types:
4364 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4365 - MPC824X: data cache
4366 - PPC4xx: data cache
4367
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004368- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004369
4370 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004371 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4372 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004373 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004374 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004375 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004376 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4377 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004378
4379 Note:
4380 On the MPC824X (or other systems that use the data
4381 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004382 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004383 point to an otherwise UNUSED address space between
4384 the top of RAM and the start of the PCI space.
4385
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004386- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004387
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004388- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004389
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004390- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004391
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004392- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004393
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004394- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004395
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004396- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004397
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004398- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004399 SDRAM timing
4400
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004401- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004402 periodic timer for refresh
4403
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004404- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004405
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004406- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4407 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4408 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4409 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004410 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4411
4412- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004413 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4414 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004415 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4416
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004417- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4418 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004419 Machine Mode Register and Memory Periodic Timer
4420 Prescaler definitions (SDRAM timing)
4421
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004422- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004423 enable I2C microcode relocation patch (MPC8xx);
4424 define relocation offset in DPRAM [DSP2]
4425
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004426- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004427 enable SMC microcode relocation patch (MPC8xx);
4428 define relocation offset in DPRAM [SMC1]
4429
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004430- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004431 enable SPI microcode relocation patch (MPC8xx);
4432 define relocation offset in DPRAM [SCC4]
4433
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004434- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004435 Offset of the bootmode word in DPRAM used by post
4436 (Power On Self Tests). This definition overrides
4437 #define'd default value in commproc.h resp.
4438 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004439
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004440- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4441 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4442 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4443 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4444 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4445 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4446 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4447 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004448 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004449
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004450- CONFIG_PCI_DISABLE_PCIE:
4451 Disable PCI-Express on systems where it is supported but not
4452 required.
4453
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004454- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004455 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004456 Don't do any setup work, presumably because someone or
4457 something has already done it, and we don't need to do it
4458 a second time. Useful for platforms that are pre-booted
4459 by coreboot or similar.
4460
Gabor Juhosb4458732013-05-30 07:06:12 +00004461- CONFIG_PCI_INDIRECT_BRIDGE:
4462 Enable support for indirect PCI bridges.
4463
Kumar Gala8975d7a2010-12-30 12:09:53 -06004464- CONFIG_SYS_SRIO:
4465 Chip has SRIO or not
4466
4467- CONFIG_SRIO1:
4468 Board has SRIO 1 port available
4469
4470- CONFIG_SRIO2:
4471 Board has SRIO 2 port available
4472
Liu Gang27afb9c2013-05-07 16:30:46 +08004473- CONFIG_SRIO_PCIE_BOOT_MASTER
4474 Board can support master function for Boot from SRIO and PCIE
4475
Kumar Gala8975d7a2010-12-30 12:09:53 -06004476- CONFIG_SYS_SRIOn_MEM_VIRT:
4477 Virtual Address of SRIO port 'n' memory region
4478
4479- CONFIG_SYS_SRIOn_MEM_PHYS:
4480 Physical Address of SRIO port 'n' memory region
4481
4482- CONFIG_SYS_SRIOn_MEM_SIZE:
4483 Size of SRIO port 'n' memory region
4484
Fabio Estevamf17e8782013-04-11 09:35:34 +00004485- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4486 Defined to tell the NAND controller that the NAND chip is using
4487 a 16 bit bus.
4488 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004489 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004490 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004491 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004492
4493- CONFIG_SYS_NDFC_EBC0_CFG
4494 Sets the EBC0_CFG register for the NDFC. If not defined
4495 a default value will be used.
4496
Ben Warren45657152006-09-07 16:50:54 -04004497- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004498 Get DDR timing information from an I2C EEPROM. Common
4499 with pluggable memory modules such as SODIMMs
4500
Ben Warren45657152006-09-07 16:50:54 -04004501 SPD_EEPROM_ADDRESS
4502 I2C address of the SPD EEPROM
4503
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004504- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004505 If SPD EEPROM is on an I2C bus other than the first
4506 one, specify here. Note that the value must resolve
4507 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004508
York Sune73cc042011-06-07 09:42:16 +08004509- CONFIG_SYS_DDR_RAW_TIMING
4510 Get DDR timing information from other than SPD. Common with
4511 soldered DDR chips onboard without SPD. DDR raw timing
4512 parameters are extracted from datasheet and hard-coded into
4513 header files or board specific files.
4514
York Sunbd495cf2011-09-16 13:21:35 -07004515- CONFIG_FSL_DDR_INTERACTIVE
4516 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4517
York Sun8ced0502015-01-06 13:18:55 -08004518- CONFIG_FSL_DDR_SYNC_REFRESH
4519 Enable sync of refresh for multiple controllers.
4520
York Sunb6a35f82015-03-19 09:30:28 -07004521- CONFIG_FSL_DDR_BIST
4522 Enable built-in memory test for Freescale DDR controllers.
4523
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004524- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004525 Only for 83xx systems. If specified, then DDR should
4526 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004527
wdenk6203e402004-04-18 10:13:26 +00004528- CONFIG_ETHER_ON_FEC[12]
4529 Define to enable FEC[12] on a 8xx series processor.
4530
4531- CONFIG_FEC[12]_PHY
4532 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004533 to the given FEC; i. e.
4534 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004535 means that the PHY with address 4 is connected to FEC1
4536
4537 When set to -1, means to probe for first available.
4538
4539- CONFIG_FEC[12]_PHY_NORXERR
4540 The PHY does not have a RXERR line (RMII only).
4541 (so program the FEC to ignore it).
4542
4543- CONFIG_RMII
4544 Enable RMII mode for all FECs.
4545 Note that this is a global option, we can't
4546 have one FEC in standard MII mode and another in RMII mode.
4547
wdenk20c98a62004-04-23 20:32:05 +00004548- CONFIG_CRC32_VERIFY
4549 Add a verify option to the crc32 command.
4550 The syntax is:
4551
4552 => crc32 -v <address> <count> <crc32>
4553
4554 Where address/count indicate a memory area
4555 and crc32 is the correct crc32 which the
4556 area should have.
4557
wdenk64519362004-07-11 17:40:54 +00004558- CONFIG_LOOPW
4559 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004560 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004561
stroesecc3af832004-12-16 18:46:55 +00004562- CONFIG_MX_CYCLIC
4563 Add the "mdc" and "mwc" memory commands. These are cyclic
4564 "md/mw" commands.
4565 Examples:
4566
wdenk07d7e6b2004-12-16 21:44:03 +00004567 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004568 This command will print 4 bytes (10,11,12,13) each 500 ms.
4569
wdenk07d7e6b2004-12-16 21:44:03 +00004570 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004571 This command will write 12345678 to address 100 all 10 ms.
4572
wdenk07d7e6b2004-12-16 21:44:03 +00004573 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004574 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004575
wdenk3d3d99f2005-04-04 12:44:11 +00004576- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004577 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004578 low level initializations (like setting up the memory
4579 controller) are omitted and/or U-Boot does not
4580 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004581
Wolfgang Denk302141d2010-11-27 23:30:56 +01004582 Normally this variable MUST NOT be defined. The only
4583 exception is when U-Boot is loaded (to RAM) by some
4584 other boot loader or by a debugger which performs
4585 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004586
Simon Glass90844072016-05-05 07:28:06 -06004587- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4588 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004589 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004590 instruction cache) is still performed.
4591
Aneesh V552a3192011-07-13 05:11:07 +00004592- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004593 Modifies the behaviour of start.S when compiling a loader
4594 that is executed before the actual U-Boot. E.g. when
4595 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004596
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004597- CONFIG_TPL_BUILD
4598 Modifies the behaviour of start.S when compiling a loader
4599 that is executed after the SPL and before the actual U-Boot.
4600 It is loaded by the SPL.
4601
Ying Zhang0d4f5442013-05-20 14:07:23 +08004602- CONFIG_SYS_MPC85XX_NO_RESETVEC
4603 Only for 85xx systems. If this variable is specified, the section
4604 .resetvec is not kept and the section .bootpg is placed in the
4605 previous 4k of the .text section.
4606
Simon Glass17dabf02013-02-24 17:33:14 +00004607- CONFIG_ARCH_MAP_SYSMEM
4608 Generally U-Boot (and in particular the md command) uses
4609 effective address. It is therefore not necessary to regard
4610 U-Boot address as virtual addresses that need to be translated
4611 to physical addresses. However, sandbox requires this, since
4612 it maintains its own little RAM buffer which contains all
4613 addressable memory. This option causes some memory accesses
4614 to be mapped through map_sysmem() / unmap_sysmem().
4615
Matthias Weisser93416c12011-03-10 21:36:32 +00004616- CONFIG_USE_ARCH_MEMCPY
4617 CONFIG_USE_ARCH_MEMSET
4618 If these options are used a optimized version of memcpy/memset will
4619 be used if available. These functions may be faster under some
4620 conditions but may increase the binary size.
4621
Simon Glassbfb59802013-02-14 04:18:54 +00004622- CONFIG_X86_RESET_VECTOR
4623 If defined, the x86 reset vector code is included. This is not
4624 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004625
Mark Jackson52b003c2013-03-04 01:27:20 +00004626- CONFIG_SYS_MPUCLK
4627 Defines the MPU clock speed (in MHz).
4628
4629 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004630
Heiko Schocher2233e462013-11-04 14:05:00 +01004631- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4632 Enables the RTC32K OSC on AM33xx based plattforms
4633
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004634- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4635 Option to disable subpage write in NAND driver
4636 driver that uses this:
4637 drivers/mtd/nand/davinci_nand.c
4638
Timur Tabi275f4bb2011-11-22 09:21:25 -06004639Freescale QE/FMAN Firmware Support:
4640-----------------------------------
4641
4642The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4643loading of "firmware", which is encoded in the QE firmware binary format.
4644This firmware often needs to be loaded during U-Boot booting, so macros
4645are used to identify the storage device (NOR flash, SPI, etc) and the address
4646within that device.
4647
Zhao Qiang83a90842014-03-21 16:21:44 +08004648- CONFIG_SYS_FMAN_FW_ADDR
4649 The address in the storage device where the FMAN microcode is located. The
4650 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4651 is also specified.
4652
4653- CONFIG_SYS_QE_FW_ADDR
4654 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004655 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4656 is also specified.
4657
4658- CONFIG_SYS_QE_FMAN_FW_LENGTH
4659 The maximum possible size of the firmware. The firmware binary format
4660 has a field that specifies the actual size of the firmware, but it
4661 might not be possible to read any part of the firmware unless some
4662 local storage is allocated to hold the entire firmware first.
4663
4664- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4665 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4666 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4667 virtual address in NOR flash.
4668
4669- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4670 Specifies that QE/FMAN firmware is located in NAND flash.
4671 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4672
4673- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4674 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4675 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4676
Liu Gang1e084582012-03-08 00:33:18 +00004677- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4678 Specifies that QE/FMAN firmware is located in the remote (master)
4679 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004680 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4681 window->master inbound window->master LAW->the ucode address in
4682 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004683
J. German Rivera8ff14b72014-06-23 15:15:55 -07004684Freescale Layerscape Management Complex Firmware Support:
4685---------------------------------------------------------
4686The Freescale Layerscape Management Complex (MC) supports the loading of
4687"firmware".
4688This firmware often needs to be loaded during U-Boot booting, so macros
4689are used to identify the storage device (NOR flash, SPI, etc) and the address
4690within that device.
4691
4692- CONFIG_FSL_MC_ENET
4693 Enable the MC driver for Layerscape SoCs.
4694
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304695Freescale Layerscape Debug Server Support:
4696-------------------------------------------
4697The Freescale Layerscape Debug Server Support supports the loading of
4698"Debug Server firmware" and triggering SP boot-rom.
4699This firmware often needs to be loaded during U-Boot booting.
4700
York Sun928b6812015-12-07 11:08:58 -08004701- CONFIG_SYS_MC_RSV_MEM_ALIGN
4702 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304703
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004704Reproducible builds
4705-------------------
4706
4707In order to achieve reproducible builds, timestamps used in the U-Boot build
4708process have to be set to a fixed value.
4709
4710This is done using the SOURCE_DATE_EPOCH environment variable.
4711SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4712option for U-Boot or an environment variable in U-Boot.
4713
4714SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4715
wdenkc6097192002-11-03 00:24:07 +00004716Building the Software:
4717======================
4718
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004719Building U-Boot has been tested in several native build environments
4720and in many different cross environments. Of course we cannot support
4721all possibly existing versions of cross development tools in all
4722(potentially obsolete) versions. In case of tool chain problems we
4723recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4724which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004725
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004726If you are not using a native environment, it is assumed that you
4727have GNU cross compiling tools available in your path. In this case,
4728you must set the environment variable CROSS_COMPILE in your shell.
4729Note that no changes to the Makefile or any other source files are
4730necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004731
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004732 $ CROSS_COMPILE=ppc_4xx-
4733 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004734
Peter Tyserb06976d2009-03-13 18:54:51 -05004735Note: If you wish to generate Windows versions of the utilities in
4736 the tools directory you can use the MinGW toolchain
4737 (http://www.mingw.org). Set your HOST tools to the MinGW
4738 toolchain and execute 'make tools'. For example:
4739
4740 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4741
4742 Binaries such as tools/mkimage.exe will be created which can
4743 be executed on computers running Windows.
4744
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004745U-Boot is intended to be simple to build. After installing the
4746sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004747is done by typing:
4748
Holger Freyther7ba4e572014-08-04 09:26:05 +02004749 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004750
Holger Freyther7ba4e572014-08-04 09:26:05 +02004751where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004752rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004753
wdenk6c59edc2004-05-03 20:45:30 +00004754Note: for some board special configuration names may exist; check if
4755 additional information is available from the board vendor; for
4756 instance, the TQM823L systems are available without (standard)
4757 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004758 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004759
Holger Freyther7ba4e572014-08-04 09:26:05 +02004760 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004761 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004762
Holger Freyther7ba4e572014-08-04 09:26:05 +02004763 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004764 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004765
wdenk6c59edc2004-05-03 20:45:30 +00004766 etc.
wdenkc6097192002-11-03 00:24:07 +00004767
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769Finally, type "make all", and you should get some working U-Boot
4770images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004771
wdenk6c59edc2004-05-03 20:45:30 +00004772- "u-boot.bin" is a raw binary image
4773- "u-boot" is an image in ELF binary format
4774- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004775
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004776By default the build is performed locally and the objects are saved
4777in the source directory. One of the two methods can be used to change
4778this behavior and build U-Boot to some external directory:
4779
47801. Add O= to the make command line invocations:
4781
4782 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004783 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004784 make O=/tmp/build all
4785
Timo Ketolac8c67602014-11-06 14:39:05 +020047862. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004787
Timo Ketolac8c67602014-11-06 14:39:05 +02004788 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004789 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004790 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004791 make all
4792
Timo Ketolac8c67602014-11-06 14:39:05 +02004793Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004794variable.
4795
wdenkc6097192002-11-03 00:24:07 +00004796
wdenk6c59edc2004-05-03 20:45:30 +00004797Please be aware that the Makefiles assume you are using GNU make, so
4798for instance on NetBSD you might need to use "gmake" instead of
4799native "make".
wdenkc6097192002-11-03 00:24:07 +00004800
wdenkc6097192002-11-03 00:24:07 +00004801
wdenk6c59edc2004-05-03 20:45:30 +00004802If the system board that you have is not listed, then you will need
4803to port U-Boot to your hardware platform. To do this, follow these
4804steps:
wdenkc6097192002-11-03 00:24:07 +00004805
Phil Sutterc77b4882015-12-25 14:41:18 +010048061. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004807 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004808 the "Makefile" and a "<board>.c".
48092. Create a new configuration file "include/configs/<board>.h" for
4810 your board.
wdenk6c59edc2004-05-03 20:45:30 +000048113. If you're porting U-Boot to a new CPU, then also create a new
4812 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020048134. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000048145. Type "make", and you should get a working "u-boot.srec" file
4815 to be installed on your target system.
48166. Debug and solve any problems that might arise.
4817 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004818
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4821==============================================================
wdenkc6097192002-11-03 00:24:07 +00004822
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004823If you have modified U-Boot sources (for instance added a new board
4824or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004825provide feedback to the other developers. The feedback normally takes
4826the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004827official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004828
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004829But before you submit such a patch, please verify that your modifi-
4830cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004831the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004832just run the buildman script (tools/buildman/buildman), which will
4833configure and build U-Boot for ALL supported system. Be warned, this
4834will take a while. Please see the buildman README, or run 'buildman -H'
4835for documentation.
wdenkc6097192002-11-03 00:24:07 +00004836
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004837
wdenk6c59edc2004-05-03 20:45:30 +00004838See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004839
wdenkc6097192002-11-03 00:24:07 +00004840
wdenk6c59edc2004-05-03 20:45:30 +00004841Monitor Commands - Overview:
4842============================
wdenkc6097192002-11-03 00:24:07 +00004843
wdenk6c59edc2004-05-03 20:45:30 +00004844go - start application at address 'addr'
4845run - run commands in an environment variable
4846bootm - boot application image from memory
4847bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004848bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004849tftpboot- boot image via network using TFTP protocol
4850 and env variables "ipaddr" and "serverip"
4851 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004852tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004853rarpboot- boot image via network using RARP/TFTP protocol
4854diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4855loads - load S-Record file over serial line
4856loadb - load binary file over serial line (kermit mode)
4857md - memory display
4858mm - memory modify (auto-incrementing)
4859nm - memory modify (constant address)
4860mw - memory write (fill)
4861cp - memory copy
4862cmp - memory compare
4863crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004864i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004865sspi - SPI utility commands
4866base - print or set address offset
4867printenv- print environment variables
4868setenv - set environment variables
4869saveenv - save environment variables to persistent storage
4870protect - enable or disable FLASH write protection
4871erase - erase FLASH memory
4872flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004873nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004874bdinfo - print Board Info structure
4875iminfo - print header information for application image
4876coninfo - print console devices and informations
4877ide - IDE sub-system
4878loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004879loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004880mtest - simple RAM test
4881icache - enable or disable instruction cache
4882dcache - enable or disable data cache
4883reset - Perform RESET of the CPU
4884echo - echo args to console
4885version - print monitor version
4886help - print online help
4887? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004888
wdenkc6097192002-11-03 00:24:07 +00004889
wdenk6c59edc2004-05-03 20:45:30 +00004890Monitor Commands - Detailed Description:
4891========================================
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893TODO.
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk6c59edc2004-05-03 20:45:30 +00004895For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004896
4897
wdenk6c59edc2004-05-03 20:45:30 +00004898Environment Variables:
4899======================
wdenkc6097192002-11-03 00:24:07 +00004900
wdenk6c59edc2004-05-03 20:45:30 +00004901U-Boot supports user configuration using Environment Variables which
4902can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904Environment Variables are set using "setenv", printed using
4905"printenv", and saved to Flash using "saveenv". Using "setenv"
4906without a value can be used to delete a variable from the
4907environment. As long as you don't save the environment you are
4908working with an in-memory copy. In case the Flash area containing the
4909environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004910
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004911Some configuration options can be set using Environment Variables.
4912
4913List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004914
wdenk6c59edc2004-05-03 20:45:30 +00004915 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004916
wdenk6c59edc2004-05-03 20:45:30 +00004917 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004918
wdenk6c59edc2004-05-03 20:45:30 +00004919 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004920
wdenk6c59edc2004-05-03 20:45:30 +00004921 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004922
wdenk6c59edc2004-05-03 20:45:30 +00004923 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004924
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004925 bootm_low - Memory range available for image processing in the bootm
4926 command can be restricted. This variable is given as
4927 a hexadecimal number and defines lowest address allowed
4928 for use by the bootm command. See also "bootm_size"
4929 environment variable. Address defined by "bootm_low" is
4930 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004931 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4932 bootm_mapsize.
4933
Wolfgang Denk092ae952011-10-26 10:21:21 +00004934 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004935 This variable is given as a hexadecimal number and it
4936 defines the size of the memory region starting at base
4937 address bootm_low that is accessible by the Linux kernel
4938 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4939 as the default value if it is defined, and bootm_size is
4940 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004941
4942 bootm_size - Memory range available for image processing in the bootm
4943 command can be restricted. This variable is given as
4944 a hexadecimal number and defines the size of the region
4945 allowed for use by the bootm command. See also "bootm_low"
4946 environment variable.
4947
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004948 updatefile - Location of the software update file on a TFTP server, used
4949 by the automatic software update feature. Please refer to
4950 documentation in doc/README.update for more details.
4951
wdenk6c59edc2004-05-03 20:45:30 +00004952 autoload - if set to "no" (any string beginning with 'n'),
4953 "bootp" will just load perform a lookup of the
4954 configuration from the BOOTP server, but not try to
4955 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004956
wdenk6c59edc2004-05-03 20:45:30 +00004957 autostart - if set to "yes", an image loaded using the "bootp",
4958 "rarpboot", "tftpboot" or "diskboot" commands will
4959 be automatically started (by internally calling
4960 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004961
wdenk6c59edc2004-05-03 20:45:30 +00004962 If set to "no", a standalone image passed to the
4963 "bootm" command will be copied to the load address
4964 (and eventually uncompressed), but NOT be started.
4965 This can be used to load and uncompress arbitrary
4966 data.
wdenkc6097192002-11-03 00:24:07 +00004967
David A. Longd558a4e2011-07-09 16:40:19 -04004968 fdt_high - if set this restricts the maximum address that the
4969 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004970 For example, if you have a system with 1 GB memory
4971 at physical address 0x10000000, while Linux kernel
4972 only recognizes the first 704 MB as low memory, you
4973 may need to set fdt_high as 0x3C000000 to have the
4974 device tree blob be copied to the maximum address
4975 of the 704 MB low memory, so that Linux kernel can
4976 access it during the boot procedure.
4977
David A. Longd558a4e2011-07-09 16:40:19 -04004978 If this is set to the special value 0xFFFFFFFF then
4979 the fdt will not be copied at all on boot. For this
4980 to work it must reside in writable memory, have
4981 sufficient padding on the end of it for u-boot to
4982 add the information it needs into it, and the memory
4983 must be accessible by the kernel.
4984
Simon Glassdc6fa642011-10-24 19:15:34 +00004985 fdtcontroladdr- if set this is the address of the control flattened
4986 device tree used by U-Boot when CONFIG_OF_CONTROL is
4987 defined.
4988
wdenk0e2bd9c2004-06-06 21:51:03 +00004989 i2cfast - (PPC405GP|PPC405EP only)
4990 if set to 'y' configures Linux I2C driver for fast
4991 mode (400kHZ). This environment variable is used in
4992 initialization code. So, for changes to be effective
4993 it must be saved and board must be reset.
4994
wdenk6c59edc2004-05-03 20:45:30 +00004995 initrd_high - restrict positioning of initrd images:
4996 If this variable is not set, initrd images will be
4997 copied to the highest possible address in RAM; this
4998 is usually what you want since it allows for
4999 maximum initrd size. If for some reason you want to
5000 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005001 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005002 variable to a value of "no" or "off" or "0".
5003 Alternatively, you can set it to a maximum upper
5004 address to use (U-Boot will still check that it
5005 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005006
wdenk6c59edc2004-05-03 20:45:30 +00005007 For instance, when you have a system with 16 MB
5008 RAM, and want to reserve 4 MB from use by Linux,
5009 you can do this by adding "mem=12M" to the value of
5010 the "bootargs" variable. However, now you must make
5011 sure that the initrd image is placed in the first
5012 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005013
wdenk6c59edc2004-05-03 20:45:30 +00005014 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005015
wdenk6c59edc2004-05-03 20:45:30 +00005016 If you set initrd_high to 0xFFFFFFFF, this is an
5017 indication to U-Boot that all addresses are legal
5018 for the Linux kernel, including addresses in flash
5019 memory. In this case U-Boot will NOT COPY the
5020 ramdisk at all. This may be useful to reduce the
5021 boot time on your system, but requires that this
5022 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005023
wdenk6c59edc2004-05-03 20:45:30 +00005024 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026 loadaddr - Default load address for commands like "bootp",
5027 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005028
wdenk6c59edc2004-05-03 20:45:30 +00005029 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005030
wdenk6c59edc2004-05-03 20:45:30 +00005031 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005032
wdenk6c59edc2004-05-03 20:45:30 +00005033 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005034
wdenk6c59edc2004-05-03 20:45:30 +00005035 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005036
wdenk6c59edc2004-05-03 20:45:30 +00005037 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005038
Mike Frysingera23230c2011-10-02 10:01:27 +00005039 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005040
Mike Frysingera23230c2011-10-02 10:01:27 +00005041 ethact - controls which interface is currently active.
5042 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005043
Heiko Schocherc5e84052010-07-20 17:45:02 +02005044 => setenv ethact FEC
5045 => ping 192.168.0.1 # traffic sent on FEC
5046 => setenv ethact SCC
5047 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005048
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005049 ethrotate - When set to "no" U-Boot does not go through all
5050 available network interfaces.
5051 It just stays at the currently selected interface.
5052
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005053 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005054 either succeed or fail without retrying.
5055 When set to "once" the network operation will
5056 fail when all the available network interfaces
5057 are tried once without success.
5058 Useful on scripts which control the retry operation
5059 themselves.
wdenkc6097192002-11-03 00:24:07 +00005060
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005061 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005062
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005063 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005064 changing the console to be empty. If "yes" it will be
5065 made silent. If "no" it will not be made silent. If
5066 unset, then it will be made silent if the U-Boot console
5067 is silent.
5068
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005069 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005070 UDP source port.
5071
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005072 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005073 destination port instead of the Well Know Port 69.
5074
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005075 tftpblocksize - Block size to use for TFTP transfers; if not set,
5076 we use the TFTP server's default block size
5077
5078 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5079 seconds, minimum value is 1000 = 1 second). Defines
5080 when a packet is considered to be lost so it has to
5081 be retransmitted. The default is 5000 = 5 seconds.
5082 Lowering this value may make downloads succeed
5083 faster in networks with high packet loss rates or
5084 with unreliable TFTP servers.
5085
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005086 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5087 unit, minimum value = 0). Defines how many timeouts
5088 can happen during a single file transfer before that
5089 transfer is aborted. The default is 10, and 0 means
5090 'no timeouts allowed'. Increasing this value may help
5091 downloads succeed with high packet loss rates, or with
5092 unreliable TFTP servers or client hardware.
5093
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005094 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005095 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005096 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005097
Alexandre Messier15971322016-02-01 17:08:57 -05005098 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5099 Unsigned value, in milliseconds. If not set, the period will
5100 be either the default (28000), or a value based on
5101 CONFIG_NET_RETRY_COUNT, if defined. This value has
5102 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5103
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005104The following image location variables contain the location of images
5105used in booting. The "Image" column gives the role of the image and is
5106not an environment variable name. The other columns are environment
5107variable names. "File Name" gives the name of the file on a TFTP
5108server, "RAM Address" gives the location in RAM the image will be
5109loaded to, and "Flash Location" gives the image's address in NOR
5110flash or offset in NAND flash.
5111
5112*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005113boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005114boards use these variables for other purposes.
5115
Wolfgang Denk092ae952011-10-26 10:21:21 +00005116Image File Name RAM Address Flash Location
5117----- --------- ----------- --------------
5118u-boot u-boot u-boot_addr_r u-boot_addr
5119Linux kernel bootfile kernel_addr_r kernel_addr
5120device tree blob fdtfile fdt_addr_r fdt_addr
5121ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005122
wdenk6c59edc2004-05-03 20:45:30 +00005123The following environment variables may be used and automatically
5124updated by the network boot commands ("bootp" and "rarpboot"),
5125depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005126
wdenk6c59edc2004-05-03 20:45:30 +00005127 bootfile - see above
5128 dnsip - IP address of your Domain Name Server
5129 dnsip2 - IP address of your secondary Domain Name Server
5130 gatewayip - IP address of the Gateway (Router) to use
5131 hostname - Target hostname
5132 ipaddr - see above
5133 netmask - Subnet Mask
5134 rootpath - Pathname of the root filesystem on the NFS server
5135 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005136
wdenk145d2c12004-04-15 21:48:45 +00005137
wdenk6c59edc2004-05-03 20:45:30 +00005138There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk6c59edc2004-05-03 20:45:30 +00005140 serial# - contains hardware identification information such
5141 as type string and/or serial number
5142 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005143
wdenk6c59edc2004-05-03 20:45:30 +00005144These variables can be set only once (usually during manufacturing of
5145the board). U-Boot refuses to delete or overwrite these variables
5146once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005147
5148
wdenk6c59edc2004-05-03 20:45:30 +00005149Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk6c59edc2004-05-03 20:45:30 +00005151 ver - Contains the U-Boot version string as printed
5152 with the "version" command. This variable is
5153 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005154
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk6c59edc2004-05-03 20:45:30 +00005156Please note that changes to some configuration parameters may take
5157only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005158
stroeseb9c17c52003-04-04 15:53:41 +00005159
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005160Callback functions for environment variables:
5161---------------------------------------------
5162
5163For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005164when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005165be associated with arbitrary variables. On creation, overwrite, or
5166deletion, the callback will provide the opportunity for some side
5167effect to happen or for the change to be rejected.
5168
5169The callbacks are named and associated with a function using the
5170U_BOOT_ENV_CALLBACK macro in your board or driver code.
5171
5172These callbacks are associated with variables in one of two ways. The
5173static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5174in the board configuration to a string that defines a list of
5175associations. The list must be in the following format:
5176
5177 entry = variable_name[:callback_name]
5178 list = entry[,list]
5179
5180If the callback name is not specified, then the callback is deleted.
5181Spaces are also allowed anywhere in the list.
5182
5183Callbacks can also be associated by defining the ".callbacks" variable
5184with the same list format above. Any association in ".callbacks" will
5185override any association in the static list. You can define
5186CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005187".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005188
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005189If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5190regular expression. This allows multiple variables to be connected to
5191the same callback without explicitly listing them all out.
5192
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005193
wdenk6c59edc2004-05-03 20:45:30 +00005194Command Line Parsing:
5195=====================
stroeseb9c17c52003-04-04 15:53:41 +00005196
wdenk6c59edc2004-05-03 20:45:30 +00005197There are two different command line parsers available with U-Boot:
5198the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005199
wdenk6c59edc2004-05-03 20:45:30 +00005200Old, simple command line parser:
5201--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005202
wdenk6c59edc2004-05-03 20:45:30 +00005203- supports environment variables (through setenv / saveenv commands)
5204- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005205- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005206- special characters ('$', ';') can be escaped by prefixing with '\',
5207 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005208 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005209- You can also escape text by enclosing in single apostrophes, for example:
5210 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk6c59edc2004-05-03 20:45:30 +00005212Hush shell:
5213-----------
wdenkf4688a22003-05-28 08:06:31 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215- similar to Bourne shell, with control structures like
5216 if...then...else...fi, for...do...done; while...do...done,
5217 until...do...done, ...
5218- supports environment ("global") variables (through setenv / saveenv
5219 commands) and local shell variables (through standard shell syntax
5220 "name=value"); only environment variables can be used with "run"
5221 command
wdenkf4688a22003-05-28 08:06:31 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223General rules:
5224--------------
wdenkf4688a22003-05-28 08:06:31 +00005225
wdenk6c59edc2004-05-03 20:45:30 +00005226(1) If a command line (or an environment variable executed by a "run"
5227 command) contains several commands separated by semicolon, and
5228 one of these commands fails, then the remaining commands will be
5229 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005230
wdenk6c59edc2004-05-03 20:45:30 +00005231(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005232 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005233 command will cause "run" to terminate, i. e. the remaining
5234 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005235
wdenk6c59edc2004-05-03 20:45:30 +00005236Note for Redundant Ethernet Interfaces:
5237=======================================
wdenkf4688a22003-05-28 08:06:31 +00005238
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005239Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005240such configurations and is capable of automatic selection of a
5241"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005242
wdenk6c59edc2004-05-03 20:45:30 +00005243Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5244MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5245"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005246
wdenk6c59edc2004-05-03 20:45:30 +00005247If the network interface stores some valid MAC address (for instance
5248in SROM), this is used as default address if there is NO correspon-
5249ding setting in the environment; if the corresponding environment
5250variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005251
wdenk6c59edc2004-05-03 20:45:30 +00005252o If the SROM has a valid MAC address, and there is no address in the
5253 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005254
wdenk6c59edc2004-05-03 20:45:30 +00005255o If there is no valid address in the SROM, and a definition in the
5256 environment exists, then the value from the environment variable is
5257 used.
wdenkc6097192002-11-03 00:24:07 +00005258
wdenk6c59edc2004-05-03 20:45:30 +00005259o If both the SROM and the environment contain a MAC address, and
5260 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk6c59edc2004-05-03 20:45:30 +00005262o If both the SROM and the environment contain a MAC address, and the
5263 addresses differ, the value from the environment is used and a
5264 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005265
wdenk6c59edc2004-05-03 20:45:30 +00005266o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005267 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5268 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005269
Ben Warren6db991a2010-04-26 11:11:46 -07005270If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005271will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005272may be skipped by setting the appropriate 'ethmacskip' environment variable.
5273The naming convention is as follows:
5274"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276Image Formats:
5277==============
wdenkc6097192002-11-03 00:24:07 +00005278
Marian Balakowicz18710b82008-03-12 12:13:13 +01005279U-Boot is capable of booting (and performing other auxiliary operations on)
5280images in two formats:
5281
5282New uImage format (FIT)
5283-----------------------
5284
5285Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5286to Flattened Device Tree). It allows the use of images with multiple
5287components (several kernels, ramdisks, etc.), with contents protected by
5288SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5289
5290
5291Old uImage format
5292-----------------
5293
5294Old image format is based on binary files which can be basically anything,
5295preceded by a special header; see the definitions in include/image.h for
5296details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005297
wdenk6c59edc2004-05-03 20:45:30 +00005298* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5299 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005300 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5301 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5302 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005303* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005304 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5305 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005306* Compression Type (uncompressed, gzip, bzip2)
5307* Load Address
5308* Entry Point
5309* Image Name
5310* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005311
wdenk6c59edc2004-05-03 20:45:30 +00005312The header is marked by a special Magic Number, and both the header
5313and the data portions of the image are secured against corruption by
5314CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005315
wdenkc6097192002-11-03 00:24:07 +00005316
wdenk6c59edc2004-05-03 20:45:30 +00005317Linux Support:
5318==============
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk6c59edc2004-05-03 20:45:30 +00005320Although U-Boot should support any OS or standalone application
5321easily, the main focus has always been on Linux during the design of
5322U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005323
wdenk6c59edc2004-05-03 20:45:30 +00005324U-Boot includes many features that so far have been part of some
5325special "boot loader" code within the Linux kernel. Also, any
5326"initrd" images to be used are no longer part of one big Linux image;
5327instead, kernel and "initrd" are separate images. This implementation
5328serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330- the same features can be used for other OS or standalone
5331 applications (for instance: using compressed images to reduce the
5332 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk6c59edc2004-05-03 20:45:30 +00005334- it becomes much easier to port new Linux kernel versions because
5335 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005336
wdenk6c59edc2004-05-03 20:45:30 +00005337- the same Linux kernel image can now be used with different "initrd"
5338 images; of course this also means that different kernel images can
5339 be run with the same "initrd". This makes testing easier (you don't
5340 have to build a new "zImage.initrd" Linux image when you just
5341 change a file in your "initrd"). Also, a field-upgrade of the
5342 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005343
wdenkc6097192002-11-03 00:24:07 +00005344
wdenk6c59edc2004-05-03 20:45:30 +00005345Linux HOWTO:
5346============
wdenkc6097192002-11-03 00:24:07 +00005347
wdenk6c59edc2004-05-03 20:45:30 +00005348Porting Linux to U-Boot based systems:
5349---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351U-Boot cannot save you from doing all the necessary modifications to
5352configure the Linux device drivers for use with your target hardware
5353(no, we don't intend to provide a full virtual machine interface to
5354Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005355
Stefan Roese88fbf932010-04-15 16:07:28 +02005356But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358Just make sure your machine specific header file (for instance
5359include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005360Information structure as we define in include/asm-<arch>/u-boot.h,
5361and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005362as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005363
Simon Glassd097e592014-06-11 23:29:46 -06005364Note that U-Boot now has a driver model, a unified model for drivers.
5365If you are adding a new driver, plumb it into driver model. If there
5366is no uclass available, you are encouraged to create one. See
5367doc/driver-model.
5368
wdenkc6097192002-11-03 00:24:07 +00005369
wdenk6c59edc2004-05-03 20:45:30 +00005370Configuring the Linux kernel:
5371-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005372
wdenk6c59edc2004-05-03 20:45:30 +00005373No specific requirements for U-Boot. Make sure you have some root
5374device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005375
wdenkc6097192002-11-03 00:24:07 +00005376
wdenk6c59edc2004-05-03 20:45:30 +00005377Building a Linux Image:
5378-----------------------
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk6c59edc2004-05-03 20:45:30 +00005380With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5381not used. If you use recent kernel source, a new build target
5382"uImage" will exist which automatically builds an image usable by
5383U-Boot. Most older kernels also have support for a "pImage" target,
5384which was introduced for our predecessor project PPCBoot and uses a
5385100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005386
wdenk6c59edc2004-05-03 20:45:30 +00005387Example:
wdenkc6097192002-11-03 00:24:07 +00005388
Holger Freyther7ba4e572014-08-04 09:26:05 +02005389 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005390 make oldconfig
5391 make dep
5392 make uImage
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394The "uImage" build target uses a special tool (in 'tools/mkimage') to
5395encapsulate a compressed Linux kernel image with header information,
5396CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005397
wdenk6c59edc2004-05-03 20:45:30 +00005398* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005399
wdenk6c59edc2004-05-03 20:45:30 +00005400* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005401
wdenk6c59edc2004-05-03 20:45:30 +00005402 ${CROSS_COMPILE}-objcopy -O binary \
5403 -R .note -R .comment \
5404 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005405
wdenk6c59edc2004-05-03 20:45:30 +00005406* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005407
wdenk6c59edc2004-05-03 20:45:30 +00005408 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005411
wdenk6c59edc2004-05-03 20:45:30 +00005412 mkimage -A ppc -O linux -T kernel -C gzip \
5413 -a 0 -e 0 -n "Linux Kernel Image" \
5414 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005415
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417The "mkimage" tool can also be used to create ramdisk images for use
5418with U-Boot, either separated from the Linux kernel image, or
5419combined into one file. "mkimage" encapsulates the images with a 64
5420byte header containing information about target architecture,
5421operating system, image type, compression method, entry points, time
5422stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005423
wdenk6c59edc2004-05-03 20:45:30 +00005424"mkimage" can be called in two ways: to verify existing images and
5425print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005426
wdenk6c59edc2004-05-03 20:45:30 +00005427In the first form (with "-l" option) mkimage lists the information
5428contained in the header of an existing U-Boot image; this includes
5429checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005430
wdenk6c59edc2004-05-03 20:45:30 +00005431 tools/mkimage -l image
5432 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005433
wdenk6c59edc2004-05-03 20:45:30 +00005434The second form (with "-d" option) is used to build a U-Boot image
5435from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005436
wdenk6c59edc2004-05-03 20:45:30 +00005437 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5438 -n name -d data_file image
5439 -A ==> set architecture to 'arch'
5440 -O ==> set operating system to 'os'
5441 -T ==> set image type to 'type'
5442 -C ==> set compression type 'comp'
5443 -a ==> set load address to 'addr' (hex)
5444 -e ==> set entry point to 'ep' (hex)
5445 -n ==> set image name to 'name'
5446 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005447
wdenkcd914452004-05-29 16:53:29 +00005448Right now, all Linux kernels for PowerPC systems use the same load
5449address (0x00000000), but the entry point address depends on the
5450kernel version:
wdenkc6097192002-11-03 00:24:07 +00005451
wdenk6c59edc2004-05-03 20:45:30 +00005452- 2.2.x kernels have the entry point at 0x0000000C,
5453- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005454
wdenk6c59edc2004-05-03 20:45:30 +00005455So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005456
wdenk6c59edc2004-05-03 20:45:30 +00005457 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5458 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005459 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005460 > examples/uImage.TQM850L
5461 Image Name: 2.4.4 kernel for TQM850L
5462 Created: Wed Jul 19 02:34:59 2000
5463 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5464 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5465 Load Address: 0x00000000
5466 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk6c59edc2004-05-03 20:45:30 +00005468To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005469
wdenk6c59edc2004-05-03 20:45:30 +00005470 -> tools/mkimage -l examples/uImage.TQM850L
5471 Image Name: 2.4.4 kernel for TQM850L
5472 Created: Wed Jul 19 02:34:59 2000
5473 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5474 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5475 Load Address: 0x00000000
5476 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005477
wdenk6c59edc2004-05-03 20:45:30 +00005478NOTE: for embedded systems where boot time is critical you can trade
5479speed for memory and install an UNCOMPRESSED image instead: this
5480needs more space in Flash, but boots much faster since it does not
5481need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005482
Stefan Roese88fbf932010-04-15 16:07:28 +02005483 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005484 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5485 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005486 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005487 > examples/uImage.TQM850L-uncompressed
5488 Image Name: 2.4.4 kernel for TQM850L
5489 Created: Wed Jul 19 02:34:59 2000
5490 Image Type: PowerPC Linux Kernel Image (uncompressed)
5491 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5492 Load Address: 0x00000000
5493 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005494
wdenkc6097192002-11-03 00:24:07 +00005495
wdenk6c59edc2004-05-03 20:45:30 +00005496Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5497when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005498
wdenk6c59edc2004-05-03 20:45:30 +00005499 -> tools/mkimage -n 'Simple Ramdisk Image' \
5500 > -A ppc -O linux -T ramdisk -C gzip \
5501 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5502 Image Name: Simple Ramdisk Image
5503 Created: Wed Jan 12 14:01:50 2000
5504 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5505 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5506 Load Address: 0x00000000
5507 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005508
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005509The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5510option performs the converse operation of the mkimage's second form (the "-d"
5511option). Given an image built by mkimage, the dumpimage extracts a "data file"
5512from the image:
5513
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005514 tools/dumpimage -i image -T type -p position data_file
5515 -i ==> extract from the 'image' a specific 'data_file'
5516 -T ==> set image type to 'type'
5517 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005518
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520Installing a Linux Image:
5521-------------------------
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523To downloading a U-Boot image over the serial (console) interface,
5524you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005525
wdenk6c59edc2004-05-03 20:45:30 +00005526 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005527
wdenk6c59edc2004-05-03 20:45:30 +00005528The 'objcopy' does not understand the information in the U-Boot
5529image header, so the resulting S-Record file will be relative to
5530address 0x00000000. To load it to a given address, you need to
5531specify the target address as 'offset' parameter with the 'loads'
5532command.
wdenkc6097192002-11-03 00:24:07 +00005533
wdenk6c59edc2004-05-03 20:45:30 +00005534Example: install the image to address 0x40100000 (which on the
5535TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005538
wdenk6c59edc2004-05-03 20:45:30 +00005539 .......... done
5540 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005541
wdenk6c59edc2004-05-03 20:45:30 +00005542 => loads 40100000
5543 ## Ready for S-Record download ...
5544 ~>examples/image.srec
5545 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5546 ...
5547 15989 15990 15991 15992
5548 [file transfer complete]
5549 [connected]
5550 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005551
wdenkc6097192002-11-03 00:24:07 +00005552
wdenk6c59edc2004-05-03 20:45:30 +00005553You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005554this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005555corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005556
wdenk6c59edc2004-05-03 20:45:30 +00005557 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559 ## Checking Image at 40100000 ...
5560 Image Name: 2.2.13 for initrd on TQM850L
5561 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5562 Data Size: 335725 Bytes = 327 kB = 0 MB
5563 Load Address: 00000000
5564 Entry Point: 0000000c
5565 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005566
5567
wdenk6c59edc2004-05-03 20:45:30 +00005568Boot Linux:
5569-----------
wdenkc6097192002-11-03 00:24:07 +00005570
wdenk6c59edc2004-05-03 20:45:30 +00005571The "bootm" command is used to boot an application that is stored in
5572memory (RAM or Flash). In case of a Linux kernel image, the contents
5573of the "bootargs" environment variable is passed to the kernel as
5574parameters. You can check and modify this variable using the
5575"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005576
wdenkc6097192002-11-03 00:24:07 +00005577
wdenk6c59edc2004-05-03 20:45:30 +00005578 => printenv bootargs
5579 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005580
wdenk6c59edc2004-05-03 20:45:30 +00005581 => 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 +00005582
wdenk6c59edc2004-05-03 20:45:30 +00005583 => printenv bootargs
5584 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 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586 => bootm 40020000
5587 ## Booting Linux kernel at 40020000 ...
5588 Image Name: 2.2.13 for NFS on TQM850L
5589 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5590 Data Size: 381681 Bytes = 372 kB = 0 MB
5591 Load Address: 00000000
5592 Entry Point: 0000000c
5593 Verifying Checksum ... OK
5594 Uncompressing Kernel Image ... OK
5595 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
5596 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5597 time_init: decrementer frequency = 187500000/60
5598 Calibrating delay loop... 49.77 BogoMIPS
5599 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5600 ...
wdenkc6097192002-11-03 00:24:07 +00005601
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005602If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005603the memory addresses of both the kernel and the initrd image (PPBCOOT
5604format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk6c59edc2004-05-03 20:45:30 +00005606 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608 ## Checking Image at 40100000 ...
5609 Image Name: 2.2.13 for initrd on TQM850L
5610 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5611 Data Size: 335725 Bytes = 327 kB = 0 MB
5612 Load Address: 00000000
5613 Entry Point: 0000000c
5614 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005615
wdenk6c59edc2004-05-03 20:45:30 +00005616 ## Checking Image at 40200000 ...
5617 Image Name: Simple Ramdisk Image
5618 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5619 Data Size: 566530 Bytes = 553 kB = 0 MB
5620 Load Address: 00000000
5621 Entry Point: 00000000
5622 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005623
wdenk6c59edc2004-05-03 20:45:30 +00005624 => bootm 40100000 40200000
5625 ## Booting Linux kernel at 40100000 ...
5626 Image Name: 2.2.13 for initrd on TQM850L
5627 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5628 Data Size: 335725 Bytes = 327 kB = 0 MB
5629 Load Address: 00000000
5630 Entry Point: 0000000c
5631 Verifying Checksum ... OK
5632 Uncompressing Kernel Image ... OK
5633 ## Loading RAMDisk Image at 40200000 ...
5634 Image Name: Simple Ramdisk Image
5635 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5636 Data Size: 566530 Bytes = 553 kB = 0 MB
5637 Load Address: 00000000
5638 Entry Point: 00000000
5639 Verifying Checksum ... OK
5640 Loading Ramdisk ... OK
5641 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
5642 Boot arguments: root=/dev/ram
5643 time_init: decrementer frequency = 187500000/60
5644 Calibrating delay loop... 49.77 BogoMIPS
5645 ...
5646 RAMDISK: Compressed image found at block 0
5647 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005648
wdenk6c59edc2004-05-03 20:45:30 +00005649 bash#
wdenkc6097192002-11-03 00:24:07 +00005650
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005651Boot Linux and pass a flat device tree:
5652-----------
5653
5654First, U-Boot must be compiled with the appropriate defines. See the section
5655titled "Linux Kernel Interface" above for a more in depth explanation. The
5656following is an example of how to start a kernel and pass an updated
5657flat device tree:
5658
5659=> print oftaddr
5660oftaddr=0x300000
5661=> print oft
5662oft=oftrees/mpc8540ads.dtb
5663=> tftp $oftaddr $oft
5664Speed: 1000, full duplex
5665Using TSEC0 device
5666TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5667Filename 'oftrees/mpc8540ads.dtb'.
5668Load address: 0x300000
5669Loading: #
5670done
5671Bytes transferred = 4106 (100a hex)
5672=> tftp $loadaddr $bootfile
5673Speed: 1000, full duplex
5674Using TSEC0 device
5675TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5676Filename 'uImage'.
5677Load address: 0x200000
5678Loading:############
5679done
5680Bytes transferred = 1029407 (fb51f hex)
5681=> print loadaddr
5682loadaddr=200000
5683=> print oftaddr
5684oftaddr=0x300000
5685=> bootm $loadaddr - $oftaddr
5686## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005687 Image Name: Linux-2.6.17-dirty
5688 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5689 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005690 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005691 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005692 Verifying Checksum ... OK
5693 Uncompressing Kernel Image ... OK
5694Booting using flat device tree at 0x300000
5695Using MPC85xx ADS machine description
5696Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5697[snip]
5698
5699
wdenk6c59edc2004-05-03 20:45:30 +00005700More About U-Boot Image Types:
5701------------------------------
wdenkc6097192002-11-03 00:24:07 +00005702
wdenk6c59edc2004-05-03 20:45:30 +00005703U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk6c59edc2004-05-03 20:45:30 +00005705 "Standalone Programs" are directly runnable in the environment
5706 provided by U-Boot; it is expected that (if they behave
5707 well) you can continue to work in U-Boot after return from
5708 the Standalone Program.
5709 "OS Kernel Images" are usually images of some Embedded OS which
5710 will take over control completely. Usually these programs
5711 will install their own set of exception handlers, device
5712 drivers, set up the MMU, etc. - this means, that you cannot
5713 expect to re-enter U-Boot except by resetting the CPU.
5714 "RAMDisk Images" are more or less just data blocks, and their
5715 parameters (address, size) are passed to an OS kernel that is
5716 being started.
5717 "Multi-File Images" contain several images, typically an OS
5718 (Linux) kernel image and one or more data images like
5719 RAMDisks. This construct is useful for instance when you want
5720 to boot over the network using BOOTP etc., where the boot
5721 server provides just a single image file, but you want to get
5722 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk6c59edc2004-05-03 20:45:30 +00005724 "Multi-File Images" start with a list of image sizes, each
5725 image size (in bytes) specified by an "uint32_t" in network
5726 byte order. This list is terminated by an "(uint32_t)0".
5727 Immediately after the terminating 0 follow the images, one by
5728 one, all aligned on "uint32_t" boundaries (size rounded up to
5729 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk6c59edc2004-05-03 20:45:30 +00005731 "Firmware Images" are binary images containing firmware (like
5732 U-Boot or FPGA images) which usually will be programmed to
5733 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005734
wdenk6c59edc2004-05-03 20:45:30 +00005735 "Script files" are command sequences that will be executed by
5736 U-Boot's command interpreter; this feature is especially
5737 useful when you configure U-Boot to use a real shell (hush)
5738 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005739
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005740Booting the Linux zImage:
5741-------------------------
5742
5743On some platforms, it's possible to boot Linux zImage. This is done
5744using the "bootz" command. The syntax of "bootz" command is the same
5745as the syntax of "bootm" command.
5746
Tom Rini45f46d12013-05-16 11:40:11 -04005747Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005748kernel with raw initrd images. The syntax is slightly different, the
5749address of the initrd must be augmented by it's size, in the following
5750format: "<initrd addres>:<initrd size>".
5751
stroeseb9c17c52003-04-04 15:53:41 +00005752
wdenk6c59edc2004-05-03 20:45:30 +00005753Standalone HOWTO:
5754=================
stroeseb9c17c52003-04-04 15:53:41 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756One of the features of U-Boot is that you can dynamically load and
5757run "standalone" applications, which can use some resources of
5758U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005759
wdenk6c59edc2004-05-03 20:45:30 +00005760Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005761
wdenk6c59edc2004-05-03 20:45:30 +00005762"Hello World" Demo:
5763-------------------
wdenkc6097192002-11-03 00:24:07 +00005764
wdenk6c59edc2004-05-03 20:45:30 +00005765'examples/hello_world.c' contains a small "Hello World" Demo
5766application; it is automatically compiled when you build U-Boot.
5767It's configured to run at address 0x00040004, so you can play with it
5768like that:
wdenkc6097192002-11-03 00:24:07 +00005769
wdenk6c59edc2004-05-03 20:45:30 +00005770 => loads
5771 ## Ready for S-Record download ...
5772 ~>examples/hello_world.srec
5773 1 2 3 4 5 6 7 8 9 10 11 ...
5774 [file transfer complete]
5775 [connected]
5776 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005777
wdenk6c59edc2004-05-03 20:45:30 +00005778 => go 40004 Hello World! This is a test.
5779 ## Starting application at 0x00040004 ...
5780 Hello World
5781 argc = 7
5782 argv[0] = "40004"
5783 argv[1] = "Hello"
5784 argv[2] = "World!"
5785 argv[3] = "This"
5786 argv[4] = "is"
5787 argv[5] = "a"
5788 argv[6] = "test."
5789 argv[7] = "<NULL>"
5790 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005791
wdenk6c59edc2004-05-03 20:45:30 +00005792 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005793
wdenk6c59edc2004-05-03 20:45:30 +00005794Another example, which demonstrates how to register a CPM interrupt
5795handler with the U-Boot code, can be found in 'examples/timer.c'.
5796Here, a CPM timer is set up to generate an interrupt every second.
5797The interrupt service routine is trivial, just printing a '.'
5798character, but this is just a demo program. The application can be
5799controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005800
wdenk6c59edc2004-05-03 20:45:30 +00005801 ? - print current values og the CPM Timer registers
5802 b - enable interrupts and start timer
5803 e - stop timer and disable interrupts
5804 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk6c59edc2004-05-03 20:45:30 +00005806 => loads
5807 ## Ready for S-Record download ...
5808 ~>examples/timer.srec
5809 1 2 3 4 5 6 7 8 9 10 11 ...
5810 [file transfer complete]
5811 [connected]
5812 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814 => go 40004
5815 ## Starting application at 0x00040004 ...
5816 TIMERS=0xfff00980
5817 Using timer 1
5818 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005819
wdenk6c59edc2004-05-03 20:45:30 +00005820Hit 'b':
5821 [q, b, e, ?] Set interval 1000000 us
5822 Enabling timer
5823Hit '?':
5824 [q, b, e, ?] ........
5825 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5826Hit '?':
5827 [q, b, e, ?] .
5828 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5829Hit '?':
5830 [q, b, e, ?] .
5831 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5832Hit '?':
5833 [q, b, e, ?] .
5834 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5835Hit 'e':
5836 [q, b, e, ?] ...Stopping timer
5837Hit 'q':
5838 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005839
wdenkc6097192002-11-03 00:24:07 +00005840
wdenk6c59edc2004-05-03 20:45:30 +00005841Minicom warning:
5842================
wdenkc6097192002-11-03 00:24:07 +00005843
wdenk6c59edc2004-05-03 20:45:30 +00005844Over time, many people have reported problems when trying to use the
5845"minicom" terminal emulation program for serial download. I (wd)
5846consider minicom to be broken, and recommend not to use it. Under
5847Unix, I recommend to use C-Kermit for general purpose use (and
5848especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005849use "cu" for S-Record download ("loads" command). See
5850http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5851for help with kermit.
5852
wdenkc6097192002-11-03 00:24:07 +00005853
wdenk6c59edc2004-05-03 20:45:30 +00005854Nevertheless, if you absolutely want to use it try adding this
5855configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005856
wdenk6c59edc2004-05-03 20:45:30 +00005857 Name Program Name U/D FullScr IO-Red. Multi
5858 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5859 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005860
wdenk8dba0502003-03-31 16:34:49 +00005861
wdenk6c59edc2004-05-03 20:45:30 +00005862NetBSD Notes:
5863=============
wdenkc6097192002-11-03 00:24:07 +00005864
wdenk6c59edc2004-05-03 20:45:30 +00005865Starting at version 0.9.2, U-Boot supports NetBSD both as host
5866(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005867
wdenk6c59edc2004-05-03 20:45:30 +00005868Building requires a cross environment; it is known to work on
5869NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5870need gmake since the Makefiles are not compatible with BSD make).
5871Note that the cross-powerpc package does not install include files;
5872attempting to build U-Boot will fail because <machine/ansi.h> is
5873missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005874
wdenk6c59edc2004-05-03 20:45:30 +00005875 # cd /usr/pkg/cross/powerpc-netbsd/include
5876 # mkdir powerpc
5877 # ln -s powerpc machine
5878 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5879 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005880
wdenk6c59edc2004-05-03 20:45:30 +00005881Native builds *don't* work due to incompatibilities between native
5882and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005883
wdenk6c59edc2004-05-03 20:45:30 +00005884Booting assumes that (the first part of) the image booted is a
5885stage-2 loader which in turn loads and then invokes the kernel
5886proper. Loader sources will eventually appear in the NetBSD source
5887tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005888meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005889
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk6c59edc2004-05-03 20:45:30 +00005891Implementation Internals:
5892=========================
wdenkc6097192002-11-03 00:24:07 +00005893
wdenk6c59edc2004-05-03 20:45:30 +00005894The following is not intended to be a complete description of every
5895implementation detail. However, it should help to understand the
5896inner workings of U-Boot and make it easier to port it to custom
5897hardware.
wdenkc6097192002-11-03 00:24:07 +00005898
wdenkc6097192002-11-03 00:24:07 +00005899
wdenk6c59edc2004-05-03 20:45:30 +00005900Initial Stack, Global Data:
5901---------------------------
wdenkc6097192002-11-03 00:24:07 +00005902
wdenk6c59edc2004-05-03 20:45:30 +00005903The implementation of U-Boot is complicated by the fact that U-Boot
5904starts running out of ROM (flash memory), usually without access to
5905system RAM (because the memory controller is not initialized yet).
5906This means that we don't have writable Data or BSS segments, and BSS
5907is not initialized as zero. To be able to get a C environment working
5908at all, we have to allocate at least a minimal stack. Implementation
5909options for this are defined and restricted by the CPU used: Some CPU
5910models provide on-chip memory (like the IMMR area on MPC8xx and
5911MPC826x processors), on others (parts of) the data cache can be
5912locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005913
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005914 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005915 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005916
wdenk6c59edc2004-05-03 20:45:30 +00005917 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5918 From: "Chris Hallinan" <clh@net1plus.com>
5919 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5920 ...
wdenkc6097192002-11-03 00:24:07 +00005921
wdenk6c59edc2004-05-03 20:45:30 +00005922 Correct me if I'm wrong, folks, but the way I understand it
5923 is this: Using DCACHE as initial RAM for Stack, etc, does not
5924 require any physical RAM backing up the cache. The cleverness
5925 is that the cache is being used as a temporary supply of
5926 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005927 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005928 can see how this works by studying the cache architecture and
5929 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005930
wdenk6c59edc2004-05-03 20:45:30 +00005931 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5932 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005933 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005934 option should work for you. Using CS 4 should be fine if your
5935 board designers haven't used it for something that would
5936 cause you grief during the initial boot! It is frequently not
5937 used.
wdenkc6097192002-11-03 00:24:07 +00005938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005939 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005940 with your processor/board/system design. The default value
5941 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005942 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005943 than your SDRAM module. If you have a 64MB SDRAM module, set
5944 it above 400_0000. Just make sure your board has no resources
5945 that are supposed to respond to that address! That code in
5946 start.S has been around a while and should work as is when
5947 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005948
wdenk6c59edc2004-05-03 20:45:30 +00005949 -Chris Hallinan
5950 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005951
wdenk6c59edc2004-05-03 20:45:30 +00005952It is essential to remember this, since it has some impact on the C
5953code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005954
wdenk6c59edc2004-05-03 20:45:30 +00005955* Initialized global data (data segment) is read-only. Do not attempt
5956 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005957
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005958* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005959 as zero data - BSS segment) at all - this is undefined, initiali-
5960 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005961
wdenk6c59edc2004-05-03 20:45:30 +00005962* Stack space is very limited. Avoid big data buffers or things like
5963 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005964
wdenk6c59edc2004-05-03 20:45:30 +00005965Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005966normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005967turned out that the implementation of U-Boot can be greatly
5968simplified by making a global data structure (gd_t) available to all
5969functions. We could pass a pointer to this data as argument to _all_
5970functions, but this would bloat the code. Instead we use a feature of
5971the GCC compiler (Global Register Variables) to share the data: we
5972place a pointer (gd) to the global data into a register which we
5973reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005974
wdenk6c59edc2004-05-03 20:45:30 +00005975When choosing a register for such a purpose we are restricted by the
5976relevant (E)ABI specifications for the current architecture, and by
5977GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005978
wdenk6c59edc2004-05-03 20:45:30 +00005979For PowerPC, the following registers have specific use:
5980 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005981 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005982 R3-R4: parameter passing and return values
5983 R5-R10: parameter passing
5984 R13: small data area pointer
5985 R30: GOT pointer
5986 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005987
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005988 (U-Boot also uses R12 as internal GOT pointer. r12
5989 is a volatile register so r12 needs to be reset when
5990 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005991
Wolfgang Denk69c09642008-02-14 22:43:22 +01005992 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005993
wdenk6c59edc2004-05-03 20:45:30 +00005994 Note: on PPC, we could use a static initializer (since the
5995 address of the global data structure is known at compile time),
5996 but it turned out that reserving a register results in somewhat
5997 smaller code - although the code savings are not that big (on
5998 average for all boards 752 bytes for the whole U-Boot image,
5999 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006000
Robin Getz2773d5f2009-08-17 15:23:02 +00006001On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006002 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6003
Robin Getz2773d5f2009-08-17 15:23:02 +00006004 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006005
wdenk6c59edc2004-05-03 20:45:30 +00006006On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006007
wdenk6c59edc2004-05-03 20:45:30 +00006008 R0: function argument word/integer result
6009 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006010 R9: platform specific
6011 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006012 R11: argument (frame) pointer
6013 R12: temporary workspace
6014 R13: stack pointer
6015 R14: link register
6016 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006017
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006018 ==> U-Boot will use R9 to hold a pointer to the global data
6019
6020 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006021
Thomas Chou8fa38582010-05-21 11:08:03 +08006022On Nios II, the ABI is documented here:
6023 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6024
6025 ==> U-Boot will use gp to hold a pointer to the global data
6026
6027 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6028 to access small data sections, so gp is free.
6029
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006030On NDS32, the following registers are used:
6031
6032 R0-R1: argument/return
6033 R2-R5: argument
6034 R15: temporary register for assembler
6035 R16: trampoline register
6036 R28: frame pointer (FP)
6037 R29: global pointer (GP)
6038 R30: link register (LP)
6039 R31: stack pointer (SP)
6040 PC: program counter (PC)
6041
6042 ==> U-Boot will use R10 to hold a pointer to the global data
6043
Wolfgang Denk6405a152006-03-31 18:32:53 +02006044NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6045or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006046
wdenk6c59edc2004-05-03 20:45:30 +00006047Memory Management:
6048------------------
wdenkc6097192002-11-03 00:24:07 +00006049
wdenk6c59edc2004-05-03 20:45:30 +00006050U-Boot runs in system state and uses physical addresses, i.e. the
6051MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006052
wdenk6c59edc2004-05-03 20:45:30 +00006053The available memory is mapped to fixed addresses using the memory
6054controller. In this process, a contiguous block is formed for each
6055memory type (Flash, SDRAM, SRAM), even when it consists of several
6056physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006057
wdenk6c59edc2004-05-03 20:45:30 +00006058U-Boot is installed in the first 128 kB of the first Flash bank (on
6059TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6060booting and sizing and initializing DRAM, the code relocates itself
6061to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006062memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006063configuration setting]. Below that, a structure with global Board
6064Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006065
wdenk6c59edc2004-05-03 20:45:30 +00006066Additionally, some exception handler code is copied to the low 8 kB
6067of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006068
wdenk6c59edc2004-05-03 20:45:30 +00006069So a typical memory configuration with 16 MB of DRAM could look like
6070this:
wdenkc6097192002-11-03 00:24:07 +00006071
wdenk6c59edc2004-05-03 20:45:30 +00006072 0x0000 0000 Exception Vector code
6073 :
6074 0x0000 1FFF
6075 0x0000 2000 Free for Application Use
6076 :
6077 :
wdenkc6097192002-11-03 00:24:07 +00006078
wdenk6c59edc2004-05-03 20:45:30 +00006079 :
6080 :
6081 0x00FB FF20 Monitor Stack (Growing downward)
6082 0x00FB FFAC Board Info Data and permanent copy of global data
6083 0x00FC 0000 Malloc Arena
6084 :
6085 0x00FD FFFF
6086 0x00FE 0000 RAM Copy of Monitor Code
6087 ... eventually: LCD or video framebuffer
6088 ... eventually: pRAM (Protected RAM - unchanged by reset)
6089 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006090
wdenkc6097192002-11-03 00:24:07 +00006091
wdenk6c59edc2004-05-03 20:45:30 +00006092System Initialization:
6093----------------------
wdenkc6097192002-11-03 00:24:07 +00006094
wdenk6c59edc2004-05-03 20:45:30 +00006095In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006096(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006097configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006098To be able to re-map memory U-Boot then jumps to its link address.
6099To be able to implement the initialization code in C, a (small!)
6100initial stack is set up in the internal Dual Ported RAM (in case CPUs
6101which provide such a feature like MPC8xx or MPC8260), or in a locked
6102part of the data cache. After that, U-Boot initializes the CPU core,
6103the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006104
wdenk6c59edc2004-05-03 20:45:30 +00006105Next, all (potentially) available memory banks are mapped using a
6106preliminary mapping. For example, we put them on 512 MB boundaries
6107(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6108on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6109programmed for SDRAM access. Using the temporary configuration, a
6110simple memory test is run that determines the size of the SDRAM
6111banks.
wdenkc6097192002-11-03 00:24:07 +00006112
wdenk6c59edc2004-05-03 20:45:30 +00006113When there is more than one SDRAM bank, and the banks are of
6114different size, the largest is mapped first. For equal size, the first
6115bank (CS2#) is mapped first. The first mapping is always for address
61160x00000000, with any additional banks following immediately to create
6117contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006118
wdenk6c59edc2004-05-03 20:45:30 +00006119Then, the monitor installs itself at the upper end of the SDRAM area
6120and allocates memory for use by malloc() and for the global Board
6121Info data; also, the exception vector code is copied to the low RAM
6122pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006123
wdenk6c59edc2004-05-03 20:45:30 +00006124Only after this relocation will you have a "normal" C environment;
6125until that you are restricted in several ways, mostly because you are
6126running from ROM, and because the code will have to be relocated to a
6127new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006128
wdenkc6097192002-11-03 00:24:07 +00006129
wdenk6c59edc2004-05-03 20:45:30 +00006130U-Boot Porting Guide:
6131----------------------
wdenkc6097192002-11-03 00:24:07 +00006132
wdenk6c59edc2004-05-03 20:45:30 +00006133[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6134list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006135
wdenkc6097192002-11-03 00:24:07 +00006136
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006137int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006138{
6139 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006140
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006141 signal(SIGALRM, no_more_time);
6142 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006143
wdenk6c59edc2004-05-03 20:45:30 +00006144 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006145 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006146 return 0;
6147 }
wdenkc6097192002-11-03 00:24:07 +00006148
wdenk6c59edc2004-05-03 20:45:30 +00006149 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006150
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006151 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006152
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006153 if (clueless)
6154 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006155
wdenk6c59edc2004-05-03 20:45:30 +00006156 while (learning) {
6157 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006158 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6159 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006160 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006161 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006162 }
wdenkc6097192002-11-03 00:24:07 +00006163
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006164 if (available_money > toLocalCurrency ($2500))
6165 Buy a BDI3000;
6166 else
wdenk6c59edc2004-05-03 20:45:30 +00006167 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006168
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006169 if (a similar board exists) { /* hopefully... */
6170 cp -a board/<similar> board/<myboard>
6171 cp include/configs/<similar>.h include/configs/<myboard>.h
6172 } else {
6173 Create your own board support subdirectory;
6174 Create your own board include/configs/<myboard>.h file;
6175 }
6176 Edit new board/<myboard> files
6177 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006178
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006179 while (!accepted) {
6180 while (!running) {
6181 do {
6182 Add / modify source code;
6183 } until (compiles);
6184 Debug;
6185 if (clueless)
6186 email("Hi, I am having problems...");
6187 }
6188 Send patch file to the U-Boot email list;
6189 if (reasonable critiques)
6190 Incorporate improvements from email list code review;
6191 else
6192 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006193 }
wdenkc6097192002-11-03 00:24:07 +00006194
wdenk6c59edc2004-05-03 20:45:30 +00006195 return 0;
6196}
wdenkc6097192002-11-03 00:24:07 +00006197
wdenk6c59edc2004-05-03 20:45:30 +00006198void no_more_time (int sig)
6199{
6200 hire_a_guru();
6201}
wdenkc6097192002-11-03 00:24:07 +00006202
wdenkc6097192002-11-03 00:24:07 +00006203
wdenk6c59edc2004-05-03 20:45:30 +00006204Coding Standards:
6205-----------------
wdenkc6097192002-11-03 00:24:07 +00006206
wdenk6c59edc2004-05-03 20:45:30 +00006207All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006208coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006209"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006210
6211Source files originating from a different project (for example the
6212MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006213reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006214sources.
wdenkc6097192002-11-03 00:24:07 +00006215
Detlev Zundelaa63d482006-09-01 15:39:02 +02006216Please note that U-Boot is implemented in C (and to some small parts in
6217Assembler); no C++ is used, so please do not use C++ style comments (//)
6218in your code.
wdenkad276f22004-01-04 16:28:35 +00006219
wdenk6c59edc2004-05-03 20:45:30 +00006220Please also stick to the following formatting rules:
6221- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006222- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006223- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006224- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006225- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006226
wdenk6c59edc2004-05-03 20:45:30 +00006227Submissions which do not conform to the standards may be returned
6228with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006229
wdenkc6097192002-11-03 00:24:07 +00006230
wdenk6c59edc2004-05-03 20:45:30 +00006231Submitting Patches:
6232-------------------
wdenkc6097192002-11-03 00:24:07 +00006233
wdenk6c59edc2004-05-03 20:45:30 +00006234Since the number of patches for U-Boot is growing, we need to
6235establish some rules. Submissions which do not conform to these rules
6236may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006237
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006238Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006239
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006240Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6241see http://lists.denx.de/mailman/listinfo/u-boot
6242
wdenk6c59edc2004-05-03 20:45:30 +00006243When you send a patch, please include the following information with
6244it:
wdenkc6097192002-11-03 00:24:07 +00006245
wdenk6c59edc2004-05-03 20:45:30 +00006246* For bug fixes: a description of the bug and how your patch fixes
6247 this bug. Please try to include a way of demonstrating that the
6248 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006249
wdenk6c59edc2004-05-03 20:45:30 +00006250* For new features: a description of the feature and your
6251 implementation.
wdenkc6097192002-11-03 00:24:07 +00006252
wdenk6c59edc2004-05-03 20:45:30 +00006253* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006254
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006255* For major contributions, add a MAINTAINERS file with your
6256 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006257
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006258* When you add support for a new board, don't forget to add a
6259 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006260
wdenk6c59edc2004-05-03 20:45:30 +00006261* If your patch adds new configuration options, don't forget to
6262 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006263
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006264* The patch itself. If you are using git (which is *strongly*
6265 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006266 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006267 the U-Boot mailing list, you will avoid most of the common problems
6268 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006269
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006270 If you cannot use git, use "diff -purN OLD NEW". If your version of
6271 diff does not support these options, then get the latest version of
6272 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006273
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006274 The current directory when running this command shall be the parent
6275 directory of the U-Boot source tree (i. e. please make sure that
6276 your patch includes sufficient directory information for the
6277 affected files).
6278
6279 We prefer patches as plain text. MIME attachments are discouraged,
6280 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006281
wdenk6c59edc2004-05-03 20:45:30 +00006282* If one logical set of modifications affects or creates several
6283 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006284
wdenk6c59edc2004-05-03 20:45:30 +00006285* Changesets that contain different, unrelated modifications shall be
6286 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006287
wdenkc6097192002-11-03 00:24:07 +00006288
wdenk6c59edc2004-05-03 20:45:30 +00006289Notes:
wdenkc6097192002-11-03 00:24:07 +00006290
Simon Glassdc27def2016-07-27 20:33:08 -06006291* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006292 source tree and make sure that no errors or warnings are reported
6293 for any of the boards.
6294
6295* Keep your modifications to the necessary minimum: A patch
6296 containing several unrelated changes or arbitrary reformats will be
6297 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006298
wdenk6c59edc2004-05-03 20:45:30 +00006299* If you modify existing code, make sure that your new code does not
6300 add to the memory footprint of the code ;-) Small is beautiful!
6301 When adding new features, these should compile conditionally only
6302 (using #ifdef), and the resulting code with the new feature
6303 disabled must not need more memory than the old code without your
6304 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006305
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006306* Remember that there is a size limit of 100 kB per message on the
6307 u-boot mailing list. Bigger patches will be moderated. If they are
6308 reasonable and not too big, they will be acknowledged. But patches
6309 bigger than the size limit should be avoided.