blob: 5a892b33c7f7501dc8cfd98c13b5b3c8607c7b72 [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
1696
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001697 CONFIG_LCD_ROTATION
1698
1699 Sometimes, for example if the display is mounted in portrait
1700 mode or even if it's mounted landscape but rotated by 180degree,
1701 we need to rotate our content of the display relative to the
1702 framebuffer, so that user can read the messages which are
1703 printed out.
1704 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1705 initialized with a given rotation from "vl_rot" out of
1706 "vidinfo_t" which is provided by the board specific code.
1707 The value for vl_rot is coded as following (matching to
1708 fbcon=rotate:<n> linux-kernel commandline):
1709 0 = no rotation respectively 0 degree
1710 1 = 90 degree rotation
1711 2 = 180 degree rotation
1712 3 = 270 degree rotation
1713
1714 If CONFIG_LCD_ROTATION is not defined, the console will be
1715 initialized with 0degree rotation.
1716
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001717 CONFIG_LCD_BMP_RLE8
1718
1719 Support drawing of RLE8-compressed bitmaps on the LCD.
1720
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001721 CONFIG_I2C_EDID
1722
1723 Enables an 'i2c edid' command which can read EDID
1724 information over I2C from an attached LCD display.
1725
wdenkeb20ad32003-09-05 23:19:14 +00001726- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001727
wdenk57b2d802003-06-27 21:31:46 +00001728 If this option is set, the environment is checked for
1729 a variable "splashimage". If found, the usual display
1730 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001731 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001732 specified in "splashimage" is loaded instead. The
1733 console is redirected to the "nulldev", too. This
1734 allows for a "silent" boot where a splash screen is
1735 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001736
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001737 CONFIG_SPLASHIMAGE_GUARD
1738
1739 If this option is set, then U-Boot will prevent the environment
1740 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001741 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001742 This option is useful for targets where, due to alignment
1743 restrictions, an improperly aligned BMP image will cause a data
1744 abort. If you think you will not have problems with unaligned
1745 accesses (for example because your toolchain prevents them)
1746 there is no need to set this option.
1747
Matthias Weisser53884182009-07-09 16:07:30 +02001748 CONFIG_SPLASH_SCREEN_ALIGN
1749
1750 If this option is set the splash image can be freely positioned
1751 on the screen. Environment variable "splashpos" specifies the
1752 position as "x,y". If a positive number is given it is used as
1753 number of pixel from left/top. If a negative number is given it
1754 is used as number of pixel from right/bottom. You can also
1755 specify 'm' for centering the image.
1756
1757 Example:
1758 setenv splashpos m,m
1759 => image at center of screen
1760
1761 setenv splashpos 30,20
1762 => image at x = 30 and y = 20
1763
1764 setenv splashpos -10,m
1765 => vertically centered image
1766 at x = dspWidth - bmpWidth - 9
1767
Stefan Roesed9d97742005-09-22 09:04:17 +02001768- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1769
1770 If this option is set, additionally to standard BMP
1771 images, gzipped BMP images can be displayed via the
1772 splashscreen support or the bmp command.
1773
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001774- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1775
1776 If this option is set, 8-bit RLE compressed BMP images
1777 can be displayed via the splashscreen support or the
1778 bmp command.
1779
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001780- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001781 CONFIG_CMD_ZIP
1782
1783 If this option is set, it would use zlib deflate method
1784 to compress the specified memory at its best effort.
1785
wdenk710e3502003-08-29 20:57:53 +00001786- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001787 CONFIG_GZIP
1788
1789 Enabled by default to support gzip compressed images.
1790
wdenk710e3502003-08-29 20:57:53 +00001791 CONFIG_BZIP2
1792
1793 If this option is set, support for bzip2 compressed
1794 images is included. If not, only uncompressed and gzip
1795 compressed images are supported.
1796
wdenk9c53f402003-10-15 23:53:47 +00001797 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001798 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001799 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001800
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001801 CONFIG_LZMA
1802
1803 If this option is set, support for lzma compressed
1804 images is included.
1805
1806 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1807 requires an amount of dynamic memory that is given by the
1808 formula:
1809
1810 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1811
1812 Where lc and lp stand for, respectively, Literal context bits
1813 and Literal pos bits.
1814
1815 This value is upper-bounded by 14MB in the worst case. Anyway,
1816 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1817 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1818 a very small buffer.
1819
1820 Use the lzmainfo tool to determinate the lc and lp values and
1821 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001822 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001823
Kees Cook5b06e642013-08-16 07:59:12 -07001824 CONFIG_LZO
1825
1826 If this option is set, support for LZO compressed images
1827 is included.
1828
wdenk0e2bd9c2004-06-06 21:51:03 +00001829- MII/PHY support:
1830 CONFIG_PHY_ADDR
1831
1832 The address of PHY on MII bus.
1833
1834 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1835
1836 The clock frequency of the MII bus
1837
1838 CONFIG_PHY_GIGE
1839
1840 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001841 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001842
1843 CONFIG_PHY_RESET_DELAY
1844
1845 Some PHY like Intel LXT971A need extra delay after
1846 reset before any MII register access is possible.
1847 For such PHY, set this option to the usec delay
1848 required. (minimum 300usec for LXT971A)
1849
1850 CONFIG_PHY_CMD_DELAY (ppc4xx)
1851
1852 Some PHY like Intel LXT971A need extra delay after
1853 command issued before MII status register can be read
1854
wdenkc6097192002-11-03 00:24:07 +00001855- IP address:
1856 CONFIG_IPADDR
1857
1858 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001859 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001860 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001861 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001862
1863- Server IP address:
1864 CONFIG_SERVERIP
1865
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001866 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001867 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001868 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001869
Robin Getz470a6d42009-07-21 12:15:28 -04001870 CONFIG_KEEP_SERVERADDR
1871
1872 Keeps the server's MAC address, in the env 'serveraddr'
1873 for passing to bootargs (like Linux's netconsole option)
1874
Wolfgang Denk26da2992011-10-26 10:21:22 +00001875- Gateway IP address:
1876 CONFIG_GATEWAYIP
1877
1878 Defines a default value for the IP address of the
1879 default router where packets to other networks are
1880 sent to.
1881 (Environment variable "gatewayip")
1882
1883- Subnet mask:
1884 CONFIG_NETMASK
1885
1886 Defines a default value for the subnet mask (or
1887 routing prefix) which is used to determine if an IP
1888 address belongs to the local subnet or needs to be
1889 forwarded through a router.
1890 (Environment variable "netmask")
1891
David Updegraff7280da72007-06-11 10:41:07 -05001892- Multicast TFTP Mode:
1893 CONFIG_MCAST_TFTP
1894
1895 Defines whether you want to support multicast TFTP as per
1896 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001897 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001898 driver in use must provide a function: mcast() to join/leave a
1899 multicast group.
1900
wdenkc6097192002-11-03 00:24:07 +00001901- BOOTP Recovery Mode:
1902 CONFIG_BOOTP_RANDOM_DELAY
1903
1904 If you have many targets in a network that try to
1905 boot using BOOTP, you may want to avoid that all
1906 systems send out BOOTP requests at precisely the same
1907 moment (which would happen for instance at recovery
1908 from a power failure, when all systems will try to
1909 boot, thus flooding the BOOTP server. Defining
1910 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1911 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001912 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001913
1914 1st BOOTP request: delay 0 ... 1 sec
1915 2nd BOOTP request: delay 0 ... 2 sec
1916 3rd BOOTP request: delay 0 ... 4 sec
1917 4th and following
1918 BOOTP requests: delay 0 ... 8 sec
1919
Thierry Reding8977cda2014-08-19 10:21:24 +02001920 CONFIG_BOOTP_ID_CACHE_SIZE
1921
1922 BOOTP packets are uniquely identified using a 32-bit ID. The
1923 server will copy the ID from client requests to responses and
1924 U-Boot will use this to determine if it is the destination of
1925 an incoming response. Some servers will check that addresses
1926 aren't in use before handing them out (usually using an ARP
1927 ping) and therefore take up to a few hundred milliseconds to
1928 respond. Network congestion may also influence the time it
1929 takes for a response to make it back to the client. If that
1930 time is too long, U-Boot will retransmit requests. In order
1931 to allow earlier responses to still be accepted after these
1932 retransmissions, U-Boot's BOOTP client keeps a small cache of
1933 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1934 cache. The default is to keep IDs for up to four outstanding
1935 requests. Increasing this will allow U-Boot to accept offers
1936 from a BOOTP client in networks with unusually high latency.
1937
stroesee0aadfb2003-08-28 14:17:32 +00001938- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001939 You can fine tune the DHCP functionality by defining
1940 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001941
Jon Loeliger5336a762007-07-09 22:08:34 -05001942 CONFIG_BOOTP_SUBNETMASK
1943 CONFIG_BOOTP_GATEWAY
1944 CONFIG_BOOTP_HOSTNAME
1945 CONFIG_BOOTP_NISDOMAIN
1946 CONFIG_BOOTP_BOOTPATH
1947 CONFIG_BOOTP_BOOTFILESIZE
1948 CONFIG_BOOTP_DNS
1949 CONFIG_BOOTP_DNS2
1950 CONFIG_BOOTP_SEND_HOSTNAME
1951 CONFIG_BOOTP_NTPSERVER
1952 CONFIG_BOOTP_TIMEOFFSET
1953 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001954 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001955
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001956 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1957 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001958
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001959 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1960 after the configured retry count, the call will fail
1961 instead of starting over. This can be used to fail over
1962 to Link-local IP address configuration if the DHCP server
1963 is not available.
1964
stroesee0aadfb2003-08-28 14:17:32 +00001965 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1966 serverip from a DHCP server, it is possible that more
1967 than one DNS serverip is offered to the client.
1968 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1969 serverip will be stored in the additional environment
1970 variable "dnsip2". The first DNS serverip is always
1971 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001972 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001973
1974 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1975 to do a dynamic update of a DNS server. To do this, they
1976 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001977 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001978 of the "hostname" environment variable is passed as
1979 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001980
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001981 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1982
1983 A 32bit value in microseconds for a delay between
1984 receiving a "DHCP Offer" and sending the "DHCP Request".
1985 This fixes a problem with certain DHCP servers that don't
1986 respond 100% of the time to a "DHCP request". E.g. On an
1987 AT91RM9200 processor running at 180MHz, this delay needed
1988 to be *at least* 15,000 usec before a Windows Server 2003
1989 DHCP server would reply 100% of the time. I recommend at
1990 least 50,000 usec to be safe. The alternative is to hope
1991 that one of the retries will be successful but note that
1992 the DHCP timeout and retry process takes a longer than
1993 this delay.
1994
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001995 - Link-local IP address negotiation:
1996 Negotiate with other link-local clients on the local network
1997 for an address that doesn't require explicit configuration.
1998 This is especially useful if a DHCP server cannot be guaranteed
1999 to exist in all environments that the device must operate.
2000
2001 See doc/README.link-local for more information.
2002
wdenk145d2c12004-04-15 21:48:45 +00002003 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002004 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002005
2006 The device id used in CDP trigger frames.
2007
2008 CONFIG_CDP_DEVICE_ID_PREFIX
2009
2010 A two character string which is prefixed to the MAC address
2011 of the device.
2012
2013 CONFIG_CDP_PORT_ID
2014
2015 A printf format string which contains the ascii name of
2016 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002017 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002018
2019 CONFIG_CDP_CAPABILITIES
2020
2021 A 32bit integer which indicates the device capabilities;
2022 0x00000010 for a normal host which does not forwards.
2023
2024 CONFIG_CDP_VERSION
2025
2026 An ascii string containing the version of the software.
2027
2028 CONFIG_CDP_PLATFORM
2029
2030 An ascii string containing the name of the platform.
2031
2032 CONFIG_CDP_TRIGGER
2033
2034 A 32bit integer sent on the trigger.
2035
2036 CONFIG_CDP_POWER_CONSUMPTION
2037
2038 A 16bit integer containing the power consumption of the
2039 device in .1 of milliwatts.
2040
2041 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2042
2043 A byte containing the id of the VLAN.
2044
wdenkc6097192002-11-03 00:24:07 +00002045- Status LED: CONFIG_STATUS_LED
2046
2047 Several configurations allow to display the current
2048 status using a LED. For instance, the LED will blink
2049 fast while running U-Boot code, stop blinking as
2050 soon as a reply to a BOOTP request was received, and
2051 start blinking slow once the Linux kernel is running
2052 (supported by a status LED driver in the Linux
2053 kernel). Defining CONFIG_STATUS_LED enables this
2054 feature in U-Boot.
2055
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002056 Additional options:
2057
2058 CONFIG_GPIO_LED
2059 The status LED can be connected to a GPIO pin.
2060 In such cases, the gpio_led driver can be used as a
2061 status LED backend implementation. Define CONFIG_GPIO_LED
2062 to include the gpio_led driver in the U-Boot binary.
2063
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002064 CONFIG_GPIO_LED_INVERTED_TABLE
2065 Some GPIO connected LEDs may have inverted polarity in which
2066 case the GPIO high value corresponds to LED off state and
2067 GPIO low value corresponds to LED on state.
2068 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2069 with a list of GPIO LEDs that have inverted polarity.
2070
wdenkc6097192002-11-03 00:24:07 +00002071- CAN Support: CONFIG_CAN_DRIVER
2072
2073 Defining CONFIG_CAN_DRIVER enables CAN driver support
2074 on those systems that support this (optional)
2075 feature, like the TQM8xxL modules.
2076
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002077- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002078
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002079 This enable the NEW i2c subsystem, and will allow you to use
2080 i2c commands at the u-boot command line (as long as you set
2081 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2082 based realtime clock chips or other i2c devices. See
2083 common/cmd_i2c.c for a description of the command line
2084 interface.
2085
2086 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002087 - drivers/i2c/soft_i2c.c:
2088 - activate first bus with CONFIG_SYS_I2C_SOFT define
2089 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2090 for defining speed and slave address
2091 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2092 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2093 for defining speed and slave address
2094 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2095 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2096 for defining speed and slave address
2097 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2098 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2099 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002100
Heiko Schocherf2850742012-10-24 13:48:22 +02002101 - drivers/i2c/fsl_i2c.c:
2102 - activate i2c driver with CONFIG_SYS_I2C_FSL
2103 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2104 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2105 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2106 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002107 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002108 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2109 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2110 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2111 second bus.
2112
Simon Glass026fefb2012-10-30 07:28:53 +00002113 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002114 - activate this driver with CONFIG_SYS_I2C_TEGRA
2115 - This driver adds 4 i2c buses with a fix speed from
2116 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002117
Dirk Eibach42b204f2013-04-25 02:40:01 +00002118 - drivers/i2c/ppc4xx_i2c.c
2119 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2120 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2121 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2122
trema49f40a2013-09-21 18:13:35 +02002123 - drivers/i2c/i2c_mxc.c
2124 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002125 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2126 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2127 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2128 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002129 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2130 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2131 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2132 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2133 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2134 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002135 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2136 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002137 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002138 for speed, and 0 for slave.
2139
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002140 - drivers/i2c/rcar_i2c.c:
2141 - activate this driver with CONFIG_SYS_I2C_RCAR
2142 - This driver adds 4 i2c buses
2143
2144 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2145 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2146 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2147 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2148 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2149 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2150 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2151 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2152 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2153
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002154 - drivers/i2c/sh_i2c.c:
2155 - activate this driver with CONFIG_SYS_I2C_SH
2156 - This driver adds from 2 to 5 i2c buses
2157
2158 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2159 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2160 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2161 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2162 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2163 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2164 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2165 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2166 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2167 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002168 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002169
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002170 - drivers/i2c/omap24xx_i2c.c
2171 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2172 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2173 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2174 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2175 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2176 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2177 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2178 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2179 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2180 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2181 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2182
Heiko Schocher465819a2013-11-08 07:30:53 +01002183 - drivers/i2c/zynq_i2c.c
2184 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2185 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2186 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2187
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302188 - drivers/i2c/s3c24x0_i2c.c:
2189 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2190 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2191 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2192 with a fix speed from 100000 and the slave addr 0!
2193
Dirk Eibachb9577432014-07-03 09:28:18 +02002194 - drivers/i2c/ihs_i2c.c
2195 - activate this driver with CONFIG_SYS_I2C_IHS
2196 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2197 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2198 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2199 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2200 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2201 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2202 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2203 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2204 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2205 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2206 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2207 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002208 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2209 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2210 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2211 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2212 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2213 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2214 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2215 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2216 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002217
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002218 additional defines:
2219
2220 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002221 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002222
2223 CONFIG_SYS_I2C_DIRECT_BUS
2224 define this, if you don't use i2c muxes on your hardware.
2225 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2226 omit this define.
2227
2228 CONFIG_SYS_I2C_MAX_HOPS
2229 define how many muxes are maximal consecutively connected
2230 on one i2c bus. If you not use i2c muxes, omit this
2231 define.
2232
2233 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002234 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002235 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2236 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2237 CONFIG_SYS_NUM_I2C_BUSES = 9:
2238
2239 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2240 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2241 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2242 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2243 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2244 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2245 {1, {I2C_NULL_HOP}}, \
2246 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2247 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2248 }
2249
2250 which defines
2251 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002252 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2253 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2254 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2255 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2256 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002257 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002258 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2259 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002260
2261 If you do not have i2c muxes on your board, omit this define.
2262
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002263- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002264
2265 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2266 provides the following compelling advantages:
2267
2268 - more than one i2c adapter is usable
2269 - approved multibus support
2270 - better i2c mux support
2271
2272 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002273
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002274 These enable legacy I2C serial bus commands. Defining
2275 CONFIG_HARD_I2C will include the appropriate I2C driver
2276 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002277
wdenk21136db2003-07-16 21:53:01 +00002278 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002279 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002280 CONFIG_COMMANDS) and communicate with i2c based realtime
2281 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002282 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002283
Ben Warren45657152006-09-07 16:50:54 -04002284 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002285
wdenk21136db2003-07-16 21:53:01 +00002286 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002287 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002288
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002289 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002290 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002291 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002292 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002293
Peter Tysere4d1abc2010-04-12 22:28:21 -05002294 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002295 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002296 and so its address should therefore be cleared to 0 (See,
2297 eg, MPC823e User's Manual p.16-473). So, set
2298 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002299
Eric Millbrandt12990a42009-09-03 08:09:44 -05002300 CONFIG_SYS_I2C_INIT_MPC5XXX
2301
2302 When a board is reset during an i2c bus transfer
2303 chips might think that the current transfer is still
2304 in progress. Reset the slave devices by sending start
2305 commands until the slave device responds.
2306
wdenk21136db2003-07-16 21:53:01 +00002307 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002308
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002309 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002310 then the following macros need to be defined (examples are
2311 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002312
2313 I2C_INIT
2314
wdenkb9bbd242003-06-30 16:24:52 +00002315 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002316 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002317
wdenk544e9732004-02-06 23:19:44 +00002318 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002319
wdenkc6097192002-11-03 00:24:07 +00002320 I2C_PORT
2321
wdenk4a5c8a72003-03-06 00:02:04 +00002322 (Only for MPC8260 CPU). The I/O port to use (the code
2323 assumes both bits are on the same port). Valid values
2324 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002325
2326 I2C_ACTIVE
2327
2328 The code necessary to make the I2C data line active
2329 (driven). If the data line is open collector, this
2330 define can be null.
2331
wdenkb9bbd242003-06-30 16:24:52 +00002332 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2333
wdenkc6097192002-11-03 00:24:07 +00002334 I2C_TRISTATE
2335
2336 The code necessary to make the I2C data line tri-stated
2337 (inactive). If the data line is open collector, this
2338 define can be null.
2339
wdenkb9bbd242003-06-30 16:24:52 +00002340 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2341
wdenkc6097192002-11-03 00:24:07 +00002342 I2C_READ
2343
York Sun4a598092013-04-01 11:29:11 -07002344 Code that returns true if the I2C data line is high,
2345 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002346
wdenkb9bbd242003-06-30 16:24:52 +00002347 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2348
wdenkc6097192002-11-03 00:24:07 +00002349 I2C_SDA(bit)
2350
York Sun4a598092013-04-01 11:29:11 -07002351 If <bit> is true, sets the I2C data line high. If it
2352 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002353
wdenkb9bbd242003-06-30 16:24:52 +00002354 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002355 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002356 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002357
wdenkc6097192002-11-03 00:24:07 +00002358 I2C_SCL(bit)
2359
York Sun4a598092013-04-01 11:29:11 -07002360 If <bit> is true, sets the I2C clock line high. If it
2361 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002362
wdenkb9bbd242003-06-30 16:24:52 +00002363 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002364 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002365 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002366
wdenkc6097192002-11-03 00:24:07 +00002367 I2C_DELAY
2368
2369 This delay is invoked four times per clock cycle so this
2370 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002371 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002372 like:
2373
wdenkb9bbd242003-06-30 16:24:52 +00002374 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002375
Mike Frysingeree12d542010-07-21 13:38:02 -04002376 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2377
2378 If your arch supports the generic GPIO framework (asm/gpio.h),
2379 then you may alternatively define the two GPIOs that are to be
2380 used as SCL / SDA. Any of the previous I2C_xxx macros will
2381 have GPIO-based defaults assigned to them as appropriate.
2382
2383 You should define these to the GPIO value as given directly to
2384 the generic GPIO functions.
2385
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002386 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002387
wdenk57b2d802003-06-27 21:31:46 +00002388 When a board is reset during an i2c bus transfer
2389 chips might think that the current transfer is still
2390 in progress. On some boards it is possible to access
2391 the i2c SCLK line directly, either by using the
2392 processor pin as a GPIO or by having a second pin
2393 connected to the bus. If this option is defined a
2394 custom i2c_init_board() routine in boards/xxx/board.c
2395 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002396
Richard Retanubundf0149c2010-04-12 15:08:17 -04002397 CONFIG_SYS_I2C_BOARD_LATE_INIT
2398
2399 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2400 defined a custom i2c_board_late_init() routine in
2401 boards/xxx/board.c is run AFTER the operations in i2c_init()
2402 is completed. This callpoint can be used to unreset i2c bus
2403 using CPU i2c controller register accesses for CPUs whose i2c
2404 controller provide such a method. It is called at the end of
2405 i2c_init() to allow i2c_init operations to setup the i2c bus
2406 controller on the CPU (e.g. setting bus speed & slave address).
2407
wdenk0e2bd9c2004-06-06 21:51:03 +00002408 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2409
2410 This option enables configuration of bi_iic_fast[] flags
2411 in u-boot bd_info structure based on u-boot environment
2412 variable "i2cfast". (see also i2cfast)
2413
Ben Warren45657152006-09-07 16:50:54 -04002414 CONFIG_I2C_MULTI_BUS
2415
2416 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002417 must have a controller. At any point in time, only one bus is
2418 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002419 Note that bus numbering is zero-based.
2420
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002421 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002422
2423 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002424 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002425 is set, specify a list of bus-device pairs. Otherwise, specify
2426 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002427
2428 e.g.
2429 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002430 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002431
2432 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2433
Wolfgang Denk092ae952011-10-26 10:21:21 +00002434 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002435 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002436
2437 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002439 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002440
2441 If defined, then this indicates the I2C bus number for DDR SPD.
2442 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2443
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002444 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002445
2446 If defined, then this indicates the I2C bus number for the RTC.
2447 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2448
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002449 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002450
2451 If defined, then this indicates the I2C bus number for the DTT.
2452 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2453
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002454 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002455
2456 If defined, specifies the I2C address of the DTT device.
2457 If not defined, then U-Boot uses predefined value for
2458 specified DTT device.
2459
Andrew Dyer58c41f92008-12-29 17:36:01 -06002460 CONFIG_SOFT_I2C_READ_REPEATED_START
2461
2462 defining this will force the i2c_read() function in
2463 the soft_i2c driver to perform an I2C repeated start
2464 between writing the address pointer and reading the
2465 data. If this define is omitted the default behaviour
2466 of doing a stop-start sequence will be used. Most I2C
2467 devices can use either method, but some require one or
2468 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002469
wdenkc6097192002-11-03 00:24:07 +00002470- SPI Support: CONFIG_SPI
2471
2472 Enables SPI driver (so far only tested with
2473 SPI EEPROM, also an instance works with Crystal A/D and
2474 D/As on the SACSng board)
2475
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002476 CONFIG_SH_SPI
2477
2478 Enables the driver for SPI controller on SuperH. Currently
2479 only SH7757 is supported.
2480
wdenkc6097192002-11-03 00:24:07 +00002481 CONFIG_SOFT_SPI
2482
wdenk4a5c8a72003-03-06 00:02:04 +00002483 Enables a software (bit-bang) SPI driver rather than
2484 using hardware support. This is a general purpose
2485 driver that only requires three general I/O port pins
2486 (two outputs, one input) to function. If this is
2487 defined, the board configuration must define several
2488 SPI configuration items (port pins to use, etc). For
2489 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002490
Ben Warren7efe9272008-01-16 22:37:35 -05002491 CONFIG_HARD_SPI
2492
2493 Enables a hardware SPI driver for general-purpose reads
2494 and writes. As with CONFIG_SOFT_SPI, the board configuration
2495 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002496 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002497 example, see include/configs/mpc8349emds.h.
2498
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002499 CONFIG_MXC_SPI
2500
2501 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002502 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002503
Heiko Schocherb77c8882014-07-14 10:22:11 +02002504 CONFIG_SYS_SPI_MXC_WAIT
2505 Timeout for waiting until spi transfer completed.
2506 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2507
Matthias Fuchsa4400872007-12-27 17:12:34 +01002508- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002509
Matthias Fuchsa4400872007-12-27 17:12:34 +01002510 Enables FPGA subsystem.
2511
2512 CONFIG_FPGA_<vendor>
2513
2514 Enables support for specific chip vendors.
2515 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002516
Matthias Fuchsa4400872007-12-27 17:12:34 +01002517 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002518
Matthias Fuchsa4400872007-12-27 17:12:34 +01002519 Enables support for FPGA family.
2520 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2521
2522 CONFIG_FPGA_COUNT
2523
2524 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002525
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302526 CONFIG_CMD_FPGA_LOADMK
2527
2528 Enable support for fpga loadmk command
2529
Michal Simek64c70982014-05-02 13:43:39 +02002530 CONFIG_CMD_FPGA_LOADP
2531
2532 Enable support for fpga loadp command - load partial bitstream
2533
2534 CONFIG_CMD_FPGA_LOADBP
2535
2536 Enable support for fpga loadbp command - load partial bitstream
2537 (Xilinx only)
2538
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002539 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002540
wdenk57b2d802003-06-27 21:31:46 +00002541 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002542
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002543 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002544
wdenk4a5c8a72003-03-06 00:02:04 +00002545 Enable checks on FPGA configuration interface busy
2546 status by the configuration function. This option
2547 will require a board or device specific function to
2548 be written.
wdenkc6097192002-11-03 00:24:07 +00002549
2550 CONFIG_FPGA_DELAY
2551
2552 If defined, a function that provides delays in the FPGA
2553 configuration driver.
2554
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002555 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002556 Allow Control-C to interrupt FPGA configuration
2557
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002558 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002559
wdenk4a5c8a72003-03-06 00:02:04 +00002560 Check for configuration errors during FPGA bitfile
2561 loading. For example, abort during Virtex II
2562 configuration if the INIT_B line goes low (which
2563 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002565 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002566
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002567 Maximum time to wait for the INIT_B line to de-assert
2568 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002569 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002570 ms.
wdenkc6097192002-11-03 00:24:07 +00002571
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002572 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002573
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002574 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002575 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002577 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002578
wdenk4a5c8a72003-03-06 00:02:04 +00002579 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002580 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002581
2582- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002583 CONFIG_BUILD_TARGET
2584
2585 Some SoCs need special image types (e.g. U-Boot binary
2586 with a special header) as build targets. By defining
2587 CONFIG_BUILD_TARGET in the SoC / board header, this
2588 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002589 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002590
wdenkc6097192002-11-03 00:24:07 +00002591 CONFIG_IDENT_STRING
2592
wdenk4a5c8a72003-03-06 00:02:04 +00002593 If defined, this string will be added to the U-Boot
2594 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002595
2596- Vendor Parameter Protection:
2597
wdenk4a5c8a72003-03-06 00:02:04 +00002598 U-Boot considers the values of the environment
2599 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002600 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002601 are set once by the board vendor / manufacturer, and
2602 protects these variables from casual modification by
2603 the user. Once set, these variables are read-only,
2604 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002605 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002606
2607 If CONFIG_ENV_OVERWRITE is #defined in your config
2608 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002609 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002610 these parameters.
2611
Joe Hershberger76f353e2015-05-04 14:55:14 -05002612 Alternatively, if you define _both_ an ethaddr in the
2613 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002614 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002615 which can be changed exactly ONCE by the user. [The
2616 serial# is unaffected by this, i. e. it remains
2617 read-only.]
2618
Joe Hershberger71497d02012-12-11 22:16:31 -06002619 The same can be accomplished in a more flexible way
2620 for any variable by configuring the type of access
2621 to allow for those variables in the ".flags" variable
2622 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2623
wdenkc6097192002-11-03 00:24:07 +00002624- Protected RAM:
2625 CONFIG_PRAM
2626
2627 Define this variable to enable the reservation of
2628 "protected RAM", i. e. RAM which is not overwritten
2629 by U-Boot. Define CONFIG_PRAM to hold the number of
2630 kB you want to reserve for pRAM. You can overwrite
2631 this default value by defining an environment
2632 variable "pram" to the number of kB you want to
2633 reserve. Note that the board info structure will
2634 still show the full amount of RAM. If pRAM is
2635 reserved, a new environment variable "mem" will
2636 automatically be defined to hold the amount of
2637 remaining RAM in a form that can be passed as boot
2638 argument to Linux, for instance like that:
2639
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002640 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002641 saveenv
2642
2643 This way you can tell Linux not to use this memory,
2644 either, which results in a memory region that will
2645 not be affected by reboots.
2646
2647 *WARNING* If your board configuration uses automatic
2648 detection of the RAM size, you must make sure that
2649 this memory test is non-destructive. So far, the
2650 following board configurations are known to be
2651 "pRAM-clean":
2652
Wolfgang Denk90326762012-10-24 02:36:15 +00002653 IVMS8, IVML24, SPD8xx, TQM8xxL,
2654 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002655 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002656
Gabe Blacka2f3a932012-12-02 04:55:18 +00002657- Access to physical memory region (> 4GB)
2658 Some basic support is provided for operations on memory not
2659 normally accessible to U-Boot - e.g. some architectures
2660 support access to more than 4GB of memory on 32-bit
2661 machines using physical address extension or similar.
2662 Define CONFIG_PHYSMEM to access this basic support, which
2663 currently only supports clearing the memory.
2664
wdenkc6097192002-11-03 00:24:07 +00002665- Error Recovery:
2666 CONFIG_PANIC_HANG
2667
2668 Define this variable to stop the system in case of a
2669 fatal error, so that you have to reset it manually.
2670 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002671 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002672 automatically as fast as possible, but it may be
2673 useful during development since you can try to debug
2674 the conditions that lead to the situation.
2675
2676 CONFIG_NET_RETRY_COUNT
2677
wdenk4a5c8a72003-03-06 00:02:04 +00002678 This variable defines the number of retries for
2679 network operations like ARP, RARP, TFTP, or BOOTP
2680 before giving up the operation. If not defined, a
2681 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002682
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002683 CONFIG_ARP_TIMEOUT
2684
2685 Timeout waiting for an ARP reply in milliseconds.
2686
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002687 CONFIG_NFS_TIMEOUT
2688
2689 Timeout in milliseconds used in NFS protocol.
2690 If you encounter "ERROR: Cannot umount" in nfs command,
2691 try longer timeout such as
2692 #define CONFIG_NFS_TIMEOUT 10000UL
2693
wdenkc6097192002-11-03 00:24:07 +00002694- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002695 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002696
2697 Enable auto completion of commands using TAB.
2698
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002699 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002700
2701 This defines the secondary prompt string, which is
2702 printed when the command interpreter needs more input
2703 to complete a command. Usually "> ".
2704
2705 Note:
2706
wdenk57b2d802003-06-27 21:31:46 +00002707 In the current implementation, the local variables
2708 space and global environment variables space are
2709 separated. Local variables are those you define by
2710 simply typing `name=value'. To access a local
2711 variable later on, you have write `$name' or
2712 `${name}'; to execute the contents of a variable
2713 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002714
wdenk4a5c8a72003-03-06 00:02:04 +00002715 Global environment variables are those you use
2716 setenv/printenv to work with. To run a command stored
2717 in such a variable, you need to use the run command,
2718 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002719
2720 To store commands and special characters in a
2721 variable, please use double quotation marks
2722 surrounding the whole text of the variable, instead
2723 of the backslashes before semicolons and special
2724 symbols.
2725
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002726- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002727 CONFIG_CMDLINE_EDITING
2728
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002729 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002730 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002731
Marek Vasut734fb042016-01-27 04:47:55 +01002732- Command Line PS1/PS2 support:
2733 CONFIG_CMDLINE_PS_SUPPORT
2734
2735 Enable support for changing the command prompt string
2736 at run-time. Only static string is supported so far.
2737 The string is obtained from environment variables PS1
2738 and PS2.
2739
wdenkc0aa5c52003-12-06 19:49:23 +00002740- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002741 CONFIG_EXTRA_ENV_SETTINGS
2742
wdenk4a5c8a72003-03-06 00:02:04 +00002743 Define this to contain any number of null terminated
2744 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002745 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002746
wdenk4a5c8a72003-03-06 00:02:04 +00002747 For example, place something like this in your
2748 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002749
2750 #define CONFIG_EXTRA_ENV_SETTINGS \
2751 "myvar1=value1\0" \
2752 "myvar2=value2\0"
2753
wdenk4a5c8a72003-03-06 00:02:04 +00002754 Warning: This method is based on knowledge about the
2755 internal format how the environment is stored by the
2756 U-Boot code. This is NOT an official, exported
2757 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002758 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002759 You better know what you are doing here.
2760
wdenk4a5c8a72003-03-06 00:02:04 +00002761 Note: overly (ab)use of the default environment is
2762 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002763 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002764 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002765
Stephen Warren1465d5f2012-05-22 09:21:54 +00002766 CONFIG_ENV_VARS_UBOOT_CONFIG
2767
2768 Define this in order to add variables describing the
2769 U-Boot build configuration to the default environment.
2770 These will be named arch, cpu, board, vendor, and soc.
2771
2772 Enabling this option will cause the following to be defined:
2773
2774 - CONFIG_SYS_ARCH
2775 - CONFIG_SYS_CPU
2776 - CONFIG_SYS_BOARD
2777 - CONFIG_SYS_VENDOR
2778 - CONFIG_SYS_SOC
2779
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002780 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2781
2782 Define this in order to add variables describing certain
2783 run-time determined information about the hardware to the
2784 environment. These will be named board_name, board_rev.
2785
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002786 CONFIG_DELAY_ENVIRONMENT
2787
2788 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002789 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002790 that so that the environment is not available until
2791 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2792 this is instead controlled by the value of
2793 /config/load-environment.
2794
Chris Packham2216ddb2015-06-19 20:25:59 +12002795- Parallel Flash support:
2796 CONFIG_SYS_NO_FLASH
2797
Bin Meng75574052016-02-05 19:30:11 -08002798 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham2216ddb2015-06-19 20:25:59 +12002799 flash. This option is used to disable support for parallel NOR
2800 flash. This option should be defined if the board does not have
2801 parallel flash.
2802
2803 If this option is not defined one of the generic flash drivers
2804 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2805 selected or the board must provide an implementation of the
2806 flash API (see include/flash.h).
2807
wdenkc0aa5c52003-12-06 19:49:23 +00002808- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002809 CONFIG_HAS_DATAFLASH
2810
wdenk57b2d802003-06-27 21:31:46 +00002811 Defining this option enables DataFlash features and
2812 allows to read/write in Dataflash via the standard
2813 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002814
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002815- Serial Flash support
2816 CONFIG_CMD_SF
2817
2818 Defining this option enables SPI flash commands
2819 'sf probe/read/write/erase/update'.
2820
2821 Usage requires an initial 'probe' to define the serial
2822 flash parameters, followed by read/write/erase/update
2823 commands.
2824
2825 The following defaults may be provided by the platform
2826 to handle the common case when only a single serial
2827 flash is present on the system.
2828
2829 CONFIG_SF_DEFAULT_BUS Bus identifier
2830 CONFIG_SF_DEFAULT_CS Chip-select
2831 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2832 CONFIG_SF_DEFAULT_SPEED in Hz
2833
Simon Glass4b5545e2012-10-08 13:16:02 +00002834 CONFIG_CMD_SF_TEST
2835
2836 Define this option to include a destructive SPI flash
2837 test ('sf test').
2838
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302839 CONFIG_SF_DUAL_FLASH Dual flash memories
2840
2841 Define this option to use dual flash support where two flash
2842 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002843 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302844
wdenkef893942004-02-23 16:11:30 +00002845- SystemACE Support:
2846 CONFIG_SYSTEMACE
2847
2848 Adding this option adds support for Xilinx SystemACE
2849 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002850 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002851 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002852
2853 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002854 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002855
2856 When SystemACE support is added, the "ace" device type
2857 becomes available to the fat commands, i.e. fatls.
2858
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002859- TFTP Fixed UDP Port:
2860 CONFIG_TFTP_PORT
2861
Wolfgang Denk227b5192005-09-24 23:25:46 +02002862 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002863 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002864 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002865 number generator is used.
2866
Wolfgang Denk227b5192005-09-24 23:25:46 +02002867 Also, the environment variable tftpdstp is used to supply
2868 the TFTP UDP destination port value. If tftpdstp isn't
2869 defined, the normal port 69 is used.
2870
2871 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002872 blindly start the TFTP transfer using the pre-configured
2873 target IP address and UDP port. This has the effect of
2874 "punching through" the (Windows XP) firewall, allowing
2875 the remainder of the TFTP transfer to proceed normally.
2876 A better solution is to properly configure the firewall,
2877 but sometimes that is not allowed.
2878
Simon Glass058bb8d2012-12-05 14:46:38 +00002879- Hashing support:
2880 CONFIG_CMD_HASH
2881
2882 This enables a generic 'hash' command which can produce
2883 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2884
2885 CONFIG_HASH_VERIFY
2886
2887 Enable the hash verify command (hash -v). This adds to code
2888 size a little.
2889
gaurav ranaef201592015-02-20 12:51:46 +05302890 CONFIG_SHA1 - This option enables support of hashing using SHA1
2891 algorithm. The hash is calculated in software.
2892 CONFIG_SHA256 - This option enables support of hashing using
2893 SHA256 algorithm. The hash is calculated in software.
2894 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
2895 for SHA1/SHA256 hashing.
2896 This affects the 'hash' command and also the
2897 hash_lookup_algo() function.
2898 CONFIG_SHA_PROG_HW_ACCEL - This option enables
2899 hardware-acceleration for SHA1/SHA256 progressive hashing.
2900 Data can be streamed in a block at a time and the hashing
2901 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00002902
2903 Note: There is also a sha1sum command, which should perhaps
2904 be deprecated in favour of 'hash sha1'.
2905
Robert Winkler765ccf42013-07-24 17:57:06 -07002906- Freescale i.MX specific commands:
2907 CONFIG_CMD_HDMIDETECT
2908 This enables 'hdmidet' command which returns true if an
2909 HDMI monitor is detected. This command is i.MX 6 specific.
2910
2911 CONFIG_CMD_BMODE
2912 This enables the 'bmode' (bootmode) command for forcing
2913 a boot from specific media.
2914
2915 This is useful for forcing the ROM's usb downloader to
2916 activate upon a watchdog reset which is nice when iterating
2917 on U-Boot. Using the reset button or running bmode normal
2918 will set it back to normal. This command currently
2919 supports i.MX53 and i.MX6.
2920
Heiko Schocher443ca402014-01-25 07:27:13 +01002921- bootcount support:
2922 CONFIG_BOOTCOUNT_LIMIT
2923
2924 This enables the bootcounter support, see:
2925 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2926
2927 CONFIG_AT91SAM9XE
2928 enable special bootcounter support on at91sam9xe based boards.
2929 CONFIG_BLACKFIN
2930 enable special bootcounter support on blackfin based boards.
2931 CONFIG_SOC_DA8XX
2932 enable special bootcounter support on da850 based boards.
2933 CONFIG_BOOTCOUNT_RAM
2934 enable support for the bootcounter in RAM
2935 CONFIG_BOOTCOUNT_I2C
2936 enable support for the bootcounter on an i2c (like RTC) device.
2937 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2938 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2939 the bootcounter.
2940 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002941
wdenkc0aa5c52003-12-06 19:49:23 +00002942- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002943 CONFIG_SHOW_BOOT_PROGRESS
2944
wdenk4a5c8a72003-03-06 00:02:04 +00002945 Defining this option allows to add some board-
2946 specific code (calling a user-provided function
2947 "show_boot_progress(int)") that enables you to show
2948 the system's boot progress on some display (for
2949 example, some LED's) on your board. At the moment,
2950 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002951
Simon Glass0fa36a42012-09-28 08:56:37 +00002952
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002953Legacy uImage format:
2954
wdenkc6097192002-11-03 00:24:07 +00002955 Arg Where When
2956 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002957 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002958 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002959 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002960 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002961 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002962 4 common/cmd_bootm.c Image data has correct checksum
2963 -4 common/cmd_bootm.c Image is for unsupported architecture
2964 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002965 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002966 6 common/cmd_bootm.c Image Type check OK
2967 -6 common/cmd_bootm.c gunzip uncompression error
2968 -7 common/cmd_bootm.c Unimplemented compression type
2969 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002970 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002971 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002972
2973 9 common/image.c Start initial ramdisk verification
2974 -10 common/image.c Ramdisk header has bad magic number
2975 -11 common/image.c Ramdisk header has bad checksum
2976 10 common/image.c Ramdisk header is OK
2977 -12 common/image.c Ramdisk data has bad checksum
2978 11 common/image.c Ramdisk data has correct checksum
2979 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002980 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002981 13 common/image.c Start multifile image verification
2982 14 common/image.c No initial ramdisk, no multifile, continue.
2983
Wolfgang Denk092ae952011-10-26 10:21:21 +00002984 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002985
Stefan Roese88fbf932010-04-15 16:07:28 +02002986 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002987 -31 post/post.c POST test failed, detected by post_output_backlog()
2988 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002989
Heiko Schocher633e03a2007-06-22 19:11:54 +02002990 34 common/cmd_doc.c before loading a Image from a DOC device
2991 -35 common/cmd_doc.c Bad usage of "doc" command
2992 35 common/cmd_doc.c correct usage of "doc" command
2993 -36 common/cmd_doc.c No boot device
2994 36 common/cmd_doc.c correct boot device
2995 -37 common/cmd_doc.c Unknown Chip ID on boot device
2996 37 common/cmd_doc.c correct chip ID found, device available
2997 -38 common/cmd_doc.c Read Error on boot device
2998 38 common/cmd_doc.c reading Image header from DOC device OK
2999 -39 common/cmd_doc.c Image header has bad magic number
3000 39 common/cmd_doc.c Image header has correct magic number
3001 -40 common/cmd_doc.c Error reading Image from DOC device
3002 40 common/cmd_doc.c Image header has correct magic number
3003 41 common/cmd_ide.c before loading a Image from a IDE device
3004 -42 common/cmd_ide.c Bad usage of "ide" command
3005 42 common/cmd_ide.c correct usage of "ide" command
3006 -43 common/cmd_ide.c No boot device
3007 43 common/cmd_ide.c boot device found
3008 -44 common/cmd_ide.c Device not available
3009 44 common/cmd_ide.c Device available
3010 -45 common/cmd_ide.c wrong partition selected
3011 45 common/cmd_ide.c partition selected
3012 -46 common/cmd_ide.c Unknown partition table
3013 46 common/cmd_ide.c valid partition table found
3014 -47 common/cmd_ide.c Invalid partition type
3015 47 common/cmd_ide.c correct partition type
3016 -48 common/cmd_ide.c Error reading Image Header on boot device
3017 48 common/cmd_ide.c reading Image Header from IDE device OK
3018 -49 common/cmd_ide.c Image header has bad magic number
3019 49 common/cmd_ide.c Image header has correct magic number
3020 -50 common/cmd_ide.c Image header has bad checksum
3021 50 common/cmd_ide.c Image header has correct checksum
3022 -51 common/cmd_ide.c Error reading Image from IDE device
3023 51 common/cmd_ide.c reading Image from IDE device OK
3024 52 common/cmd_nand.c before loading a Image from a NAND device
3025 -53 common/cmd_nand.c Bad usage of "nand" command
3026 53 common/cmd_nand.c correct usage of "nand" command
3027 -54 common/cmd_nand.c No boot device
3028 54 common/cmd_nand.c boot device found
3029 -55 common/cmd_nand.c Unknown Chip ID on boot device
3030 55 common/cmd_nand.c correct chip ID found, device available
3031 -56 common/cmd_nand.c Error reading Image Header on boot device
3032 56 common/cmd_nand.c reading Image Header from NAND device OK
3033 -57 common/cmd_nand.c Image header has bad magic number
3034 57 common/cmd_nand.c Image header has correct magic number
3035 -58 common/cmd_nand.c Error reading Image from NAND device
3036 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003037
Heiko Schocher633e03a2007-06-22 19:11:54 +02003038 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003039
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003040 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003041 -64 net/eth.c no Ethernet found.
3042 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003043
Heiko Schocher633e03a2007-06-22 19:11:54 +02003044 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003045 80 common/cmd_net.c before calling net_loop()
3046 -81 common/cmd_net.c some error in net_loop() occurred
3047 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003048 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3049 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003050 83 common/cmd_net.c running "source" command
3051 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003052 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003053
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003054FIT uImage format:
3055
3056 Arg Where When
3057 100 common/cmd_bootm.c Kernel FIT Image has correct format
3058 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3059 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3060 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3061 102 common/cmd_bootm.c Kernel unit name specified
3062 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003063 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003064 104 common/cmd_bootm.c Got kernel subimage node offset
3065 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3066 105 common/cmd_bootm.c Kernel subimage hash verification OK
3067 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3068 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003069 -106 common/cmd_bootm.c Kernel subimage has wrong type
3070 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003071 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3072 108 common/cmd_bootm.c Got kernel subimage data/size
3073 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3074 -109 common/cmd_bootm.c Can't get kernel subimage type
3075 -110 common/cmd_bootm.c Can't get kernel subimage comp
3076 -111 common/cmd_bootm.c Can't get kernel subimage os
3077 -112 common/cmd_bootm.c Can't get kernel subimage load address
3078 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3079
3080 120 common/image.c Start initial ramdisk verification
3081 -120 common/image.c Ramdisk FIT image has incorrect format
3082 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003083 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003084 -122 common/image.c Can't get configuration for ramdisk subimage
3085 123 common/image.c Ramdisk unit name specified
3086 -124 common/image.c Can't get ramdisk subimage node offset
3087 125 common/image.c Got ramdisk subimage node offset
3088 -125 common/image.c Ramdisk subimage hash verification failed
3089 126 common/image.c Ramdisk subimage hash verification OK
3090 -126 common/image.c Ramdisk subimage for unsupported architecture
3091 127 common/image.c Architecture check OK
3092 -127 common/image.c Can't get ramdisk subimage data/size
3093 128 common/image.c Got ramdisk subimage data/size
3094 129 common/image.c Can't get ramdisk load address
3095 -129 common/image.c Got ramdisk load address
3096
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003097 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003098 131 common/cmd_doc.c FIT image format OK
3099
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003100 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003101 141 common/cmd_ide.c FIT image format OK
3102
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003103 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003104 151 common/cmd_nand.c FIT image format OK
3105
Heiko Schocher515eb122014-05-28 11:33:33 +02003106- legacy image format:
3107 CONFIG_IMAGE_FORMAT_LEGACY
3108 enables the legacy image format support in U-Boot.
3109
3110 Default:
3111 enabled if CONFIG_FIT_SIGNATURE is not defined.
3112
3113 CONFIG_DISABLE_IMAGE_LEGACY
3114 disable the legacy image format
3115
3116 This define is introduced, as the legacy image format is
3117 enabled per default for backward compatibility.
3118
Gabe Blackd572e162012-10-25 16:31:10 +00003119- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003120 CONFIG_FIT_DISABLE_SHA256
3121 Supporting SHA256 hashes has quite an impact on binary size.
3122 For constrained systems sha256 hash support can be disabled
3123 with this option.
3124
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003125 TODO(sjg@chromium.org): Adjust this option to be positive,
3126 and move it to Kconfig
3127
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003128- Standalone program support:
3129 CONFIG_STANDALONE_LOAD_ADDR
3130
Wolfgang Denk23f78482011-10-09 21:06:34 +02003131 This option defines a board specific value for the
3132 address where standalone program gets loaded, thus
3133 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003134 settings.
3135
3136- Frame Buffer Address:
3137 CONFIG_FB_ADDR
3138
3139 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003140 address for frame buffer. This is typically the case
3141 when using a graphics controller has separate video
3142 memory. U-Boot will then place the frame buffer at
3143 the given address instead of dynamically reserving it
3144 in system RAM by calling lcd_setmem(), which grabs
3145 the memory for the frame buffer depending on the
3146 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003147
3148 Please see board_init_f function.
3149
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003150- Automatic software updates via TFTP server
3151 CONFIG_UPDATE_TFTP
3152 CONFIG_UPDATE_TFTP_CNT_MAX
3153 CONFIG_UPDATE_TFTP_MSEC_MAX
3154
3155 These options enable and control the auto-update feature;
3156 for a more detailed description refer to doc/README.update.
3157
3158- MTD Support (mtdparts command, UBI support)
3159 CONFIG_MTD_DEVICE
3160
3161 Adds the MTD device infrastructure from the Linux kernel.
3162 Needed for mtdparts command support.
3163
3164 CONFIG_MTD_PARTITIONS
3165
3166 Adds the MTD partitioning infrastructure from the Linux
3167 kernel. Needed for UBI support.
3168
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003169- UBI support
3170 CONFIG_CMD_UBI
3171
3172 Adds commands for interacting with MTD partitions formatted
3173 with the UBI flash translation layer
3174
3175 Requires also defining CONFIG_RBTREE
3176
Joe Hershberger47550fc2013-04-08 10:32:49 +00003177 CONFIG_UBI_SILENCE_MSG
3178
3179 Make the verbose messages from UBI stop printing. This leaves
3180 warnings and errors enabled.
3181
Heiko Schocherf5895d12014-06-24 10:10:04 +02003182
3183 CONFIG_MTD_UBI_WL_THRESHOLD
3184 This parameter defines the maximum difference between the highest
3185 erase counter value and the lowest erase counter value of eraseblocks
3186 of UBI devices. When this threshold is exceeded, UBI starts performing
3187 wear leveling by means of moving data from eraseblock with low erase
3188 counter to eraseblocks with high erase counter.
3189
3190 The default value should be OK for SLC NAND flashes, NOR flashes and
3191 other flashes which have eraseblock life-cycle 100000 or more.
3192 However, in case of MLC NAND flashes which typically have eraseblock
3193 life-cycle less than 10000, the threshold should be lessened (e.g.,
3194 to 128 or 256, although it does not have to be power of 2).
3195
3196 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003197
Heiko Schocherf5895d12014-06-24 10:10:04 +02003198 CONFIG_MTD_UBI_BEB_LIMIT
3199 This option specifies the maximum bad physical eraseblocks UBI
3200 expects on the MTD device (per 1024 eraseblocks). If the
3201 underlying flash does not admit of bad eraseblocks (e.g. NOR
3202 flash), this value is ignored.
3203
3204 NAND datasheets often specify the minimum and maximum NVM
3205 (Number of Valid Blocks) for the flashes' endurance lifetime.
3206 The maximum expected bad eraseblocks per 1024 eraseblocks
3207 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3208 which gives 20 for most NANDs (MaxNVB is basically the total
3209 count of eraseblocks on the chip).
3210
3211 To put it differently, if this value is 20, UBI will try to
3212 reserve about 1.9% of physical eraseblocks for bad blocks
3213 handling. And that will be 1.9% of eraseblocks on the entire
3214 NAND chip, not just the MTD partition UBI attaches. This means
3215 that if you have, say, a NAND flash chip admits maximum 40 bad
3216 eraseblocks, and it is split on two MTD partitions of the same
3217 size, UBI will reserve 40 eraseblocks when attaching a
3218 partition.
3219
3220 default: 20
3221
3222 CONFIG_MTD_UBI_FASTMAP
3223 Fastmap is a mechanism which allows attaching an UBI device
3224 in nearly constant time. Instead of scanning the whole MTD device it
3225 only has to locate a checkpoint (called fastmap) on the device.
3226 The on-flash fastmap contains all information needed to attach
3227 the device. Using fastmap makes only sense on large devices where
3228 attaching by scanning takes long. UBI will not automatically install
3229 a fastmap on old images, but you can set the UBI parameter
3230 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3231 that fastmap-enabled images are still usable with UBI implementations
3232 without fastmap support. On typical flash devices the whole fastmap
3233 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3234
3235 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3236 Set this parameter to enable fastmap automatically on images
3237 without a fastmap.
3238 default: 0
3239
Heiko Schocher94b66de2015-10-22 06:19:21 +02003240 CONFIG_MTD_UBI_FM_DEBUG
3241 Enable UBI fastmap debug
3242 default: 0
3243
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003244- UBIFS support
3245 CONFIG_CMD_UBIFS
3246
3247 Adds commands for interacting with UBI volumes formatted as
3248 UBIFS. UBIFS is read-only in u-boot.
3249
3250 Requires UBI support as well as CONFIG_LZO
3251
Joe Hershberger47550fc2013-04-08 10:32:49 +00003252 CONFIG_UBIFS_SILENCE_MSG
3253
3254 Make the verbose messages from UBIFS stop printing. This leaves
3255 warnings and errors enabled.
3256
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003257- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003258 CONFIG_SPL
3259 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003260
Tom Rini36853852012-02-14 07:29:40 +00003261 CONFIG_SPL_LDSCRIPT
3262 LDSCRIPT for linking the SPL binary.
3263
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003264 CONFIG_SPL_MAX_FOOTPRINT
3265 Maximum size in memory allocated to the SPL, BSS included.
3266 When defined, the linker checks that the actual memory
3267 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003268 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003269 must not be both defined at the same time.
3270
Tom Rini36853852012-02-14 07:29:40 +00003271 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003272 Maximum size of the SPL image (text, data, rodata, and
3273 linker lists sections), BSS excluded.
3274 When defined, the linker checks that the actual size does
3275 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003276
Wolfgang Denk825223d2011-09-11 21:24:09 +02003277 CONFIG_SPL_TEXT_BASE
3278 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003279
Scott Woodc4f0d002012-09-20 19:05:12 -05003280 CONFIG_SPL_RELOC_TEXT_BASE
3281 Address to relocate to. If unspecified, this is equal to
3282 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3283
Tom Rini36853852012-02-14 07:29:40 +00003284 CONFIG_SPL_BSS_START_ADDR
3285 Link address for the BSS within the SPL binary.
3286
3287 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003288 Maximum size in memory allocated to the SPL BSS.
3289 When defined, the linker checks that the actual memory used
3290 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003291 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003292 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003293
3294 CONFIG_SPL_STACK
3295 Adress of the start of the stack SPL will use
3296
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003297 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3298 When defined, SPL will panic() if the image it has
3299 loaded does not have a signature.
3300 Defining this is useful when code which loads images
3301 in SPL cannot guarantee that absolutely all read errors
3302 will be caught.
3303 An example is the LPC32XX MLC NAND driver, which will
3304 consider that a completely unreadable NAND block is bad,
3305 and thus should be skipped silently.
3306
Marek Vasutbf541b22016-04-29 00:44:55 +02003307 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3308 When defined, SPL will proceed to another boot method
3309 if the image it has loaded does not have a signature.
3310
Scott Woodc4f0d002012-09-20 19:05:12 -05003311 CONFIG_SPL_RELOC_STACK
3312 Adress of the start of the stack SPL will use after
3313 relocation. If unspecified, this is equal to
3314 CONFIG_SPL_STACK.
3315
Tom Rini36853852012-02-14 07:29:40 +00003316 CONFIG_SYS_SPL_MALLOC_START
3317 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003318 When this option is set the full malloc is used in SPL and
3319 it is set up by spl_init() and before that, the simple malloc()
3320 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003321
3322 CONFIG_SYS_SPL_MALLOC_SIZE
3323 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003324
Tom Rini28591df2012-08-13 12:03:19 -07003325 CONFIG_SPL_FRAMEWORK
3326 Enable the SPL framework under common/. This framework
3327 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3328 NAND loading of the Linux Kernel.
3329
Tom Rinic2b76002014-03-28 12:03:39 -04003330 CONFIG_SPL_OS_BOOT
3331 Enable booting directly to an OS from SPL.
3332 See also: doc/README.falcon
3333
Tom Rinife3b0c72012-08-13 11:37:56 -07003334 CONFIG_SPL_DISPLAY_PRINT
3335 For ARM, enable an optional function to print more information
3336 about the running system.
3337
Scott Wood7c810902012-09-20 16:35:21 -05003338 CONFIG_SPL_INIT_MINIMAL
3339 Arch init code should be built for a very small image
3340
Tom Rini36853852012-02-14 07:29:40 +00003341 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3342 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003343 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003344 when the MMC is being used in raw mode.
3345
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003346 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3347 Partition on the MMC to load U-Boot from when the MMC is being
3348 used in raw mode
3349
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003350 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3351 Sector to load kernel uImage from when MMC is being
3352 used in raw mode (for Falcon mode)
3353
3354 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3355 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3356 Sector and number of sectors to load kernel argument
3357 parameters from when MMC is being used in raw mode
3358 (for falcon mode)
3359
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003360 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3361 Partition on the MMC to load U-Boot from when the MMC is being
3362 used in fs mode
3363
Guillaume GARDET5065b712014-10-15 17:53:13 +02003364 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3365 Filename to read to load U-Boot when reading from filesystem
3366
3367 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003368 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003369 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003370
Guillaume GARDET5065b712014-10-15 17:53:13 +02003371 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003372 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003373 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003374
Scott Wood2b36fbb2012-12-06 13:33:17 +00003375 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3376 Set this for NAND SPL on PPC mpc83xx targets, so that
3377 start.S waits for the rest of the SPL to load before
3378 continuing (the hardware starts execution after just
3379 loading the first page rather than the full 4K).
3380
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303381 CONFIG_SPL_SKIP_RELOCATE
3382 Avoid SPL relocation
3383
Scott Woodc352a0c2012-09-20 19:09:07 -05003384 CONFIG_SPL_NAND_BASE
3385 Include nand_base.c in the SPL. Requires
3386 CONFIG_SPL_NAND_DRIVERS.
3387
3388 CONFIG_SPL_NAND_DRIVERS
3389 SPL uses normal NAND drivers, not minimal drivers.
3390
3391 CONFIG_SPL_NAND_ECC
3392 Include standard software ECC in the SPL
3393
Tom Rini36853852012-02-14 07:29:40 +00003394 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003395 Support for NAND boot using simple NAND drivers that
3396 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003397
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003398 CONFIG_SPL_UBI
3399 Support for a lightweight UBI (fastmap) scanner and
3400 loader
3401
Heiko Schochercf000272014-10-31 08:31:00 +01003402 CONFIG_SPL_NAND_RAW_ONLY
3403 Support to boot only raw u-boot.bin images. Use this only
3404 if you need to save space.
3405
Ying Zhangdfb2b152013-08-16 15:16:12 +08003406 CONFIG_SPL_COMMON_INIT_DDR
3407 Set for common ddr init with serial presence detect in
3408 SPL binary.
3409
Tom Rini36853852012-02-14 07:29:40 +00003410 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3411 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3412 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3413 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3414 CONFIG_SYS_NAND_ECCBYTES
3415 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003416 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003417
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303418 CONFIG_SPL_NAND_BOOT
3419 Add support NAND boot
3420
Tom Rini36853852012-02-14 07:29:40 +00003421 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003422 Location in NAND to read U-Boot from
3423
3424 CONFIG_SYS_NAND_U_BOOT_DST
3425 Location in memory to load U-Boot to
3426
3427 CONFIG_SYS_NAND_U_BOOT_SIZE
3428 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003429
3430 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003431 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003432
3433 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3434 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003435 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003436
3437 CONFIG_SPL_OMAP3_ID_NAND
3438 Support for an OMAP3-specific set of functions to return the
3439 ID and MFR of the first attached NAND chip, if present.
3440
Pavel Machekde997252012-08-30 22:42:11 +02003441 CONFIG_SPL_RAM_DEVICE
3442 Support for running image already present in ram, in SPL binary
3443
Scott Woodeb7bd972012-12-06 13:33:16 +00003444 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003445 Image offset to which the SPL should be padded before appending
3446 the SPL payload. By default, this is defined as
3447 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3448 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3449 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003450
Scott Woodf147eb72012-09-21 16:27:32 -05003451 CONFIG_SPL_TARGET
3452 Final target image containing SPL and payload. Some SPLs
3453 use an arch-specific makefile fragment instead, for
3454 example if more than one image needs to be produced.
3455
Simon Glass82d94532013-05-08 08:05:59 +00003456 CONFIG_FIT_SPL_PRINT
3457 Printing information about a FIT image adds quite a bit of
3458 code to SPL. So this is normally disabled in SPL. Use this
3459 option to re-enable it. This will affect the output of the
3460 bootm command when booting a FIT image.
3461
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003462- TPL framework
3463 CONFIG_TPL
3464 Enable building of TPL globally.
3465
3466 CONFIG_TPL_PAD_TO
3467 Image offset to which the TPL should be padded before appending
3468 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003469 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3470 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3471 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003472
wdenkc0aa5c52003-12-06 19:49:23 +00003473- Interrupt support (PPC):
3474
wdenk1ebf41e2004-01-02 14:00:00 +00003475 There are common interrupt_init() and timer_interrupt()
3476 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003477 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003478 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003479 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003480 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003481 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003482 specific handling. If board has watchdog / status_led
3483 / other_activity_monitor it works automatically from
3484 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003485
wdenkc6097192002-11-03 00:24:07 +00003486
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003487Board initialization settings:
3488------------------------------
3489
3490During Initialization u-boot calls a number of board specific functions
3491to allow the preparation of board specific prerequisites, e.g. pin setup
3492before drivers are initialized. To enable these callbacks the
3493following configuration macros have to be defined. Currently this is
3494architecture specific, so please check arch/your_architecture/lib/board.c
3495typically in board_init_f() and board_init_r().
3496
3497- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3498- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3499- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3500- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003501
wdenkc6097192002-11-03 00:24:07 +00003502Configuration Settings:
3503-----------------------
3504
York Sun6c480012014-02-26 17:03:19 -08003505- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3506 Optionally it can be defined to support 64-bit memory commands.
3507
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003508- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003509 undefine this when you're short of memory.
3510
Peter Tyserdfb72b82009-01-27 18:03:12 -06003511- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3512 width of the commands listed in the 'help' command output.
3513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003514- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003515 prompt for user input.
3516
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003517- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003519- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003520
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003521- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003522
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003523- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003524 the application (usually a Linux kernel) when it is
3525 booted
3526
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003527- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003528 List of legal baudrate settings for this board.
3529
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003530- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003531 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003532
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003533- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003534 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003535
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003536- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003537 Begin and End addresses of the area used by the
3538 simple memory test.
3539
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003540- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003541 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003542
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003543- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003544 Scratch address used by the alternate memory test
3545 You only need to set this if address zero isn't writeable
3546
York Sun5d286cd2015-12-04 11:57:07 -08003547- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003548 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003549 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3550 is substracted from total RAM and won't be reported to OS.
3551 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003552 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003553 the RAM base is not zero, or RAM is divided into banks,
3554 this variable needs to be recalcuated to get the address.
3555
York Sun50739372015-12-07 11:05:29 -08003556- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003557 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003558 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003559 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003560 fixing up gd->ram_size the Linux kernel should gets passed
3561 the now "corrected" memory size and won't touch it either.
3562 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003563 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003564 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003565 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003566
3567 This option can be used as a workaround for the 440EPx/GRx
3568 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3569 be touched.
3570
3571 WARNING: Please make sure that this value is a multiple of
3572 the Linux page size (normally 4k). If this is not the case,
3573 then the end address of the Linux memory will be located at a
3574 non page size aligned address and this could cause major
3575 problems.
3576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003577- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003578 Enable temporary baudrate change while serial download
3579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003580- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003581 Physical start address of SDRAM. _Must_ be 0 here.
3582
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003583- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003584 Physical start address of Flash memory.
3585
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003586- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003587 Physical start address of boot monitor code (set by
3588 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003589 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003590 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003591
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003592- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003593 Size of memory reserved for monitor code, used to
3594 determine _at_compile_time_ (!) if the environment is
3595 embedded within the U-Boot image, or in a separate
3596 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003597
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003598- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003599 Size of DRAM reserved for malloc() use.
3600
Simon Glass863e4042014-07-10 22:23:28 -06003601- CONFIG_SYS_MALLOC_F_LEN
3602 Size of the malloc() pool for use before relocation. If
3603 this is defined, then a very simple malloc() implementation
3604 will become available before relocation. The address is just
3605 below the global data, and the stack is moved down to make
3606 space.
3607
3608 This feature allocates regions with increasing addresses
3609 within the region. calloc() is supported, but realloc()
3610 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003611 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003612 U-Boot relocates itself.
3613
Simon Glass9fa901b2014-11-10 17:16:54 -07003614- CONFIG_SYS_MALLOC_SIMPLE
3615 Provides a simple and small malloc() and calloc() for those
3616 boards which do not use the full malloc in SPL (which is
3617 enabled with CONFIG_SYS_SPL_MALLOC_START).
3618
Thierry Redingc97d9742014-12-09 22:25:22 -07003619- CONFIG_SYS_NONCACHED_MEMORY:
3620 Size of non-cached memory area. This area of memory will be
3621 typically located right below the malloc() area and mapped
3622 uncached in the MMU. This is useful for drivers that would
3623 otherwise require a lot of explicit cache maintenance. For
3624 some drivers it's also impossible to properly maintain the
3625 cache. For example if the regions that need to be flushed
3626 are not a multiple of the cache-line size, *and* padding
3627 cannot be allocated between the regions to align them (i.e.
3628 if the HW requires a contiguous array of regions, and the
3629 size of each region is not cache-aligned), then a flush of
3630 one region may result in overwriting data that hardware has
3631 written to another region in the same cache-line. This can
3632 happen for example in network drivers where descriptors for
3633 buffers are typically smaller than the CPU cache-line (e.g.
3634 16 bytes vs. 32 or 64 bytes).
3635
3636 Non-cached memory is only supported on 32-bit ARM at present.
3637
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003638- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003639 Normally compressed uImages are limited to an
3640 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003641 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003642 to adjust this setting to your needs.
3643
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003644- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003645 Maximum size of memory mapped by the startup code of
3646 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003647 the Linux kernel (bd_info, boot arguments, FDT blob if
3648 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003649 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003650 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003651 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003652 variable "bootm_mapsize" will override the value of
3653 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3654 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003655
John Rigbyeea8e692010-10-13 13:57:35 -06003656- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3657 Enable initrd_high functionality. If defined then the
3658 initrd_high feature is enabled and the bootm ramdisk subcommand
3659 is enabled.
3660
3661- CONFIG_SYS_BOOT_GET_CMDLINE:
3662 Enables allocating and saving kernel cmdline in space between
3663 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3664
3665- CONFIG_SYS_BOOT_GET_KBD:
3666 Enables allocating and saving a kernel copy of the bd_info in
3667 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3668
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003669- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003670 Max number of Flash memory banks
3671
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003672- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003673 Max number of sectors on a Flash chip
3674
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003675- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003676 Timeout for Flash erase operations (in ms)
3677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003678- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003679 Timeout for Flash write operations (in ms)
3680
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003681- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003682 Timeout for Flash set sector lock bit operation (in ms)
3683
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003684- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003685 Timeout for Flash clear lock bits operation (in ms)
3686
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003687- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003688 If defined, hardware flash sectors protection is used
3689 instead of U-Boot software protection.
3690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003691- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003692
3693 Enable TFTP transfers directly to flash memory;
3694 without this option such a download has to be
3695 performed in two steps: (1) download to RAM, and (2)
3696 copy from RAM to flash.
3697
3698 The two-step approach is usually more reliable, since
3699 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003700 the flash, but in some situations (when system RAM is
3701 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003702 downloaded image) this option may be very useful.
3703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003704- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003705 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003706 common flash structure for storing flash geometry.
3707
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003708- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003709 This option also enables the building of the cfi_flash driver
3710 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003711
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003712- CONFIG_FLASH_CFI_MTD
3713 This option enables the building of the cfi_mtd driver
3714 in the drivers directory. The driver exports CFI flash
3715 to the MTD layer.
3716
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003717- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003718 Use buffered writes to flash.
3719
3720- CONFIG_FLASH_SPANSION_S29WS_N
3721 s29ws-n MirrorBit flash has non-standard addresses for buffered
3722 write commands.
3723
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003724- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003725 If this option is defined, the common CFI flash doesn't
3726 print it's warning upon not recognized FLASH banks. This
3727 is useful, if some of the configured banks are only
3728 optionally available.
3729
Jerry Van Barenaae73572008-03-08 13:48:01 -05003730- CONFIG_FLASH_SHOW_PROGRESS
3731 If defined (must be an integer), print out countdown
3732 digits and dots. Recommended value: 45 (9..1) for 80
3733 column displays, 15 (3..1) for 40 column displays.
3734
Stefan Roesed20cba52013-04-04 15:53:14 +02003735- CONFIG_FLASH_VERIFY
3736 If defined, the content of the flash (destination) is compared
3737 against the source after the write operation. An error message
3738 will be printed when the contents are not identical.
3739 Please note that this option is useless in nearly all cases,
3740 since such flash programming errors usually are detected earlier
3741 while unprotecting/erasing/programming. Please only enable
3742 this option if you really know what you are doing.
3743
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003744- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003745 Defines the number of Ethernet receive buffers. On some
3746 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003747 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3748 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003749 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003750 Defaults to 4 if not defined.
3751
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003752- CONFIG_ENV_MAX_ENTRIES
3753
Wolfgang Denk1136f69e2010-10-27 22:48:30 +02003754 Maximum number of entries in the hash table that is used
3755 internally to store the environment settings. The default
3756 setting is supposed to be generous and should work in most
3757 cases. This setting can be used to tune behaviour; see
3758 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003759
Joe Hershberger71497d02012-12-11 22:16:31 -06003760- CONFIG_ENV_FLAGS_LIST_DEFAULT
3761- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003762 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003763 calling env set. Variables can be restricted to only decimal,
3764 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3765 the variables can also be restricted to IP address or MAC address.
3766
3767 The format of the list is:
3768 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003769 access_attribute = [a|r|o|c]
3770 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003771 entry = variable_name[:attributes]
3772 list = entry[,list]
3773
3774 The type attributes are:
3775 s - String (default)
3776 d - Decimal
3777 x - Hexadecimal
3778 b - Boolean ([1yYtT|0nNfF])
3779 i - IP address
3780 m - MAC address
3781
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003782 The access attributes are:
3783 a - Any (default)
3784 r - Read-only
3785 o - Write-once
3786 c - Change-default
3787
Joe Hershberger71497d02012-12-11 22:16:31 -06003788 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3789 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003790 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003791
3792 - CONFIG_ENV_FLAGS_LIST_STATIC
3793 Define this to a list (string) to define validation that
3794 should be done if an entry is not found in the ".flags"
3795 environment variable. To override a setting in the static
3796 list, simply add an entry for the same variable name to the
3797 ".flags" variable.
3798
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003799 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3800 regular expression. This allows multiple variables to define the same
3801 flags without explicitly listing them for each variable.
3802
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003803- CONFIG_ENV_ACCESS_IGNORE_FORCE
3804 If defined, don't allow the -f switch to env set override variable
3805 access flags.
3806
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003807- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3808 This is set by OMAP boards for the max time that reset should
3809 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003810 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003811
Gabe Black3687fe42014-10-15 04:38:30 -06003812- CONFIG_USE_STDINT
3813 If stdint.h is available with your toolchain you can define this
3814 option to enable it. You can provide option 'USE_STDINT=1' when
3815 building U-Boot to enable this.
3816
wdenkc6097192002-11-03 00:24:07 +00003817The following definitions that deal with the placement and management
3818of environment data (variable area); in general, we support the
3819following configurations:
3820
Mike Frysinger63b8f122011-07-08 10:44:25 +00003821- CONFIG_BUILD_ENVCRC:
3822
3823 Builds up envcrc with the target environment so that external utils
3824 may easily extract it and embed it in final U-Boot images.
3825
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003826- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003827
3828 Define this if the environment is in flash memory.
3829
3830 a) The environment occupies one whole flash sector, which is
3831 "embedded" in the text segment with the U-Boot code. This
3832 happens usually with "bottom boot sector" or "top boot
3833 sector" type flash chips, which have several smaller
3834 sectors at the start or the end. For instance, such a
3835 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3836 such a case you would place the environment in one of the
3837 4 kB sectors - with U-Boot code before and after it. With
3838 "top boot sector" type flash chips, you would put the
3839 environment in one of the last sectors, leaving a gap
3840 between U-Boot and the environment.
3841
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003842 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003843
3844 Offset of environment data (variable area) to the
3845 beginning of flash memory; for instance, with bottom boot
3846 type flash chips the second sector can be used: the offset
3847 for this sector is given here.
3848
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003849 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003850
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003851 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003852
3853 This is just another way to specify the start address of
3854 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003855 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003856
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003857 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003858
3859 Size of the sector containing the environment.
3860
3861
3862 b) Sometimes flash chips have few, equal sized, BIG sectors.
3863 In such a case you don't want to spend a whole sector for
3864 the environment.
3865
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003866 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003867
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003868 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003869 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003870 of this flash sector for the environment. This saves
3871 memory for the RAM copy of the environment.
3872
3873 It may also save flash memory if you decide to use this
3874 when your environment is "embedded" within U-Boot code,
3875 since then the remainder of the flash sector could be used
3876 for U-Boot code. It should be pointed out that this is
3877 STRONGLY DISCOURAGED from a robustness point of view:
3878 updating the environment in flash makes it always
3879 necessary to erase the WHOLE sector. If something goes
3880 wrong before the contents has been restored from a copy in
3881 RAM, your target system will be dead.
3882
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003883 - CONFIG_ENV_ADDR_REDUND
3884 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003885
wdenk4a5c8a72003-03-06 00:02:04 +00003886 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003887 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003888 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003889 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003890
3891BE CAREFUL! Any changes to the flash layout, and some changes to the
3892source code will make it necessary to adapt <board>/u-boot.lds*
3893accordingly!
3894
3895
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003896- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003897
3898 Define this if you have some non-volatile memory device
3899 (NVRAM, battery buffered SRAM) which you want to use for the
3900 environment.
3901
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003902 - CONFIG_ENV_ADDR:
3903 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003904
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003905 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003906 want to use for environment. It is assumed that this memory
3907 can just be read and written to, without any special
3908 provision.
3909
3910BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003911in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003912console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003913U-Boot will hang.
3914
3915Please note that even with NVRAM we still use a copy of the
3916environment in RAM: we could work on NVRAM directly, but we want to
3917keep settings there always unmodified except somebody uses "saveenv"
3918to save the current settings.
3919
3920
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003921- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003922
3923 Use this if you have an EEPROM or similar serial access
3924 device and a driver for it.
3925
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003926 - CONFIG_ENV_OFFSET:
3927 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003928
3929 These two #defines specify the offset and size of the
3930 environment area within the total memory of your EEPROM.
3931
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003932 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003933 If defined, specified the chip address of the EEPROM device.
3934 The default address is zero.
3935
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003936 - CONFIG_SYS_I2C_EEPROM_BUS:
3937 If defined, specified the i2c bus of the EEPROM device.
3938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003939 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003940 If defined, the number of bits used to address bytes in a
3941 single page in the EEPROM device. A 64 byte page, for example
3942 would require six bits.
3943
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003944 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003945 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003946 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003948 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003949 The length in bytes of the EEPROM memory array address. Note
3950 that this is NOT the chip address length!
3951
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003952 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003953 EEPROM chips that implement "address overflow" are ones
3954 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3955 address and the extra bits end up in the "chip address" bit
3956 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3957 byte chips.
3958
3959 Note that we consider the length of the address field to
3960 still be one byte because the extra address bits are hidden
3961 in the chip address.
3962
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003963 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003964 The size in bytes of the EEPROM device.
3965
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003966 - CONFIG_ENV_EEPROM_IS_ON_I2C
3967 define this, if you have I2C and SPI activated, and your
3968 EEPROM, which holds the environment, is on the I2C bus.
3969
3970 - CONFIG_I2C_ENV_EEPROM_BUS
3971 if you have an Environment on an EEPROM reached over
3972 I2C muxes, you can define here, how to reach this
3973 EEPROM. For example:
3974
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003975 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003976
3977 EEPROM which holds the environment, is reached over
3978 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003979
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003980- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003981
wdenk1ebf41e2004-01-02 14:00:00 +00003982 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003983 want to use for the environment.
3984
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003985 - CONFIG_ENV_OFFSET:
3986 - CONFIG_ENV_ADDR:
3987 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003988
3989 These three #defines specify the offset and size of the
3990 environment area within the total memory of your DataFlash placed
3991 at the specified address.
3992
Wu, Josh76db7bf2014-07-01 19:30:13 +08003993- CONFIG_ENV_IS_IN_SPI_FLASH:
3994
3995 Define this if you have a SPI Flash memory device which you
3996 want to use for the environment.
3997
3998 - CONFIG_ENV_OFFSET:
3999 - CONFIG_ENV_SIZE:
4000
4001 These two #defines specify the offset and size of the
4002 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4003 aligned to an erase sector boundary.
4004
4005 - CONFIG_ENV_SECT_SIZE:
4006
4007 Define the SPI flash's sector size.
4008
4009 - CONFIG_ENV_OFFSET_REDUND (optional):
4010
4011 This setting describes a second storage area of CONFIG_ENV_SIZE
4012 size used to hold a redundant copy of the environment data, so
4013 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06004014 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08004015 aligned to an erase sector boundary.
4016
4017 - CONFIG_ENV_SPI_BUS (optional):
4018 - CONFIG_ENV_SPI_CS (optional):
4019
4020 Define the SPI bus and chip select. If not defined they will be 0.
4021
4022 - CONFIG_ENV_SPI_MAX_HZ (optional):
4023
4024 Define the SPI max work clock. If not defined then use 1MHz.
4025
4026 - CONFIG_ENV_SPI_MODE (optional):
4027
4028 Define the SPI work mode. If not defined then use SPI_MODE_3.
4029
Liu Gang85bcd732012-03-08 00:33:20 +00004030- CONFIG_ENV_IS_IN_REMOTE:
4031
4032 Define this if you have a remote memory space which you
4033 want to use for the local device's environment.
4034
4035 - CONFIG_ENV_ADDR:
4036 - CONFIG_ENV_SIZE:
4037
4038 These two #defines specify the address and size of the
4039 environment area within the remote memory space. The
4040 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004041 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004042
4043BE CAREFUL! For some special cases, the local device can not use
4044"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004045environment stored in a remote NOR flash by SRIO or PCIE link,
4046but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004047
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004048- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004049
4050 Define this if you have a NAND device which you want to use
4051 for the environment.
4052
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004053 - CONFIG_ENV_OFFSET:
4054 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004055
4056 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004057 area within the first NAND device. CONFIG_ENV_OFFSET must be
4058 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004059
Scott Wood08239322010-09-17 14:38:37 -05004060 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004061
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004062 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004063 size used to hold a redundant copy of the environment data, so
4064 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06004065 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004066 aligned to an erase block boundary.
4067
4068 - CONFIG_ENV_RANGE (optional):
4069
4070 Specifies the length of the region in which the environment
4071 can be written. This should be a multiple of the NAND device's
4072 block size. Specifying a range with more erase blocks than
4073 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4074 the range to be avoided.
4075
4076 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004077
Scott Wood08239322010-09-17 14:38:37 -05004078 Enables support for dynamically retrieving the offset of the
4079 environment from block zero's out-of-band data. The
4080 "nand env.oob" command can be used to record this offset.
4081 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4082 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004083
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004084- CONFIG_NAND_ENV_DST
4085
4086 Defines address in RAM to which the nand_spl code should copy the
4087 environment. If redundant environment is used, it will be copied to
4088 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4089
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004090- CONFIG_ENV_IS_IN_UBI:
4091
4092 Define this if you have an UBI volume that you want to use for the
4093 environment. This has the benefit of wear-leveling the environment
4094 accesses, which is important on NAND.
4095
4096 - CONFIG_ENV_UBI_PART:
4097
4098 Define this to a string that is the mtd partition containing the UBI.
4099
4100 - CONFIG_ENV_UBI_VOLUME:
4101
4102 Define this to the name of the volume that you want to store the
4103 environment in.
4104
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004105 - CONFIG_ENV_UBI_VOLUME_REDUND:
4106
4107 Define this to the name of another volume to store a second copy of
4108 the environment in. This will enable redundant environments in UBI.
4109 It is assumed that both volumes are in the same MTD partition.
4110
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004111 - CONFIG_UBI_SILENCE_MSG
4112 - CONFIG_UBIFS_SILENCE_MSG
4113
4114 You will probably want to define these to avoid a really noisy system
4115 when storing the env in UBI.
4116
Wu, Josha7d0c872014-06-24 17:31:03 +08004117- CONFIG_ENV_IS_IN_FAT:
4118 Define this if you want to use the FAT file system for the environment.
4119
4120 - FAT_ENV_INTERFACE:
4121
4122 Define this to a string that is the name of the block device.
4123
4124 - FAT_ENV_DEV_AND_PART:
4125
4126 Define this to a string to specify the partition of the device. It can
4127 be as following:
4128
4129 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4130 - "D:P": device D partition P. Error occurs if device D has no
4131 partition table.
4132 - "D:0": device D.
4133 - "D" or "D:": device D partition 1 if device D has partition
4134 table, or the whole device D if has no partition
4135 table.
4136 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004137 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004138 partition table then means device D.
4139
4140 - FAT_ENV_FILE:
4141
4142 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004143 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004144
4145 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004146 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004147
Stephen Warreneedcacd2013-06-11 15:14:00 -06004148- CONFIG_ENV_IS_IN_MMC:
4149
4150 Define this if you have an MMC device which you want to use for the
4151 environment.
4152
4153 - CONFIG_SYS_MMC_ENV_DEV:
4154
4155 Specifies which MMC device the environment is stored in.
4156
4157 - CONFIG_SYS_MMC_ENV_PART (optional):
4158
4159 Specifies which MMC partition the environment is stored in. If not
4160 set, defaults to partition 0, the user area. Common values might be
4161 1 (first MMC boot partition), 2 (second MMC boot partition).
4162
4163 - CONFIG_ENV_OFFSET:
4164 - CONFIG_ENV_SIZE:
4165
4166 These two #defines specify the offset and size of the environment
4167 area within the specified MMC device.
4168
Stephen Warren24dc2032013-06-11 15:14:02 -06004169 If offset is positive (the usual case), it is treated as relative to
4170 the start of the MMC partition. If offset is negative, it is treated
4171 as relative to the end of the MMC partition. This can be useful if
4172 your board may be fitted with different MMC devices, which have
4173 different sizes for the MMC partitions, and you always want the
4174 environment placed at the very end of the partition, to leave the
4175 maximum possible space before it, to store other data.
4176
Stephen Warreneedcacd2013-06-11 15:14:00 -06004177 These two values are in units of bytes, but must be aligned to an
4178 MMC sector boundary.
4179
4180 - CONFIG_ENV_OFFSET_REDUND (optional):
4181
4182 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4183 hold a redundant copy of the environment data. This provides a
4184 valid backup copy in case the other copy is corrupted, e.g. due
4185 to a power failure during a "saveenv" operation.
4186
Stephen Warren24dc2032013-06-11 15:14:02 -06004187 This value may also be positive or negative; this is handled in the
4188 same way as CONFIG_ENV_OFFSET.
4189
Stephen Warreneedcacd2013-06-11 15:14:00 -06004190 This value is also in units of bytes, but must also be aligned to
4191 an MMC sector boundary.
4192
4193 - CONFIG_ENV_SIZE_REDUND (optional):
4194
4195 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4196 set. If this value is set, it must be set to the same value as
4197 CONFIG_ENV_SIZE.
4198
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004199- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004200
4201 Defines offset to the initial SPI buffer area in DPRAM. The
4202 area is used at an early stage (ROM part) if the environment
4203 is configured to reside in the SPI EEPROM: We need a 520 byte
4204 scratch DPRAM area. It is used between the two initialization
4205 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4206 to be a good choice since it makes it far enough from the
4207 start of the data area as well as from the stack pointer.
4208
Bruce Adleredecc942007-11-02 13:15:42 -07004209Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004210has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004211created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004212until then to read environment variables.
4213
wdenk8dba0502003-03-31 16:34:49 +00004214The environment is protected by a CRC32 checksum. Before the monitor
4215is relocated into RAM, as a result of a bad CRC you will be working
4216with the compiled-in default environment - *silently*!!! [This is
4217necessary, because the first environment variable we need is the
4218"baudrate" setting for the console - if we have a bad CRC, we don't
4219have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004220
4221Note: once the monitor has been relocated, then it will complain if
4222the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004223use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004224
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004225- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004226 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004227
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004228 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004229 also needs to be defined.
4230
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004231- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004232 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004233
Ron Madriddfa028a2009-02-18 14:30:44 -08004234- CONFIG_NS16550_MIN_FUNCTIONS:
4235 Define this if you desire to only have use of the NS16550_init
4236 and NS16550_putc functions for the serial driver located at
4237 drivers/serial/ns16550.c. This option is useful for saving
4238 space for already greatly restricted images, including but not
4239 limited to NAND_SPL configurations.
4240
Simon Glass28a9e332012-11-30 13:01:18 +00004241- CONFIG_DISPLAY_BOARDINFO
4242 Display information about the board that U-Boot is running on
4243 when U-Boot starts up. The board function checkboard() is called
4244 to do this.
4245
Simon Glasse8822012012-11-30 13:01:19 +00004246- CONFIG_DISPLAY_BOARDINFO_LATE
4247 Similar to the previous option, but display this information
4248 later, once stdio is running and output goes to the LCD, if
4249 present.
4250
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004251- CONFIG_BOARD_SIZE_LIMIT:
4252 Maximum size of the U-Boot image. When defined, the
4253 build system checks that the actual size does not
4254 exceed it.
4255
wdenkc6097192002-11-03 00:24:07 +00004256Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004257---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004258
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004259- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004260 Cache Line Size of the CPU.
4261
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004262- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004263 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004264
wdenk9c53f402003-10-15 23:53:47 +00004265 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4266 and RPXsuper) to be able to adjust the position of
4267 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004268
Timur Tabid8f341c2011-08-04 18:03:41 -05004269- CONFIG_SYS_CCSRBAR_DEFAULT:
4270 Default (power-on reset) physical address of CCSR on Freescale
4271 PowerPC SOCs.
4272
4273- CONFIG_SYS_CCSRBAR:
4274 Virtual address of CCSR. On a 32-bit build, this is typically
4275 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4276
4277 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4278 for cross-platform code that uses that macro instead.
4279
4280- CONFIG_SYS_CCSRBAR_PHYS:
4281 Physical address of CCSR. CCSR can be relocated to a new
4282 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004283 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004284 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4285 is typically relocated on 36-bit builds. It is recommended
4286 that this macro be defined via the _HIGH and _LOW macros:
4287
4288 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4289 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4290
4291- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004292 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4293 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004294 used in assembly code, so it must not contain typecasts or
4295 integer size suffixes (e.g. "ULL").
4296
4297- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4298 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4299 used in assembly code, so it must not contain typecasts or
4300 integer size suffixes (e.g. "ULL").
4301
4302- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4303 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4304 forced to a value that ensures that CCSR is not relocated.
4305
wdenk1272e232002-11-10 22:06:23 +00004306- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004307 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004308
4309 the default drive number (default value 0)
4310
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004311 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004312
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004313 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004314 (default value 1)
4315
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004316 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004317
wdenk4a5c8a72003-03-06 00:02:04 +00004318 defines the offset of register from address. It
4319 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004320 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004321
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004322 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4323 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004324 default value.
wdenk1272e232002-11-10 22:06:23 +00004325
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004326 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004327 fdc_hw_init() is called at the beginning of the FDC
4328 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004329 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004330 initializations.
wdenk1272e232002-11-10 22:06:23 +00004331
Macpaul Lind1e49942011-04-11 20:45:32 +00004332- CONFIG_IDE_AHB:
4333 Most IDE controllers were designed to be connected with PCI
4334 interface. Only few of them were designed for AHB interface.
4335 When software is doing ATA command and data transfer to
4336 IDE devices through IDE-AHB controller, some additional
4337 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004338 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004339
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004340- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004341 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004342 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004343
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004344- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004345
wdenkeb20ad32003-09-05 23:19:14 +00004346 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004347 initial data and stack; please note that this must be
4348 writable memory that is working WITHOUT special
4349 initialization, i. e. you CANNOT use normal RAM which
4350 will become available only after programming the
4351 memory controller and running certain initialization
4352 sequences.
4353
4354 U-Boot uses the following memory types:
4355 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4356 - MPC824X: data cache
4357 - PPC4xx: data cache
4358
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004359- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004360
4361 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004362 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4363 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004364 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004365 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004366 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004367 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4368 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004369
4370 Note:
4371 On the MPC824X (or other systems that use the data
4372 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004373 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004374 point to an otherwise UNUSED address space between
4375 the top of RAM and the start of the PCI space.
4376
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004377- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004378
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004379- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004380
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004381- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004382
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004383- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004384
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004385- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004386
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004387- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004388
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004389- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004390 SDRAM timing
4391
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004392- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004393 periodic timer for refresh
4394
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004395- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004397- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4398 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4399 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4400 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004401 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4402
4403- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004404 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4405 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004406 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004408- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4409 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004410 Machine Mode Register and Memory Periodic Timer
4411 Prescaler definitions (SDRAM timing)
4412
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004413- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004414 enable I2C microcode relocation patch (MPC8xx);
4415 define relocation offset in DPRAM [DSP2]
4416
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004417- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004418 enable SMC microcode relocation patch (MPC8xx);
4419 define relocation offset in DPRAM [SMC1]
4420
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004421- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004422 enable SPI microcode relocation patch (MPC8xx);
4423 define relocation offset in DPRAM [SCC4]
4424
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004425- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004426 Offset of the bootmode word in DPRAM used by post
4427 (Power On Self Tests). This definition overrides
4428 #define'd default value in commproc.h resp.
4429 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004430
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004431- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4432 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4433 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4434 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4435 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4436 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4437 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4438 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004439 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004440
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004441- CONFIG_PCI_DISABLE_PCIE:
4442 Disable PCI-Express on systems where it is supported but not
4443 required.
4444
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004445- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004446 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004447 Don't do any setup work, presumably because someone or
4448 something has already done it, and we don't need to do it
4449 a second time. Useful for platforms that are pre-booted
4450 by coreboot or similar.
4451
Gabor Juhosb4458732013-05-30 07:06:12 +00004452- CONFIG_PCI_INDIRECT_BRIDGE:
4453 Enable support for indirect PCI bridges.
4454
Kumar Gala8975d7a2010-12-30 12:09:53 -06004455- CONFIG_SYS_SRIO:
4456 Chip has SRIO or not
4457
4458- CONFIG_SRIO1:
4459 Board has SRIO 1 port available
4460
4461- CONFIG_SRIO2:
4462 Board has SRIO 2 port available
4463
Liu Gang27afb9c2013-05-07 16:30:46 +08004464- CONFIG_SRIO_PCIE_BOOT_MASTER
4465 Board can support master function for Boot from SRIO and PCIE
4466
Kumar Gala8975d7a2010-12-30 12:09:53 -06004467- CONFIG_SYS_SRIOn_MEM_VIRT:
4468 Virtual Address of SRIO port 'n' memory region
4469
4470- CONFIG_SYS_SRIOn_MEM_PHYS:
4471 Physical Address of SRIO port 'n' memory region
4472
4473- CONFIG_SYS_SRIOn_MEM_SIZE:
4474 Size of SRIO port 'n' memory region
4475
Fabio Estevamf17e8782013-04-11 09:35:34 +00004476- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4477 Defined to tell the NAND controller that the NAND chip is using
4478 a 16 bit bus.
4479 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004480 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004481 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004482 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004483
4484- CONFIG_SYS_NDFC_EBC0_CFG
4485 Sets the EBC0_CFG register for the NDFC. If not defined
4486 a default value will be used.
4487
Ben Warren45657152006-09-07 16:50:54 -04004488- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004489 Get DDR timing information from an I2C EEPROM. Common
4490 with pluggable memory modules such as SODIMMs
4491
Ben Warren45657152006-09-07 16:50:54 -04004492 SPD_EEPROM_ADDRESS
4493 I2C address of the SPD EEPROM
4494
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004495- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004496 If SPD EEPROM is on an I2C bus other than the first
4497 one, specify here. Note that the value must resolve
4498 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004499
York Sune73cc042011-06-07 09:42:16 +08004500- CONFIG_SYS_DDR_RAW_TIMING
4501 Get DDR timing information from other than SPD. Common with
4502 soldered DDR chips onboard without SPD. DDR raw timing
4503 parameters are extracted from datasheet and hard-coded into
4504 header files or board specific files.
4505
York Sunbd495cf2011-09-16 13:21:35 -07004506- CONFIG_FSL_DDR_INTERACTIVE
4507 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4508
York Sun8ced0502015-01-06 13:18:55 -08004509- CONFIG_FSL_DDR_SYNC_REFRESH
4510 Enable sync of refresh for multiple controllers.
4511
York Sunb6a35f82015-03-19 09:30:28 -07004512- CONFIG_FSL_DDR_BIST
4513 Enable built-in memory test for Freescale DDR controllers.
4514
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004515- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004516 Only for 83xx systems. If specified, then DDR should
4517 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004518
wdenk6203e402004-04-18 10:13:26 +00004519- CONFIG_ETHER_ON_FEC[12]
4520 Define to enable FEC[12] on a 8xx series processor.
4521
4522- CONFIG_FEC[12]_PHY
4523 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004524 to the given FEC; i. e.
4525 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004526 means that the PHY with address 4 is connected to FEC1
4527
4528 When set to -1, means to probe for first available.
4529
4530- CONFIG_FEC[12]_PHY_NORXERR
4531 The PHY does not have a RXERR line (RMII only).
4532 (so program the FEC to ignore it).
4533
4534- CONFIG_RMII
4535 Enable RMII mode for all FECs.
4536 Note that this is a global option, we can't
4537 have one FEC in standard MII mode and another in RMII mode.
4538
wdenk20c98a62004-04-23 20:32:05 +00004539- CONFIG_CRC32_VERIFY
4540 Add a verify option to the crc32 command.
4541 The syntax is:
4542
4543 => crc32 -v <address> <count> <crc32>
4544
4545 Where address/count indicate a memory area
4546 and crc32 is the correct crc32 which the
4547 area should have.
4548
wdenk64519362004-07-11 17:40:54 +00004549- CONFIG_LOOPW
4550 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004551 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004552
stroesecc3af832004-12-16 18:46:55 +00004553- CONFIG_MX_CYCLIC
4554 Add the "mdc" and "mwc" memory commands. These are cyclic
4555 "md/mw" commands.
4556 Examples:
4557
wdenk07d7e6b2004-12-16 21:44:03 +00004558 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004559 This command will print 4 bytes (10,11,12,13) each 500 ms.
4560
wdenk07d7e6b2004-12-16 21:44:03 +00004561 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004562 This command will write 12345678 to address 100 all 10 ms.
4563
wdenk07d7e6b2004-12-16 21:44:03 +00004564 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004565 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004566
wdenk3d3d99f2005-04-04 12:44:11 +00004567- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004568 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004569 low level initializations (like setting up the memory
4570 controller) are omitted and/or U-Boot does not
4571 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004572
Wolfgang Denk302141d2010-11-27 23:30:56 +01004573 Normally this variable MUST NOT be defined. The only
4574 exception is when U-Boot is loaded (to RAM) by some
4575 other boot loader or by a debugger which performs
4576 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004577
Simon Glass90844072016-05-05 07:28:06 -06004578- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4579 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004580 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004581 instruction cache) is still performed.
4582
Aneesh V552a3192011-07-13 05:11:07 +00004583- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004584 Modifies the behaviour of start.S when compiling a loader
4585 that is executed before the actual U-Boot. E.g. when
4586 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004587
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004588- CONFIG_TPL_BUILD
4589 Modifies the behaviour of start.S when compiling a loader
4590 that is executed after the SPL and before the actual U-Boot.
4591 It is loaded by the SPL.
4592
Ying Zhang0d4f5442013-05-20 14:07:23 +08004593- CONFIG_SYS_MPC85XX_NO_RESETVEC
4594 Only for 85xx systems. If this variable is specified, the section
4595 .resetvec is not kept and the section .bootpg is placed in the
4596 previous 4k of the .text section.
4597
Simon Glass17dabf02013-02-24 17:33:14 +00004598- CONFIG_ARCH_MAP_SYSMEM
4599 Generally U-Boot (and in particular the md command) uses
4600 effective address. It is therefore not necessary to regard
4601 U-Boot address as virtual addresses that need to be translated
4602 to physical addresses. However, sandbox requires this, since
4603 it maintains its own little RAM buffer which contains all
4604 addressable memory. This option causes some memory accesses
4605 to be mapped through map_sysmem() / unmap_sysmem().
4606
Matthias Weisser93416c12011-03-10 21:36:32 +00004607- CONFIG_USE_ARCH_MEMCPY
4608 CONFIG_USE_ARCH_MEMSET
4609 If these options are used a optimized version of memcpy/memset will
4610 be used if available. These functions may be faster under some
4611 conditions but may increase the binary size.
4612
Simon Glassbfb59802013-02-14 04:18:54 +00004613- CONFIG_X86_RESET_VECTOR
4614 If defined, the x86 reset vector code is included. This is not
4615 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004616
Mark Jackson52b003c2013-03-04 01:27:20 +00004617- CONFIG_SYS_MPUCLK
4618 Defines the MPU clock speed (in MHz).
4619
4620 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004621
Heiko Schocher2233e462013-11-04 14:05:00 +01004622- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4623 Enables the RTC32K OSC on AM33xx based plattforms
4624
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004625- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4626 Option to disable subpage write in NAND driver
4627 driver that uses this:
4628 drivers/mtd/nand/davinci_nand.c
4629
Timur Tabi275f4bb2011-11-22 09:21:25 -06004630Freescale QE/FMAN Firmware Support:
4631-----------------------------------
4632
4633The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4634loading of "firmware", which is encoded in the QE firmware binary format.
4635This firmware often needs to be loaded during U-Boot booting, so macros
4636are used to identify the storage device (NOR flash, SPI, etc) and the address
4637within that device.
4638
Zhao Qiang83a90842014-03-21 16:21:44 +08004639- CONFIG_SYS_FMAN_FW_ADDR
4640 The address in the storage device where the FMAN microcode is located. The
4641 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4642 is also specified.
4643
4644- CONFIG_SYS_QE_FW_ADDR
4645 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004646 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4647 is also specified.
4648
4649- CONFIG_SYS_QE_FMAN_FW_LENGTH
4650 The maximum possible size of the firmware. The firmware binary format
4651 has a field that specifies the actual size of the firmware, but it
4652 might not be possible to read any part of the firmware unless some
4653 local storage is allocated to hold the entire firmware first.
4654
4655- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4656 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4657 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4658 virtual address in NOR flash.
4659
4660- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4661 Specifies that QE/FMAN firmware is located in NAND flash.
4662 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4663
4664- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4665 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4666 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4667
Liu Gang1e084582012-03-08 00:33:18 +00004668- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4669 Specifies that QE/FMAN firmware is located in the remote (master)
4670 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004671 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4672 window->master inbound window->master LAW->the ucode address in
4673 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004674
J. German Rivera8ff14b72014-06-23 15:15:55 -07004675Freescale Layerscape Management Complex Firmware Support:
4676---------------------------------------------------------
4677The Freescale Layerscape Management Complex (MC) supports the loading of
4678"firmware".
4679This firmware often needs to be loaded during U-Boot booting, so macros
4680are used to identify the storage device (NOR flash, SPI, etc) and the address
4681within that device.
4682
4683- CONFIG_FSL_MC_ENET
4684 Enable the MC driver for Layerscape SoCs.
4685
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304686Freescale Layerscape Debug Server Support:
4687-------------------------------------------
4688The Freescale Layerscape Debug Server Support supports the loading of
4689"Debug Server firmware" and triggering SP boot-rom.
4690This firmware often needs to be loaded during U-Boot booting.
4691
York Sun928b6812015-12-07 11:08:58 -08004692- CONFIG_SYS_MC_RSV_MEM_ALIGN
4693 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304694
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004695Reproducible builds
4696-------------------
4697
4698In order to achieve reproducible builds, timestamps used in the U-Boot build
4699process have to be set to a fixed value.
4700
4701This is done using the SOURCE_DATE_EPOCH environment variable.
4702SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4703option for U-Boot or an environment variable in U-Boot.
4704
4705SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4706
wdenkc6097192002-11-03 00:24:07 +00004707Building the Software:
4708======================
4709
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004710Building U-Boot has been tested in several native build environments
4711and in many different cross environments. Of course we cannot support
4712all possibly existing versions of cross development tools in all
4713(potentially obsolete) versions. In case of tool chain problems we
4714recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4715which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004716
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004717If you are not using a native environment, it is assumed that you
4718have GNU cross compiling tools available in your path. In this case,
4719you must set the environment variable CROSS_COMPILE in your shell.
4720Note that no changes to the Makefile or any other source files are
4721necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004722
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004723 $ CROSS_COMPILE=ppc_4xx-
4724 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004725
Peter Tyserb06976d2009-03-13 18:54:51 -05004726Note: If you wish to generate Windows versions of the utilities in
4727 the tools directory you can use the MinGW toolchain
4728 (http://www.mingw.org). Set your HOST tools to the MinGW
4729 toolchain and execute 'make tools'. For example:
4730
4731 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4732
4733 Binaries such as tools/mkimage.exe will be created which can
4734 be executed on computers running Windows.
4735
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004736U-Boot is intended to be simple to build. After installing the
4737sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004738is done by typing:
4739
Holger Freyther7ba4e572014-08-04 09:26:05 +02004740 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004741
Holger Freyther7ba4e572014-08-04 09:26:05 +02004742where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004743rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004744
wdenk6c59edc2004-05-03 20:45:30 +00004745Note: for some board special configuration names may exist; check if
4746 additional information is available from the board vendor; for
4747 instance, the TQM823L systems are available without (standard)
4748 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004749 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004750
Holger Freyther7ba4e572014-08-04 09:26:05 +02004751 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004752 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004753
Holger Freyther7ba4e572014-08-04 09:26:05 +02004754 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004755 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004756
wdenk6c59edc2004-05-03 20:45:30 +00004757 etc.
wdenkc6097192002-11-03 00:24:07 +00004758
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk6c59edc2004-05-03 20:45:30 +00004760Finally, type "make all", and you should get some working U-Boot
4761images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004762
wdenk6c59edc2004-05-03 20:45:30 +00004763- "u-boot.bin" is a raw binary image
4764- "u-boot" is an image in ELF binary format
4765- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004766
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004767By default the build is performed locally and the objects are saved
4768in the source directory. One of the two methods can be used to change
4769this behavior and build U-Boot to some external directory:
4770
47711. Add O= to the make command line invocations:
4772
4773 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004774 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004775 make O=/tmp/build all
4776
Timo Ketolac8c67602014-11-06 14:39:05 +020047772. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004778
Timo Ketolac8c67602014-11-06 14:39:05 +02004779 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004780 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004781 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004782 make all
4783
Timo Ketolac8c67602014-11-06 14:39:05 +02004784Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004785variable.
4786
wdenkc6097192002-11-03 00:24:07 +00004787
wdenk6c59edc2004-05-03 20:45:30 +00004788Please be aware that the Makefiles assume you are using GNU make, so
4789for instance on NetBSD you might need to use "gmake" instead of
4790native "make".
wdenkc6097192002-11-03 00:24:07 +00004791
wdenkc6097192002-11-03 00:24:07 +00004792
wdenk6c59edc2004-05-03 20:45:30 +00004793If the system board that you have is not listed, then you will need
4794to port U-Boot to your hardware platform. To do this, follow these
4795steps:
wdenkc6097192002-11-03 00:24:07 +00004796
Phil Sutterc77b4882015-12-25 14:41:18 +010047971. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004798 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004799 the "Makefile" and a "<board>.c".
48002. Create a new configuration file "include/configs/<board>.h" for
4801 your board.
wdenk6c59edc2004-05-03 20:45:30 +000048023. If you're porting U-Boot to a new CPU, then also create a new
4803 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020048044. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000048055. Type "make", and you should get a working "u-boot.srec" file
4806 to be installed on your target system.
48076. Debug and solve any problems that might arise.
4808 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004809
wdenkc6097192002-11-03 00:24:07 +00004810
wdenk6c59edc2004-05-03 20:45:30 +00004811Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4812==============================================================
wdenkc6097192002-11-03 00:24:07 +00004813
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004814If you have modified U-Boot sources (for instance added a new board
4815or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004816provide feedback to the other developers. The feedback normally takes
4817the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004818official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004819
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004820But before you submit such a patch, please verify that your modifi-
4821cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004822the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004823just run the buildman script (tools/buildman/buildman), which will
4824configure and build U-Boot for ALL supported system. Be warned, this
4825will take a while. Please see the buildman README, or run 'buildman -H'
4826for documentation.
wdenkc6097192002-11-03 00:24:07 +00004827
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004828
wdenk6c59edc2004-05-03 20:45:30 +00004829See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004830
wdenkc6097192002-11-03 00:24:07 +00004831
wdenk6c59edc2004-05-03 20:45:30 +00004832Monitor Commands - Overview:
4833============================
wdenkc6097192002-11-03 00:24:07 +00004834
wdenk6c59edc2004-05-03 20:45:30 +00004835go - start application at address 'addr'
4836run - run commands in an environment variable
4837bootm - boot application image from memory
4838bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004839bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004840tftpboot- boot image via network using TFTP protocol
4841 and env variables "ipaddr" and "serverip"
4842 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004843tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004844rarpboot- boot image via network using RARP/TFTP protocol
4845diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4846loads - load S-Record file over serial line
4847loadb - load binary file over serial line (kermit mode)
4848md - memory display
4849mm - memory modify (auto-incrementing)
4850nm - memory modify (constant address)
4851mw - memory write (fill)
4852cp - memory copy
4853cmp - memory compare
4854crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004855i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004856sspi - SPI utility commands
4857base - print or set address offset
4858printenv- print environment variables
4859setenv - set environment variables
4860saveenv - save environment variables to persistent storage
4861protect - enable or disable FLASH write protection
4862erase - erase FLASH memory
4863flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004864nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004865bdinfo - print Board Info structure
4866iminfo - print header information for application image
4867coninfo - print console devices and informations
4868ide - IDE sub-system
4869loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004870loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004871mtest - simple RAM test
4872icache - enable or disable instruction cache
4873dcache - enable or disable data cache
4874reset - Perform RESET of the CPU
4875echo - echo args to console
4876version - print monitor version
4877help - print online help
4878? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004879
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881Monitor Commands - Detailed Description:
4882========================================
wdenkc6097192002-11-03 00:24:07 +00004883
wdenk6c59edc2004-05-03 20:45:30 +00004884TODO.
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk6c59edc2004-05-03 20:45:30 +00004886For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004887
4888
wdenk6c59edc2004-05-03 20:45:30 +00004889Environment Variables:
4890======================
wdenkc6097192002-11-03 00:24:07 +00004891
wdenk6c59edc2004-05-03 20:45:30 +00004892U-Boot supports user configuration using Environment Variables which
4893can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004894
wdenk6c59edc2004-05-03 20:45:30 +00004895Environment Variables are set using "setenv", printed using
4896"printenv", and saved to Flash using "saveenv". Using "setenv"
4897without a value can be used to delete a variable from the
4898environment. As long as you don't save the environment you are
4899working with an in-memory copy. In case the Flash area containing the
4900environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004901
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004902Some configuration options can be set using Environment Variables.
4903
4904List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004905
wdenk6c59edc2004-05-03 20:45:30 +00004906 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004907
wdenk6c59edc2004-05-03 20:45:30 +00004908 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004909
wdenk6c59edc2004-05-03 20:45:30 +00004910 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004911
wdenk6c59edc2004-05-03 20:45:30 +00004912 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004913
wdenk6c59edc2004-05-03 20:45:30 +00004914 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004915
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004916 bootm_low - Memory range available for image processing in the bootm
4917 command can be restricted. This variable is given as
4918 a hexadecimal number and defines lowest address allowed
4919 for use by the bootm command. See also "bootm_size"
4920 environment variable. Address defined by "bootm_low" is
4921 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004922 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4923 bootm_mapsize.
4924
Wolfgang Denk092ae952011-10-26 10:21:21 +00004925 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004926 This variable is given as a hexadecimal number and it
4927 defines the size of the memory region starting at base
4928 address bootm_low that is accessible by the Linux kernel
4929 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4930 as the default value if it is defined, and bootm_size is
4931 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004932
4933 bootm_size - Memory range available for image processing in the bootm
4934 command can be restricted. This variable is given as
4935 a hexadecimal number and defines the size of the region
4936 allowed for use by the bootm command. See also "bootm_low"
4937 environment variable.
4938
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004939 updatefile - Location of the software update file on a TFTP server, used
4940 by the automatic software update feature. Please refer to
4941 documentation in doc/README.update for more details.
4942
wdenk6c59edc2004-05-03 20:45:30 +00004943 autoload - if set to "no" (any string beginning with 'n'),
4944 "bootp" will just load perform a lookup of the
4945 configuration from the BOOTP server, but not try to
4946 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004947
wdenk6c59edc2004-05-03 20:45:30 +00004948 autostart - if set to "yes", an image loaded using the "bootp",
4949 "rarpboot", "tftpboot" or "diskboot" commands will
4950 be automatically started (by internally calling
4951 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004952
wdenk6c59edc2004-05-03 20:45:30 +00004953 If set to "no", a standalone image passed to the
4954 "bootm" command will be copied to the load address
4955 (and eventually uncompressed), but NOT be started.
4956 This can be used to load and uncompress arbitrary
4957 data.
wdenkc6097192002-11-03 00:24:07 +00004958
David A. Longd558a4e2011-07-09 16:40:19 -04004959 fdt_high - if set this restricts the maximum address that the
4960 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004961 For example, if you have a system with 1 GB memory
4962 at physical address 0x10000000, while Linux kernel
4963 only recognizes the first 704 MB as low memory, you
4964 may need to set fdt_high as 0x3C000000 to have the
4965 device tree blob be copied to the maximum address
4966 of the 704 MB low memory, so that Linux kernel can
4967 access it during the boot procedure.
4968
David A. Longd558a4e2011-07-09 16:40:19 -04004969 If this is set to the special value 0xFFFFFFFF then
4970 the fdt will not be copied at all on boot. For this
4971 to work it must reside in writable memory, have
4972 sufficient padding on the end of it for u-boot to
4973 add the information it needs into it, and the memory
4974 must be accessible by the kernel.
4975
Simon Glassdc6fa642011-10-24 19:15:34 +00004976 fdtcontroladdr- if set this is the address of the control flattened
4977 device tree used by U-Boot when CONFIG_OF_CONTROL is
4978 defined.
4979
wdenk0e2bd9c2004-06-06 21:51:03 +00004980 i2cfast - (PPC405GP|PPC405EP only)
4981 if set to 'y' configures Linux I2C driver for fast
4982 mode (400kHZ). This environment variable is used in
4983 initialization code. So, for changes to be effective
4984 it must be saved and board must be reset.
4985
wdenk6c59edc2004-05-03 20:45:30 +00004986 initrd_high - restrict positioning of initrd images:
4987 If this variable is not set, initrd images will be
4988 copied to the highest possible address in RAM; this
4989 is usually what you want since it allows for
4990 maximum initrd size. If for some reason you want to
4991 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004992 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004993 variable to a value of "no" or "off" or "0".
4994 Alternatively, you can set it to a maximum upper
4995 address to use (U-Boot will still check that it
4996 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004997
wdenk6c59edc2004-05-03 20:45:30 +00004998 For instance, when you have a system with 16 MB
4999 RAM, and want to reserve 4 MB from use by Linux,
5000 you can do this by adding "mem=12M" to the value of
5001 the "bootargs" variable. However, now you must make
5002 sure that the initrd image is placed in the first
5003 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005004
wdenk6c59edc2004-05-03 20:45:30 +00005005 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005006
wdenk6c59edc2004-05-03 20:45:30 +00005007 If you set initrd_high to 0xFFFFFFFF, this is an
5008 indication to U-Boot that all addresses are legal
5009 for the Linux kernel, including addresses in flash
5010 memory. In this case U-Boot will NOT COPY the
5011 ramdisk at all. This may be useful to reduce the
5012 boot time on your system, but requires that this
5013 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005014
wdenk6c59edc2004-05-03 20:45:30 +00005015 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005016
wdenk6c59edc2004-05-03 20:45:30 +00005017 loadaddr - Default load address for commands like "bootp",
5018 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005019
wdenk6c59edc2004-05-03 20:45:30 +00005020 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005021
wdenk6c59edc2004-05-03 20:45:30 +00005022 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005023
wdenk6c59edc2004-05-03 20:45:30 +00005024 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005027
wdenk6c59edc2004-05-03 20:45:30 +00005028 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005029
Mike Frysingera23230c2011-10-02 10:01:27 +00005030 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005031
Mike Frysingera23230c2011-10-02 10:01:27 +00005032 ethact - controls which interface is currently active.
5033 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005034
Heiko Schocherc5e84052010-07-20 17:45:02 +02005035 => setenv ethact FEC
5036 => ping 192.168.0.1 # traffic sent on FEC
5037 => setenv ethact SCC
5038 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005039
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005040 ethrotate - When set to "no" U-Boot does not go through all
5041 available network interfaces.
5042 It just stays at the currently selected interface.
5043
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005044 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005045 either succeed or fail without retrying.
5046 When set to "once" the network operation will
5047 fail when all the available network interfaces
5048 are tried once without success.
5049 Useful on scripts which control the retry operation
5050 themselves.
wdenkc6097192002-11-03 00:24:07 +00005051
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005052 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005053
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005054 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005055 changing the console to be empty. If "yes" it will be
5056 made silent. If "no" it will not be made silent. If
5057 unset, then it will be made silent if the U-Boot console
5058 is silent.
5059
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005060 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005061 UDP source port.
5062
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005063 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005064 destination port instead of the Well Know Port 69.
5065
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005066 tftpblocksize - Block size to use for TFTP transfers; if not set,
5067 we use the TFTP server's default block size
5068
5069 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5070 seconds, minimum value is 1000 = 1 second). Defines
5071 when a packet is considered to be lost so it has to
5072 be retransmitted. The default is 5000 = 5 seconds.
5073 Lowering this value may make downloads succeed
5074 faster in networks with high packet loss rates or
5075 with unreliable TFTP servers.
5076
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005077 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5078 unit, minimum value = 0). Defines how many timeouts
5079 can happen during a single file transfer before that
5080 transfer is aborted. The default is 10, and 0 means
5081 'no timeouts allowed'. Increasing this value may help
5082 downloads succeed with high packet loss rates, or with
5083 unreliable TFTP servers or client hardware.
5084
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005085 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005086 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005087 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005088
Alexandre Messier15971322016-02-01 17:08:57 -05005089 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5090 Unsigned value, in milliseconds. If not set, the period will
5091 be either the default (28000), or a value based on
5092 CONFIG_NET_RETRY_COUNT, if defined. This value has
5093 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5094
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005095The following image location variables contain the location of images
5096used in booting. The "Image" column gives the role of the image and is
5097not an environment variable name. The other columns are environment
5098variable names. "File Name" gives the name of the file on a TFTP
5099server, "RAM Address" gives the location in RAM the image will be
5100loaded to, and "Flash Location" gives the image's address in NOR
5101flash or offset in NAND flash.
5102
5103*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005104boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005105boards use these variables for other purposes.
5106
Wolfgang Denk092ae952011-10-26 10:21:21 +00005107Image File Name RAM Address Flash Location
5108----- --------- ----------- --------------
5109u-boot u-boot u-boot_addr_r u-boot_addr
5110Linux kernel bootfile kernel_addr_r kernel_addr
5111device tree blob fdtfile fdt_addr_r fdt_addr
5112ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005113
wdenk6c59edc2004-05-03 20:45:30 +00005114The following environment variables may be used and automatically
5115updated by the network boot commands ("bootp" and "rarpboot"),
5116depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118 bootfile - see above
5119 dnsip - IP address of your Domain Name Server
5120 dnsip2 - IP address of your secondary Domain Name Server
5121 gatewayip - IP address of the Gateway (Router) to use
5122 hostname - Target hostname
5123 ipaddr - see above
5124 netmask - Subnet Mask
5125 rootpath - Pathname of the root filesystem on the NFS server
5126 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005127
wdenk145d2c12004-04-15 21:48:45 +00005128
wdenk6c59edc2004-05-03 20:45:30 +00005129There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk6c59edc2004-05-03 20:45:30 +00005131 serial# - contains hardware identification information such
5132 as type string and/or serial number
5133 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005134
wdenk6c59edc2004-05-03 20:45:30 +00005135These variables can be set only once (usually during manufacturing of
5136the board). U-Boot refuses to delete or overwrite these variables
5137once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005138
5139
wdenk6c59edc2004-05-03 20:45:30 +00005140Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk6c59edc2004-05-03 20:45:30 +00005142 ver - Contains the U-Boot version string as printed
5143 with the "version" command. This variable is
5144 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005145
wdenkc6097192002-11-03 00:24:07 +00005146
wdenk6c59edc2004-05-03 20:45:30 +00005147Please note that changes to some configuration parameters may take
5148only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005149
stroeseb9c17c52003-04-04 15:53:41 +00005150
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005151Callback functions for environment variables:
5152---------------------------------------------
5153
5154For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005155when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005156be associated with arbitrary variables. On creation, overwrite, or
5157deletion, the callback will provide the opportunity for some side
5158effect to happen or for the change to be rejected.
5159
5160The callbacks are named and associated with a function using the
5161U_BOOT_ENV_CALLBACK macro in your board or driver code.
5162
5163These callbacks are associated with variables in one of two ways. The
5164static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5165in the board configuration to a string that defines a list of
5166associations. The list must be in the following format:
5167
5168 entry = variable_name[:callback_name]
5169 list = entry[,list]
5170
5171If the callback name is not specified, then the callback is deleted.
5172Spaces are also allowed anywhere in the list.
5173
5174Callbacks can also be associated by defining the ".callbacks" variable
5175with the same list format above. Any association in ".callbacks" will
5176override any association in the static list. You can define
5177CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005178".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005179
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005180If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5181regular expression. This allows multiple variables to be connected to
5182the same callback without explicitly listing them all out.
5183
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005184
wdenk6c59edc2004-05-03 20:45:30 +00005185Command Line Parsing:
5186=====================
stroeseb9c17c52003-04-04 15:53:41 +00005187
wdenk6c59edc2004-05-03 20:45:30 +00005188There are two different command line parsers available with U-Boot:
5189the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005190
wdenk6c59edc2004-05-03 20:45:30 +00005191Old, simple command line parser:
5192--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005193
wdenk6c59edc2004-05-03 20:45:30 +00005194- supports environment variables (through setenv / saveenv commands)
5195- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005196- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005197- special characters ('$', ';') can be escaped by prefixing with '\',
5198 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005199 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005200- You can also escape text by enclosing in single apostrophes, for example:
5201 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005202
wdenk6c59edc2004-05-03 20:45:30 +00005203Hush shell:
5204-----------
wdenkf4688a22003-05-28 08:06:31 +00005205
wdenk6c59edc2004-05-03 20:45:30 +00005206- similar to Bourne shell, with control structures like
5207 if...then...else...fi, for...do...done; while...do...done,
5208 until...do...done, ...
5209- supports environment ("global") variables (through setenv / saveenv
5210 commands) and local shell variables (through standard shell syntax
5211 "name=value"); only environment variables can be used with "run"
5212 command
wdenkf4688a22003-05-28 08:06:31 +00005213
wdenk6c59edc2004-05-03 20:45:30 +00005214General rules:
5215--------------
wdenkf4688a22003-05-28 08:06:31 +00005216
wdenk6c59edc2004-05-03 20:45:30 +00005217(1) If a command line (or an environment variable executed by a "run"
5218 command) contains several commands separated by semicolon, and
5219 one of these commands fails, then the remaining commands will be
5220 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005221
wdenk6c59edc2004-05-03 20:45:30 +00005222(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005223 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005224 command will cause "run" to terminate, i. e. the remaining
5225 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005226
wdenk6c59edc2004-05-03 20:45:30 +00005227Note for Redundant Ethernet Interfaces:
5228=======================================
wdenkf4688a22003-05-28 08:06:31 +00005229
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005230Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005231such configurations and is capable of automatic selection of a
5232"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005233
wdenk6c59edc2004-05-03 20:45:30 +00005234Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5235MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5236"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005237
wdenk6c59edc2004-05-03 20:45:30 +00005238If the network interface stores some valid MAC address (for instance
5239in SROM), this is used as default address if there is NO correspon-
5240ding setting in the environment; if the corresponding environment
5241variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005242
wdenk6c59edc2004-05-03 20:45:30 +00005243o If the SROM has a valid MAC address, and there is no address in the
5244 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005245
wdenk6c59edc2004-05-03 20:45:30 +00005246o If there is no valid address in the SROM, and a definition in the
5247 environment exists, then the value from the environment variable is
5248 used.
wdenkc6097192002-11-03 00:24:07 +00005249
wdenk6c59edc2004-05-03 20:45:30 +00005250o If both the SROM and the environment contain a MAC address, and
5251 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005252
wdenk6c59edc2004-05-03 20:45:30 +00005253o If both the SROM and the environment contain a MAC address, and the
5254 addresses differ, the value from the environment is used and a
5255 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005256
wdenk6c59edc2004-05-03 20:45:30 +00005257o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005258 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5259 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005260
Ben Warren6db991a2010-04-26 11:11:46 -07005261If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005262will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005263may be skipped by setting the appropriate 'ethmacskip' environment variable.
5264The naming convention is as follows:
5265"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005266
wdenk6c59edc2004-05-03 20:45:30 +00005267Image Formats:
5268==============
wdenkc6097192002-11-03 00:24:07 +00005269
Marian Balakowicz18710b82008-03-12 12:13:13 +01005270U-Boot is capable of booting (and performing other auxiliary operations on)
5271images in two formats:
5272
5273New uImage format (FIT)
5274-----------------------
5275
5276Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5277to Flattened Device Tree). It allows the use of images with multiple
5278components (several kernels, ramdisks, etc.), with contents protected by
5279SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5280
5281
5282Old uImage format
5283-----------------
5284
5285Old image format is based on binary files which can be basically anything,
5286preceded by a special header; see the definitions in include/image.h for
5287details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005288
wdenk6c59edc2004-05-03 20:45:30 +00005289* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5290 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005291 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5292 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5293 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005294* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005295 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5296 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005297* Compression Type (uncompressed, gzip, bzip2)
5298* Load Address
5299* Entry Point
5300* Image Name
5301* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk6c59edc2004-05-03 20:45:30 +00005303The header is marked by a special Magic Number, and both the header
5304and the data portions of the image are secured against corruption by
5305CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005306
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk6c59edc2004-05-03 20:45:30 +00005308Linux Support:
5309==============
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk6c59edc2004-05-03 20:45:30 +00005311Although U-Boot should support any OS or standalone application
5312easily, the main focus has always been on Linux during the design of
5313U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk6c59edc2004-05-03 20:45:30 +00005315U-Boot includes many features that so far have been part of some
5316special "boot loader" code within the Linux kernel. Also, any
5317"initrd" images to be used are no longer part of one big Linux image;
5318instead, kernel and "initrd" are separate images. This implementation
5319serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk6c59edc2004-05-03 20:45:30 +00005321- the same features can be used for other OS or standalone
5322 applications (for instance: using compressed images to reduce the
5323 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005324
wdenk6c59edc2004-05-03 20:45:30 +00005325- it becomes much easier to port new Linux kernel versions because
5326 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk6c59edc2004-05-03 20:45:30 +00005328- the same Linux kernel image can now be used with different "initrd"
5329 images; of course this also means that different kernel images can
5330 be run with the same "initrd". This makes testing easier (you don't
5331 have to build a new "zImage.initrd" Linux image when you just
5332 change a file in your "initrd"). Also, a field-upgrade of the
5333 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005334
wdenkc6097192002-11-03 00:24:07 +00005335
wdenk6c59edc2004-05-03 20:45:30 +00005336Linux HOWTO:
5337============
wdenkc6097192002-11-03 00:24:07 +00005338
wdenk6c59edc2004-05-03 20:45:30 +00005339Porting Linux to U-Boot based systems:
5340---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005341
wdenk6c59edc2004-05-03 20:45:30 +00005342U-Boot cannot save you from doing all the necessary modifications to
5343configure the Linux device drivers for use with your target hardware
5344(no, we don't intend to provide a full virtual machine interface to
5345Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005346
Stefan Roese88fbf932010-04-15 16:07:28 +02005347But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349Just make sure your machine specific header file (for instance
5350include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005351Information structure as we define in include/asm-<arch>/u-boot.h,
5352and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005353as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005354
Simon Glassd097e592014-06-11 23:29:46 -06005355Note that U-Boot now has a driver model, a unified model for drivers.
5356If you are adding a new driver, plumb it into driver model. If there
5357is no uclass available, you are encouraged to create one. See
5358doc/driver-model.
5359
wdenkc6097192002-11-03 00:24:07 +00005360
wdenk6c59edc2004-05-03 20:45:30 +00005361Configuring the Linux kernel:
5362-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005363
wdenk6c59edc2004-05-03 20:45:30 +00005364No specific requirements for U-Boot. Make sure you have some root
5365device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005366
wdenkc6097192002-11-03 00:24:07 +00005367
wdenk6c59edc2004-05-03 20:45:30 +00005368Building a Linux Image:
5369-----------------------
wdenkc6097192002-11-03 00:24:07 +00005370
wdenk6c59edc2004-05-03 20:45:30 +00005371With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5372not used. If you use recent kernel source, a new build target
5373"uImage" will exist which automatically builds an image usable by
5374U-Boot. Most older kernels also have support for a "pImage" target,
5375which was introduced for our predecessor project PPCBoot and uses a
5376100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378Example:
wdenkc6097192002-11-03 00:24:07 +00005379
Holger Freyther7ba4e572014-08-04 09:26:05 +02005380 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005381 make oldconfig
5382 make dep
5383 make uImage
wdenkc6097192002-11-03 00:24:07 +00005384
wdenk6c59edc2004-05-03 20:45:30 +00005385The "uImage" build target uses a special tool (in 'tools/mkimage') to
5386encapsulate a compressed Linux kernel image with header information,
5387CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005388
wdenk6c59edc2004-05-03 20:45:30 +00005389* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005392
wdenk6c59edc2004-05-03 20:45:30 +00005393 ${CROSS_COMPILE}-objcopy -O binary \
5394 -R .note -R .comment \
5395 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005396
wdenk6c59edc2004-05-03 20:45:30 +00005397* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005398
wdenk6c59edc2004-05-03 20:45:30 +00005399 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005400
wdenk6c59edc2004-05-03 20:45:30 +00005401* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005402
wdenk6c59edc2004-05-03 20:45:30 +00005403 mkimage -A ppc -O linux -T kernel -C gzip \
5404 -a 0 -e 0 -n "Linux Kernel Image" \
5405 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005406
wdenkc6097192002-11-03 00:24:07 +00005407
wdenk6c59edc2004-05-03 20:45:30 +00005408The "mkimage" tool can also be used to create ramdisk images for use
5409with U-Boot, either separated from the Linux kernel image, or
5410combined into one file. "mkimage" encapsulates the images with a 64
5411byte header containing information about target architecture,
5412operating system, image type, compression method, entry points, time
5413stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005414
wdenk6c59edc2004-05-03 20:45:30 +00005415"mkimage" can be called in two ways: to verify existing images and
5416print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005417
wdenk6c59edc2004-05-03 20:45:30 +00005418In the first form (with "-l" option) mkimage lists the information
5419contained in the header of an existing U-Boot image; this includes
5420checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005421
wdenk6c59edc2004-05-03 20:45:30 +00005422 tools/mkimage -l image
5423 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005424
wdenk6c59edc2004-05-03 20:45:30 +00005425The second form (with "-d" option) is used to build a U-Boot image
5426from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005427
wdenk6c59edc2004-05-03 20:45:30 +00005428 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5429 -n name -d data_file image
5430 -A ==> set architecture to 'arch'
5431 -O ==> set operating system to 'os'
5432 -T ==> set image type to 'type'
5433 -C ==> set compression type 'comp'
5434 -a ==> set load address to 'addr' (hex)
5435 -e ==> set entry point to 'ep' (hex)
5436 -n ==> set image name to 'name'
5437 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005438
wdenkcd914452004-05-29 16:53:29 +00005439Right now, all Linux kernels for PowerPC systems use the same load
5440address (0x00000000), but the entry point address depends on the
5441kernel version:
wdenkc6097192002-11-03 00:24:07 +00005442
wdenk6c59edc2004-05-03 20:45:30 +00005443- 2.2.x kernels have the entry point at 0x0000000C,
5444- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005445
wdenk6c59edc2004-05-03 20:45:30 +00005446So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk6c59edc2004-05-03 20:45:30 +00005448 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5449 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005450 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005451 > examples/uImage.TQM850L
5452 Image Name: 2.4.4 kernel for TQM850L
5453 Created: Wed Jul 19 02:34:59 2000
5454 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5455 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5456 Load Address: 0x00000000
5457 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005458
wdenk6c59edc2004-05-03 20:45:30 +00005459To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk6c59edc2004-05-03 20:45:30 +00005461 -> tools/mkimage -l examples/uImage.TQM850L
5462 Image Name: 2.4.4 kernel for TQM850L
5463 Created: Wed Jul 19 02:34:59 2000
5464 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5465 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5466 Load Address: 0x00000000
5467 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005468
wdenk6c59edc2004-05-03 20:45:30 +00005469NOTE: for embedded systems where boot time is critical you can trade
5470speed for memory and install an UNCOMPRESSED image instead: this
5471needs more space in Flash, but boots much faster since it does not
5472need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005473
Stefan Roese88fbf932010-04-15 16:07:28 +02005474 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005475 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5476 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005477 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005478 > examples/uImage.TQM850L-uncompressed
5479 Image Name: 2.4.4 kernel for TQM850L
5480 Created: Wed Jul 19 02:34:59 2000
5481 Image Type: PowerPC Linux Kernel Image (uncompressed)
5482 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5483 Load Address: 0x00000000
5484 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005485
wdenkc6097192002-11-03 00:24:07 +00005486
wdenk6c59edc2004-05-03 20:45:30 +00005487Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5488when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005489
wdenk6c59edc2004-05-03 20:45:30 +00005490 -> tools/mkimage -n 'Simple Ramdisk Image' \
5491 > -A ppc -O linux -T ramdisk -C gzip \
5492 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5493 Image Name: Simple Ramdisk Image
5494 Created: Wed Jan 12 14:01:50 2000
5495 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5496 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5497 Load Address: 0x00000000
5498 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005499
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005500The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5501option performs the converse operation of the mkimage's second form (the "-d"
5502option). Given an image built by mkimage, the dumpimage extracts a "data file"
5503from the image:
5504
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005505 tools/dumpimage -i image -T type -p position data_file
5506 -i ==> extract from the 'image' a specific 'data_file'
5507 -T ==> set image type to 'type'
5508 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005509
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk6c59edc2004-05-03 20:45:30 +00005511Installing a Linux Image:
5512-------------------------
wdenkc6097192002-11-03 00:24:07 +00005513
wdenk6c59edc2004-05-03 20:45:30 +00005514To downloading a U-Boot image over the serial (console) interface,
5515you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005516
wdenk6c59edc2004-05-03 20:45:30 +00005517 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005518
wdenk6c59edc2004-05-03 20:45:30 +00005519The 'objcopy' does not understand the information in the U-Boot
5520image header, so the resulting S-Record file will be relative to
5521address 0x00000000. To load it to a given address, you need to
5522specify the target address as 'offset' parameter with the 'loads'
5523command.
wdenkc6097192002-11-03 00:24:07 +00005524
wdenk6c59edc2004-05-03 20:45:30 +00005525Example: install the image to address 0x40100000 (which on the
5526TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005527
wdenk6c59edc2004-05-03 20:45:30 +00005528 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk6c59edc2004-05-03 20:45:30 +00005530 .......... done
5531 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533 => loads 40100000
5534 ## Ready for S-Record download ...
5535 ~>examples/image.srec
5536 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5537 ...
5538 15989 15990 15991 15992
5539 [file transfer complete]
5540 [connected]
5541 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005542
wdenkc6097192002-11-03 00:24:07 +00005543
wdenk6c59edc2004-05-03 20:45:30 +00005544You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005545this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005546corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005547
wdenk6c59edc2004-05-03 20:45:30 +00005548 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005549
wdenk6c59edc2004-05-03 20:45:30 +00005550 ## Checking Image at 40100000 ...
5551 Image Name: 2.2.13 for initrd on TQM850L
5552 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5553 Data Size: 335725 Bytes = 327 kB = 0 MB
5554 Load Address: 00000000
5555 Entry Point: 0000000c
5556 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005557
5558
wdenk6c59edc2004-05-03 20:45:30 +00005559Boot Linux:
5560-----------
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk6c59edc2004-05-03 20:45:30 +00005562The "bootm" command is used to boot an application that is stored in
5563memory (RAM or Flash). In case of a Linux kernel image, the contents
5564of the "bootargs" environment variable is passed to the kernel as
5565parameters. You can check and modify this variable using the
5566"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005567
wdenkc6097192002-11-03 00:24:07 +00005568
wdenk6c59edc2004-05-03 20:45:30 +00005569 => printenv bootargs
5570 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005571
wdenk6c59edc2004-05-03 20:45:30 +00005572 => 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 +00005573
wdenk6c59edc2004-05-03 20:45:30 +00005574 => printenv bootargs
5575 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 +00005576
wdenk6c59edc2004-05-03 20:45:30 +00005577 => bootm 40020000
5578 ## Booting Linux kernel at 40020000 ...
5579 Image Name: 2.2.13 for NFS on TQM850L
5580 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5581 Data Size: 381681 Bytes = 372 kB = 0 MB
5582 Load Address: 00000000
5583 Entry Point: 0000000c
5584 Verifying Checksum ... OK
5585 Uncompressing Kernel Image ... OK
5586 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
5587 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5588 time_init: decrementer frequency = 187500000/60
5589 Calibrating delay loop... 49.77 BogoMIPS
5590 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5591 ...
wdenkc6097192002-11-03 00:24:07 +00005592
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005593If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005594the memory addresses of both the kernel and the initrd image (PPBCOOT
5595format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk6c59edc2004-05-03 20:45:30 +00005597 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005598
wdenk6c59edc2004-05-03 20:45:30 +00005599 ## Checking Image at 40100000 ...
5600 Image Name: 2.2.13 for initrd on TQM850L
5601 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5602 Data Size: 335725 Bytes = 327 kB = 0 MB
5603 Load Address: 00000000
5604 Entry Point: 0000000c
5605 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607 ## Checking Image at 40200000 ...
5608 Image Name: Simple Ramdisk Image
5609 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5610 Data Size: 566530 Bytes = 553 kB = 0 MB
5611 Load Address: 00000000
5612 Entry Point: 00000000
5613 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615 => bootm 40100000 40200000
5616 ## Booting Linux kernel at 40100000 ...
5617 Image Name: 2.2.13 for initrd on TQM850L
5618 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5619 Data Size: 335725 Bytes = 327 kB = 0 MB
5620 Load Address: 00000000
5621 Entry Point: 0000000c
5622 Verifying Checksum ... OK
5623 Uncompressing Kernel Image ... OK
5624 ## Loading RAMDisk Image at 40200000 ...
5625 Image Name: Simple Ramdisk Image
5626 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5627 Data Size: 566530 Bytes = 553 kB = 0 MB
5628 Load Address: 00000000
5629 Entry Point: 00000000
5630 Verifying Checksum ... OK
5631 Loading Ramdisk ... OK
5632 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
5633 Boot arguments: root=/dev/ram
5634 time_init: decrementer frequency = 187500000/60
5635 Calibrating delay loop... 49.77 BogoMIPS
5636 ...
5637 RAMDISK: Compressed image found at block 0
5638 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005639
wdenk6c59edc2004-05-03 20:45:30 +00005640 bash#
wdenkc6097192002-11-03 00:24:07 +00005641
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005642Boot Linux and pass a flat device tree:
5643-----------
5644
5645First, U-Boot must be compiled with the appropriate defines. See the section
5646titled "Linux Kernel Interface" above for a more in depth explanation. The
5647following is an example of how to start a kernel and pass an updated
5648flat device tree:
5649
5650=> print oftaddr
5651oftaddr=0x300000
5652=> print oft
5653oft=oftrees/mpc8540ads.dtb
5654=> tftp $oftaddr $oft
5655Speed: 1000, full duplex
5656Using TSEC0 device
5657TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5658Filename 'oftrees/mpc8540ads.dtb'.
5659Load address: 0x300000
5660Loading: #
5661done
5662Bytes transferred = 4106 (100a hex)
5663=> tftp $loadaddr $bootfile
5664Speed: 1000, full duplex
5665Using TSEC0 device
5666TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5667Filename 'uImage'.
5668Load address: 0x200000
5669Loading:############
5670done
5671Bytes transferred = 1029407 (fb51f hex)
5672=> print loadaddr
5673loadaddr=200000
5674=> print oftaddr
5675oftaddr=0x300000
5676=> bootm $loadaddr - $oftaddr
5677## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005678 Image Name: Linux-2.6.17-dirty
5679 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5680 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005681 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005682 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005683 Verifying Checksum ... OK
5684 Uncompressing Kernel Image ... OK
5685Booting using flat device tree at 0x300000
5686Using MPC85xx ADS machine description
5687Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5688[snip]
5689
5690
wdenk6c59edc2004-05-03 20:45:30 +00005691More About U-Boot Image Types:
5692------------------------------
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005695
wdenk6c59edc2004-05-03 20:45:30 +00005696 "Standalone Programs" are directly runnable in the environment
5697 provided by U-Boot; it is expected that (if they behave
5698 well) you can continue to work in U-Boot after return from
5699 the Standalone Program.
5700 "OS Kernel Images" are usually images of some Embedded OS which
5701 will take over control completely. Usually these programs
5702 will install their own set of exception handlers, device
5703 drivers, set up the MMU, etc. - this means, that you cannot
5704 expect to re-enter U-Boot except by resetting the CPU.
5705 "RAMDisk Images" are more or less just data blocks, and their
5706 parameters (address, size) are passed to an OS kernel that is
5707 being started.
5708 "Multi-File Images" contain several images, typically an OS
5709 (Linux) kernel image and one or more data images like
5710 RAMDisks. This construct is useful for instance when you want
5711 to boot over the network using BOOTP etc., where the boot
5712 server provides just a single image file, but you want to get
5713 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005714
wdenk6c59edc2004-05-03 20:45:30 +00005715 "Multi-File Images" start with a list of image sizes, each
5716 image size (in bytes) specified by an "uint32_t" in network
5717 byte order. This list is terminated by an "(uint32_t)0".
5718 Immediately after the terminating 0 follow the images, one by
5719 one, all aligned on "uint32_t" boundaries (size rounded up to
5720 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005721
wdenk6c59edc2004-05-03 20:45:30 +00005722 "Firmware Images" are binary images containing firmware (like
5723 U-Boot or FPGA images) which usually will be programmed to
5724 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005725
wdenk6c59edc2004-05-03 20:45:30 +00005726 "Script files" are command sequences that will be executed by
5727 U-Boot's command interpreter; this feature is especially
5728 useful when you configure U-Boot to use a real shell (hush)
5729 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005730
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005731Booting the Linux zImage:
5732-------------------------
5733
5734On some platforms, it's possible to boot Linux zImage. This is done
5735using the "bootz" command. The syntax of "bootz" command is the same
5736as the syntax of "bootm" command.
5737
Tom Rini45f46d12013-05-16 11:40:11 -04005738Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005739kernel with raw initrd images. The syntax is slightly different, the
5740address of the initrd must be augmented by it's size, in the following
5741format: "<initrd addres>:<initrd size>".
5742
stroeseb9c17c52003-04-04 15:53:41 +00005743
wdenk6c59edc2004-05-03 20:45:30 +00005744Standalone HOWTO:
5745=================
stroeseb9c17c52003-04-04 15:53:41 +00005746
wdenk6c59edc2004-05-03 20:45:30 +00005747One of the features of U-Boot is that you can dynamically load and
5748run "standalone" applications, which can use some resources of
5749U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005750
wdenk6c59edc2004-05-03 20:45:30 +00005751Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005752
wdenk6c59edc2004-05-03 20:45:30 +00005753"Hello World" Demo:
5754-------------------
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756'examples/hello_world.c' contains a small "Hello World" Demo
5757application; it is automatically compiled when you build U-Boot.
5758It's configured to run at address 0x00040004, so you can play with it
5759like that:
wdenkc6097192002-11-03 00:24:07 +00005760
wdenk6c59edc2004-05-03 20:45:30 +00005761 => loads
5762 ## Ready for S-Record download ...
5763 ~>examples/hello_world.srec
5764 1 2 3 4 5 6 7 8 9 10 11 ...
5765 [file transfer complete]
5766 [connected]
5767 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769 => go 40004 Hello World! This is a test.
5770 ## Starting application at 0x00040004 ...
5771 Hello World
5772 argc = 7
5773 argv[0] = "40004"
5774 argv[1] = "Hello"
5775 argv[2] = "World!"
5776 argv[3] = "This"
5777 argv[4] = "is"
5778 argv[5] = "a"
5779 argv[6] = "test."
5780 argv[7] = "<NULL>"
5781 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005782
wdenk6c59edc2004-05-03 20:45:30 +00005783 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005784
wdenk6c59edc2004-05-03 20:45:30 +00005785Another example, which demonstrates how to register a CPM interrupt
5786handler with the U-Boot code, can be found in 'examples/timer.c'.
5787Here, a CPM timer is set up to generate an interrupt every second.
5788The interrupt service routine is trivial, just printing a '.'
5789character, but this is just a demo program. The application can be
5790controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005791
wdenk6c59edc2004-05-03 20:45:30 +00005792 ? - print current values og the CPM Timer registers
5793 b - enable interrupts and start timer
5794 e - stop timer and disable interrupts
5795 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005796
wdenk6c59edc2004-05-03 20:45:30 +00005797 => loads
5798 ## Ready for S-Record download ...
5799 ~>examples/timer.srec
5800 1 2 3 4 5 6 7 8 9 10 11 ...
5801 [file transfer complete]
5802 [connected]
5803 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005804
wdenk6c59edc2004-05-03 20:45:30 +00005805 => go 40004
5806 ## Starting application at 0x00040004 ...
5807 TIMERS=0xfff00980
5808 Using timer 1
5809 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005810
wdenk6c59edc2004-05-03 20:45:30 +00005811Hit 'b':
5812 [q, b, e, ?] Set interval 1000000 us
5813 Enabling timer
5814Hit '?':
5815 [q, b, e, ?] ........
5816 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5817Hit '?':
5818 [q, b, e, ?] .
5819 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5820Hit '?':
5821 [q, b, e, ?] .
5822 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5823Hit '?':
5824 [q, b, e, ?] .
5825 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5826Hit 'e':
5827 [q, b, e, ?] ...Stopping timer
5828Hit 'q':
5829 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005830
wdenkc6097192002-11-03 00:24:07 +00005831
wdenk6c59edc2004-05-03 20:45:30 +00005832Minicom warning:
5833================
wdenkc6097192002-11-03 00:24:07 +00005834
wdenk6c59edc2004-05-03 20:45:30 +00005835Over time, many people have reported problems when trying to use the
5836"minicom" terminal emulation program for serial download. I (wd)
5837consider minicom to be broken, and recommend not to use it. Under
5838Unix, I recommend to use C-Kermit for general purpose use (and
5839especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005840use "cu" for S-Record download ("loads" command). See
5841http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5842for help with kermit.
5843
wdenkc6097192002-11-03 00:24:07 +00005844
wdenk6c59edc2004-05-03 20:45:30 +00005845Nevertheless, if you absolutely want to use it try adding this
5846configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005847
wdenk6c59edc2004-05-03 20:45:30 +00005848 Name Program Name U/D FullScr IO-Red. Multi
5849 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5850 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005851
wdenk8dba0502003-03-31 16:34:49 +00005852
wdenk6c59edc2004-05-03 20:45:30 +00005853NetBSD Notes:
5854=============
wdenkc6097192002-11-03 00:24:07 +00005855
wdenk6c59edc2004-05-03 20:45:30 +00005856Starting at version 0.9.2, U-Boot supports NetBSD both as host
5857(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005858
wdenk6c59edc2004-05-03 20:45:30 +00005859Building requires a cross environment; it is known to work on
5860NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5861need gmake since the Makefiles are not compatible with BSD make).
5862Note that the cross-powerpc package does not install include files;
5863attempting to build U-Boot will fail because <machine/ansi.h> is
5864missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005865
wdenk6c59edc2004-05-03 20:45:30 +00005866 # cd /usr/pkg/cross/powerpc-netbsd/include
5867 # mkdir powerpc
5868 # ln -s powerpc machine
5869 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5870 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005871
wdenk6c59edc2004-05-03 20:45:30 +00005872Native builds *don't* work due to incompatibilities between native
5873and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005874
wdenk6c59edc2004-05-03 20:45:30 +00005875Booting assumes that (the first part of) the image booted is a
5876stage-2 loader which in turn loads and then invokes the kernel
5877proper. Loader sources will eventually appear in the NetBSD source
5878tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005879meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005880
wdenkc6097192002-11-03 00:24:07 +00005881
wdenk6c59edc2004-05-03 20:45:30 +00005882Implementation Internals:
5883=========================
wdenkc6097192002-11-03 00:24:07 +00005884
wdenk6c59edc2004-05-03 20:45:30 +00005885The following is not intended to be a complete description of every
5886implementation detail. However, it should help to understand the
5887inner workings of U-Boot and make it easier to port it to custom
5888hardware.
wdenkc6097192002-11-03 00:24:07 +00005889
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk6c59edc2004-05-03 20:45:30 +00005891Initial Stack, Global Data:
5892---------------------------
wdenkc6097192002-11-03 00:24:07 +00005893
wdenk6c59edc2004-05-03 20:45:30 +00005894The implementation of U-Boot is complicated by the fact that U-Boot
5895starts running out of ROM (flash memory), usually without access to
5896system RAM (because the memory controller is not initialized yet).
5897This means that we don't have writable Data or BSS segments, and BSS
5898is not initialized as zero. To be able to get a C environment working
5899at all, we have to allocate at least a minimal stack. Implementation
5900options for this are defined and restricted by the CPU used: Some CPU
5901models provide on-chip memory (like the IMMR area on MPC8xx and
5902MPC826x processors), on others (parts of) the data cache can be
5903locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005904
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005905 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005906 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005907
wdenk6c59edc2004-05-03 20:45:30 +00005908 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5909 From: "Chris Hallinan" <clh@net1plus.com>
5910 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5911 ...
wdenkc6097192002-11-03 00:24:07 +00005912
wdenk6c59edc2004-05-03 20:45:30 +00005913 Correct me if I'm wrong, folks, but the way I understand it
5914 is this: Using DCACHE as initial RAM for Stack, etc, does not
5915 require any physical RAM backing up the cache. The cleverness
5916 is that the cache is being used as a temporary supply of
5917 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005918 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005919 can see how this works by studying the cache architecture and
5920 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005921
wdenk6c59edc2004-05-03 20:45:30 +00005922 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5923 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005924 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005925 option should work for you. Using CS 4 should be fine if your
5926 board designers haven't used it for something that would
5927 cause you grief during the initial boot! It is frequently not
5928 used.
wdenkc6097192002-11-03 00:24:07 +00005929
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005930 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005931 with your processor/board/system design. The default value
5932 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005933 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005934 than your SDRAM module. If you have a 64MB SDRAM module, set
5935 it above 400_0000. Just make sure your board has no resources
5936 that are supposed to respond to that address! That code in
5937 start.S has been around a while and should work as is when
5938 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005939
wdenk6c59edc2004-05-03 20:45:30 +00005940 -Chris Hallinan
5941 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005942
wdenk6c59edc2004-05-03 20:45:30 +00005943It is essential to remember this, since it has some impact on the C
5944code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005945
wdenk6c59edc2004-05-03 20:45:30 +00005946* Initialized global data (data segment) is read-only. Do not attempt
5947 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005948
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005949* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005950 as zero data - BSS segment) at all - this is undefined, initiali-
5951 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005952
wdenk6c59edc2004-05-03 20:45:30 +00005953* Stack space is very limited. Avoid big data buffers or things like
5954 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005955
wdenk6c59edc2004-05-03 20:45:30 +00005956Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005957normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005958turned out that the implementation of U-Boot can be greatly
5959simplified by making a global data structure (gd_t) available to all
5960functions. We could pass a pointer to this data as argument to _all_
5961functions, but this would bloat the code. Instead we use a feature of
5962the GCC compiler (Global Register Variables) to share the data: we
5963place a pointer (gd) to the global data into a register which we
5964reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005965
wdenk6c59edc2004-05-03 20:45:30 +00005966When choosing a register for such a purpose we are restricted by the
5967relevant (E)ABI specifications for the current architecture, and by
5968GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005969
wdenk6c59edc2004-05-03 20:45:30 +00005970For PowerPC, the following registers have specific use:
5971 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005972 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005973 R3-R4: parameter passing and return values
5974 R5-R10: parameter passing
5975 R13: small data area pointer
5976 R30: GOT pointer
5977 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005978
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005979 (U-Boot also uses R12 as internal GOT pointer. r12
5980 is a volatile register so r12 needs to be reset when
5981 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005982
Wolfgang Denk69c09642008-02-14 22:43:22 +01005983 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005984
wdenk6c59edc2004-05-03 20:45:30 +00005985 Note: on PPC, we could use a static initializer (since the
5986 address of the global data structure is known at compile time),
5987 but it turned out that reserving a register results in somewhat
5988 smaller code - although the code savings are not that big (on
5989 average for all boards 752 bytes for the whole U-Boot image,
5990 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005991
Robin Getz2773d5f2009-08-17 15:23:02 +00005992On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005993 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5994
Robin Getz2773d5f2009-08-17 15:23:02 +00005995 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005996
wdenk6c59edc2004-05-03 20:45:30 +00005997On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005998
wdenk6c59edc2004-05-03 20:45:30 +00005999 R0: function argument word/integer result
6000 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006001 R9: platform specific
6002 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006003 R11: argument (frame) pointer
6004 R12: temporary workspace
6005 R13: stack pointer
6006 R14: link register
6007 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006008
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006009 ==> U-Boot will use R9 to hold a pointer to the global data
6010
6011 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006012
Thomas Chou8fa38582010-05-21 11:08:03 +08006013On Nios II, the ABI is documented here:
6014 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6015
6016 ==> U-Boot will use gp to hold a pointer to the global data
6017
6018 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6019 to access small data sections, so gp is free.
6020
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006021On NDS32, the following registers are used:
6022
6023 R0-R1: argument/return
6024 R2-R5: argument
6025 R15: temporary register for assembler
6026 R16: trampoline register
6027 R28: frame pointer (FP)
6028 R29: global pointer (GP)
6029 R30: link register (LP)
6030 R31: stack pointer (SP)
6031 PC: program counter (PC)
6032
6033 ==> U-Boot will use R10 to hold a pointer to the global data
6034
Wolfgang Denk6405a152006-03-31 18:32:53 +02006035NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6036or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006037
wdenk6c59edc2004-05-03 20:45:30 +00006038Memory Management:
6039------------------
wdenkc6097192002-11-03 00:24:07 +00006040
wdenk6c59edc2004-05-03 20:45:30 +00006041U-Boot runs in system state and uses physical addresses, i.e. the
6042MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006043
wdenk6c59edc2004-05-03 20:45:30 +00006044The available memory is mapped to fixed addresses using the memory
6045controller. In this process, a contiguous block is formed for each
6046memory type (Flash, SDRAM, SRAM), even when it consists of several
6047physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006048
wdenk6c59edc2004-05-03 20:45:30 +00006049U-Boot is installed in the first 128 kB of the first Flash bank (on
6050TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6051booting and sizing and initializing DRAM, the code relocates itself
6052to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006053memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006054configuration setting]. Below that, a structure with global Board
6055Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006056
wdenk6c59edc2004-05-03 20:45:30 +00006057Additionally, some exception handler code is copied to the low 8 kB
6058of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006059
wdenk6c59edc2004-05-03 20:45:30 +00006060So a typical memory configuration with 16 MB of DRAM could look like
6061this:
wdenkc6097192002-11-03 00:24:07 +00006062
wdenk6c59edc2004-05-03 20:45:30 +00006063 0x0000 0000 Exception Vector code
6064 :
6065 0x0000 1FFF
6066 0x0000 2000 Free for Application Use
6067 :
6068 :
wdenkc6097192002-11-03 00:24:07 +00006069
wdenk6c59edc2004-05-03 20:45:30 +00006070 :
6071 :
6072 0x00FB FF20 Monitor Stack (Growing downward)
6073 0x00FB FFAC Board Info Data and permanent copy of global data
6074 0x00FC 0000 Malloc Arena
6075 :
6076 0x00FD FFFF
6077 0x00FE 0000 RAM Copy of Monitor Code
6078 ... eventually: LCD or video framebuffer
6079 ... eventually: pRAM (Protected RAM - unchanged by reset)
6080 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006081
wdenkc6097192002-11-03 00:24:07 +00006082
wdenk6c59edc2004-05-03 20:45:30 +00006083System Initialization:
6084----------------------
wdenkc6097192002-11-03 00:24:07 +00006085
wdenk6c59edc2004-05-03 20:45:30 +00006086In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006087(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006088configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006089To be able to re-map memory U-Boot then jumps to its link address.
6090To be able to implement the initialization code in C, a (small!)
6091initial stack is set up in the internal Dual Ported RAM (in case CPUs
6092which provide such a feature like MPC8xx or MPC8260), or in a locked
6093part of the data cache. After that, U-Boot initializes the CPU core,
6094the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006095
wdenk6c59edc2004-05-03 20:45:30 +00006096Next, all (potentially) available memory banks are mapped using a
6097preliminary mapping. For example, we put them on 512 MB boundaries
6098(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6099on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6100programmed for SDRAM access. Using the temporary configuration, a
6101simple memory test is run that determines the size of the SDRAM
6102banks.
wdenkc6097192002-11-03 00:24:07 +00006103
wdenk6c59edc2004-05-03 20:45:30 +00006104When there is more than one SDRAM bank, and the banks are of
6105different size, the largest is mapped first. For equal size, the first
6106bank (CS2#) is mapped first. The first mapping is always for address
61070x00000000, with any additional banks following immediately to create
6108contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006109
wdenk6c59edc2004-05-03 20:45:30 +00006110Then, the monitor installs itself at the upper end of the SDRAM area
6111and allocates memory for use by malloc() and for the global Board
6112Info data; also, the exception vector code is copied to the low RAM
6113pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006114
wdenk6c59edc2004-05-03 20:45:30 +00006115Only after this relocation will you have a "normal" C environment;
6116until that you are restricted in several ways, mostly because you are
6117running from ROM, and because the code will have to be relocated to a
6118new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006119
wdenkc6097192002-11-03 00:24:07 +00006120
wdenk6c59edc2004-05-03 20:45:30 +00006121U-Boot Porting Guide:
6122----------------------
wdenkc6097192002-11-03 00:24:07 +00006123
wdenk6c59edc2004-05-03 20:45:30 +00006124[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6125list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006126
wdenkc6097192002-11-03 00:24:07 +00006127
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006128int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006129{
6130 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006131
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006132 signal(SIGALRM, no_more_time);
6133 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006134
wdenk6c59edc2004-05-03 20:45:30 +00006135 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006136 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006137 return 0;
6138 }
wdenkc6097192002-11-03 00:24:07 +00006139
wdenk6c59edc2004-05-03 20:45:30 +00006140 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006141
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006142 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006143
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006144 if (clueless)
6145 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006146
wdenk6c59edc2004-05-03 20:45:30 +00006147 while (learning) {
6148 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006149 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6150 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006151 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006152 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006153 }
wdenkc6097192002-11-03 00:24:07 +00006154
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006155 if (available_money > toLocalCurrency ($2500))
6156 Buy a BDI3000;
6157 else
wdenk6c59edc2004-05-03 20:45:30 +00006158 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006159
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006160 if (a similar board exists) { /* hopefully... */
6161 cp -a board/<similar> board/<myboard>
6162 cp include/configs/<similar>.h include/configs/<myboard>.h
6163 } else {
6164 Create your own board support subdirectory;
6165 Create your own board include/configs/<myboard>.h file;
6166 }
6167 Edit new board/<myboard> files
6168 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006169
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006170 while (!accepted) {
6171 while (!running) {
6172 do {
6173 Add / modify source code;
6174 } until (compiles);
6175 Debug;
6176 if (clueless)
6177 email("Hi, I am having problems...");
6178 }
6179 Send patch file to the U-Boot email list;
6180 if (reasonable critiques)
6181 Incorporate improvements from email list code review;
6182 else
6183 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006184 }
wdenkc6097192002-11-03 00:24:07 +00006185
wdenk6c59edc2004-05-03 20:45:30 +00006186 return 0;
6187}
wdenkc6097192002-11-03 00:24:07 +00006188
wdenk6c59edc2004-05-03 20:45:30 +00006189void no_more_time (int sig)
6190{
6191 hire_a_guru();
6192}
wdenkc6097192002-11-03 00:24:07 +00006193
wdenkc6097192002-11-03 00:24:07 +00006194
wdenk6c59edc2004-05-03 20:45:30 +00006195Coding Standards:
6196-----------------
wdenkc6097192002-11-03 00:24:07 +00006197
wdenk6c59edc2004-05-03 20:45:30 +00006198All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006199coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006200"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006201
6202Source files originating from a different project (for example the
6203MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006204reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006205sources.
wdenkc6097192002-11-03 00:24:07 +00006206
Detlev Zundelaa63d482006-09-01 15:39:02 +02006207Please note that U-Boot is implemented in C (and to some small parts in
6208Assembler); no C++ is used, so please do not use C++ style comments (//)
6209in your code.
wdenkad276f22004-01-04 16:28:35 +00006210
wdenk6c59edc2004-05-03 20:45:30 +00006211Please also stick to the following formatting rules:
6212- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006213- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006214- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006215- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006216- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006217
wdenk6c59edc2004-05-03 20:45:30 +00006218Submissions which do not conform to the standards may be returned
6219with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006220
wdenkc6097192002-11-03 00:24:07 +00006221
wdenk6c59edc2004-05-03 20:45:30 +00006222Submitting Patches:
6223-------------------
wdenkc6097192002-11-03 00:24:07 +00006224
wdenk6c59edc2004-05-03 20:45:30 +00006225Since the number of patches for U-Boot is growing, we need to
6226establish some rules. Submissions which do not conform to these rules
6227may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006228
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006229Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006230
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006231Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6232see http://lists.denx.de/mailman/listinfo/u-boot
6233
wdenk6c59edc2004-05-03 20:45:30 +00006234When you send a patch, please include the following information with
6235it:
wdenkc6097192002-11-03 00:24:07 +00006236
wdenk6c59edc2004-05-03 20:45:30 +00006237* For bug fixes: a description of the bug and how your patch fixes
6238 this bug. Please try to include a way of demonstrating that the
6239 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006240
wdenk6c59edc2004-05-03 20:45:30 +00006241* For new features: a description of the feature and your
6242 implementation.
wdenkc6097192002-11-03 00:24:07 +00006243
wdenk6c59edc2004-05-03 20:45:30 +00006244* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006245
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006246* For major contributions, add a MAINTAINERS file with your
6247 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006248
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006249* When you add support for a new board, don't forget to add a
6250 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006251
wdenk6c59edc2004-05-03 20:45:30 +00006252* If your patch adds new configuration options, don't forget to
6253 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006254
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006255* The patch itself. If you are using git (which is *strongly*
6256 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006257 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006258 the U-Boot mailing list, you will avoid most of the common problems
6259 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006260
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006261 If you cannot use git, use "diff -purN OLD NEW". If your version of
6262 diff does not support these options, then get the latest version of
6263 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006264
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006265 The current directory when running this command shall be the parent
6266 directory of the U-Boot source tree (i. e. please make sure that
6267 your patch includes sufficient directory information for the
6268 affected files).
6269
6270 We prefer patches as plain text. MIME attachments are discouraged,
6271 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006272
wdenk6c59edc2004-05-03 20:45:30 +00006273* If one logical set of modifications affects or creates several
6274 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006275
wdenk6c59edc2004-05-03 20:45:30 +00006276* Changesets that contain different, unrelated modifications shall be
6277 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006278
wdenkc6097192002-11-03 00:24:07 +00006279
wdenk6c59edc2004-05-03 20:45:30 +00006280Notes:
wdenkc6097192002-11-03 00:24:07 +00006281
Simon Glassdc27def2016-07-27 20:33:08 -06006282* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006283 source tree and make sure that no errors or warnings are reported
6284 for any of the boards.
6285
6286* Keep your modifications to the necessary minimum: A patch
6287 containing several unrelated changes or arbitrary reformats will be
6288 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006289
wdenk6c59edc2004-05-03 20:45:30 +00006290* If you modify existing code, make sure that your new code does not
6291 add to the memory footprint of the code ;-) Small is beautiful!
6292 When adding new features, these should compile conditionally only
6293 (using #ifdef), and the resulting code with the new feature
6294 disabled must not need more memory than the old code without your
6295 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006296
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006297* Remember that there is a size limit of 100 kB per message on the
6298 u-boot mailing list. Bigger patches will be moderated. If they are
6299 reasonable and not too big, they will be acknowledged. But patches
6300 bigger than the size limit should be avoided.