blob: aa907ced8a0a3484acdf9458acdc99816822f87c [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denkb240aef2008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschin08337f32008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000112
wdenk24ee89b2002-11-03 17:56:27 +0000113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
wdenkc6097192002-11-03 00:24:07 +0000116
wdenk7474aca2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Webere89e6282010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000126
Thomas Webere89e6282010-09-28 08:06:25 +0200127Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /blackfin Files generic to Analog Devices Blackfin architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500143 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000144 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500145 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400146 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200147 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500148 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149 /sh Files generic to SH architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150 /sparc Files generic to SPARC architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400151 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500152/api Machine/arch independent API for external apps
153/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800154/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500155/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500156/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500157/disk Code for disk drive partition handling
158/doc Documentation (don't expect too much)
159/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400160/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500161/examples Example code for standalone applications, etc.
162/fs Filesystem code (cramfs, ext2, jffs2, etc.)
163/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500164/lib Library routines generic to all architectures
165/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500166/net Networking code
167/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500168/scripts Various build scripts and Makefiles
169/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500170/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000171
wdenkc6097192002-11-03 00:24:07 +0000172Software Configuration:
173=======================
174
175Configuration is usually done using C preprocessor defines; the
176rationale behind that is to avoid dead code whenever possible.
177
178There are two classes of configuration variables:
179
180* Configuration _OPTIONS_:
181 These are selectable by the user and have names beginning with
182 "CONFIG_".
183
184* Configuration _SETTINGS_:
185 These depend on the hardware etc. and should not be meddled with if
186 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200187 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000188
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500189Previously, all configuration was done by hand, which involved creating
190symbolic links and editing configuration files manually. More recently,
191U-Boot has added the Kbuild infrastructure used by the Linux kernel,
192allowing you to use the "make menuconfig" command to configure your
193build.
wdenkc6097192002-11-03 00:24:07 +0000194
195
196Selection of Processor Architecture and Board Type:
197---------------------------------------------------
198
199For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200200configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000201
202Example: For a TQM823L module type:
203
204 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200205 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000206
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500207Note: If you're looking for the default configuration file for a board
208you're sure used to be there but is now missing, check the file
209doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000210
Simon Glass53552c92014-03-22 17:12:59 -0600211Sandbox Environment:
212--------------------
213
214U-Boot can be built natively to run on a Linux host using the 'sandbox'
215board. This allows feature development which is not board- or architecture-
216specific to be undertaken on a native platform. The sandbox is also used to
217run some of U-Boot's tests.
218
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530219See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600220
221
Simon Glassd8711af2015-03-03 08:03:00 -0700222Board Initialisation Flow:
223--------------------------
224
225This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500226SPL and U-Boot proper (i.e. they both follow the same rules).
227
228Note: "SPL" stands for "Secondary Program Loader," which is explained in
229more detail later in this file.
230
231At present, SPL mostly uses a separate code path, but the function names
232and roles of each function are the same. Some boards or architectures
233may not conform to this. At least most ARM boards which use
234CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700235
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500236Execution typically starts with an architecture-specific (and possibly
237CPU-specific) start.S file, such as:
238
239 - arch/arm/cpu/armv7/start.S
240 - arch/powerpc/cpu/mpc83xx/start.S
241 - arch/mips/cpu/start.S
242
243and so on. From there, three functions are called; the purpose and
244limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700245
246lowlevel_init():
247 - purpose: essential init to permit execution to reach board_init_f()
248 - no global_data or BSS
249 - there is no stack (ARMv7 may have one but it will soon be removed)
250 - must not set up SDRAM or use console
251 - must only do the bare minimum to allow execution to continue to
252 board_init_f()
253 - this is almost never needed
254 - return normally from this function
255
256board_init_f():
257 - purpose: set up the machine ready for running board_init_r():
258 i.e. SDRAM and serial UART
259 - global_data is available
260 - stack is in SRAM
261 - BSS is not available, so you cannot use global/static variables,
262 only stack variables and global_data
263
264 Non-SPL-specific notes:
265 - dram_init() is called to set up DRAM. If already done in SPL this
266 can do nothing
267
268 SPL-specific notes:
269 - you can override the entire board_init_f() function with your own
270 version as needed.
271 - preloader_console_init() can be called here in extremis
272 - should set up SDRAM, and anything needed to make the UART work
273 - these is no need to clear BSS, it will be done by crt0.S
274 - must return normally from this function (don't call board_init_r()
275 directly)
276
277Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
278this point the stack and global_data are relocated to below
279CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
280memory.
281
282board_init_r():
283 - purpose: main execution, common code
284 - global_data is available
285 - SDRAM is available
286 - BSS is available, all static/global variables can be used
287 - execution eventually continues to main_loop()
288
289 Non-SPL-specific notes:
290 - U-Boot is relocated to the top of memory and is now running from
291 there.
292
293 SPL-specific notes:
294 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
295 CONFIG_SPL_STACK_R_ADDR points into SDRAM
296 - preloader_console_init() can be called here - typically this is
297 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
298 spl_board_init() function containing this call
299 - loads U-Boot or (in falcon mode) Linux
300
301
302
wdenkc6097192002-11-03 00:24:07 +0000303Configuration Options:
304----------------------
305
306Configuration depends on the combination of board and CPU type; all
307such information is kept in a configuration file
308"include/configs/<board_name>.h".
309
310Example: For a TQM823L module, all configuration settings are in
311"include/configs/TQM823L.h".
312
313
wdenk1272e232002-11-10 22:06:23 +0000314Many of the options are named exactly as the corresponding Linux
315kernel configuration options. The intention is to make it easier to
316build a config tool - later.
317
318
wdenkc6097192002-11-03 00:24:07 +0000319The following options need to be configured:
320
Kim Phillips203fee32007-08-10 13:28:25 -0500321- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000322
Kim Phillips203fee32007-08-10 13:28:25 -0500323- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200324
325- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100326 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000327
Lei Wen20014762011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala179b1b22011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Scott Wood80806962012-08-14 10:14:53 +0000379 CONFIG_SYS_FSL_ERRATUM_A004510
380
381 Enables a workaround for erratum A004510. If set,
382 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
383 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
384
385 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
386 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
387
388 Defines one or two SoC revisions (low 8 bits of SVR)
389 for which the A004510 workaround should be applied.
390
391 The rest of SVR is either not relevant to the decision
392 of whether the erratum is present (e.g. p2040 versus
393 p2041) or is implied by the build target, which controls
394 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
395
396 See Freescale App Note 4493 for more information about
397 this erratum.
398
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530399 CONFIG_A003399_NOR_WORKAROUND
400 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800401 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530402
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530403 CONFIG_A008044_WORKAROUND
404 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800405 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530406
Scott Wood80806962012-08-14 10:14:53 +0000407 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
408
409 This is the value to write into CCSR offset 0x18600
410 according to the A004510 workaround.
411
Priyanka Jainc73b9032013-07-02 09:21:04 +0530412 CONFIG_SYS_FSL_DSP_DDR_ADDR
413 This value denotes start offset of DDR memory which is
414 connected exclusively to the DSP cores.
415
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530416 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
417 This value denotes start offset of M2 memory
418 which is directly connected to the DSP core.
419
Priyanka Jainc73b9032013-07-02 09:21:04 +0530420 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
421 This value denotes start offset of M3 memory which is directly
422 connected to the DSP core.
423
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530424 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
425 This value denotes start offset of DSP CCSR space.
426
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530427 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
428 Single Source Clock is clocking mode present in some of FSL SoC's.
429 In this mode, a single differential clock is used to supply
430 clocks to the sysclock, ddrclock and usbclock.
431
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530432 CONFIG_SYS_CPC_REINIT_F
433 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800434 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530435
Tang Yuantiana7364af2014-04-17 15:33:46 +0800436 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800437 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800438 supported, core will start to execute uboot when wakes up.
439
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000440- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700441 CONFIG_SYS_GENERIC_GLOBAL_DATA
442 Defines global data is initialized in generic board board_init_f().
443 If this macro is defined, global data is created and cleared in
444 generic board board_init_f(). Without this macro, architecture/board
445 should initialize global data before calling board_init_f().
446
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000447 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
448
449 Defines the endianess of the CPU. Implementation of those
450 values is arch specific.
451
York Sunf0626592013-09-30 09:22:09 -0700452 CONFIG_SYS_FSL_DDR
453 Freescale DDR driver in use. This type of DDR controller is
454 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
455 SoCs.
456
457 CONFIG_SYS_FSL_DDR_ADDR
458 Freescale DDR memory-mapped register base.
459
460 CONFIG_SYS_FSL_DDR_EMU
461 Specify emulator support for DDR. Some DDR features such as
462 deskew training are not available.
463
464 CONFIG_SYS_FSL_DDRC_GEN1
465 Freescale DDR1 controller.
466
467 CONFIG_SYS_FSL_DDRC_GEN2
468 Freescale DDR2 controller.
469
470 CONFIG_SYS_FSL_DDRC_GEN3
471 Freescale DDR3 controller.
472
York Sun2896cb72014-03-27 17:54:47 -0700473 CONFIG_SYS_FSL_DDRC_GEN4
474 Freescale DDR4 controller.
475
York Sun461c9392013-09-30 14:20:51 -0700476 CONFIG_SYS_FSL_DDRC_ARM_GEN3
477 Freescale DDR3 controller for ARM-based SoCs.
478
York Sunf0626592013-09-30 09:22:09 -0700479 CONFIG_SYS_FSL_DDR1
480 Board config to use DDR1. It can be enabled for SoCs with
481 Freescale DDR1 or DDR2 controllers, depending on the board
482 implemetation.
483
484 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400485 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700486 Freescale DDR2 or DDR3 controllers, depending on the board
487 implementation.
488
489 CONFIG_SYS_FSL_DDR3
490 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700491 Freescale DDR3 or DDR3L controllers.
492
493 CONFIG_SYS_FSL_DDR3L
494 Board config to use DDR3L. It can be enabled for SoCs with
495 DDR3L controllers.
496
497 CONFIG_SYS_FSL_DDR4
498 Board config to use DDR4. It can be enabled for SoCs with
499 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700500
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530501 CONFIG_SYS_FSL_IFC_BE
502 Defines the IFC controller register space as Big Endian
503
504 CONFIG_SYS_FSL_IFC_LE
505 Defines the IFC controller register space as Little Endian
506
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530507 CONFIG_SYS_FSL_IFC_CLK_DIV
508 Defines divider of platform clock(clock input to IFC controller).
509
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530510 CONFIG_SYS_FSL_LBC_CLK_DIV
511 Defines divider of platform clock(clock input to eLBC controller).
512
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530513 CONFIG_SYS_FSL_PBL_PBI
514 It enables addition of RCW (Power on reset configuration) in built image.
515 Please refer doc/README.pblimage for more details
516
517 CONFIG_SYS_FSL_PBL_RCW
518 It adds PBI(pre-boot instructions) commands in u-boot build image.
519 PBI commands can be used to configure SoC before it starts the execution.
520 Please refer doc/README.pblimage for more details
521
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530522 CONFIG_SPL_FSL_PBL
523 It adds a target to create boot binary having SPL binary in PBI format
524 concatenated with u-boot binary.
525
York Sun29647ab2014-02-10 13:59:42 -0800526 CONFIG_SYS_FSL_DDR_BE
527 Defines the DDR controller register space as Big Endian
528
529 CONFIG_SYS_FSL_DDR_LE
530 Defines the DDR controller register space as Little Endian
531
York Sun3a0916d2014-02-10 13:59:43 -0800532 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
533 Physical address from the view of DDR controllers. It is the
534 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
535 it could be different for ARM SoCs.
536
York Sunc459ae62014-02-10 13:59:44 -0800537 CONFIG_SYS_FSL_DDR_INTLV_256B
538 DDR controller interleaving on 256-byte. This is a special
539 interleaving mode, handled by Dickens for Freescale layerscape
540 SoCs with ARM core.
541
York Sun79a779b2014-08-01 15:51:00 -0700542 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
543 Number of controllers used as main memory.
544
545 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
546 Number of controllers used for other than main memory.
547
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530548 CONFIG_SYS_FSL_HAS_DP_DDR
549 Defines the SoC has DP-DDR used for DPAA.
550
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530551 CONFIG_SYS_FSL_SEC_BE
552 Defines the SEC controller register space as Big Endian
553
554 CONFIG_SYS_FSL_SEC_LE
555 Defines the SEC controller register space as Little Endian
556
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200557- MIPS CPU options:
558 CONFIG_SYS_INIT_SP_OFFSET
559
560 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
561 pointer. This is needed for the temporary stack before
562 relocation.
563
564 CONFIG_SYS_MIPS_CACHE_MODE
565
566 Cache operation mode for the MIPS CPU.
567 See also arch/mips/include/asm/mipsregs.h.
568 Possible values are:
569 CONF_CM_CACHABLE_NO_WA
570 CONF_CM_CACHABLE_WA
571 CONF_CM_UNCACHED
572 CONF_CM_CACHABLE_NONCOHERENT
573 CONF_CM_CACHABLE_CE
574 CONF_CM_CACHABLE_COW
575 CONF_CM_CACHABLE_CUW
576 CONF_CM_CACHABLE_ACCELERATED
577
578 CONFIG_SYS_XWAY_EBU_BOOTCFG
579
580 Special option for Lantiq XWAY SoCs for booting from NOR flash.
581 See also arch/mips/cpu/mips32/start.S.
582
583 CONFIG_XWAY_SWAP_BYTES
584
585 Enable compilation of tools/xway-swap-bytes needed for Lantiq
586 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
587 be swapped if a flash programmer is used.
588
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000589- ARM options:
590 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
591
592 Select high exception vectors of the ARM core, e.g., do not
593 clear the V bit of the c1 register of CP15.
594
York Sun77a10972015-03-20 19:28:08 -0700595 COUNTER_FREQUENCY
596 Generic timer clock source frequency.
597
598 COUNTER_FREQUENCY_REAL
599 Generic timer clock source frequency if the real clock is
600 different from COUNTER_FREQUENCY, and can only be determined
601 at run time.
602
Stephen Warren8d1fb312015-01-19 16:25:52 -0700603- Tegra SoC options:
604 CONFIG_TEGRA_SUPPORT_NON_SECURE
605
606 Support executing U-Boot in non-secure (NS) mode. Certain
607 impossible actions will be skipped if the CPU is in NS mode,
608 such as ARM architectural timer initialization.
609
wdenk9b7f3842003-10-09 20:09:04 +0000610- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000611 CONFIG_CLOCKS_IN_MHZ
612
613 U-Boot stores all clock information in Hz
614 internally. For binary compatibility with older Linux
615 kernels (which expect the clocks passed in the
616 bd_info data to be in MHz) the environment variable
617 "clocks_in_mhz" can be defined so that U-Boot
618 converts clock data to MHZ before passing it to the
619 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000620 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100621 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000622 default environment.
623
wdenk9b7f3842003-10-09 20:09:04 +0000624 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
625
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800626 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000627 expect it to be in bytes, others in MB.
628 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
629
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400630 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200631
632 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400633 passed using flattened device trees (based on open firmware
634 concepts).
635
636 CONFIG_OF_LIBFDT
637 * New libfdt-based support
638 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500639 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400640
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200641 OF_CPU - The proper name of the cpus node (only required for
642 MPC512X and MPC5xxx based boards).
643 OF_SOC - The proper name of the soc node (only required for
644 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200645 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600646 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200647
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200648 boards with QUICC Engines require OF_QE to set UCC MAC
649 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500650
Kumar Gala1e26aa52006-01-11 13:54:17 -0600651 CONFIG_OF_BOARD_SETUP
652
653 Board code has addition modification that it wants to make
654 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000655
Simon Glass6c0be912014-10-23 18:58:54 -0600656 CONFIG_OF_SYSTEM_SETUP
657
658 Other code has addition modification that it wants to make
659 to the flat device tree before handing it off to the kernel.
660 This causes ft_system_setup() to be called before booting
661 the kernel.
662
Heiko Schocherffb293a2009-09-23 07:56:08 +0200663 CONFIG_OF_IDE_FIXUP
664
665 U-Boot can detect if an IDE device is present or not.
666 If not, and this new config option is activated, U-Boot
667 removes the ATA node from the DTS before booting Linux,
668 so the Linux IDE driver does not probe the device and
669 crash. This is needed for buggy hardware (uc101) where
670 no pull down resistor is connected to the signal IDE5V_DD7.
671
Igor Grinberg06890672011-07-14 05:45:07 +0000672 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
673
674 This setting is mandatory for all boards that have only one
675 machine type and must be used to specify the machine type
676 number as it appears in the ARM machine registry
677 (see http://www.arm.linux.org.uk/developer/machines/).
678 Only boards that have multiple machine types supported
679 in a single configuration file and the machine type is
680 runtime discoverable, do not have to use this setting.
681
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100682- vxWorks boot parameters:
683
684 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700685 environments variables: bootdev, bootfile, ipaddr, netmask,
686 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100687 It loads the vxWorks image pointed bootfile.
688
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100689 Note: If a "bootargs" environment is defined, it will overwride
690 the defaults discussed just above.
691
Aneesh V960f5c02011-06-16 23:30:47 +0000692- Cache Configuration:
693 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
694 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
695 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
696
Aneesh V686a0752011-06-16 23:30:51 +0000697- Cache Configuration for ARM:
698 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
699 controller
700 CONFIG_SYS_PL310_BASE - Physical base address of PL310
701 controller register space
702
wdenkda04a8b2004-08-02 23:22:59 +0000703- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200704 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000705
706 Define this if you want support for Amba PrimeCell PL010 UARTs.
707
Andreas Engel0813b122008-09-08 14:30:53 +0200708 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000709
710 Define this if you want support for Amba PrimeCell PL011 UARTs.
711
712 CONFIG_PL011_CLOCK
713
714 If you have Amba PrimeCell PL011 UARTs, set this variable to
715 the clock speed of the UARTs.
716
717 CONFIG_PL01x_PORTS
718
719 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
720 define this to a list of base addresses for each (supported)
721 port. See e.g. include/configs/versatile.h
722
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400723 CONFIG_SERIAL_HW_FLOW_CONTROL
724
725 Define this variable to enable hw flow control in serial driver.
726 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000727
wdenkc6097192002-11-03 00:24:07 +0000728- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000729 Depending on board, define exactly one serial port
730 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
731 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
732 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000733
734 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
735 port routines must be defined elsewhere
736 (i.e. serial_init(), serial_getc(), ...)
737
wdenkc6097192002-11-03 00:24:07 +0000738- Console Baudrate:
739 CONFIG_BAUDRATE - in bps
740 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200741 CONFIG_SYS_BAUDRATE_TABLE, see below.
742 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000743
Heiko Schocher327480a2009-01-30 12:55:38 +0100744- Console Rx buffer length
745 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
746 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100747 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100748 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
749 must be defined, to setup the maximum idle timeout for
750 the SMC.
751
wdenkc6097192002-11-03 00:24:07 +0000752- Autoboot Command:
753 CONFIG_BOOTCOMMAND
754 Only needed when CONFIG_BOOTDELAY is enabled;
755 define a command string that is automatically executed
756 when no character is read on the console interface
757 within "Boot Delay" after reset.
758
759 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000760 This can be used to pass arguments to the bootm
761 command. The value of CONFIG_BOOTARGS goes into the
762 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000763
764 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000765 The value of these goes into the environment as
766 "ramboot" and "nfsboot" respectively, and can be used
767 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200768 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000769
Heiko Schocher040c5c32013-11-04 14:04:59 +0100770- Bootcount:
771 CONFIG_BOOTCOUNT_LIMIT
772 Implements a mechanism for detecting a repeating reboot
773 cycle, see:
774 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
775
776 CONFIG_BOOTCOUNT_ENV
777 If no softreset save registers are found on the hardware
778 "bootcount" is stored in the environment. To prevent a
779 saveenv on all reboots, the environment variable
780 "upgrade_available" is used. If "upgrade_available" is
781 0, "bootcount" is always 0, if "upgrade_available" is
782 1 "bootcount" is incremented in the environment.
783 So the Userspace Applikation must set the "upgrade_available"
784 and "bootcount" variable to 0, if a boot was successfully.
785
wdenkc6097192002-11-03 00:24:07 +0000786- Pre-Boot Commands:
787 CONFIG_PREBOOT
788
789 When this option is #defined, the existence of the
790 environment variable "preboot" will be checked
791 immediately before starting the CONFIG_BOOTDELAY
792 countdown and/or running the auto-boot command resp.
793 entering interactive mode.
794
795 This feature is especially useful when "preboot" is
796 automatically generated or modified. For an example
797 see the LWMON board specific code: here "preboot" is
798 modified when the user holds down a certain
799 combination of keys on the (special) keyboard when
800 booting the systems
801
802- Serial Download Echo Mode:
803 CONFIG_LOADS_ECHO
804 If defined to 1, all characters received during a
805 serial download (using the "loads" command) are
806 echoed back. This might be needed by some terminal
807 emulations (like "cu"), but may as well just take
808 time on others. This setting #define's the initial
809 value of the "loads_echo" environment variable.
810
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500811- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000812 CONFIG_KGDB_BAUDRATE
813 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200814 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000815
816- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500817 Monitor commands can be included or excluded
818 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000819 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500820 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000821
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500822 The default command configuration includes all commands
823 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000824
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100825 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500826 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500827 CONFIG_CMD_BDI bdinfo
828 CONFIG_CMD_BEDBUG * Include BedBug Debugger
829 CONFIG_CMD_BMP * BMP support
830 CONFIG_CMD_BSP * Board specific commands
831 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400832 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500833 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800834 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500835 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500836 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500837 CONFIG_CMD_DATE * support for RTC, date/time...
838 CONFIG_CMD_DHCP * DHCP support
839 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600840 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
841 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
842 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
843 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500844 CONFIG_CMD_DTT * Digital Therm and Thermostat
845 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500846 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500847 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanov37dda1c2016-04-16 17:55:03 +0300848 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500849 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600850 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600851 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500852 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500853 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000854 CONFIG_CMD_EXT2 * ext2 command support
855 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700856 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
857 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100858 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500859 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500860 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000861 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_FLASH flinfo, erase, protect
863 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200864 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000865 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500866 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000867 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000868 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500869 CONFIG_CMD_I2C * I2C serial bus support
870 CONFIG_CMD_IDE * IDE harddisk support
871 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000872 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200873 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500874 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -0600875 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500876 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000877 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500878 CONFIG_CMD_IRQ * irqinfo
879 CONFIG_CMD_ITEST Integer/string test of 2 values
880 CONFIG_CMD_JFFS2 * JFFS2 Support
881 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200882 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000883 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
884 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500885 CONFIG_CMD_LOADB loadb
886 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200887 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400888 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000889 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500890 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000891 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200892 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500893 CONFIG_CMD_MISC Misc functions like sleep etc
894 CONFIG_CMD_MMC * MMC memory mapped support
895 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100896 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500897 CONFIG_CMD_NAND * NAND support
898 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200899 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600900 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000901 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500902 CONFIG_CMD_PCI * pciinfo
903 CONFIG_CMD_PCMCIA * PCMCIA support
904 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
905 host
906 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000907 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500908 CONFIG_CMD_REGINFO * Register dump
909 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000910 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500911 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600912 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500913 CONFIG_CMD_SDRAM * print SDRAM configuration information
914 (requires CONFIG_CMD_I2C)
915 CONFIG_CMD_SETGETDCR Support for DCR Register access
916 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700917 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200918 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400919 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800920 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200921 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500922 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000923 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000924 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000925 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
926 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500927 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500928 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000929 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200930 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200931 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000932
933 EXAMPLE: If you want all functions except of network
934 support you can write:
935
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500936 #include "config_cmd_all.h"
937 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000938
Gerald Van Barend6abef42007-03-31 12:23:51 -0400939 Other Commands:
940 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000941
942 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500943 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000944 what you (and your U-Boot users) are doing. Data
945 cache cannot be enabled on systems like the 8xx or
946 8260 (where accesses to the IMMR region must be
947 uncached), and it cannot be disabled on all other
948 systems where we (mis-) use the data cache to hold an
949 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000950
951
952 XXX - this list needs to get updated!
953
Simon Glassaa34ef22016-03-13 19:07:28 -0600954- Removal of commands
955 If no commands are needed to boot, you can disable
956 CONFIG_CMDLINE to remove them. In this case, the command line
957 will not be available, and when U-Boot wants to execute the
958 boot command (on start-up) it will call board_run_command()
959 instead. This can reduce image size significantly for very
960 simple boot procedures.
961
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000962- Regular expression support:
963 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200964 If this variable is defined, U-Boot is linked against
965 the SLRE (Super Light Regular Expression) library,
966 which adds regex support to some commands, as for
967 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000968
Simon Glass3d686442011-10-15 05:48:20 +0000969- Device tree:
970 CONFIG_OF_CONTROL
971 If this variable is defined, U-Boot will use a device tree
972 to configure its devices, instead of relying on statically
973 compiled #defines in the board file. This option is
974 experimental and only available on a few boards. The device
975 tree is available in the global data as gd->fdt_blob.
976
Simon Glass5cb34db2011-10-24 19:15:31 +0000977 U-Boot needs to get its device tree from somewhere. This can
978 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000979
980 CONFIG_OF_EMBED
981 If this variable is defined, U-Boot will embed a device tree
982 binary in its image. This device tree file should be in the
983 board directory and called <soc>-<board>.dts. The binary file
984 is then picked up in board_init_f() and made available through
985 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000986
Simon Glass5cb34db2011-10-24 19:15:31 +0000987 CONFIG_OF_SEPARATE
988 If this variable is defined, U-Boot will build a device tree
989 binary. It will be called u-boot.dtb. Architecture-specific
990 code will locate it at run-time. Generally this works by:
991
992 cat u-boot.bin u-boot.dtb >image.bin
993
994 and in fact, U-Boot does this for you, creating a file called
995 u-boot-dtb.bin which is useful in the common case. You can
996 still use the individual files if you need something more
997 exotic.
998
wdenkc6097192002-11-03 00:24:07 +0000999- Watchdog:
1000 CONFIG_WATCHDOG
1001 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001002 support for the SoC. There must be support in the SoC
1003 specific code for a watchdog. For the 8xx and 8260
1004 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1005 register. When supported for a specific SoC is
1006 available, then no further board specific code should
1007 be needed to use it.
1008
1009 CONFIG_HW_WATCHDOG
1010 When using a watchdog circuitry external to the used
1011 SoC, then define this variable and provide board
1012 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001013
Heiko Schocher735326c2015-01-21 08:38:22 +01001014 CONFIG_AT91_HW_WDT_TIMEOUT
1015 specify the timeout in seconds. default 2 seconds.
1016
stroeseb9c17c52003-04-04 15:53:41 +00001017- U-Boot Version:
1018 CONFIG_VERSION_VARIABLE
1019 If this variable is defined, an environment variable
1020 named "ver" is created by U-Boot showing the U-Boot
1021 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001022 Any change to this variable will be reverted at the
1023 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001024
wdenkc6097192002-11-03 00:24:07 +00001025- Real-Time Clock:
1026
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001027 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001028 has to be selected, too. Define exactly one of the
1029 following options:
1030
1031 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1032 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001033 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001034 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001035 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001036 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001037 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001038 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001039 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001040 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001041 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001042 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001043 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1044 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001045
wdenkb9bbd242003-06-30 16:24:52 +00001046 Note that if the RTC uses I2C, then the I2C interface
1047 must also be configured. See I2C Support, below.
1048
Peter Tyser9902e422008-12-17 16:36:21 -06001049- GPIO Support:
1050 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001051
Chris Packham9b383202010-12-19 10:12:13 +00001052 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1053 chip-ngpio pairs that tell the PCA953X driver the number of
1054 pins supported by a particular chip.
1055
Peter Tyser9902e422008-12-17 16:36:21 -06001056 Note that if the GPIO device uses I2C, then the I2C interface
1057 must also be configured. See I2C Support, below.
1058
Simon Glass4dc47ca2014-06-11 23:29:41 -06001059- I/O tracing:
1060 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1061 accesses and can checksum them or write a list of them out
1062 to memory. See the 'iotrace' command for details. This is
1063 useful for testing device drivers since it can confirm that
1064 the driver behaves the same way before and after a code
1065 change. Currently this is supported on sandbox and arm. To
1066 add support for your architecture, add '#include <iotrace.h>'
1067 to the bottom of arch/<arch>/include/asm/io.h and test.
1068
1069 Example output from the 'iotrace stats' command is below.
1070 Note that if the trace buffer is exhausted, the checksum will
1071 still continue to operate.
1072
1073 iotrace is enabled
1074 Start: 10000000 (buffer start address)
1075 Size: 00010000 (buffer size)
1076 Offset: 00000120 (current buffer offset)
1077 Output: 10000120 (start + offset)
1078 Count: 00000018 (number of trace records)
1079 CRC32: 9526fb66 (CRC32 of all trace records)
1080
wdenkc6097192002-11-03 00:24:07 +00001081- Timestamp Support:
1082
wdenk4a5c8a72003-03-06 00:02:04 +00001083 When CONFIG_TIMESTAMP is selected, the timestamp
1084 (date and time) of an image is printed by image
1085 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001086 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001087
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001088- Partition Labels (disklabels) Supported:
1089 Zero or more of the following:
1090 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1091 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1092 Intel architecture, USB sticks, etc.
1093 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1094 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1095 bootloader. Note 2TB partition limit; see
1096 disk/part_efi.c
1097 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001098
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001099 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001100 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001101 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001102
1103- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001104 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1105 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001106
wdenk369d43d2004-03-14 14:09:05 +00001107 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1108 be performed by calling the function
1109 ide_set_reset(int reset)
1110 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001111
1112- ATAPI Support:
1113 CONFIG_ATAPI
1114
1115 Set this to enable ATAPI support.
1116
wdenkf602aa02004-03-13 23:29:43 +00001117- LBA48 Support
1118 CONFIG_LBA48
1119
1120 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001121 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001122 Whithout these , LBA48 support uses 32bit variables and will 'only'
1123 support disks up to 2.1TB.
1124
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001125 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001126 When enabled, makes the IDE subsystem use 64bit sector addresses.
1127 Default is 32bit.
1128
wdenkc6097192002-11-03 00:24:07 +00001129- SCSI Support:
1130 At the moment only there is only support for the
1131 SYM53C8XX SCSI controller; define
1132 CONFIG_SCSI_SYM53C8XX to enable it.
1133
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001134 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1135 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1136 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001137 maximum numbers of LUNs, SCSI ID's and target
1138 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001139 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001140
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001141 The environment variable 'scsidevs' is set to the number of
1142 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001143
wdenkc6097192002-11-03 00:24:07 +00001144- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001145 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001146 Support for Intel 8254x/8257x gigabit chips.
1147
1148 CONFIG_E1000_SPI
1149 Utility code for direct access to the SPI bus on Intel 8257x.
1150 This does not do anything useful unless you set at least one
1151 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1152
1153 CONFIG_E1000_SPI_GENERIC
1154 Allow generic access to the SPI bus on the Intel 8257x, for
1155 example with the "sspi" command.
1156
1157 CONFIG_CMD_E1000
1158 Management command for E1000 devices. When used on devices
1159 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001160
wdenkc6097192002-11-03 00:24:07 +00001161 CONFIG_EEPRO100
1162 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001163 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001164 write routine for first time initialisation.
1165
1166 CONFIG_TULIP
1167 Support for Digital 2114x chips.
1168 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1169 modem chip initialisation (KS8761/QS6611).
1170
1171 CONFIG_NATSEMI
1172 Support for National dp83815 chips.
1173
1174 CONFIG_NS8382X
1175 Support for National dp8382[01] gigabit chips.
1176
wdenkaa603362003-05-12 21:50:16 +00001177- NETWORK Support (other):
1178
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001179 CONFIG_DRIVER_AT91EMAC
1180 Support for AT91RM9200 EMAC.
1181
1182 CONFIG_RMII
1183 Define this to use reduced MII inteface
1184
1185 CONFIG_DRIVER_AT91EMAC_QUIET
1186 If this defined, the driver is quiet.
1187 The driver doen't show link status messages.
1188
Rob Herringc9830dc2011-12-15 11:15:49 +00001189 CONFIG_CALXEDA_XGMAC
1190 Support for the Calxeda XGMAC device
1191
Ashok93fb8722012-10-15 06:20:47 +00001192 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001193 Support for SMSC's LAN91C96 chips.
1194
wdenkaa603362003-05-12 21:50:16 +00001195 CONFIG_LAN91C96_USE_32_BIT
1196 Define this to enable 32 bit addressing
1197
Ashok93fb8722012-10-15 06:20:47 +00001198 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001199 Support for SMSC's LAN91C111 chip
1200
1201 CONFIG_SMC91111_BASE
1202 Define this to hold the physical address
1203 of the device (I/O space)
1204
1205 CONFIG_SMC_USE_32_BIT
1206 Define this if data bus is 32 bits
1207
1208 CONFIG_SMC_USE_IOFUNCS
1209 Define this to use i/o functions instead of macros
1210 (some hardware wont work with macros)
1211
Heiko Schocher7d037f72011-11-15 10:00:04 -05001212 CONFIG_DRIVER_TI_EMAC
1213 Support for davinci emac
1214
1215 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1216 Define this if you have more then 3 PHYs.
1217
Macpaul Lin199c6252010-12-21 16:59:46 +08001218 CONFIG_FTGMAC100
1219 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1220
1221 CONFIG_FTGMAC100_EGIGA
1222 Define this to use GE link update with gigabit PHY.
1223 Define this if FTGMAC100 is connected to gigabit PHY.
1224 If your system has 10/100 PHY only, it might not occur
1225 wrong behavior. Because PHY usually return timeout or
1226 useless data when polling gigabit status and gigabit
1227 control registers. This behavior won't affect the
1228 correctnessof 10/100 link speed update.
1229
Mike Rapoportf4761af2009-11-11 10:03:03 +02001230 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001231 Support for SMSC's LAN911x and LAN921x chips
1232
Mike Rapoportf4761af2009-11-11 10:03:03 +02001233 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001234 Define this to hold the physical address
1235 of the device (I/O space)
1236
Mike Rapoportf4761af2009-11-11 10:03:03 +02001237 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001238 Define this if data bus is 32 bits
1239
Mike Rapoportf4761af2009-11-11 10:03:03 +02001240 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001241 Define this if data bus is 16 bits. If your processor
1242 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001243 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001244
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001245 CONFIG_SH_ETHER
1246 Support for Renesas on-chip Ethernet controller
1247
1248 CONFIG_SH_ETHER_USE_PORT
1249 Define the number of ports to be used
1250
1251 CONFIG_SH_ETHER_PHY_ADDR
1252 Define the ETH PHY's address
1253
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001254 CONFIG_SH_ETHER_CACHE_WRITEBACK
1255 If this option is set, the driver enables cache flush.
1256
Heiko Schocher2b387762014-07-18 06:07:19 +02001257- PWM Support:
1258 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001259 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001260
Vadim Bendeburydac69642011-10-17 08:36:14 +00001261- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001262 CONFIG_TPM
1263 Support TPM devices.
1264
Christophe Ricard8759ff82015-10-06 22:54:41 +02001265 CONFIG_TPM_TIS_INFINEON
1266 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001267 per system is supported at this time.
1268
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001269 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1270 Define the burst count bytes upper limit
1271
Christophe Ricard88249232016-01-21 23:27:13 +01001272 CONFIG_TPM_ST33ZP24
1273 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1274
1275 CONFIG_TPM_ST33ZP24_I2C
1276 Support for STMicroelectronics ST33ZP24 I2C devices.
1277 Requires TPM_ST33ZP24 and I2C.
1278
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001279 CONFIG_TPM_ST33ZP24_SPI
1280 Support for STMicroelectronics ST33ZP24 SPI devices.
1281 Requires TPM_ST33ZP24 and SPI.
1282
Dirk Eibach20489092013-06-26 15:55:15 +02001283 CONFIG_TPM_ATMEL_TWI
1284 Support for Atmel TWI TPM device. Requires I2C support.
1285
Che-liang Chiouacea5702013-04-12 11:04:34 +00001286 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001287 Support for generic parallel port TPM devices. Only one device
1288 per system is supported at this time.
1289
1290 CONFIG_TPM_TIS_BASE_ADDRESS
1291 Base address where the generic TPM device is mapped
1292 to. Contemporary x86 systems usually map it at
1293 0xfed40000.
1294
Reinhard Pfau4fece432013-06-26 15:55:13 +02001295 CONFIG_CMD_TPM
1296 Add tpm monitor functions.
1297 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1298 provides monitor access to authorized functions.
1299
1300 CONFIG_TPM
1301 Define this to enable the TPM support library which provides
1302 functional interfaces to some TPM commands.
1303 Requires support for a TPM device.
1304
1305 CONFIG_TPM_AUTH_SESSIONS
1306 Define this to enable authorized functions in the TPM library.
1307 Requires CONFIG_TPM and CONFIG_SHA1.
1308
wdenkc6097192002-11-03 00:24:07 +00001309- USB Support:
1310 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001311 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001312 CONFIG_USB_UHCI to enable it.
1313 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001314 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001315 storage devices.
1316 Note:
1317 Supported are USB Keyboards and USB Floppy drives
1318 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001319 MPC5200 USB requires additional defines:
1320 CONFIG_USB_CLOCK
1321 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001322 CONFIG_PSC3_USB
1323 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001324 CONFIG_USB_CONFIG
1325 for differential drivers: 0x00001000
1326 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001327 for differential drivers on PSC3: 0x00000100
1328 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001329 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001330 May be defined to allow interrupt polling
1331 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001332
Simon Glass5978cdb2012-02-27 10:52:47 +00001333 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1334 txfilltuning field in the EHCI controller on reset.
1335
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001336 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1337 HW module registers.
1338
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001339- USB Device:
1340 Define the below if you wish to use the USB console.
1341 Once firmware is rebuilt from a serial console issue the
1342 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001343 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001344 it has found a new device. The environment variable usbtty
1345 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001346 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001347 Common Device Class Abstract Control Model serial device.
1348 If you select usbtty = gserial you should be able to enumerate
1349 a Linux host by
1350 # modprobe usbserial vendor=0xVendorID product=0xProductID
1351 else if using cdc_acm, simply setting the environment
1352 variable usbtty to be cdc_acm should suffice. The following
1353 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001354
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001355 CONFIG_USB_DEVICE
1356 Define this to build a UDC device
1357
1358 CONFIG_USB_TTY
1359 Define this to have a tty type of device available to
1360 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001361
Vipin KUMARbdb17702012-03-26 15:38:06 +05301362 CONFIG_USBD_HS
1363 Define this to enable the high speed support for usb
1364 device and usbtty. If this feature is enabled, a routine
1365 int is_usbd_high_speed(void)
1366 also needs to be defined by the driver to dynamically poll
1367 whether the enumeration has succeded at high speed or full
1368 speed.
1369
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001370 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001371 Define this if you want stdin, stdout &/or stderr to
1372 be set to usbtty.
1373
1374 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001375 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001376 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001377 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001378
Wolfgang Denke2601822006-06-14 18:14:56 +02001379 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001380 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001381 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001382 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1383 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1384 should pretend to be a Linux device to it's target host.
1385
1386 CONFIG_USBD_MANUFACTURER
1387 Define this string as the name of your company for
1388 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001389
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001390 CONFIG_USBD_PRODUCT_NAME
1391 Define this string as the name of your product
1392 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001393
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001394 CONFIG_USBD_VENDORID
1395 Define this as your assigned Vendor ID from the USB
1396 Implementors Forum. This *must* be a genuine Vendor ID
1397 to avoid polluting the USB namespace.
1398 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001399
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001400 CONFIG_USBD_PRODUCTID
1401 Define this as the unique Product ID
1402 for your device
1403 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001404
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001405- ULPI Layer Support:
1406 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1407 the generic ULPI layer. The generic layer accesses the ULPI PHY
1408 via the platform viewport, so you need both the genric layer and
1409 the viewport enabled. Currently only Chipidea/ARC based
1410 viewport is supported.
1411 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1412 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001413 If your ULPI phy needs a different reference clock than the
1414 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1415 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001416
wdenk7a428cc2003-06-15 22:40:42 +00001417- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001418 The MMC controller on the Intel PXA is supported. To
1419 enable this define CONFIG_MMC. The MMC can be
1420 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001421 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001422 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1423 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001424
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001425 CONFIG_SH_MMCIF
1426 Support for Renesas on-chip MMCIF controller
1427
1428 CONFIG_SH_MMCIF_ADDR
1429 Define the base address of MMCIF registers
1430
1431 CONFIG_SH_MMCIF_CLK
1432 Define the clock frequency for MMCIF
1433
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001434 CONFIG_SUPPORT_EMMC_BOOT
1435 Enable some additional features of the eMMC boot partitions.
1436
1437 CONFIG_SUPPORT_EMMC_RPMB
1438 Enable the commands for reading, writing and programming the
1439 key for the Replay Protection Memory Block partition in eMMC.
1440
Tom Rini58a8d322013-03-14 05:32:47 +00001441- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001442 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001443 This enables the USB portion of the DFU USB class
1444
1445 CONFIG_CMD_DFU
1446 This enables the command "dfu" which is used to have
1447 U-Boot create a DFU class device via USB. This command
1448 requires that the "dfu_alt_info" environment variable be
1449 set and define the alt settings to expose to the host.
1450
1451 CONFIG_DFU_MMC
1452 This enables support for exposing (e)MMC devices via DFU.
1453
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001454 CONFIG_DFU_NAND
1455 This enables support for exposing NAND devices via DFU.
1456
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301457 CONFIG_DFU_RAM
1458 This enables support for exposing RAM via DFU.
1459 Note: DFU spec refer to non-volatile memory usage, but
1460 allow usages beyond the scope of spec - here RAM usage,
1461 one that would help mostly the developer.
1462
Heiko Schochera2f831e2013-06-12 06:05:51 +02001463 CONFIG_SYS_DFU_DATA_BUF_SIZE
1464 Dfu transfer uses a buffer before writing data to the
1465 raw storage device. Make the size (in bytes) of this buffer
1466 configurable. The size of this buffer is also configurable
1467 through the "dfu_bufsiz" environment variable.
1468
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001469 CONFIG_SYS_DFU_MAX_FILE_SIZE
1470 When updating files rather than the raw storage device,
1471 we use a static buffer to copy the file into and then write
1472 the buffer once we've been given the whole file. Define
1473 this to the maximum filesize (in bytes) for the buffer.
1474 Default is 4 MiB if undefined.
1475
Heiko Schochere1ba1512014-03-18 08:09:56 +01001476 DFU_DEFAULT_POLL_TIMEOUT
1477 Poll timeout [ms], is the timeout a device can send to the
1478 host. The host must wait for this timeout before sending
1479 a subsequent DFU_GET_STATUS request to the device.
1480
1481 DFU_MANIFEST_POLL_TIMEOUT
1482 Poll timeout [ms], which the device sends to the host when
1483 entering dfuMANIFEST state. Host waits this timeout, before
1484 sending again an USB request to the device.
1485
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001486- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001487 CONFIG_USB_FUNCTION_FASTBOOT
1488 This enables the USB part of the fastboot gadget
1489
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001490 CONFIG_CMD_FASTBOOT
1491 This enables the command "fastboot" which enables the Android
1492 fastboot mode for the platform's USB device. Fastboot is a USB
1493 protocol for downloading images, flashing and device control
1494 used on Android devices.
1495 See doc/README.android-fastboot for more information.
1496
1497 CONFIG_ANDROID_BOOT_IMAGE
1498 This enables support for booting images which use the Android
1499 image format header.
1500
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001501 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001502 The fastboot protocol requires a large memory buffer for
1503 downloads. Define this to the starting RAM address to use for
1504 downloaded images.
1505
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001506 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001507 The fastboot protocol requires a large memory buffer for
1508 downloads. This buffer should be as large as possible for a
1509 platform. Define this to the size available RAM for fastboot.
1510
Steve Raebfb9ba42014-08-26 11:47:28 -07001511 CONFIG_FASTBOOT_FLASH
1512 The fastboot protocol includes a "flash" command for writing
1513 the downloaded image to a non-volatile storage device. Define
1514 this to enable the "fastboot flash" command.
1515
1516 CONFIG_FASTBOOT_FLASH_MMC_DEV
1517 The fastboot "flash" command requires additional information
1518 regarding the non-volatile storage device. Define this to
1519 the eMMC device that fastboot should use to store the image.
1520
Steve Rae7d059342014-12-12 15:51:54 -08001521 CONFIG_FASTBOOT_GPT_NAME
1522 The fastboot "flash" command supports writing the downloaded
1523 image to the Protective MBR and the Primary GUID Partition
1524 Table. (Additionally, this downloaded image is post-processed
1525 to generate and write the Backup GUID Partition Table.)
1526 This occurs when the specified "partition name" on the
1527 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001528 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001529
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001530 CONFIG_FASTBOOT_MBR_NAME
1531 The fastboot "flash" command supports writing the downloaded
1532 image to DOS MBR.
1533 This occurs when the "partition name" specified on the
1534 "fastboot flash" command line matches this value.
1535 If not defined the default value "mbr" is used.
1536
wdenkda04a8b2004-08-02 23:22:59 +00001537- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001538 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001539 Define these for a default partition on a NAND device
1540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001541 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1542 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001543 Define these for a default partition on a NOR device
1544
Donggeun Kim8f814002011-10-24 21:15:28 +00001545- FAT(File Allocation Table) filesystem write function support:
1546 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001547
1548 Define this to enable support for saving memory data as a
1549 file in FAT formatted partition.
1550
1551 This will also enable the command "fatwrite" enabling the
1552 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001553
Alexander von Gernler3ab5f462016-10-07 19:44:14 +02001554- CBFS (Coreboot Filesystem) support:
Gabe Black7f8574c2012-10-12 14:26:11 +00001555 CONFIG_CMD_CBFS
1556
1557 Define this to enable support for reading from a Coreboot
1558 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1559 and cbfsload.
1560
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301561- FAT(File Allocation Table) filesystem cluster size:
1562 CONFIG_FS_FAT_MAX_CLUSTSIZE
1563
1564 Define the max cluster size for fat operations else
1565 a default value of 65536 will be defined.
1566
wdenkc6097192002-11-03 00:24:07 +00001567- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001568 See Kconfig help for available keyboard drivers.
1569
1570 CONFIG_KEYBOARD
1571
1572 Define this to enable a custom keyboard support.
1573 This simply calls drv_keyboard_init() which must be
1574 defined in your board-specific files. This option is deprecated
1575 and is only used by novena. For new boards, use driver model
1576 instead.
wdenkc6097192002-11-03 00:24:07 +00001577
1578- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001579 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001580 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001581 SOCs that have a DIU should define this macro to enable DIU
1582 support, and should also define these other macros:
1583
1584 CONFIG_SYS_DIU_ADDR
1585 CONFIG_VIDEO
1586 CONFIG_CMD_BMP
1587 CONFIG_CFB_CONSOLE
1588 CONFIG_VIDEO_SW_CURSOR
1589 CONFIG_VGA_AS_SINGLE_DEVICE
1590 CONFIG_VIDEO_LOGO
1591 CONFIG_VIDEO_BMP_LOGO
1592
Timur Tabi32f709e2011-04-11 14:18:22 -05001593 The DIU driver will look for the 'video-mode' environment
1594 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001595 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001596 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001597
wdenkc6097192002-11-03 00:24:07 +00001598- LCD Support: CONFIG_LCD
1599
1600 Define this to enable LCD support (for output to LCD
1601 display); also select one of the supported displays
1602 by defining one of these:
1603
Stelian Popf6f86652008-05-09 21:57:18 +02001604 CONFIG_ATMEL_LCD:
1605
1606 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1607
wdenkc0d54ae2003-11-25 16:55:19 +00001608 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001609
wdenkc0d54ae2003-11-25 16:55:19 +00001610 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001611
wdenkc0d54ae2003-11-25 16:55:19 +00001612 CONFIG_NEC_NL6448BC20
1613
1614 NEC NL6448BC20-08. 6.5", 640x480.
1615 Active, color, single scan.
1616
1617 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001618
wdenkc0d54ae2003-11-25 16:55:19 +00001619 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001620 Active, color, single scan.
1621
1622 CONFIG_SHARP_16x9
1623
1624 Sharp 320x240. Active, color, single scan.
1625 It isn't 16x9, and I am not sure what it is.
1626
1627 CONFIG_SHARP_LQ64D341
1628
1629 Sharp LQ64D341 display, 640x480.
1630 Active, color, single scan.
1631
1632 CONFIG_HLD1045
1633
1634 HLD1045 display, 640x480.
1635 Active, color, single scan.
1636
1637 CONFIG_OPTREX_BW
1638
1639 Optrex CBL50840-2 NF-FW 99 22 M5
1640 or
1641 Hitachi LMG6912RPFC-00T
1642 or
1643 Hitachi SP14Q002
1644
1645 320x240. Black & white.
1646
1647 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001648 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001649
Simon Glass599a4df2012-10-17 13:24:54 +00001650 CONFIG_LCD_ALIGNMENT
1651
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001652 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001653 defined then the LCD will be aligned to this value instead.
1654 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1655 here, since it is cheaper to change data cache settings on
1656 a per-section basis.
1657
1658
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001659 CONFIG_LCD_ROTATION
1660
1661 Sometimes, for example if the display is mounted in portrait
1662 mode or even if it's mounted landscape but rotated by 180degree,
1663 we need to rotate our content of the display relative to the
1664 framebuffer, so that user can read the messages which are
1665 printed out.
1666 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1667 initialized with a given rotation from "vl_rot" out of
1668 "vidinfo_t" which is provided by the board specific code.
1669 The value for vl_rot is coded as following (matching to
1670 fbcon=rotate:<n> linux-kernel commandline):
1671 0 = no rotation respectively 0 degree
1672 1 = 90 degree rotation
1673 2 = 180 degree rotation
1674 3 = 270 degree rotation
1675
1676 If CONFIG_LCD_ROTATION is not defined, the console will be
1677 initialized with 0degree rotation.
1678
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001679 CONFIG_LCD_BMP_RLE8
1680
1681 Support drawing of RLE8-compressed bitmaps on the LCD.
1682
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001683 CONFIG_I2C_EDID
1684
1685 Enables an 'i2c edid' command which can read EDID
1686 information over I2C from an attached LCD display.
1687
wdenkeb20ad32003-09-05 23:19:14 +00001688- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001689
wdenk57b2d802003-06-27 21:31:46 +00001690 If this option is set, the environment is checked for
1691 a variable "splashimage". If found, the usual display
1692 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001693 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001694 specified in "splashimage" is loaded instead. The
1695 console is redirected to the "nulldev", too. This
1696 allows for a "silent" boot where a splash screen is
1697 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001698
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001699 CONFIG_SPLASHIMAGE_GUARD
1700
1701 If this option is set, then U-Boot will prevent the environment
1702 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001703 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001704 This option is useful for targets where, due to alignment
1705 restrictions, an improperly aligned BMP image will cause a data
1706 abort. If you think you will not have problems with unaligned
1707 accesses (for example because your toolchain prevents them)
1708 there is no need to set this option.
1709
Matthias Weisser53884182009-07-09 16:07:30 +02001710 CONFIG_SPLASH_SCREEN_ALIGN
1711
1712 If this option is set the splash image can be freely positioned
1713 on the screen. Environment variable "splashpos" specifies the
1714 position as "x,y". If a positive number is given it is used as
1715 number of pixel from left/top. If a negative number is given it
1716 is used as number of pixel from right/bottom. You can also
1717 specify 'm' for centering the image.
1718
1719 Example:
1720 setenv splashpos m,m
1721 => image at center of screen
1722
1723 setenv splashpos 30,20
1724 => image at x = 30 and y = 20
1725
1726 setenv splashpos -10,m
1727 => vertically centered image
1728 at x = dspWidth - bmpWidth - 9
1729
Stefan Roesed9d97742005-09-22 09:04:17 +02001730- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1731
1732 If this option is set, additionally to standard BMP
1733 images, gzipped BMP images can be displayed via the
1734 splashscreen support or the bmp command.
1735
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001736- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1737
1738 If this option is set, 8-bit RLE compressed BMP images
1739 can be displayed via the splashscreen support or the
1740 bmp command.
1741
wdenk710e3502003-08-29 20:57:53 +00001742- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001743 CONFIG_GZIP
1744
1745 Enabled by default to support gzip compressed images.
1746
wdenk710e3502003-08-29 20:57:53 +00001747 CONFIG_BZIP2
1748
1749 If this option is set, support for bzip2 compressed
1750 images is included. If not, only uncompressed and gzip
1751 compressed images are supported.
1752
wdenk9c53f402003-10-15 23:53:47 +00001753 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001754 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001755 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001756
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001757 CONFIG_LZMA
1758
1759 If this option is set, support for lzma compressed
1760 images is included.
1761
1762 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1763 requires an amount of dynamic memory that is given by the
1764 formula:
1765
1766 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1767
1768 Where lc and lp stand for, respectively, Literal context bits
1769 and Literal pos bits.
1770
1771 This value is upper-bounded by 14MB in the worst case. Anyway,
1772 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1773 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1774 a very small buffer.
1775
1776 Use the lzmainfo tool to determinate the lc and lp values and
1777 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001778 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001779
Kees Cook5b06e642013-08-16 07:59:12 -07001780 CONFIG_LZO
1781
1782 If this option is set, support for LZO compressed images
1783 is included.
1784
wdenk0e2bd9c2004-06-06 21:51:03 +00001785- MII/PHY support:
1786 CONFIG_PHY_ADDR
1787
1788 The address of PHY on MII bus.
1789
1790 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1791
1792 The clock frequency of the MII bus
1793
1794 CONFIG_PHY_GIGE
1795
1796 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001797 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001798
1799 CONFIG_PHY_RESET_DELAY
1800
1801 Some PHY like Intel LXT971A need extra delay after
1802 reset before any MII register access is possible.
1803 For such PHY, set this option to the usec delay
1804 required. (minimum 300usec for LXT971A)
1805
1806 CONFIG_PHY_CMD_DELAY (ppc4xx)
1807
1808 Some PHY like Intel LXT971A need extra delay after
1809 command issued before MII status register can be read
1810
wdenkc6097192002-11-03 00:24:07 +00001811- IP address:
1812 CONFIG_IPADDR
1813
1814 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001815 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001816 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001817 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001818
1819- Server IP address:
1820 CONFIG_SERVERIP
1821
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001822 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001823 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001824 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001825
Robin Getz470a6d42009-07-21 12:15:28 -04001826 CONFIG_KEEP_SERVERADDR
1827
1828 Keeps the server's MAC address, in the env 'serveraddr'
1829 for passing to bootargs (like Linux's netconsole option)
1830
Wolfgang Denk26da2992011-10-26 10:21:22 +00001831- Gateway IP address:
1832 CONFIG_GATEWAYIP
1833
1834 Defines a default value for the IP address of the
1835 default router where packets to other networks are
1836 sent to.
1837 (Environment variable "gatewayip")
1838
1839- Subnet mask:
1840 CONFIG_NETMASK
1841
1842 Defines a default value for the subnet mask (or
1843 routing prefix) which is used to determine if an IP
1844 address belongs to the local subnet or needs to be
1845 forwarded through a router.
1846 (Environment variable "netmask")
1847
David Updegraff7280da72007-06-11 10:41:07 -05001848- Multicast TFTP Mode:
1849 CONFIG_MCAST_TFTP
1850
1851 Defines whether you want to support multicast TFTP as per
1852 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001853 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001854 driver in use must provide a function: mcast() to join/leave a
1855 multicast group.
1856
wdenkc6097192002-11-03 00:24:07 +00001857- BOOTP Recovery Mode:
1858 CONFIG_BOOTP_RANDOM_DELAY
1859
1860 If you have many targets in a network that try to
1861 boot using BOOTP, you may want to avoid that all
1862 systems send out BOOTP requests at precisely the same
1863 moment (which would happen for instance at recovery
1864 from a power failure, when all systems will try to
1865 boot, thus flooding the BOOTP server. Defining
1866 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1867 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001868 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001869
1870 1st BOOTP request: delay 0 ... 1 sec
1871 2nd BOOTP request: delay 0 ... 2 sec
1872 3rd BOOTP request: delay 0 ... 4 sec
1873 4th and following
1874 BOOTP requests: delay 0 ... 8 sec
1875
Thierry Reding8977cda2014-08-19 10:21:24 +02001876 CONFIG_BOOTP_ID_CACHE_SIZE
1877
1878 BOOTP packets are uniquely identified using a 32-bit ID. The
1879 server will copy the ID from client requests to responses and
1880 U-Boot will use this to determine if it is the destination of
1881 an incoming response. Some servers will check that addresses
1882 aren't in use before handing them out (usually using an ARP
1883 ping) and therefore take up to a few hundred milliseconds to
1884 respond. Network congestion may also influence the time it
1885 takes for a response to make it back to the client. If that
1886 time is too long, U-Boot will retransmit requests. In order
1887 to allow earlier responses to still be accepted after these
1888 retransmissions, U-Boot's BOOTP client keeps a small cache of
1889 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1890 cache. The default is to keep IDs for up to four outstanding
1891 requests. Increasing this will allow U-Boot to accept offers
1892 from a BOOTP client in networks with unusually high latency.
1893
stroesee0aadfb2003-08-28 14:17:32 +00001894- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001895 You can fine tune the DHCP functionality by defining
1896 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001897
Jon Loeliger5336a762007-07-09 22:08:34 -05001898 CONFIG_BOOTP_SUBNETMASK
1899 CONFIG_BOOTP_GATEWAY
1900 CONFIG_BOOTP_HOSTNAME
1901 CONFIG_BOOTP_NISDOMAIN
1902 CONFIG_BOOTP_BOOTPATH
1903 CONFIG_BOOTP_BOOTFILESIZE
1904 CONFIG_BOOTP_DNS
1905 CONFIG_BOOTP_DNS2
1906 CONFIG_BOOTP_SEND_HOSTNAME
1907 CONFIG_BOOTP_NTPSERVER
1908 CONFIG_BOOTP_TIMEOFFSET
1909 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001910 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001911
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001912 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1913 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001914
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001915 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1916 after the configured retry count, the call will fail
1917 instead of starting over. This can be used to fail over
1918 to Link-local IP address configuration if the DHCP server
1919 is not available.
1920
stroesee0aadfb2003-08-28 14:17:32 +00001921 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1922 serverip from a DHCP server, it is possible that more
1923 than one DNS serverip is offered to the client.
1924 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1925 serverip will be stored in the additional environment
1926 variable "dnsip2". The first DNS serverip is always
1927 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001928 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001929
1930 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1931 to do a dynamic update of a DNS server. To do this, they
1932 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001933 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001934 of the "hostname" environment variable is passed as
1935 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001936
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001937 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1938
1939 A 32bit value in microseconds for a delay between
1940 receiving a "DHCP Offer" and sending the "DHCP Request".
1941 This fixes a problem with certain DHCP servers that don't
1942 respond 100% of the time to a "DHCP request". E.g. On an
1943 AT91RM9200 processor running at 180MHz, this delay needed
1944 to be *at least* 15,000 usec before a Windows Server 2003
1945 DHCP server would reply 100% of the time. I recommend at
1946 least 50,000 usec to be safe. The alternative is to hope
1947 that one of the retries will be successful but note that
1948 the DHCP timeout and retry process takes a longer than
1949 this delay.
1950
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001951 - Link-local IP address negotiation:
1952 Negotiate with other link-local clients on the local network
1953 for an address that doesn't require explicit configuration.
1954 This is especially useful if a DHCP server cannot be guaranteed
1955 to exist in all environments that the device must operate.
1956
1957 See doc/README.link-local for more information.
1958
wdenk145d2c12004-04-15 21:48:45 +00001959 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001960 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001961
1962 The device id used in CDP trigger frames.
1963
1964 CONFIG_CDP_DEVICE_ID_PREFIX
1965
1966 A two character string which is prefixed to the MAC address
1967 of the device.
1968
1969 CONFIG_CDP_PORT_ID
1970
1971 A printf format string which contains the ascii name of
1972 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001973 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001974
1975 CONFIG_CDP_CAPABILITIES
1976
1977 A 32bit integer which indicates the device capabilities;
1978 0x00000010 for a normal host which does not forwards.
1979
1980 CONFIG_CDP_VERSION
1981
1982 An ascii string containing the version of the software.
1983
1984 CONFIG_CDP_PLATFORM
1985
1986 An ascii string containing the name of the platform.
1987
1988 CONFIG_CDP_TRIGGER
1989
1990 A 32bit integer sent on the trigger.
1991
1992 CONFIG_CDP_POWER_CONSUMPTION
1993
1994 A 16bit integer containing the power consumption of the
1995 device in .1 of milliwatts.
1996
1997 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1998
1999 A byte containing the id of the VLAN.
2000
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002001- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00002002
2003 Several configurations allow to display the current
2004 status using a LED. For instance, the LED will blink
2005 fast while running U-Boot code, stop blinking as
2006 soon as a reply to a BOOTP request was received, and
2007 start blinking slow once the Linux kernel is running
2008 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002009 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00002010 feature in U-Boot.
2011
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002012 Additional options:
2013
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002014 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002015 The status LED can be connected to a GPIO pin.
2016 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002017 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002018 to include the gpio_led driver in the U-Boot binary.
2019
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002020 CONFIG_GPIO_LED_INVERTED_TABLE
2021 Some GPIO connected LEDs may have inverted polarity in which
2022 case the GPIO high value corresponds to LED off state and
2023 GPIO low value corresponds to LED on state.
2024 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2025 with a list of GPIO LEDs that have inverted polarity.
2026
wdenkc6097192002-11-03 00:24:07 +00002027- CAN Support: CONFIG_CAN_DRIVER
2028
2029 Defining CONFIG_CAN_DRIVER enables CAN driver support
2030 on those systems that support this (optional)
2031 feature, like the TQM8xxL modules.
2032
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002033- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002034
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002035 This enable the NEW i2c subsystem, and will allow you to use
2036 i2c commands at the u-boot command line (as long as you set
2037 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2038 based realtime clock chips or other i2c devices. See
2039 common/cmd_i2c.c for a description of the command line
2040 interface.
2041
2042 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002043 - drivers/i2c/soft_i2c.c:
2044 - activate first bus with CONFIG_SYS_I2C_SOFT define
2045 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2046 for defining speed and slave address
2047 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2048 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2049 for defining speed and slave address
2050 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2051 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2052 for defining speed and slave address
2053 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2054 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2055 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002056
Heiko Schocherf2850742012-10-24 13:48:22 +02002057 - drivers/i2c/fsl_i2c.c:
2058 - activate i2c driver with CONFIG_SYS_I2C_FSL
2059 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2060 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2061 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2062 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002063 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002064 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2065 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2066 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2067 second bus.
2068
Simon Glass026fefb2012-10-30 07:28:53 +00002069 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002070 - activate this driver with CONFIG_SYS_I2C_TEGRA
2071 - This driver adds 4 i2c buses with a fix speed from
2072 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002073
Dirk Eibach42b204f2013-04-25 02:40:01 +00002074 - drivers/i2c/ppc4xx_i2c.c
2075 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2076 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2077 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2078
trema49f40a2013-09-21 18:13:35 +02002079 - drivers/i2c/i2c_mxc.c
2080 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002081 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2082 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2083 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2084 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002085 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2086 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2087 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2088 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2089 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2090 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002091 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2092 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002093 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002094 for speed, and 0 for slave.
2095
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002096 - drivers/i2c/rcar_i2c.c:
2097 - activate this driver with CONFIG_SYS_I2C_RCAR
2098 - This driver adds 4 i2c buses
2099
2100 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2101 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2102 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2103 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2104 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2105 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2106 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2107 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2108 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2109
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002110 - drivers/i2c/sh_i2c.c:
2111 - activate this driver with CONFIG_SYS_I2C_SH
2112 - This driver adds from 2 to 5 i2c buses
2113
2114 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2115 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2116 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2117 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2118 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2119 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2120 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2121 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2122 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2123 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002124 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002125
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002126 - drivers/i2c/omap24xx_i2c.c
2127 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2128 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2129 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2130 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2131 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2132 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2133 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2134 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2135 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2136 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2137 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2138
Heiko Schocher465819a2013-11-08 07:30:53 +01002139 - drivers/i2c/zynq_i2c.c
2140 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2141 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2142 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2143
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302144 - drivers/i2c/s3c24x0_i2c.c:
2145 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2146 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2147 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2148 with a fix speed from 100000 and the slave addr 0!
2149
Dirk Eibachb9577432014-07-03 09:28:18 +02002150 - drivers/i2c/ihs_i2c.c
2151 - activate this driver with CONFIG_SYS_I2C_IHS
2152 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2153 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2154 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2155 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2156 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2157 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2158 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2159 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2160 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2161 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2162 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2163 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002164 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2165 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2166 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2167 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2168 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2169 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2170 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2171 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2172 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002173
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002174 additional defines:
2175
2176 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002177 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002178
2179 CONFIG_SYS_I2C_DIRECT_BUS
2180 define this, if you don't use i2c muxes on your hardware.
2181 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2182 omit this define.
2183
2184 CONFIG_SYS_I2C_MAX_HOPS
2185 define how many muxes are maximal consecutively connected
2186 on one i2c bus. If you not use i2c muxes, omit this
2187 define.
2188
2189 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002190 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002191 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2192 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2193 CONFIG_SYS_NUM_I2C_BUSES = 9:
2194
2195 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2196 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2197 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2198 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2199 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2200 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2201 {1, {I2C_NULL_HOP}}, \
2202 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2203 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2204 }
2205
2206 which defines
2207 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002208 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2209 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2210 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2211 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2212 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002213 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002214 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2215 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002216
2217 If you do not have i2c muxes on your board, omit this define.
2218
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002219- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002220
2221 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2222 provides the following compelling advantages:
2223
2224 - more than one i2c adapter is usable
2225 - approved multibus support
2226 - better i2c mux support
2227
2228 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002229
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002230 These enable legacy I2C serial bus commands. Defining
2231 CONFIG_HARD_I2C will include the appropriate I2C driver
2232 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002233
wdenk21136db2003-07-16 21:53:01 +00002234 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002235 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002236 CONFIG_COMMANDS) and communicate with i2c based realtime
2237 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002238 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002239
Ben Warren45657152006-09-07 16:50:54 -04002240 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002241
wdenk21136db2003-07-16 21:53:01 +00002242 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002243 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002244
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002245 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002246 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002247 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002248 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002249
Peter Tysere4d1abc2010-04-12 22:28:21 -05002250 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002251 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002252 and so its address should therefore be cleared to 0 (See,
2253 eg, MPC823e User's Manual p.16-473). So, set
2254 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002255
Eric Millbrandt12990a42009-09-03 08:09:44 -05002256 CONFIG_SYS_I2C_INIT_MPC5XXX
2257
2258 When a board is reset during an i2c bus transfer
2259 chips might think that the current transfer is still
2260 in progress. Reset the slave devices by sending start
2261 commands until the slave device responds.
2262
wdenk21136db2003-07-16 21:53:01 +00002263 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002264
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002265 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002266 then the following macros need to be defined (examples are
2267 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002268
2269 I2C_INIT
2270
wdenkb9bbd242003-06-30 16:24:52 +00002271 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002272 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002273
wdenk544e9732004-02-06 23:19:44 +00002274 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002275
wdenkc6097192002-11-03 00:24:07 +00002276 I2C_PORT
2277
wdenk4a5c8a72003-03-06 00:02:04 +00002278 (Only for MPC8260 CPU). The I/O port to use (the code
2279 assumes both bits are on the same port). Valid values
2280 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002281
2282 I2C_ACTIVE
2283
2284 The code necessary to make the I2C data line active
2285 (driven). If the data line is open collector, this
2286 define can be null.
2287
wdenkb9bbd242003-06-30 16:24:52 +00002288 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2289
wdenkc6097192002-11-03 00:24:07 +00002290 I2C_TRISTATE
2291
2292 The code necessary to make the I2C data line tri-stated
2293 (inactive). If the data line is open collector, this
2294 define can be null.
2295
wdenkb9bbd242003-06-30 16:24:52 +00002296 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2297
wdenkc6097192002-11-03 00:24:07 +00002298 I2C_READ
2299
York Sun4a598092013-04-01 11:29:11 -07002300 Code that returns true if the I2C data line is high,
2301 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002302
wdenkb9bbd242003-06-30 16:24:52 +00002303 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2304
wdenkc6097192002-11-03 00:24:07 +00002305 I2C_SDA(bit)
2306
York Sun4a598092013-04-01 11:29:11 -07002307 If <bit> is true, sets the I2C data line high. If it
2308 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002309
wdenkb9bbd242003-06-30 16:24:52 +00002310 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002311 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002312 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002313
wdenkc6097192002-11-03 00:24:07 +00002314 I2C_SCL(bit)
2315
York Sun4a598092013-04-01 11:29:11 -07002316 If <bit> is true, sets the I2C clock line high. If it
2317 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002318
wdenkb9bbd242003-06-30 16:24:52 +00002319 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002320 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002321 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002322
wdenkc6097192002-11-03 00:24:07 +00002323 I2C_DELAY
2324
2325 This delay is invoked four times per clock cycle so this
2326 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002327 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002328 like:
2329
wdenkb9bbd242003-06-30 16:24:52 +00002330 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002331
Mike Frysingeree12d542010-07-21 13:38:02 -04002332 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2333
2334 If your arch supports the generic GPIO framework (asm/gpio.h),
2335 then you may alternatively define the two GPIOs that are to be
2336 used as SCL / SDA. Any of the previous I2C_xxx macros will
2337 have GPIO-based defaults assigned to them as appropriate.
2338
2339 You should define these to the GPIO value as given directly to
2340 the generic GPIO functions.
2341
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002342 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002343
wdenk57b2d802003-06-27 21:31:46 +00002344 When a board is reset during an i2c bus transfer
2345 chips might think that the current transfer is still
2346 in progress. On some boards it is possible to access
2347 the i2c SCLK line directly, either by using the
2348 processor pin as a GPIO or by having a second pin
2349 connected to the bus. If this option is defined a
2350 custom i2c_init_board() routine in boards/xxx/board.c
2351 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002352
Richard Retanubundf0149c2010-04-12 15:08:17 -04002353 CONFIG_SYS_I2C_BOARD_LATE_INIT
2354
2355 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2356 defined a custom i2c_board_late_init() routine in
2357 boards/xxx/board.c is run AFTER the operations in i2c_init()
2358 is completed. This callpoint can be used to unreset i2c bus
2359 using CPU i2c controller register accesses for CPUs whose i2c
2360 controller provide such a method. It is called at the end of
2361 i2c_init() to allow i2c_init operations to setup the i2c bus
2362 controller on the CPU (e.g. setting bus speed & slave address).
2363
wdenk0e2bd9c2004-06-06 21:51:03 +00002364 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2365
2366 This option enables configuration of bi_iic_fast[] flags
2367 in u-boot bd_info structure based on u-boot environment
2368 variable "i2cfast". (see also i2cfast)
2369
Ben Warren45657152006-09-07 16:50:54 -04002370 CONFIG_I2C_MULTI_BUS
2371
2372 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002373 must have a controller. At any point in time, only one bus is
2374 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002375 Note that bus numbering is zero-based.
2376
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002377 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002378
2379 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002380 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002381 is set, specify a list of bus-device pairs. Otherwise, specify
2382 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002383
2384 e.g.
2385 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002386 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002387
2388 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2389
Wolfgang Denk092ae952011-10-26 10:21:21 +00002390 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002391 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002392
2393 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2394
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002395 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002396
2397 If defined, then this indicates the I2C bus number for DDR SPD.
2398 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2399
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002400 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002401
2402 If defined, then this indicates the I2C bus number for the RTC.
2403 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2404
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002405 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002406
2407 If defined, then this indicates the I2C bus number for the DTT.
2408 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2409
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002410 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002411
2412 If defined, specifies the I2C address of the DTT device.
2413 If not defined, then U-Boot uses predefined value for
2414 specified DTT device.
2415
Andrew Dyer58c41f92008-12-29 17:36:01 -06002416 CONFIG_SOFT_I2C_READ_REPEATED_START
2417
2418 defining this will force the i2c_read() function in
2419 the soft_i2c driver to perform an I2C repeated start
2420 between writing the address pointer and reading the
2421 data. If this define is omitted the default behaviour
2422 of doing a stop-start sequence will be used. Most I2C
2423 devices can use either method, but some require one or
2424 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002425
wdenkc6097192002-11-03 00:24:07 +00002426- SPI Support: CONFIG_SPI
2427
2428 Enables SPI driver (so far only tested with
2429 SPI EEPROM, also an instance works with Crystal A/D and
2430 D/As on the SACSng board)
2431
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002432 CONFIG_SH_SPI
2433
2434 Enables the driver for SPI controller on SuperH. Currently
2435 only SH7757 is supported.
2436
wdenkc6097192002-11-03 00:24:07 +00002437 CONFIG_SOFT_SPI
2438
wdenk4a5c8a72003-03-06 00:02:04 +00002439 Enables a software (bit-bang) SPI driver rather than
2440 using hardware support. This is a general purpose
2441 driver that only requires three general I/O port pins
2442 (two outputs, one input) to function. If this is
2443 defined, the board configuration must define several
2444 SPI configuration items (port pins to use, etc). For
2445 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002446
Ben Warren7efe9272008-01-16 22:37:35 -05002447 CONFIG_HARD_SPI
2448
2449 Enables a hardware SPI driver for general-purpose reads
2450 and writes. As with CONFIG_SOFT_SPI, the board configuration
2451 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002452 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002453 example, see include/configs/mpc8349emds.h.
2454
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002455 CONFIG_MXC_SPI
2456
2457 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002458 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002459
Heiko Schocherb77c8882014-07-14 10:22:11 +02002460 CONFIG_SYS_SPI_MXC_WAIT
2461 Timeout for waiting until spi transfer completed.
2462 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2463
Matthias Fuchsa4400872007-12-27 17:12:34 +01002464- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002465
Matthias Fuchsa4400872007-12-27 17:12:34 +01002466 Enables FPGA subsystem.
2467
2468 CONFIG_FPGA_<vendor>
2469
2470 Enables support for specific chip vendors.
2471 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002472
Matthias Fuchsa4400872007-12-27 17:12:34 +01002473 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002474
Matthias Fuchsa4400872007-12-27 17:12:34 +01002475 Enables support for FPGA family.
2476 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2477
2478 CONFIG_FPGA_COUNT
2479
2480 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002481
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302482 CONFIG_CMD_FPGA_LOADMK
2483
2484 Enable support for fpga loadmk command
2485
Michal Simek64c70982014-05-02 13:43:39 +02002486 CONFIG_CMD_FPGA_LOADP
2487
2488 Enable support for fpga loadp command - load partial bitstream
2489
2490 CONFIG_CMD_FPGA_LOADBP
2491
2492 Enable support for fpga loadbp command - load partial bitstream
2493 (Xilinx only)
2494
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002495 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002496
wdenk57b2d802003-06-27 21:31:46 +00002497 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002498
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002499 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002500
wdenk4a5c8a72003-03-06 00:02:04 +00002501 Enable checks on FPGA configuration interface busy
2502 status by the configuration function. This option
2503 will require a board or device specific function to
2504 be written.
wdenkc6097192002-11-03 00:24:07 +00002505
2506 CONFIG_FPGA_DELAY
2507
2508 If defined, a function that provides delays in the FPGA
2509 configuration driver.
2510
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002511 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002512 Allow Control-C to interrupt FPGA configuration
2513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002514 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002515
wdenk4a5c8a72003-03-06 00:02:04 +00002516 Check for configuration errors during FPGA bitfile
2517 loading. For example, abort during Virtex II
2518 configuration if the INIT_B line goes low (which
2519 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002520
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002521 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002522
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002523 Maximum time to wait for the INIT_B line to de-assert
2524 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002525 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002526 ms.
wdenkc6097192002-11-03 00:24:07 +00002527
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002528 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002529
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002530 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002531 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002532
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002533 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002534
wdenk4a5c8a72003-03-06 00:02:04 +00002535 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002536 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002537
2538- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002539 CONFIG_BUILD_TARGET
2540
2541 Some SoCs need special image types (e.g. U-Boot binary
2542 with a special header) as build targets. By defining
2543 CONFIG_BUILD_TARGET in the SoC / board header, this
2544 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002545 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002546
wdenkc6097192002-11-03 00:24:07 +00002547 CONFIG_IDENT_STRING
2548
wdenk4a5c8a72003-03-06 00:02:04 +00002549 If defined, this string will be added to the U-Boot
2550 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002551
2552- Vendor Parameter Protection:
2553
wdenk4a5c8a72003-03-06 00:02:04 +00002554 U-Boot considers the values of the environment
2555 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002556 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002557 are set once by the board vendor / manufacturer, and
2558 protects these variables from casual modification by
2559 the user. Once set, these variables are read-only,
2560 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002561 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002562
2563 If CONFIG_ENV_OVERWRITE is #defined in your config
2564 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002565 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002566 these parameters.
2567
Joe Hershberger76f353e2015-05-04 14:55:14 -05002568 Alternatively, if you define _both_ an ethaddr in the
2569 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002570 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002571 which can be changed exactly ONCE by the user. [The
2572 serial# is unaffected by this, i. e. it remains
2573 read-only.]
2574
Joe Hershberger71497d02012-12-11 22:16:31 -06002575 The same can be accomplished in a more flexible way
2576 for any variable by configuring the type of access
2577 to allow for those variables in the ".flags" variable
2578 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2579
wdenkc6097192002-11-03 00:24:07 +00002580- Protected RAM:
2581 CONFIG_PRAM
2582
2583 Define this variable to enable the reservation of
2584 "protected RAM", i. e. RAM which is not overwritten
2585 by U-Boot. Define CONFIG_PRAM to hold the number of
2586 kB you want to reserve for pRAM. You can overwrite
2587 this default value by defining an environment
2588 variable "pram" to the number of kB you want to
2589 reserve. Note that the board info structure will
2590 still show the full amount of RAM. If pRAM is
2591 reserved, a new environment variable "mem" will
2592 automatically be defined to hold the amount of
2593 remaining RAM in a form that can be passed as boot
2594 argument to Linux, for instance like that:
2595
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002596 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002597 saveenv
2598
2599 This way you can tell Linux not to use this memory,
2600 either, which results in a memory region that will
2601 not be affected by reboots.
2602
2603 *WARNING* If your board configuration uses automatic
2604 detection of the RAM size, you must make sure that
2605 this memory test is non-destructive. So far, the
2606 following board configurations are known to be
2607 "pRAM-clean":
2608
Wolfgang Denk90326762012-10-24 02:36:15 +00002609 IVMS8, IVML24, SPD8xx, TQM8xxL,
2610 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002611 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002612
Gabe Blacka2f3a932012-12-02 04:55:18 +00002613- Access to physical memory region (> 4GB)
2614 Some basic support is provided for operations on memory not
2615 normally accessible to U-Boot - e.g. some architectures
2616 support access to more than 4GB of memory on 32-bit
2617 machines using physical address extension or similar.
2618 Define CONFIG_PHYSMEM to access this basic support, which
2619 currently only supports clearing the memory.
2620
wdenkc6097192002-11-03 00:24:07 +00002621- Error Recovery:
2622 CONFIG_PANIC_HANG
2623
2624 Define this variable to stop the system in case of a
2625 fatal error, so that you have to reset it manually.
2626 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002627 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002628 automatically as fast as possible, but it may be
2629 useful during development since you can try to debug
2630 the conditions that lead to the situation.
2631
2632 CONFIG_NET_RETRY_COUNT
2633
wdenk4a5c8a72003-03-06 00:02:04 +00002634 This variable defines the number of retries for
2635 network operations like ARP, RARP, TFTP, or BOOTP
2636 before giving up the operation. If not defined, a
2637 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002638
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002639 CONFIG_ARP_TIMEOUT
2640
2641 Timeout waiting for an ARP reply in milliseconds.
2642
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002643 CONFIG_NFS_TIMEOUT
2644
2645 Timeout in milliseconds used in NFS protocol.
2646 If you encounter "ERROR: Cannot umount" in nfs command,
2647 try longer timeout such as
2648 #define CONFIG_NFS_TIMEOUT 10000UL
2649
wdenkc6097192002-11-03 00:24:07 +00002650- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002651 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002652
2653 Enable auto completion of commands using TAB.
2654
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002655 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002656
2657 This defines the secondary prompt string, which is
2658 printed when the command interpreter needs more input
2659 to complete a command. Usually "> ".
2660
2661 Note:
2662
wdenk57b2d802003-06-27 21:31:46 +00002663 In the current implementation, the local variables
2664 space and global environment variables space are
2665 separated. Local variables are those you define by
2666 simply typing `name=value'. To access a local
2667 variable later on, you have write `$name' or
2668 `${name}'; to execute the contents of a variable
2669 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002670
wdenk4a5c8a72003-03-06 00:02:04 +00002671 Global environment variables are those you use
2672 setenv/printenv to work with. To run a command stored
2673 in such a variable, you need to use the run command,
2674 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002675
2676 To store commands and special characters in a
2677 variable, please use double quotation marks
2678 surrounding the whole text of the variable, instead
2679 of the backslashes before semicolons and special
2680 symbols.
2681
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002682- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002683 CONFIG_CMDLINE_EDITING
2684
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002685 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002686 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002687
Marek Vasut734fb042016-01-27 04:47:55 +01002688- Command Line PS1/PS2 support:
2689 CONFIG_CMDLINE_PS_SUPPORT
2690
2691 Enable support for changing the command prompt string
2692 at run-time. Only static string is supported so far.
2693 The string is obtained from environment variables PS1
2694 and PS2.
2695
wdenkc0aa5c52003-12-06 19:49:23 +00002696- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002697 CONFIG_EXTRA_ENV_SETTINGS
2698
wdenk4a5c8a72003-03-06 00:02:04 +00002699 Define this to contain any number of null terminated
2700 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002701 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002702
wdenk4a5c8a72003-03-06 00:02:04 +00002703 For example, place something like this in your
2704 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002705
2706 #define CONFIG_EXTRA_ENV_SETTINGS \
2707 "myvar1=value1\0" \
2708 "myvar2=value2\0"
2709
wdenk4a5c8a72003-03-06 00:02:04 +00002710 Warning: This method is based on knowledge about the
2711 internal format how the environment is stored by the
2712 U-Boot code. This is NOT an official, exported
2713 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002714 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002715 You better know what you are doing here.
2716
wdenk4a5c8a72003-03-06 00:02:04 +00002717 Note: overly (ab)use of the default environment is
2718 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002719 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002720 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002721
Stephen Warren1465d5f2012-05-22 09:21:54 +00002722 CONFIG_ENV_VARS_UBOOT_CONFIG
2723
2724 Define this in order to add variables describing the
2725 U-Boot build configuration to the default environment.
2726 These will be named arch, cpu, board, vendor, and soc.
2727
2728 Enabling this option will cause the following to be defined:
2729
2730 - CONFIG_SYS_ARCH
2731 - CONFIG_SYS_CPU
2732 - CONFIG_SYS_BOARD
2733 - CONFIG_SYS_VENDOR
2734 - CONFIG_SYS_SOC
2735
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002736 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2737
2738 Define this in order to add variables describing certain
2739 run-time determined information about the hardware to the
2740 environment. These will be named board_name, board_rev.
2741
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002742 CONFIG_DELAY_ENVIRONMENT
2743
2744 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002745 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002746 that so that the environment is not available until
2747 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2748 this is instead controlled by the value of
2749 /config/load-environment.
2750
wdenkc0aa5c52003-12-06 19:49:23 +00002751- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002752 CONFIG_HAS_DATAFLASH
2753
wdenk57b2d802003-06-27 21:31:46 +00002754 Defining this option enables DataFlash features and
2755 allows to read/write in Dataflash via the standard
2756 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002757
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002758- Serial Flash support
2759 CONFIG_CMD_SF
2760
2761 Defining this option enables SPI flash commands
2762 'sf probe/read/write/erase/update'.
2763
2764 Usage requires an initial 'probe' to define the serial
2765 flash parameters, followed by read/write/erase/update
2766 commands.
2767
2768 The following defaults may be provided by the platform
2769 to handle the common case when only a single serial
2770 flash is present on the system.
2771
2772 CONFIG_SF_DEFAULT_BUS Bus identifier
2773 CONFIG_SF_DEFAULT_CS Chip-select
2774 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2775 CONFIG_SF_DEFAULT_SPEED in Hz
2776
Simon Glass4b5545e2012-10-08 13:16:02 +00002777 CONFIG_CMD_SF_TEST
2778
2779 Define this option to include a destructive SPI flash
2780 test ('sf test').
2781
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302782 CONFIG_SF_DUAL_FLASH Dual flash memories
2783
2784 Define this option to use dual flash support where two flash
2785 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002786 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302787
wdenkef893942004-02-23 16:11:30 +00002788- SystemACE Support:
2789 CONFIG_SYSTEMACE
2790
2791 Adding this option adds support for Xilinx SystemACE
2792 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002793 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002794 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002795
2796 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002797 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002798
2799 When SystemACE support is added, the "ace" device type
2800 becomes available to the fat commands, i.e. fatls.
2801
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002802- TFTP Fixed UDP Port:
2803 CONFIG_TFTP_PORT
2804
Wolfgang Denk227b5192005-09-24 23:25:46 +02002805 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002806 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002807 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002808 number generator is used.
2809
Wolfgang Denk227b5192005-09-24 23:25:46 +02002810 Also, the environment variable tftpdstp is used to supply
2811 the TFTP UDP destination port value. If tftpdstp isn't
2812 defined, the normal port 69 is used.
2813
2814 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002815 blindly start the TFTP transfer using the pre-configured
2816 target IP address and UDP port. This has the effect of
2817 "punching through" the (Windows XP) firewall, allowing
2818 the remainder of the TFTP transfer to proceed normally.
2819 A better solution is to properly configure the firewall,
2820 but sometimes that is not allowed.
2821
Simon Glass058bb8d2012-12-05 14:46:38 +00002822- Hashing support:
2823 CONFIG_CMD_HASH
2824
2825 This enables a generic 'hash' command which can produce
2826 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2827
2828 CONFIG_HASH_VERIFY
2829
2830 Enable the hash verify command (hash -v). This adds to code
2831 size a little.
2832
gaurav ranaef201592015-02-20 12:51:46 +05302833 CONFIG_SHA1 - This option enables support of hashing using SHA1
2834 algorithm. The hash is calculated in software.
2835 CONFIG_SHA256 - This option enables support of hashing using
2836 SHA256 algorithm. The hash is calculated in software.
2837 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
2838 for SHA1/SHA256 hashing.
2839 This affects the 'hash' command and also the
2840 hash_lookup_algo() function.
2841 CONFIG_SHA_PROG_HW_ACCEL - This option enables
2842 hardware-acceleration for SHA1/SHA256 progressive hashing.
2843 Data can be streamed in a block at a time and the hashing
2844 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00002845
2846 Note: There is also a sha1sum command, which should perhaps
2847 be deprecated in favour of 'hash sha1'.
2848
Robert Winkler765ccf42013-07-24 17:57:06 -07002849- Freescale i.MX specific commands:
2850 CONFIG_CMD_HDMIDETECT
2851 This enables 'hdmidet' command which returns true if an
2852 HDMI monitor is detected. This command is i.MX 6 specific.
2853
2854 CONFIG_CMD_BMODE
2855 This enables the 'bmode' (bootmode) command for forcing
2856 a boot from specific media.
2857
2858 This is useful for forcing the ROM's usb downloader to
2859 activate upon a watchdog reset which is nice when iterating
2860 on U-Boot. Using the reset button or running bmode normal
2861 will set it back to normal. This command currently
2862 supports i.MX53 and i.MX6.
2863
Heiko Schocher443ca402014-01-25 07:27:13 +01002864- bootcount support:
2865 CONFIG_BOOTCOUNT_LIMIT
2866
2867 This enables the bootcounter support, see:
2868 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2869
2870 CONFIG_AT91SAM9XE
2871 enable special bootcounter support on at91sam9xe based boards.
2872 CONFIG_BLACKFIN
2873 enable special bootcounter support on blackfin based boards.
2874 CONFIG_SOC_DA8XX
2875 enable special bootcounter support on da850 based boards.
2876 CONFIG_BOOTCOUNT_RAM
2877 enable support for the bootcounter in RAM
2878 CONFIG_BOOTCOUNT_I2C
2879 enable support for the bootcounter on an i2c (like RTC) device.
2880 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2881 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2882 the bootcounter.
2883 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002884
wdenkc0aa5c52003-12-06 19:49:23 +00002885- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002886 CONFIG_SHOW_BOOT_PROGRESS
2887
wdenk4a5c8a72003-03-06 00:02:04 +00002888 Defining this option allows to add some board-
2889 specific code (calling a user-provided function
2890 "show_boot_progress(int)") that enables you to show
2891 the system's boot progress on some display (for
2892 example, some LED's) on your board. At the moment,
2893 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002894
Simon Glass0fa36a42012-09-28 08:56:37 +00002895
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002896Legacy uImage format:
2897
wdenkc6097192002-11-03 00:24:07 +00002898 Arg Where When
2899 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002900 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002901 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002902 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002903 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002904 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002905 4 common/cmd_bootm.c Image data has correct checksum
2906 -4 common/cmd_bootm.c Image is for unsupported architecture
2907 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002908 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002909 6 common/cmd_bootm.c Image Type check OK
2910 -6 common/cmd_bootm.c gunzip uncompression error
2911 -7 common/cmd_bootm.c Unimplemented compression type
2912 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002913 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002914 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002915
2916 9 common/image.c Start initial ramdisk verification
2917 -10 common/image.c Ramdisk header has bad magic number
2918 -11 common/image.c Ramdisk header has bad checksum
2919 10 common/image.c Ramdisk header is OK
2920 -12 common/image.c Ramdisk data has bad checksum
2921 11 common/image.c Ramdisk data has correct checksum
2922 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002923 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002924 13 common/image.c Start multifile image verification
2925 14 common/image.c No initial ramdisk, no multifile, continue.
2926
Wolfgang Denk092ae952011-10-26 10:21:21 +00002927 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002928
Stefan Roese88fbf932010-04-15 16:07:28 +02002929 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002930 -31 post/post.c POST test failed, detected by post_output_backlog()
2931 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002932
Heiko Schocher633e03a2007-06-22 19:11:54 +02002933 34 common/cmd_doc.c before loading a Image from a DOC device
2934 -35 common/cmd_doc.c Bad usage of "doc" command
2935 35 common/cmd_doc.c correct usage of "doc" command
2936 -36 common/cmd_doc.c No boot device
2937 36 common/cmd_doc.c correct boot device
2938 -37 common/cmd_doc.c Unknown Chip ID on boot device
2939 37 common/cmd_doc.c correct chip ID found, device available
2940 -38 common/cmd_doc.c Read Error on boot device
2941 38 common/cmd_doc.c reading Image header from DOC device OK
2942 -39 common/cmd_doc.c Image header has bad magic number
2943 39 common/cmd_doc.c Image header has correct magic number
2944 -40 common/cmd_doc.c Error reading Image from DOC device
2945 40 common/cmd_doc.c Image header has correct magic number
2946 41 common/cmd_ide.c before loading a Image from a IDE device
2947 -42 common/cmd_ide.c Bad usage of "ide" command
2948 42 common/cmd_ide.c correct usage of "ide" command
2949 -43 common/cmd_ide.c No boot device
2950 43 common/cmd_ide.c boot device found
2951 -44 common/cmd_ide.c Device not available
2952 44 common/cmd_ide.c Device available
2953 -45 common/cmd_ide.c wrong partition selected
2954 45 common/cmd_ide.c partition selected
2955 -46 common/cmd_ide.c Unknown partition table
2956 46 common/cmd_ide.c valid partition table found
2957 -47 common/cmd_ide.c Invalid partition type
2958 47 common/cmd_ide.c correct partition type
2959 -48 common/cmd_ide.c Error reading Image Header on boot device
2960 48 common/cmd_ide.c reading Image Header from IDE device OK
2961 -49 common/cmd_ide.c Image header has bad magic number
2962 49 common/cmd_ide.c Image header has correct magic number
2963 -50 common/cmd_ide.c Image header has bad checksum
2964 50 common/cmd_ide.c Image header has correct checksum
2965 -51 common/cmd_ide.c Error reading Image from IDE device
2966 51 common/cmd_ide.c reading Image from IDE device OK
2967 52 common/cmd_nand.c before loading a Image from a NAND device
2968 -53 common/cmd_nand.c Bad usage of "nand" command
2969 53 common/cmd_nand.c correct usage of "nand" command
2970 -54 common/cmd_nand.c No boot device
2971 54 common/cmd_nand.c boot device found
2972 -55 common/cmd_nand.c Unknown Chip ID on boot device
2973 55 common/cmd_nand.c correct chip ID found, device available
2974 -56 common/cmd_nand.c Error reading Image Header on boot device
2975 56 common/cmd_nand.c reading Image Header from NAND device OK
2976 -57 common/cmd_nand.c Image header has bad magic number
2977 57 common/cmd_nand.c Image header has correct magic number
2978 -58 common/cmd_nand.c Error reading Image from NAND device
2979 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002980
Heiko Schocher633e03a2007-06-22 19:11:54 +02002981 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002982
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002983 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002984 -64 net/eth.c no Ethernet found.
2985 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002986
Heiko Schocher633e03a2007-06-22 19:11:54 +02002987 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002988 80 common/cmd_net.c before calling net_loop()
2989 -81 common/cmd_net.c some error in net_loop() occurred
2990 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002991 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2992 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002993 83 common/cmd_net.c running "source" command
2994 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002995 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002996
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002997FIT uImage format:
2998
2999 Arg Where When
3000 100 common/cmd_bootm.c Kernel FIT Image has correct format
3001 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3002 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3003 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3004 102 common/cmd_bootm.c Kernel unit name specified
3005 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003006 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003007 104 common/cmd_bootm.c Got kernel subimage node offset
3008 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3009 105 common/cmd_bootm.c Kernel subimage hash verification OK
3010 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3011 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003012 -106 common/cmd_bootm.c Kernel subimage has wrong type
3013 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003014 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3015 108 common/cmd_bootm.c Got kernel subimage data/size
3016 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3017 -109 common/cmd_bootm.c Can't get kernel subimage type
3018 -110 common/cmd_bootm.c Can't get kernel subimage comp
3019 -111 common/cmd_bootm.c Can't get kernel subimage os
3020 -112 common/cmd_bootm.c Can't get kernel subimage load address
3021 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3022
3023 120 common/image.c Start initial ramdisk verification
3024 -120 common/image.c Ramdisk FIT image has incorrect format
3025 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003026 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003027 -122 common/image.c Can't get configuration for ramdisk subimage
3028 123 common/image.c Ramdisk unit name specified
3029 -124 common/image.c Can't get ramdisk subimage node offset
3030 125 common/image.c Got ramdisk subimage node offset
3031 -125 common/image.c Ramdisk subimage hash verification failed
3032 126 common/image.c Ramdisk subimage hash verification OK
3033 -126 common/image.c Ramdisk subimage for unsupported architecture
3034 127 common/image.c Architecture check OK
3035 -127 common/image.c Can't get ramdisk subimage data/size
3036 128 common/image.c Got ramdisk subimage data/size
3037 129 common/image.c Can't get ramdisk load address
3038 -129 common/image.c Got ramdisk load address
3039
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003040 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003041 131 common/cmd_doc.c FIT image format OK
3042
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003043 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003044 141 common/cmd_ide.c FIT image format OK
3045
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003046 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003047 151 common/cmd_nand.c FIT image format OK
3048
Heiko Schocher515eb122014-05-28 11:33:33 +02003049- legacy image format:
3050 CONFIG_IMAGE_FORMAT_LEGACY
3051 enables the legacy image format support in U-Boot.
3052
3053 Default:
3054 enabled if CONFIG_FIT_SIGNATURE is not defined.
3055
3056 CONFIG_DISABLE_IMAGE_LEGACY
3057 disable the legacy image format
3058
3059 This define is introduced, as the legacy image format is
3060 enabled per default for backward compatibility.
3061
Gabe Blackd572e162012-10-25 16:31:10 +00003062- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003063 CONFIG_FIT_DISABLE_SHA256
3064 Supporting SHA256 hashes has quite an impact on binary size.
3065 For constrained systems sha256 hash support can be disabled
3066 with this option.
3067
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003068 TODO(sjg@chromium.org): Adjust this option to be positive,
3069 and move it to Kconfig
3070
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003071- Standalone program support:
3072 CONFIG_STANDALONE_LOAD_ADDR
3073
Wolfgang Denk23f78482011-10-09 21:06:34 +02003074 This option defines a board specific value for the
3075 address where standalone program gets loaded, thus
3076 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003077 settings.
3078
3079- Frame Buffer Address:
3080 CONFIG_FB_ADDR
3081
3082 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003083 address for frame buffer. This is typically the case
3084 when using a graphics controller has separate video
3085 memory. U-Boot will then place the frame buffer at
3086 the given address instead of dynamically reserving it
3087 in system RAM by calling lcd_setmem(), which grabs
3088 the memory for the frame buffer depending on the
3089 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003090
3091 Please see board_init_f function.
3092
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003093- Automatic software updates via TFTP server
3094 CONFIG_UPDATE_TFTP
3095 CONFIG_UPDATE_TFTP_CNT_MAX
3096 CONFIG_UPDATE_TFTP_MSEC_MAX
3097
3098 These options enable and control the auto-update feature;
3099 for a more detailed description refer to doc/README.update.
3100
3101- MTD Support (mtdparts command, UBI support)
3102 CONFIG_MTD_DEVICE
3103
3104 Adds the MTD device infrastructure from the Linux kernel.
3105 Needed for mtdparts command support.
3106
3107 CONFIG_MTD_PARTITIONS
3108
3109 Adds the MTD partitioning infrastructure from the Linux
3110 kernel. Needed for UBI support.
3111
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003112- UBI support
3113 CONFIG_CMD_UBI
3114
3115 Adds commands for interacting with MTD partitions formatted
3116 with the UBI flash translation layer
3117
3118 Requires also defining CONFIG_RBTREE
3119
Joe Hershberger47550fc2013-04-08 10:32:49 +00003120 CONFIG_UBI_SILENCE_MSG
3121
3122 Make the verbose messages from UBI stop printing. This leaves
3123 warnings and errors enabled.
3124
Heiko Schocherf5895d12014-06-24 10:10:04 +02003125
3126 CONFIG_MTD_UBI_WL_THRESHOLD
3127 This parameter defines the maximum difference between the highest
3128 erase counter value and the lowest erase counter value of eraseblocks
3129 of UBI devices. When this threshold is exceeded, UBI starts performing
3130 wear leveling by means of moving data from eraseblock with low erase
3131 counter to eraseblocks with high erase counter.
3132
3133 The default value should be OK for SLC NAND flashes, NOR flashes and
3134 other flashes which have eraseblock life-cycle 100000 or more.
3135 However, in case of MLC NAND flashes which typically have eraseblock
3136 life-cycle less than 10000, the threshold should be lessened (e.g.,
3137 to 128 or 256, although it does not have to be power of 2).
3138
3139 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003140
Heiko Schocherf5895d12014-06-24 10:10:04 +02003141 CONFIG_MTD_UBI_BEB_LIMIT
3142 This option specifies the maximum bad physical eraseblocks UBI
3143 expects on the MTD device (per 1024 eraseblocks). If the
3144 underlying flash does not admit of bad eraseblocks (e.g. NOR
3145 flash), this value is ignored.
3146
3147 NAND datasheets often specify the minimum and maximum NVM
3148 (Number of Valid Blocks) for the flashes' endurance lifetime.
3149 The maximum expected bad eraseblocks per 1024 eraseblocks
3150 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3151 which gives 20 for most NANDs (MaxNVB is basically the total
3152 count of eraseblocks on the chip).
3153
3154 To put it differently, if this value is 20, UBI will try to
3155 reserve about 1.9% of physical eraseblocks for bad blocks
3156 handling. And that will be 1.9% of eraseblocks on the entire
3157 NAND chip, not just the MTD partition UBI attaches. This means
3158 that if you have, say, a NAND flash chip admits maximum 40 bad
3159 eraseblocks, and it is split on two MTD partitions of the same
3160 size, UBI will reserve 40 eraseblocks when attaching a
3161 partition.
3162
3163 default: 20
3164
3165 CONFIG_MTD_UBI_FASTMAP
3166 Fastmap is a mechanism which allows attaching an UBI device
3167 in nearly constant time. Instead of scanning the whole MTD device it
3168 only has to locate a checkpoint (called fastmap) on the device.
3169 The on-flash fastmap contains all information needed to attach
3170 the device. Using fastmap makes only sense on large devices where
3171 attaching by scanning takes long. UBI will not automatically install
3172 a fastmap on old images, but you can set the UBI parameter
3173 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3174 that fastmap-enabled images are still usable with UBI implementations
3175 without fastmap support. On typical flash devices the whole fastmap
3176 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3177
3178 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3179 Set this parameter to enable fastmap automatically on images
3180 without a fastmap.
3181 default: 0
3182
Heiko Schocher94b66de2015-10-22 06:19:21 +02003183 CONFIG_MTD_UBI_FM_DEBUG
3184 Enable UBI fastmap debug
3185 default: 0
3186
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003187- UBIFS support
3188 CONFIG_CMD_UBIFS
3189
3190 Adds commands for interacting with UBI volumes formatted as
3191 UBIFS. UBIFS is read-only in u-boot.
3192
3193 Requires UBI support as well as CONFIG_LZO
3194
Joe Hershberger47550fc2013-04-08 10:32:49 +00003195 CONFIG_UBIFS_SILENCE_MSG
3196
3197 Make the verbose messages from UBIFS stop printing. This leaves
3198 warnings and errors enabled.
3199
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003200- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003201 CONFIG_SPL
3202 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003203
Tom Rini36853852012-02-14 07:29:40 +00003204 CONFIG_SPL_LDSCRIPT
3205 LDSCRIPT for linking the SPL binary.
3206
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003207 CONFIG_SPL_MAX_FOOTPRINT
3208 Maximum size in memory allocated to the SPL, BSS included.
3209 When defined, the linker checks that the actual memory
3210 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003211 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003212 must not be both defined at the same time.
3213
Tom Rini36853852012-02-14 07:29:40 +00003214 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003215 Maximum size of the SPL image (text, data, rodata, and
3216 linker lists sections), BSS excluded.
3217 When defined, the linker checks that the actual size does
3218 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003219
Wolfgang Denk825223d2011-09-11 21:24:09 +02003220 CONFIG_SPL_TEXT_BASE
3221 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003222
Scott Woodc4f0d002012-09-20 19:05:12 -05003223 CONFIG_SPL_RELOC_TEXT_BASE
3224 Address to relocate to. If unspecified, this is equal to
3225 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3226
Tom Rini36853852012-02-14 07:29:40 +00003227 CONFIG_SPL_BSS_START_ADDR
3228 Link address for the BSS within the SPL binary.
3229
3230 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003231 Maximum size in memory allocated to the SPL BSS.
3232 When defined, the linker checks that the actual memory used
3233 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003234 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003235 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003236
3237 CONFIG_SPL_STACK
3238 Adress of the start of the stack SPL will use
3239
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003240 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3241 When defined, SPL will panic() if the image it has
3242 loaded does not have a signature.
3243 Defining this is useful when code which loads images
3244 in SPL cannot guarantee that absolutely all read errors
3245 will be caught.
3246 An example is the LPC32XX MLC NAND driver, which will
3247 consider that a completely unreadable NAND block is bad,
3248 and thus should be skipped silently.
3249
Scott Woodc4f0d002012-09-20 19:05:12 -05003250 CONFIG_SPL_RELOC_STACK
3251 Adress of the start of the stack SPL will use after
3252 relocation. If unspecified, this is equal to
3253 CONFIG_SPL_STACK.
3254
Tom Rini36853852012-02-14 07:29:40 +00003255 CONFIG_SYS_SPL_MALLOC_START
3256 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003257 When this option is set the full malloc is used in SPL and
3258 it is set up by spl_init() and before that, the simple malloc()
3259 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003260
3261 CONFIG_SYS_SPL_MALLOC_SIZE
3262 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003263
Tom Rini28591df2012-08-13 12:03:19 -07003264 CONFIG_SPL_FRAMEWORK
3265 Enable the SPL framework under common/. This framework
3266 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3267 NAND loading of the Linux Kernel.
3268
Tom Rinic2b76002014-03-28 12:03:39 -04003269 CONFIG_SPL_OS_BOOT
3270 Enable booting directly to an OS from SPL.
3271 See also: doc/README.falcon
3272
Tom Rinife3b0c72012-08-13 11:37:56 -07003273 CONFIG_SPL_DISPLAY_PRINT
3274 For ARM, enable an optional function to print more information
3275 about the running system.
3276
Scott Wood7c810902012-09-20 16:35:21 -05003277 CONFIG_SPL_INIT_MINIMAL
3278 Arch init code should be built for a very small image
3279
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003280 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3281 Partition on the MMC to load U-Boot from when the MMC is being
3282 used in raw mode
3283
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003284 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3285 Sector to load kernel uImage from when MMC is being
3286 used in raw mode (for Falcon mode)
3287
3288 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3289 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3290 Sector and number of sectors to load kernel argument
3291 parameters from when MMC is being used in raw mode
3292 (for falcon mode)
3293
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003294 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3295 Partition on the MMC to load U-Boot from when the MMC is being
3296 used in fs mode
3297
Guillaume GARDET5065b712014-10-15 17:53:13 +02003298 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3299 Filename to read to load U-Boot when reading from filesystem
3300
3301 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003302 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003303 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003304
Guillaume GARDET5065b712014-10-15 17:53:13 +02003305 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003306 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003307 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003308
Scott Wood2b36fbb2012-12-06 13:33:17 +00003309 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3310 Set this for NAND SPL on PPC mpc83xx targets, so that
3311 start.S waits for the rest of the SPL to load before
3312 continuing (the hardware starts execution after just
3313 loading the first page rather than the full 4K).
3314
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303315 CONFIG_SPL_SKIP_RELOCATE
3316 Avoid SPL relocation
3317
Scott Woodc352a0c2012-09-20 19:09:07 -05003318 CONFIG_SPL_NAND_BASE
3319 Include nand_base.c in the SPL. Requires
3320 CONFIG_SPL_NAND_DRIVERS.
3321
3322 CONFIG_SPL_NAND_DRIVERS
3323 SPL uses normal NAND drivers, not minimal drivers.
3324
3325 CONFIG_SPL_NAND_ECC
3326 Include standard software ECC in the SPL
3327
Tom Rini36853852012-02-14 07:29:40 +00003328 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003329 Support for NAND boot using simple NAND drivers that
3330 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003331
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003332 CONFIG_SPL_UBI
3333 Support for a lightweight UBI (fastmap) scanner and
3334 loader
3335
Heiko Schochercf000272014-10-31 08:31:00 +01003336 CONFIG_SPL_NAND_RAW_ONLY
3337 Support to boot only raw u-boot.bin images. Use this only
3338 if you need to save space.
3339
Ying Zhangdfb2b152013-08-16 15:16:12 +08003340 CONFIG_SPL_COMMON_INIT_DDR
3341 Set for common ddr init with serial presence detect in
3342 SPL binary.
3343
Tom Rini36853852012-02-14 07:29:40 +00003344 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3345 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3346 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3347 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3348 CONFIG_SYS_NAND_ECCBYTES
3349 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003350 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003351
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303352 CONFIG_SPL_NAND_BOOT
3353 Add support NAND boot
3354
Tom Rini36853852012-02-14 07:29:40 +00003355 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003356 Location in NAND to read U-Boot from
3357
3358 CONFIG_SYS_NAND_U_BOOT_DST
3359 Location in memory to load U-Boot to
3360
3361 CONFIG_SYS_NAND_U_BOOT_SIZE
3362 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003363
3364 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003365 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003366
3367 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3368 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003369 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003370
3371 CONFIG_SPL_OMAP3_ID_NAND
3372 Support for an OMAP3-specific set of functions to return the
3373 ID and MFR of the first attached NAND chip, if present.
3374
Pavel Machekde997252012-08-30 22:42:11 +02003375 CONFIG_SPL_RAM_DEVICE
3376 Support for running image already present in ram, in SPL binary
3377
Scott Woodeb7bd972012-12-06 13:33:16 +00003378 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003379 Image offset to which the SPL should be padded before appending
3380 the SPL payload. By default, this is defined as
3381 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3382 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3383 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003384
Scott Woodf147eb72012-09-21 16:27:32 -05003385 CONFIG_SPL_TARGET
3386 Final target image containing SPL and payload. Some SPLs
3387 use an arch-specific makefile fragment instead, for
3388 example if more than one image needs to be produced.
3389
Simon Glass82d94532013-05-08 08:05:59 +00003390 CONFIG_FIT_SPL_PRINT
3391 Printing information about a FIT image adds quite a bit of
3392 code to SPL. So this is normally disabled in SPL. Use this
3393 option to re-enable it. This will affect the output of the
3394 bootm command when booting a FIT image.
3395
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003396- TPL framework
3397 CONFIG_TPL
3398 Enable building of TPL globally.
3399
3400 CONFIG_TPL_PAD_TO
3401 Image offset to which the TPL should be padded before appending
3402 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003403 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3404 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3405 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003406
wdenkc0aa5c52003-12-06 19:49:23 +00003407- Interrupt support (PPC):
3408
wdenk1ebf41e2004-01-02 14:00:00 +00003409 There are common interrupt_init() and timer_interrupt()
3410 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003411 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003412 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003413 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003414 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003415 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003416 specific handling. If board has watchdog / status_led
3417 / other_activity_monitor it works automatically from
3418 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003419
wdenkc6097192002-11-03 00:24:07 +00003420
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003421Board initialization settings:
3422------------------------------
3423
3424During Initialization u-boot calls a number of board specific functions
3425to allow the preparation of board specific prerequisites, e.g. pin setup
3426before drivers are initialized. To enable these callbacks the
3427following configuration macros have to be defined. Currently this is
3428architecture specific, so please check arch/your_architecture/lib/board.c
3429typically in board_init_f() and board_init_r().
3430
3431- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3432- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3433- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3434- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003435
wdenkc6097192002-11-03 00:24:07 +00003436Configuration Settings:
3437-----------------------
3438
York Sun6c480012014-02-26 17:03:19 -08003439- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3440 Optionally it can be defined to support 64-bit memory commands.
3441
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003442- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003443 undefine this when you're short of memory.
3444
Peter Tyserdfb72b82009-01-27 18:03:12 -06003445- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3446 width of the commands listed in the 'help' command output.
3447
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003448- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003449 prompt for user input.
3450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003451- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003452
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003453- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003454
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003455- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003456
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003457- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003458 the application (usually a Linux kernel) when it is
3459 booted
3460
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003461- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003462 List of legal baudrate settings for this board.
3463
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003464- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003465 Begin and End addresses of the area used by the
3466 simple memory test.
3467
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003468- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003469 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003470
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003471- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003472 Scratch address used by the alternate memory test
3473 You only need to set this if address zero isn't writeable
3474
York Sun5d286cd2015-12-04 11:57:07 -08003475- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003476 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003477 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3478 is substracted from total RAM and won't be reported to OS.
3479 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003480 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003481 the RAM base is not zero, or RAM is divided into banks,
3482 this variable needs to be recalcuated to get the address.
3483
York Sun50739372015-12-07 11:05:29 -08003484- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003485 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003486 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003487 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003488 fixing up gd->ram_size the Linux kernel should gets passed
3489 the now "corrected" memory size and won't touch it either.
3490 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003491 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003492 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003493 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003494
3495 This option can be used as a workaround for the 440EPx/GRx
3496 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3497 be touched.
3498
3499 WARNING: Please make sure that this value is a multiple of
3500 the Linux page size (normally 4k). If this is not the case,
3501 then the end address of the Linux memory will be located at a
3502 non page size aligned address and this could cause major
3503 problems.
3504
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003505- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003506 Enable temporary baudrate change while serial download
3507
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003508- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003509 Physical start address of SDRAM. _Must_ be 0 here.
3510
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003511- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003512 Physical start address of Flash memory.
3513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003514- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003515 Physical start address of boot monitor code (set by
3516 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003517 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003518 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003519
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003520- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003521 Size of memory reserved for monitor code, used to
3522 determine _at_compile_time_ (!) if the environment is
3523 embedded within the U-Boot image, or in a separate
3524 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003525
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003526- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003527 Size of DRAM reserved for malloc() use.
3528
Simon Glass863e4042014-07-10 22:23:28 -06003529- CONFIG_SYS_MALLOC_F_LEN
3530 Size of the malloc() pool for use before relocation. If
3531 this is defined, then a very simple malloc() implementation
3532 will become available before relocation. The address is just
3533 below the global data, and the stack is moved down to make
3534 space.
3535
3536 This feature allocates regions with increasing addresses
3537 within the region. calloc() is supported, but realloc()
3538 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003539 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003540 U-Boot relocates itself.
3541
Simon Glass9fa901b2014-11-10 17:16:54 -07003542- CONFIG_SYS_MALLOC_SIMPLE
3543 Provides a simple and small malloc() and calloc() for those
3544 boards which do not use the full malloc in SPL (which is
3545 enabled with CONFIG_SYS_SPL_MALLOC_START).
3546
Thierry Redingc97d9742014-12-09 22:25:22 -07003547- CONFIG_SYS_NONCACHED_MEMORY:
3548 Size of non-cached memory area. This area of memory will be
3549 typically located right below the malloc() area and mapped
3550 uncached in the MMU. This is useful for drivers that would
3551 otherwise require a lot of explicit cache maintenance. For
3552 some drivers it's also impossible to properly maintain the
3553 cache. For example if the regions that need to be flushed
3554 are not a multiple of the cache-line size, *and* padding
3555 cannot be allocated between the regions to align them (i.e.
3556 if the HW requires a contiguous array of regions, and the
3557 size of each region is not cache-aligned), then a flush of
3558 one region may result in overwriting data that hardware has
3559 written to another region in the same cache-line. This can
3560 happen for example in network drivers where descriptors for
3561 buffers are typically smaller than the CPU cache-line (e.g.
3562 16 bytes vs. 32 or 64 bytes).
3563
3564 Non-cached memory is only supported on 32-bit ARM at present.
3565
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003566- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003567 Normally compressed uImages are limited to an
3568 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003569 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003570 to adjust this setting to your needs.
3571
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003572- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003573 Maximum size of memory mapped by the startup code of
3574 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003575 the Linux kernel (bd_info, boot arguments, FDT blob if
3576 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003577 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003578 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003579 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003580 variable "bootm_mapsize" will override the value of
3581 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3582 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003583
John Rigbyeea8e692010-10-13 13:57:35 -06003584- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3585 Enable initrd_high functionality. If defined then the
3586 initrd_high feature is enabled and the bootm ramdisk subcommand
3587 is enabled.
3588
3589- CONFIG_SYS_BOOT_GET_CMDLINE:
3590 Enables allocating and saving kernel cmdline in space between
3591 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3592
3593- CONFIG_SYS_BOOT_GET_KBD:
3594 Enables allocating and saving a kernel copy of the bd_info in
3595 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3596
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003597- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003598 Max number of Flash memory banks
3599
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003600- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003601 Max number of sectors on a Flash chip
3602
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003603- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003604 Timeout for Flash erase operations (in ms)
3605
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003606- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003607 Timeout for Flash write operations (in ms)
3608
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003609- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003610 Timeout for Flash set sector lock bit operation (in ms)
3611
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003612- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003613 Timeout for Flash clear lock bits operation (in ms)
3614
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003615- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003616 If defined, hardware flash sectors protection is used
3617 instead of U-Boot software protection.
3618
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003619- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003620
3621 Enable TFTP transfers directly to flash memory;
3622 without this option such a download has to be
3623 performed in two steps: (1) download to RAM, and (2)
3624 copy from RAM to flash.
3625
3626 The two-step approach is usually more reliable, since
3627 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003628 the flash, but in some situations (when system RAM is
3629 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003630 downloaded image) this option may be very useful.
3631
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003632- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003633 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003634 common flash structure for storing flash geometry.
3635
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003636- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003637 This option also enables the building of the cfi_flash driver
3638 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003639
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003640- CONFIG_FLASH_CFI_MTD
3641 This option enables the building of the cfi_mtd driver
3642 in the drivers directory. The driver exports CFI flash
3643 to the MTD layer.
3644
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003645- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003646 Use buffered writes to flash.
3647
3648- CONFIG_FLASH_SPANSION_S29WS_N
3649 s29ws-n MirrorBit flash has non-standard addresses for buffered
3650 write commands.
3651
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003652- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003653 If this option is defined, the common CFI flash doesn't
3654 print it's warning upon not recognized FLASH banks. This
3655 is useful, if some of the configured banks are only
3656 optionally available.
3657
Jerry Van Barenaae73572008-03-08 13:48:01 -05003658- CONFIG_FLASH_SHOW_PROGRESS
3659 If defined (must be an integer), print out countdown
3660 digits and dots. Recommended value: 45 (9..1) for 80
3661 column displays, 15 (3..1) for 40 column displays.
3662
Stefan Roesed20cba52013-04-04 15:53:14 +02003663- CONFIG_FLASH_VERIFY
3664 If defined, the content of the flash (destination) is compared
3665 against the source after the write operation. An error message
3666 will be printed when the contents are not identical.
3667 Please note that this option is useless in nearly all cases,
3668 since such flash programming errors usually are detected earlier
3669 while unprotecting/erasing/programming. Please only enable
3670 this option if you really know what you are doing.
3671
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003672- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003673 Defines the number of Ethernet receive buffers. On some
3674 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003675 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3676 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003677 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003678 Defaults to 4 if not defined.
3679
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003680- CONFIG_ENV_MAX_ENTRIES
3681
Wolfgang Denk1136f692010-10-27 22:48:30 +02003682 Maximum number of entries in the hash table that is used
3683 internally to store the environment settings. The default
3684 setting is supposed to be generous and should work in most
3685 cases. This setting can be used to tune behaviour; see
3686 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003687
Joe Hershberger71497d02012-12-11 22:16:31 -06003688- CONFIG_ENV_FLAGS_LIST_DEFAULT
3689- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003690 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003691 calling env set. Variables can be restricted to only decimal,
3692 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3693 the variables can also be restricted to IP address or MAC address.
3694
3695 The format of the list is:
3696 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003697 access_attribute = [a|r|o|c]
3698 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003699 entry = variable_name[:attributes]
3700 list = entry[,list]
3701
3702 The type attributes are:
3703 s - String (default)
3704 d - Decimal
3705 x - Hexadecimal
3706 b - Boolean ([1yYtT|0nNfF])
3707 i - IP address
3708 m - MAC address
3709
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003710 The access attributes are:
3711 a - Any (default)
3712 r - Read-only
3713 o - Write-once
3714 c - Change-default
3715
Joe Hershberger71497d02012-12-11 22:16:31 -06003716 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3717 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003718 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003719
3720 - CONFIG_ENV_FLAGS_LIST_STATIC
3721 Define this to a list (string) to define validation that
3722 should be done if an entry is not found in the ".flags"
3723 environment variable. To override a setting in the static
3724 list, simply add an entry for the same variable name to the
3725 ".flags" variable.
3726
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003727 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3728 regular expression. This allows multiple variables to define the same
3729 flags without explicitly listing them for each variable.
3730
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003731- CONFIG_ENV_ACCESS_IGNORE_FORCE
3732 If defined, don't allow the -f switch to env set override variable
3733 access flags.
3734
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003735- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3736 This is set by OMAP boards for the max time that reset should
3737 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003738 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003739
Gabe Black3687fe42014-10-15 04:38:30 -06003740- CONFIG_USE_STDINT
3741 If stdint.h is available with your toolchain you can define this
3742 option to enable it. You can provide option 'USE_STDINT=1' when
3743 building U-Boot to enable this.
3744
wdenkc6097192002-11-03 00:24:07 +00003745The following definitions that deal with the placement and management
3746of environment data (variable area); in general, we support the
3747following configurations:
3748
Mike Frysinger63b8f122011-07-08 10:44:25 +00003749- CONFIG_BUILD_ENVCRC:
3750
3751 Builds up envcrc with the target environment so that external utils
3752 may easily extract it and embed it in final U-Boot images.
3753
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003754- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003755
3756 Define this if the environment is in flash memory.
3757
3758 a) The environment occupies one whole flash sector, which is
3759 "embedded" in the text segment with the U-Boot code. This
3760 happens usually with "bottom boot sector" or "top boot
3761 sector" type flash chips, which have several smaller
3762 sectors at the start or the end. For instance, such a
3763 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3764 such a case you would place the environment in one of the
3765 4 kB sectors - with U-Boot code before and after it. With
3766 "top boot sector" type flash chips, you would put the
3767 environment in one of the last sectors, leaving a gap
3768 between U-Boot and the environment.
3769
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003770 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003771
3772 Offset of environment data (variable area) to the
3773 beginning of flash memory; for instance, with bottom boot
3774 type flash chips the second sector can be used: the offset
3775 for this sector is given here.
3776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003777 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003778
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003779 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003780
3781 This is just another way to specify the start address of
3782 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003783 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003784
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003785 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003786
3787 Size of the sector containing the environment.
3788
3789
3790 b) Sometimes flash chips have few, equal sized, BIG sectors.
3791 In such a case you don't want to spend a whole sector for
3792 the environment.
3793
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003794 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003795
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003796 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003797 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003798 of this flash sector for the environment. This saves
3799 memory for the RAM copy of the environment.
3800
3801 It may also save flash memory if you decide to use this
3802 when your environment is "embedded" within U-Boot code,
3803 since then the remainder of the flash sector could be used
3804 for U-Boot code. It should be pointed out that this is
3805 STRONGLY DISCOURAGED from a robustness point of view:
3806 updating the environment in flash makes it always
3807 necessary to erase the WHOLE sector. If something goes
3808 wrong before the contents has been restored from a copy in
3809 RAM, your target system will be dead.
3810
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003811 - CONFIG_ENV_ADDR_REDUND
3812 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003813
wdenk4a5c8a72003-03-06 00:02:04 +00003814 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003815 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003816 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003817 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003818
3819BE CAREFUL! Any changes to the flash layout, and some changes to the
3820source code will make it necessary to adapt <board>/u-boot.lds*
3821accordingly!
3822
3823
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003824- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003825
3826 Define this if you have some non-volatile memory device
3827 (NVRAM, battery buffered SRAM) which you want to use for the
3828 environment.
3829
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003830 - CONFIG_ENV_ADDR:
3831 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003832
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003833 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003834 want to use for environment. It is assumed that this memory
3835 can just be read and written to, without any special
3836 provision.
3837
3838BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003839in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003840console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003841U-Boot will hang.
3842
3843Please note that even with NVRAM we still use a copy of the
3844environment in RAM: we could work on NVRAM directly, but we want to
3845keep settings there always unmodified except somebody uses "saveenv"
3846to save the current settings.
3847
3848
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003849- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003850
3851 Use this if you have an EEPROM or similar serial access
3852 device and a driver for it.
3853
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003854 - CONFIG_ENV_OFFSET:
3855 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003856
3857 These two #defines specify the offset and size of the
3858 environment area within the total memory of your EEPROM.
3859
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003860 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003861 If defined, specified the chip address of the EEPROM device.
3862 The default address is zero.
3863
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003864 - CONFIG_SYS_I2C_EEPROM_BUS:
3865 If defined, specified the i2c bus of the EEPROM device.
3866
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003867 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003868 If defined, the number of bits used to address bytes in a
3869 single page in the EEPROM device. A 64 byte page, for example
3870 would require six bits.
3871
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003872 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003873 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003874 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003875
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003876 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003877 The length in bytes of the EEPROM memory array address. Note
3878 that this is NOT the chip address length!
3879
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003880 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003881 EEPROM chips that implement "address overflow" are ones
3882 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3883 address and the extra bits end up in the "chip address" bit
3884 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3885 byte chips.
3886
3887 Note that we consider the length of the address field to
3888 still be one byte because the extra address bits are hidden
3889 in the chip address.
3890
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003891 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003892 The size in bytes of the EEPROM device.
3893
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003894 - CONFIG_ENV_EEPROM_IS_ON_I2C
3895 define this, if you have I2C and SPI activated, and your
3896 EEPROM, which holds the environment, is on the I2C bus.
3897
3898 - CONFIG_I2C_ENV_EEPROM_BUS
3899 if you have an Environment on an EEPROM reached over
3900 I2C muxes, you can define here, how to reach this
3901 EEPROM. For example:
3902
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003903 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003904
3905 EEPROM which holds the environment, is reached over
3906 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003907
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003908- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003909
wdenk1ebf41e2004-01-02 14:00:00 +00003910 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003911 want to use for the environment.
3912
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003913 - CONFIG_ENV_OFFSET:
3914 - CONFIG_ENV_ADDR:
3915 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003916
3917 These three #defines specify the offset and size of the
3918 environment area within the total memory of your DataFlash placed
3919 at the specified address.
3920
Wu, Josh76db7bf2014-07-01 19:30:13 +08003921- CONFIG_ENV_IS_IN_SPI_FLASH:
3922
3923 Define this if you have a SPI Flash memory device which you
3924 want to use for the environment.
3925
3926 - CONFIG_ENV_OFFSET:
3927 - CONFIG_ENV_SIZE:
3928
3929 These two #defines specify the offset and size of the
3930 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3931 aligned to an erase sector boundary.
3932
3933 - CONFIG_ENV_SECT_SIZE:
3934
3935 Define the SPI flash's sector size.
3936
3937 - CONFIG_ENV_OFFSET_REDUND (optional):
3938
3939 This setting describes a second storage area of CONFIG_ENV_SIZE
3940 size used to hold a redundant copy of the environment data, so
3941 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003942 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003943 aligned to an erase sector boundary.
3944
3945 - CONFIG_ENV_SPI_BUS (optional):
3946 - CONFIG_ENV_SPI_CS (optional):
3947
3948 Define the SPI bus and chip select. If not defined they will be 0.
3949
3950 - CONFIG_ENV_SPI_MAX_HZ (optional):
3951
3952 Define the SPI max work clock. If not defined then use 1MHz.
3953
3954 - CONFIG_ENV_SPI_MODE (optional):
3955
3956 Define the SPI work mode. If not defined then use SPI_MODE_3.
3957
Liu Gang85bcd732012-03-08 00:33:20 +00003958- CONFIG_ENV_IS_IN_REMOTE:
3959
3960 Define this if you have a remote memory space which you
3961 want to use for the local device's environment.
3962
3963 - CONFIG_ENV_ADDR:
3964 - CONFIG_ENV_SIZE:
3965
3966 These two #defines specify the address and size of the
3967 environment area within the remote memory space. The
3968 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003969 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003970
3971BE CAREFUL! For some special cases, the local device can not use
3972"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003973environment stored in a remote NOR flash by SRIO or PCIE link,
3974but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003975
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003976- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003977
3978 Define this if you have a NAND device which you want to use
3979 for the environment.
3980
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003981 - CONFIG_ENV_OFFSET:
3982 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003983
3984 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003985 area within the first NAND device. CONFIG_ENV_OFFSET must be
3986 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003987
Scott Wood08239322010-09-17 14:38:37 -05003988 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003989
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003990 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003991 size used to hold a redundant copy of the environment data, so
3992 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003993 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003994 aligned to an erase block boundary.
3995
3996 - CONFIG_ENV_RANGE (optional):
3997
3998 Specifies the length of the region in which the environment
3999 can be written. This should be a multiple of the NAND device's
4000 block size. Specifying a range with more erase blocks than
4001 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4002 the range to be avoided.
4003
4004 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004005
Scott Wood08239322010-09-17 14:38:37 -05004006 Enables support for dynamically retrieving the offset of the
4007 environment from block zero's out-of-band data. The
4008 "nand env.oob" command can be used to record this offset.
4009 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4010 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004011
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004012- CONFIG_NAND_ENV_DST
4013
4014 Defines address in RAM to which the nand_spl code should copy the
4015 environment. If redundant environment is used, it will be copied to
4016 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4017
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004018- CONFIG_ENV_IS_IN_UBI:
4019
4020 Define this if you have an UBI volume that you want to use for the
4021 environment. This has the benefit of wear-leveling the environment
4022 accesses, which is important on NAND.
4023
4024 - CONFIG_ENV_UBI_PART:
4025
4026 Define this to a string that is the mtd partition containing the UBI.
4027
4028 - CONFIG_ENV_UBI_VOLUME:
4029
4030 Define this to the name of the volume that you want to store the
4031 environment in.
4032
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004033 - CONFIG_ENV_UBI_VOLUME_REDUND:
4034
4035 Define this to the name of another volume to store a second copy of
4036 the environment in. This will enable redundant environments in UBI.
4037 It is assumed that both volumes are in the same MTD partition.
4038
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004039 - CONFIG_UBI_SILENCE_MSG
4040 - CONFIG_UBIFS_SILENCE_MSG
4041
4042 You will probably want to define these to avoid a really noisy system
4043 when storing the env in UBI.
4044
Wu, Josha7d0c872014-06-24 17:31:03 +08004045- CONFIG_ENV_IS_IN_FAT:
4046 Define this if you want to use the FAT file system for the environment.
4047
4048 - FAT_ENV_INTERFACE:
4049
4050 Define this to a string that is the name of the block device.
4051
Nicolae Rosia86811f22016-11-21 17:33:58 +02004052 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08004053
4054 Define this to a string to specify the partition of the device. It can
4055 be as following:
4056
4057 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4058 - "D:P": device D partition P. Error occurs if device D has no
4059 partition table.
4060 - "D:0": device D.
4061 - "D" or "D:": device D partition 1 if device D has partition
4062 table, or the whole device D if has no partition
4063 table.
4064 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004065 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004066 partition table then means device D.
4067
4068 - FAT_ENV_FILE:
4069
4070 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004071 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004072
4073 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004074 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004075
Stephen Warreneedcacd2013-06-11 15:14:00 -06004076- CONFIG_ENV_IS_IN_MMC:
4077
4078 Define this if you have an MMC device which you want to use for the
4079 environment.
4080
4081 - CONFIG_SYS_MMC_ENV_DEV:
4082
4083 Specifies which MMC device the environment is stored in.
4084
4085 - CONFIG_SYS_MMC_ENV_PART (optional):
4086
4087 Specifies which MMC partition the environment is stored in. If not
4088 set, defaults to partition 0, the user area. Common values might be
4089 1 (first MMC boot partition), 2 (second MMC boot partition).
4090
4091 - CONFIG_ENV_OFFSET:
4092 - CONFIG_ENV_SIZE:
4093
4094 These two #defines specify the offset and size of the environment
4095 area within the specified MMC device.
4096
Stephen Warren24dc2032013-06-11 15:14:02 -06004097 If offset is positive (the usual case), it is treated as relative to
4098 the start of the MMC partition. If offset is negative, it is treated
4099 as relative to the end of the MMC partition. This can be useful if
4100 your board may be fitted with different MMC devices, which have
4101 different sizes for the MMC partitions, and you always want the
4102 environment placed at the very end of the partition, to leave the
4103 maximum possible space before it, to store other data.
4104
Stephen Warreneedcacd2013-06-11 15:14:00 -06004105 These two values are in units of bytes, but must be aligned to an
4106 MMC sector boundary.
4107
4108 - CONFIG_ENV_OFFSET_REDUND (optional):
4109
4110 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4111 hold a redundant copy of the environment data. This provides a
4112 valid backup copy in case the other copy is corrupted, e.g. due
4113 to a power failure during a "saveenv" operation.
4114
Stephen Warren24dc2032013-06-11 15:14:02 -06004115 This value may also be positive or negative; this is handled in the
4116 same way as CONFIG_ENV_OFFSET.
4117
Stephen Warreneedcacd2013-06-11 15:14:00 -06004118 This value is also in units of bytes, but must also be aligned to
4119 an MMC sector boundary.
4120
4121 - CONFIG_ENV_SIZE_REDUND (optional):
4122
4123 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4124 set. If this value is set, it must be set to the same value as
4125 CONFIG_ENV_SIZE.
4126
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004127- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004128
4129 Defines offset to the initial SPI buffer area in DPRAM. The
4130 area is used at an early stage (ROM part) if the environment
4131 is configured to reside in the SPI EEPROM: We need a 520 byte
4132 scratch DPRAM area. It is used between the two initialization
4133 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4134 to be a good choice since it makes it far enough from the
4135 start of the data area as well as from the stack pointer.
4136
Bruce Adleredecc942007-11-02 13:15:42 -07004137Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004138has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004139created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004140until then to read environment variables.
4141
wdenk8dba0502003-03-31 16:34:49 +00004142The environment is protected by a CRC32 checksum. Before the monitor
4143is relocated into RAM, as a result of a bad CRC you will be working
4144with the compiled-in default environment - *silently*!!! [This is
4145necessary, because the first environment variable we need is the
4146"baudrate" setting for the console - if we have a bad CRC, we don't
4147have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004148
4149Note: once the monitor has been relocated, then it will complain if
4150the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004151use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004152
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004153- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004154 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004155
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004156 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004157 also needs to be defined.
4158
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004159- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004160 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004161
Ron Madriddfa028a2009-02-18 14:30:44 -08004162- CONFIG_NS16550_MIN_FUNCTIONS:
4163 Define this if you desire to only have use of the NS16550_init
4164 and NS16550_putc functions for the serial driver located at
4165 drivers/serial/ns16550.c. This option is useful for saving
4166 space for already greatly restricted images, including but not
4167 limited to NAND_SPL configurations.
4168
Simon Glass28a9e332012-11-30 13:01:18 +00004169- CONFIG_DISPLAY_BOARDINFO
4170 Display information about the board that U-Boot is running on
4171 when U-Boot starts up. The board function checkboard() is called
4172 to do this.
4173
Simon Glasse8822012012-11-30 13:01:19 +00004174- CONFIG_DISPLAY_BOARDINFO_LATE
4175 Similar to the previous option, but display this information
4176 later, once stdio is running and output goes to the LCD, if
4177 present.
4178
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004179- CONFIG_BOARD_SIZE_LIMIT:
4180 Maximum size of the U-Boot image. When defined, the
4181 build system checks that the actual size does not
4182 exceed it.
4183
wdenkc6097192002-11-03 00:24:07 +00004184Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004185---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004186
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004187- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004188 Cache Line Size of the CPU.
4189
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004190- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004191 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004192
wdenk9c53f402003-10-15 23:53:47 +00004193 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4194 and RPXsuper) to be able to adjust the position of
4195 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004196
Timur Tabid8f341c2011-08-04 18:03:41 -05004197- CONFIG_SYS_CCSRBAR_DEFAULT:
4198 Default (power-on reset) physical address of CCSR on Freescale
4199 PowerPC SOCs.
4200
4201- CONFIG_SYS_CCSRBAR:
4202 Virtual address of CCSR. On a 32-bit build, this is typically
4203 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4204
4205 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4206 for cross-platform code that uses that macro instead.
4207
4208- CONFIG_SYS_CCSRBAR_PHYS:
4209 Physical address of CCSR. CCSR can be relocated to a new
4210 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004211 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004212 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4213 is typically relocated on 36-bit builds. It is recommended
4214 that this macro be defined via the _HIGH and _LOW macros:
4215
4216 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4217 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4218
4219- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004220 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4221 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004222 used in assembly code, so it must not contain typecasts or
4223 integer size suffixes (e.g. "ULL").
4224
4225- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4226 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4227 used in assembly code, so it must not contain typecasts or
4228 integer size suffixes (e.g. "ULL").
4229
4230- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4231 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4232 forced to a value that ensures that CCSR is not relocated.
4233
wdenk1272e232002-11-10 22:06:23 +00004234- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004235 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004236
4237 the default drive number (default value 0)
4238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004239 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004240
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004241 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004242 (default value 1)
4243
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004244 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004245
wdenk4a5c8a72003-03-06 00:02:04 +00004246 defines the offset of register from address. It
4247 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004248 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004249
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004250 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4251 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004252 default value.
wdenk1272e232002-11-10 22:06:23 +00004253
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004254 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004255 fdc_hw_init() is called at the beginning of the FDC
4256 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004257 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004258 initializations.
wdenk1272e232002-11-10 22:06:23 +00004259
Macpaul Lind1e49942011-04-11 20:45:32 +00004260- CONFIG_IDE_AHB:
4261 Most IDE controllers were designed to be connected with PCI
4262 interface. Only few of them were designed for AHB interface.
4263 When software is doing ATA command and data transfer to
4264 IDE devices through IDE-AHB controller, some additional
4265 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004266 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004267
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004268- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004269 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004270 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004271
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004272- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004273
wdenkeb20ad32003-09-05 23:19:14 +00004274 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004275 initial data and stack; please note that this must be
4276 writable memory that is working WITHOUT special
4277 initialization, i. e. you CANNOT use normal RAM which
4278 will become available only after programming the
4279 memory controller and running certain initialization
4280 sequences.
4281
4282 U-Boot uses the following memory types:
4283 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4284 - MPC824X: data cache
4285 - PPC4xx: data cache
4286
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004287- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004288
4289 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004290 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4291 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004292 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004293 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004294 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004295 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4296 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004297
4298 Note:
4299 On the MPC824X (or other systems that use the data
4300 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004301 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004302 point to an otherwise UNUSED address space between
4303 the top of RAM and the start of the PCI space.
4304
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004305- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004306
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004307- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004308
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004309- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004310
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004311- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004312
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004313- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004314
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004315- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004316
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004317- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004318 SDRAM timing
4319
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004320- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004321 periodic timer for refresh
4322
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004323- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004324
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004325- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4326 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4327 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4328 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004329 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4330
4331- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004332 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4333 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004334 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4335
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004336- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4337 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004338 Machine Mode Register and Memory Periodic Timer
4339 Prescaler definitions (SDRAM timing)
4340
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004341- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004342 enable I2C microcode relocation patch (MPC8xx);
4343 define relocation offset in DPRAM [DSP2]
4344
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004345- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004346 enable SMC microcode relocation patch (MPC8xx);
4347 define relocation offset in DPRAM [SMC1]
4348
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004349- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004350 enable SPI microcode relocation patch (MPC8xx);
4351 define relocation offset in DPRAM [SCC4]
4352
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004353- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004354 Offset of the bootmode word in DPRAM used by post
4355 (Power On Self Tests). This definition overrides
4356 #define'd default value in commproc.h resp.
4357 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004358
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004359- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4360 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4361 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4362 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4363 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4364 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4365 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4366 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004367 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004368
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004369- CONFIG_PCI_DISABLE_PCIE:
4370 Disable PCI-Express on systems where it is supported but not
4371 required.
4372
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004373- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004374 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004375 Don't do any setup work, presumably because someone or
4376 something has already done it, and we don't need to do it
4377 a second time. Useful for platforms that are pre-booted
4378 by coreboot or similar.
4379
Gabor Juhosb4458732013-05-30 07:06:12 +00004380- CONFIG_PCI_INDIRECT_BRIDGE:
4381 Enable support for indirect PCI bridges.
4382
Kumar Gala8975d7a2010-12-30 12:09:53 -06004383- CONFIG_SYS_SRIO:
4384 Chip has SRIO or not
4385
4386- CONFIG_SRIO1:
4387 Board has SRIO 1 port available
4388
4389- CONFIG_SRIO2:
4390 Board has SRIO 2 port available
4391
Liu Gang27afb9c2013-05-07 16:30:46 +08004392- CONFIG_SRIO_PCIE_BOOT_MASTER
4393 Board can support master function for Boot from SRIO and PCIE
4394
Kumar Gala8975d7a2010-12-30 12:09:53 -06004395- CONFIG_SYS_SRIOn_MEM_VIRT:
4396 Virtual Address of SRIO port 'n' memory region
4397
4398- CONFIG_SYS_SRIOn_MEM_PHYS:
4399 Physical Address of SRIO port 'n' memory region
4400
4401- CONFIG_SYS_SRIOn_MEM_SIZE:
4402 Size of SRIO port 'n' memory region
4403
Fabio Estevamf17e8782013-04-11 09:35:34 +00004404- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4405 Defined to tell the NAND controller that the NAND chip is using
4406 a 16 bit bus.
4407 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004408 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004409 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004410 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004411
4412- CONFIG_SYS_NDFC_EBC0_CFG
4413 Sets the EBC0_CFG register for the NDFC. If not defined
4414 a default value will be used.
4415
Ben Warren45657152006-09-07 16:50:54 -04004416- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004417 Get DDR timing information from an I2C EEPROM. Common
4418 with pluggable memory modules such as SODIMMs
4419
Ben Warren45657152006-09-07 16:50:54 -04004420 SPD_EEPROM_ADDRESS
4421 I2C address of the SPD EEPROM
4422
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004423- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004424 If SPD EEPROM is on an I2C bus other than the first
4425 one, specify here. Note that the value must resolve
4426 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004427
York Sune73cc042011-06-07 09:42:16 +08004428- CONFIG_SYS_DDR_RAW_TIMING
4429 Get DDR timing information from other than SPD. Common with
4430 soldered DDR chips onboard without SPD. DDR raw timing
4431 parameters are extracted from datasheet and hard-coded into
4432 header files or board specific files.
4433
York Sunbd495cf2011-09-16 13:21:35 -07004434- CONFIG_FSL_DDR_INTERACTIVE
4435 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4436
York Sun8ced0502015-01-06 13:18:55 -08004437- CONFIG_FSL_DDR_SYNC_REFRESH
4438 Enable sync of refresh for multiple controllers.
4439
York Sunb6a35f82015-03-19 09:30:28 -07004440- CONFIG_FSL_DDR_BIST
4441 Enable built-in memory test for Freescale DDR controllers.
4442
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004443- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004444 Only for 83xx systems. If specified, then DDR should
4445 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004446
wdenk6203e402004-04-18 10:13:26 +00004447- CONFIG_ETHER_ON_FEC[12]
4448 Define to enable FEC[12] on a 8xx series processor.
4449
4450- CONFIG_FEC[12]_PHY
4451 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004452 to the given FEC; i. e.
4453 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004454 means that the PHY with address 4 is connected to FEC1
4455
4456 When set to -1, means to probe for first available.
4457
4458- CONFIG_FEC[12]_PHY_NORXERR
4459 The PHY does not have a RXERR line (RMII only).
4460 (so program the FEC to ignore it).
4461
4462- CONFIG_RMII
4463 Enable RMII mode for all FECs.
4464 Note that this is a global option, we can't
4465 have one FEC in standard MII mode and another in RMII mode.
4466
wdenk20c98a62004-04-23 20:32:05 +00004467- CONFIG_CRC32_VERIFY
4468 Add a verify option to the crc32 command.
4469 The syntax is:
4470
4471 => crc32 -v <address> <count> <crc32>
4472
4473 Where address/count indicate a memory area
4474 and crc32 is the correct crc32 which the
4475 area should have.
4476
wdenk64519362004-07-11 17:40:54 +00004477- CONFIG_LOOPW
4478 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004479 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004480
stroesecc3af832004-12-16 18:46:55 +00004481- CONFIG_MX_CYCLIC
4482 Add the "mdc" and "mwc" memory commands. These are cyclic
4483 "md/mw" commands.
4484 Examples:
4485
wdenk07d7e6b2004-12-16 21:44:03 +00004486 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004487 This command will print 4 bytes (10,11,12,13) each 500 ms.
4488
wdenk07d7e6b2004-12-16 21:44:03 +00004489 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004490 This command will write 12345678 to address 100 all 10 ms.
4491
wdenk07d7e6b2004-12-16 21:44:03 +00004492 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004493 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004494
wdenk3d3d99f2005-04-04 12:44:11 +00004495- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004496 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004497 low level initializations (like setting up the memory
4498 controller) are omitted and/or U-Boot does not
4499 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004500
Wolfgang Denk302141d2010-11-27 23:30:56 +01004501 Normally this variable MUST NOT be defined. The only
4502 exception is when U-Boot is loaded (to RAM) by some
4503 other boot loader or by a debugger which performs
4504 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004505
Simon Glass90844072016-05-05 07:28:06 -06004506- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4507 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004508 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004509 instruction cache) is still performed.
4510
Aneesh V552a3192011-07-13 05:11:07 +00004511- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004512 Modifies the behaviour of start.S when compiling a loader
4513 that is executed before the actual U-Boot. E.g. when
4514 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004515
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004516- CONFIG_TPL_BUILD
4517 Modifies the behaviour of start.S when compiling a loader
4518 that is executed after the SPL and before the actual U-Boot.
4519 It is loaded by the SPL.
4520
Ying Zhang0d4f5442013-05-20 14:07:23 +08004521- CONFIG_SYS_MPC85XX_NO_RESETVEC
4522 Only for 85xx systems. If this variable is specified, the section
4523 .resetvec is not kept and the section .bootpg is placed in the
4524 previous 4k of the .text section.
4525
Simon Glass17dabf02013-02-24 17:33:14 +00004526- CONFIG_ARCH_MAP_SYSMEM
4527 Generally U-Boot (and in particular the md command) uses
4528 effective address. It is therefore not necessary to regard
4529 U-Boot address as virtual addresses that need to be translated
4530 to physical addresses. However, sandbox requires this, since
4531 it maintains its own little RAM buffer which contains all
4532 addressable memory. This option causes some memory accesses
4533 to be mapped through map_sysmem() / unmap_sysmem().
4534
Simon Glassbfb59802013-02-14 04:18:54 +00004535- CONFIG_X86_RESET_VECTOR
4536 If defined, the x86 reset vector code is included. This is not
4537 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004538
Mark Jackson52b003c2013-03-04 01:27:20 +00004539- CONFIG_SYS_MPUCLK
4540 Defines the MPU clock speed (in MHz).
4541
4542 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004543
Heiko Schocher2233e462013-11-04 14:05:00 +01004544- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4545 Enables the RTC32K OSC on AM33xx based plattforms
4546
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004547- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4548 Option to disable subpage write in NAND driver
4549 driver that uses this:
4550 drivers/mtd/nand/davinci_nand.c
4551
Timur Tabi275f4bb2011-11-22 09:21:25 -06004552Freescale QE/FMAN Firmware Support:
4553-----------------------------------
4554
4555The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4556loading of "firmware", which is encoded in the QE firmware binary format.
4557This firmware often needs to be loaded during U-Boot booting, so macros
4558are used to identify the storage device (NOR flash, SPI, etc) and the address
4559within that device.
4560
Zhao Qiang83a90842014-03-21 16:21:44 +08004561- CONFIG_SYS_FMAN_FW_ADDR
4562 The address in the storage device where the FMAN microcode is located. The
4563 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4564 is also specified.
4565
4566- CONFIG_SYS_QE_FW_ADDR
4567 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004568 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4569 is also specified.
4570
4571- CONFIG_SYS_QE_FMAN_FW_LENGTH
4572 The maximum possible size of the firmware. The firmware binary format
4573 has a field that specifies the actual size of the firmware, but it
4574 might not be possible to read any part of the firmware unless some
4575 local storage is allocated to hold the entire firmware first.
4576
4577- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4578 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4579 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4580 virtual address in NOR flash.
4581
4582- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4583 Specifies that QE/FMAN firmware is located in NAND flash.
4584 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4585
4586- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4587 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4588 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4589
Liu Gang1e084582012-03-08 00:33:18 +00004590- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4591 Specifies that QE/FMAN firmware is located in the remote (master)
4592 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004593 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4594 window->master inbound window->master LAW->the ucode address in
4595 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004596
J. German Rivera8ff14b72014-06-23 15:15:55 -07004597Freescale Layerscape Management Complex Firmware Support:
4598---------------------------------------------------------
4599The Freescale Layerscape Management Complex (MC) supports the loading of
4600"firmware".
4601This firmware often needs to be loaded during U-Boot booting, so macros
4602are used to identify the storage device (NOR flash, SPI, etc) and the address
4603within that device.
4604
4605- CONFIG_FSL_MC_ENET
4606 Enable the MC driver for Layerscape SoCs.
4607
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304608Freescale Layerscape Debug Server Support:
4609-------------------------------------------
4610The Freescale Layerscape Debug Server Support supports the loading of
4611"Debug Server firmware" and triggering SP boot-rom.
4612This firmware often needs to be loaded during U-Boot booting.
4613
York Sun928b6812015-12-07 11:08:58 -08004614- CONFIG_SYS_MC_RSV_MEM_ALIGN
4615 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304616
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004617Reproducible builds
4618-------------------
4619
4620In order to achieve reproducible builds, timestamps used in the U-Boot build
4621process have to be set to a fixed value.
4622
4623This is done using the SOURCE_DATE_EPOCH environment variable.
4624SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4625option for U-Boot or an environment variable in U-Boot.
4626
4627SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4628
wdenkc6097192002-11-03 00:24:07 +00004629Building the Software:
4630======================
4631
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004632Building U-Boot has been tested in several native build environments
4633and in many different cross environments. Of course we cannot support
4634all possibly existing versions of cross development tools in all
4635(potentially obsolete) versions. In case of tool chain problems we
4636recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4637which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004638
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004639If you are not using a native environment, it is assumed that you
4640have GNU cross compiling tools available in your path. In this case,
4641you must set the environment variable CROSS_COMPILE in your shell.
4642Note that no changes to the Makefile or any other source files are
4643necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004644
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004645 $ CROSS_COMPILE=ppc_4xx-
4646 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004647
Peter Tyserb06976d2009-03-13 18:54:51 -05004648Note: If you wish to generate Windows versions of the utilities in
4649 the tools directory you can use the MinGW toolchain
4650 (http://www.mingw.org). Set your HOST tools to the MinGW
4651 toolchain and execute 'make tools'. For example:
4652
4653 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4654
4655 Binaries such as tools/mkimage.exe will be created which can
4656 be executed on computers running Windows.
4657
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004658U-Boot is intended to be simple to build. After installing the
4659sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004660is done by typing:
4661
Holger Freyther7ba4e572014-08-04 09:26:05 +02004662 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004663
Holger Freyther7ba4e572014-08-04 09:26:05 +02004664where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004665rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004666
wdenk6c59edc2004-05-03 20:45:30 +00004667Note: for some board special configuration names may exist; check if
4668 additional information is available from the board vendor; for
4669 instance, the TQM823L systems are available without (standard)
4670 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004671 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004672
Holger Freyther7ba4e572014-08-04 09:26:05 +02004673 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004674 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004675
Holger Freyther7ba4e572014-08-04 09:26:05 +02004676 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004677 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004678
wdenk6c59edc2004-05-03 20:45:30 +00004679 etc.
wdenkc6097192002-11-03 00:24:07 +00004680
wdenkc6097192002-11-03 00:24:07 +00004681
wdenk6c59edc2004-05-03 20:45:30 +00004682Finally, type "make all", and you should get some working U-Boot
4683images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004684
wdenk6c59edc2004-05-03 20:45:30 +00004685- "u-boot.bin" is a raw binary image
4686- "u-boot" is an image in ELF binary format
4687- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004688
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004689By default the build is performed locally and the objects are saved
4690in the source directory. One of the two methods can be used to change
4691this behavior and build U-Boot to some external directory:
4692
46931. Add O= to the make command line invocations:
4694
4695 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004696 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004697 make O=/tmp/build all
4698
Timo Ketolac8c67602014-11-06 14:39:05 +020046992. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004700
Timo Ketolac8c67602014-11-06 14:39:05 +02004701 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004702 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004703 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004704 make all
4705
Timo Ketolac8c67602014-11-06 14:39:05 +02004706Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004707variable.
4708
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk6c59edc2004-05-03 20:45:30 +00004710Please be aware that the Makefiles assume you are using GNU make, so
4711for instance on NetBSD you might need to use "gmake" instead of
4712native "make".
wdenkc6097192002-11-03 00:24:07 +00004713
wdenkc6097192002-11-03 00:24:07 +00004714
wdenk6c59edc2004-05-03 20:45:30 +00004715If the system board that you have is not listed, then you will need
4716to port U-Boot to your hardware platform. To do this, follow these
4717steps:
wdenkc6097192002-11-03 00:24:07 +00004718
Phil Sutterc77b4882015-12-25 14:41:18 +010047191. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004720 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004721 the "Makefile" and a "<board>.c".
47222. Create a new configuration file "include/configs/<board>.h" for
4723 your board.
wdenk6c59edc2004-05-03 20:45:30 +000047243. If you're porting U-Boot to a new CPU, then also create a new
4725 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020047264. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000047275. Type "make", and you should get a working "u-boot.srec" file
4728 to be installed on your target system.
47296. Debug and solve any problems that might arise.
4730 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004731
wdenkc6097192002-11-03 00:24:07 +00004732
wdenk6c59edc2004-05-03 20:45:30 +00004733Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4734==============================================================
wdenkc6097192002-11-03 00:24:07 +00004735
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004736If you have modified U-Boot sources (for instance added a new board
4737or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004738provide feedback to the other developers. The feedback normally takes
4739the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004740official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004741
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004742But before you submit such a patch, please verify that your modifi-
4743cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004744the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004745just run the buildman script (tools/buildman/buildman), which will
4746configure and build U-Boot for ALL supported system. Be warned, this
4747will take a while. Please see the buildman README, or run 'buildman -H'
4748for documentation.
wdenkc6097192002-11-03 00:24:07 +00004749
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004750
wdenk6c59edc2004-05-03 20:45:30 +00004751See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004752
wdenkc6097192002-11-03 00:24:07 +00004753
wdenk6c59edc2004-05-03 20:45:30 +00004754Monitor Commands - Overview:
4755============================
wdenkc6097192002-11-03 00:24:07 +00004756
wdenk6c59edc2004-05-03 20:45:30 +00004757go - start application at address 'addr'
4758run - run commands in an environment variable
4759bootm - boot application image from memory
4760bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004761bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004762tftpboot- boot image via network using TFTP protocol
4763 and env variables "ipaddr" and "serverip"
4764 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004765tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004766rarpboot- boot image via network using RARP/TFTP protocol
4767diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4768loads - load S-Record file over serial line
4769loadb - load binary file over serial line (kermit mode)
4770md - memory display
4771mm - memory modify (auto-incrementing)
4772nm - memory modify (constant address)
4773mw - memory write (fill)
4774cp - memory copy
4775cmp - memory compare
4776crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004777i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004778sspi - SPI utility commands
4779base - print or set address offset
4780printenv- print environment variables
4781setenv - set environment variables
4782saveenv - save environment variables to persistent storage
4783protect - enable or disable FLASH write protection
4784erase - erase FLASH memory
4785flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004786nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004787bdinfo - print Board Info structure
4788iminfo - print header information for application image
4789coninfo - print console devices and informations
4790ide - IDE sub-system
4791loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004792loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004793mtest - simple RAM test
4794icache - enable or disable instruction cache
4795dcache - enable or disable data cache
4796reset - Perform RESET of the CPU
4797echo - echo args to console
4798version - print monitor version
4799help - print online help
4800? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004801
wdenkc6097192002-11-03 00:24:07 +00004802
wdenk6c59edc2004-05-03 20:45:30 +00004803Monitor Commands - Detailed Description:
4804========================================
wdenkc6097192002-11-03 00:24:07 +00004805
wdenk6c59edc2004-05-03 20:45:30 +00004806TODO.
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk6c59edc2004-05-03 20:45:30 +00004808For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004809
4810
wdenk6c59edc2004-05-03 20:45:30 +00004811Environment Variables:
4812======================
wdenkc6097192002-11-03 00:24:07 +00004813
wdenk6c59edc2004-05-03 20:45:30 +00004814U-Boot supports user configuration using Environment Variables which
4815can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004816
wdenk6c59edc2004-05-03 20:45:30 +00004817Environment Variables are set using "setenv", printed using
4818"printenv", and saved to Flash using "saveenv". Using "setenv"
4819without a value can be used to delete a variable from the
4820environment. As long as you don't save the environment you are
4821working with an in-memory copy. In case the Flash area containing the
4822environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004823
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004824Some configuration options can be set using Environment Variables.
4825
4826List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004827
wdenk6c59edc2004-05-03 20:45:30 +00004828 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004829
wdenk6c59edc2004-05-03 20:45:30 +00004830 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004831
wdenk6c59edc2004-05-03 20:45:30 +00004832 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004833
wdenk6c59edc2004-05-03 20:45:30 +00004834 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004835
wdenk6c59edc2004-05-03 20:45:30 +00004836 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004837
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004838 bootm_low - Memory range available for image processing in the bootm
4839 command can be restricted. This variable is given as
4840 a hexadecimal number and defines lowest address allowed
4841 for use by the bootm command. See also "bootm_size"
4842 environment variable. Address defined by "bootm_low" is
4843 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004844 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4845 bootm_mapsize.
4846
Wolfgang Denk092ae952011-10-26 10:21:21 +00004847 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004848 This variable is given as a hexadecimal number and it
4849 defines the size of the memory region starting at base
4850 address bootm_low that is accessible by the Linux kernel
4851 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4852 as the default value if it is defined, and bootm_size is
4853 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004854
4855 bootm_size - Memory range available for image processing in the bootm
4856 command can be restricted. This variable is given as
4857 a hexadecimal number and defines the size of the region
4858 allowed for use by the bootm command. See also "bootm_low"
4859 environment variable.
4860
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004861 updatefile - Location of the software update file on a TFTP server, used
4862 by the automatic software update feature. Please refer to
4863 documentation in doc/README.update for more details.
4864
wdenk6c59edc2004-05-03 20:45:30 +00004865 autoload - if set to "no" (any string beginning with 'n'),
4866 "bootp" will just load perform a lookup of the
4867 configuration from the BOOTP server, but not try to
4868 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004869
wdenk6c59edc2004-05-03 20:45:30 +00004870 autostart - if set to "yes", an image loaded using the "bootp",
4871 "rarpboot", "tftpboot" or "diskboot" commands will
4872 be automatically started (by internally calling
4873 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004874
wdenk6c59edc2004-05-03 20:45:30 +00004875 If set to "no", a standalone image passed to the
4876 "bootm" command will be copied to the load address
4877 (and eventually uncompressed), but NOT be started.
4878 This can be used to load and uncompress arbitrary
4879 data.
wdenkc6097192002-11-03 00:24:07 +00004880
David A. Longd558a4e2011-07-09 16:40:19 -04004881 fdt_high - if set this restricts the maximum address that the
4882 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004883 For example, if you have a system with 1 GB memory
4884 at physical address 0x10000000, while Linux kernel
4885 only recognizes the first 704 MB as low memory, you
4886 may need to set fdt_high as 0x3C000000 to have the
4887 device tree blob be copied to the maximum address
4888 of the 704 MB low memory, so that Linux kernel can
4889 access it during the boot procedure.
4890
David A. Longd558a4e2011-07-09 16:40:19 -04004891 If this is set to the special value 0xFFFFFFFF then
4892 the fdt will not be copied at all on boot. For this
4893 to work it must reside in writable memory, have
4894 sufficient padding on the end of it for u-boot to
4895 add the information it needs into it, and the memory
4896 must be accessible by the kernel.
4897
Simon Glassdc6fa642011-10-24 19:15:34 +00004898 fdtcontroladdr- if set this is the address of the control flattened
4899 device tree used by U-Boot when CONFIG_OF_CONTROL is
4900 defined.
4901
wdenk0e2bd9c2004-06-06 21:51:03 +00004902 i2cfast - (PPC405GP|PPC405EP only)
4903 if set to 'y' configures Linux I2C driver for fast
4904 mode (400kHZ). This environment variable is used in
4905 initialization code. So, for changes to be effective
4906 it must be saved and board must be reset.
4907
wdenk6c59edc2004-05-03 20:45:30 +00004908 initrd_high - restrict positioning of initrd images:
4909 If this variable is not set, initrd images will be
4910 copied to the highest possible address in RAM; this
4911 is usually what you want since it allows for
4912 maximum initrd size. If for some reason you want to
4913 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004914 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004915 variable to a value of "no" or "off" or "0".
4916 Alternatively, you can set it to a maximum upper
4917 address to use (U-Boot will still check that it
4918 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004919
wdenk6c59edc2004-05-03 20:45:30 +00004920 For instance, when you have a system with 16 MB
4921 RAM, and want to reserve 4 MB from use by Linux,
4922 you can do this by adding "mem=12M" to the value of
4923 the "bootargs" variable. However, now you must make
4924 sure that the initrd image is placed in the first
4925 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk6c59edc2004-05-03 20:45:30 +00004927 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004928
wdenk6c59edc2004-05-03 20:45:30 +00004929 If you set initrd_high to 0xFFFFFFFF, this is an
4930 indication to U-Boot that all addresses are legal
4931 for the Linux kernel, including addresses in flash
4932 memory. In this case U-Boot will NOT COPY the
4933 ramdisk at all. This may be useful to reduce the
4934 boot time on your system, but requires that this
4935 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004936
wdenk6c59edc2004-05-03 20:45:30 +00004937 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004938
wdenk6c59edc2004-05-03 20:45:30 +00004939 loadaddr - Default load address for commands like "bootp",
4940 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004941
wdenk6c59edc2004-05-03 20:45:30 +00004942 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004943
wdenk6c59edc2004-05-03 20:45:30 +00004944 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004945
wdenk6c59edc2004-05-03 20:45:30 +00004946 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004947
wdenk6c59edc2004-05-03 20:45:30 +00004948 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004949
wdenk6c59edc2004-05-03 20:45:30 +00004950 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004951
Mike Frysingera23230c2011-10-02 10:01:27 +00004952 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004953
Mike Frysingera23230c2011-10-02 10:01:27 +00004954 ethact - controls which interface is currently active.
4955 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004956
Heiko Schocherc5e84052010-07-20 17:45:02 +02004957 => setenv ethact FEC
4958 => ping 192.168.0.1 # traffic sent on FEC
4959 => setenv ethact SCC
4960 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004961
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004962 ethrotate - When set to "no" U-Boot does not go through all
4963 available network interfaces.
4964 It just stays at the currently selected interface.
4965
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004966 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004967 either succeed or fail without retrying.
4968 When set to "once" the network operation will
4969 fail when all the available network interfaces
4970 are tried once without success.
4971 Useful on scripts which control the retry operation
4972 themselves.
wdenkc6097192002-11-03 00:24:07 +00004973
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004974 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004975
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004976 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004977 changing the console to be empty. If "yes" it will be
4978 made silent. If "no" it will not be made silent. If
4979 unset, then it will be made silent if the U-Boot console
4980 is silent.
4981
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004982 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004983 UDP source port.
4984
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004985 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004986 destination port instead of the Well Know Port 69.
4987
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004988 tftpblocksize - Block size to use for TFTP transfers; if not set,
4989 we use the TFTP server's default block size
4990
4991 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4992 seconds, minimum value is 1000 = 1 second). Defines
4993 when a packet is considered to be lost so it has to
4994 be retransmitted. The default is 5000 = 5 seconds.
4995 Lowering this value may make downloads succeed
4996 faster in networks with high packet loss rates or
4997 with unreliable TFTP servers.
4998
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004999 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5000 unit, minimum value = 0). Defines how many timeouts
5001 can happen during a single file transfer before that
5002 transfer is aborted. The default is 10, and 0 means
5003 'no timeouts allowed'. Increasing this value may help
5004 downloads succeed with high packet loss rates, or with
5005 unreliable TFTP servers or client hardware.
5006
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005007 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005008 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005009 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005010
Alexandre Messier15971322016-02-01 17:08:57 -05005011 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5012 Unsigned value, in milliseconds. If not set, the period will
5013 be either the default (28000), or a value based on
5014 CONFIG_NET_RETRY_COUNT, if defined. This value has
5015 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5016
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005017The following image location variables contain the location of images
5018used in booting. The "Image" column gives the role of the image and is
5019not an environment variable name. The other columns are environment
5020variable names. "File Name" gives the name of the file on a TFTP
5021server, "RAM Address" gives the location in RAM the image will be
5022loaded to, and "Flash Location" gives the image's address in NOR
5023flash or offset in NAND flash.
5024
5025*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005026boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005027boards use these variables for other purposes.
5028
Wolfgang Denk092ae952011-10-26 10:21:21 +00005029Image File Name RAM Address Flash Location
5030----- --------- ----------- --------------
5031u-boot u-boot u-boot_addr_r u-boot_addr
5032Linux kernel bootfile kernel_addr_r kernel_addr
5033device tree blob fdtfile fdt_addr_r fdt_addr
5034ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005035
wdenk6c59edc2004-05-03 20:45:30 +00005036The following environment variables may be used and automatically
5037updated by the network boot commands ("bootp" and "rarpboot"),
5038depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005039
wdenk6c59edc2004-05-03 20:45:30 +00005040 bootfile - see above
5041 dnsip - IP address of your Domain Name Server
5042 dnsip2 - IP address of your secondary Domain Name Server
5043 gatewayip - IP address of the Gateway (Router) to use
5044 hostname - Target hostname
5045 ipaddr - see above
5046 netmask - Subnet Mask
5047 rootpath - Pathname of the root filesystem on the NFS server
5048 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005049
wdenk145d2c12004-04-15 21:48:45 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005052
wdenk6c59edc2004-05-03 20:45:30 +00005053 serial# - contains hardware identification information such
5054 as type string and/or serial number
5055 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005056
wdenk6c59edc2004-05-03 20:45:30 +00005057These variables can be set only once (usually during manufacturing of
5058the board). U-Boot refuses to delete or overwrite these variables
5059once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005060
5061
wdenk6c59edc2004-05-03 20:45:30 +00005062Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005063
wdenk6c59edc2004-05-03 20:45:30 +00005064 ver - Contains the U-Boot version string as printed
5065 with the "version" command. This variable is
5066 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005067
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069Please note that changes to some configuration parameters may take
5070only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005071
stroeseb9c17c52003-04-04 15:53:41 +00005072
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005073Callback functions for environment variables:
5074---------------------------------------------
5075
5076For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005077when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005078be associated with arbitrary variables. On creation, overwrite, or
5079deletion, the callback will provide the opportunity for some side
5080effect to happen or for the change to be rejected.
5081
5082The callbacks are named and associated with a function using the
5083U_BOOT_ENV_CALLBACK macro in your board or driver code.
5084
5085These callbacks are associated with variables in one of two ways. The
5086static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5087in the board configuration to a string that defines a list of
5088associations. The list must be in the following format:
5089
5090 entry = variable_name[:callback_name]
5091 list = entry[,list]
5092
5093If the callback name is not specified, then the callback is deleted.
5094Spaces are also allowed anywhere in the list.
5095
5096Callbacks can also be associated by defining the ".callbacks" variable
5097with the same list format above. Any association in ".callbacks" will
5098override any association in the static list. You can define
5099CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005100".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005101
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005102If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5103regular expression. This allows multiple variables to be connected to
5104the same callback without explicitly listing them all out.
5105
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005106
wdenk6c59edc2004-05-03 20:45:30 +00005107Command Line Parsing:
5108=====================
stroeseb9c17c52003-04-04 15:53:41 +00005109
wdenk6c59edc2004-05-03 20:45:30 +00005110There are two different command line parsers available with U-Boot:
5111the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk6c59edc2004-05-03 20:45:30 +00005113Old, simple command line parser:
5114--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005115
wdenk6c59edc2004-05-03 20:45:30 +00005116- supports environment variables (through setenv / saveenv commands)
5117- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005118- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005119- special characters ('$', ';') can be escaped by prefixing with '\',
5120 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005121 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005122- You can also escape text by enclosing in single apostrophes, for example:
5123 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk6c59edc2004-05-03 20:45:30 +00005125Hush shell:
5126-----------
wdenkf4688a22003-05-28 08:06:31 +00005127
wdenk6c59edc2004-05-03 20:45:30 +00005128- similar to Bourne shell, with control structures like
5129 if...then...else...fi, for...do...done; while...do...done,
5130 until...do...done, ...
5131- supports environment ("global") variables (through setenv / saveenv
5132 commands) and local shell variables (through standard shell syntax
5133 "name=value"); only environment variables can be used with "run"
5134 command
wdenkf4688a22003-05-28 08:06:31 +00005135
wdenk6c59edc2004-05-03 20:45:30 +00005136General rules:
5137--------------
wdenkf4688a22003-05-28 08:06:31 +00005138
wdenk6c59edc2004-05-03 20:45:30 +00005139(1) If a command line (or an environment variable executed by a "run"
5140 command) contains several commands separated by semicolon, and
5141 one of these commands fails, then the remaining commands will be
5142 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005143
wdenk6c59edc2004-05-03 20:45:30 +00005144(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005145 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005146 command will cause "run" to terminate, i. e. the remaining
5147 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005148
wdenk6c59edc2004-05-03 20:45:30 +00005149Note for Redundant Ethernet Interfaces:
5150=======================================
wdenkf4688a22003-05-28 08:06:31 +00005151
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005152Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005153such configurations and is capable of automatic selection of a
5154"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005155
wdenk6c59edc2004-05-03 20:45:30 +00005156Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5157MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5158"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005159
wdenk6c59edc2004-05-03 20:45:30 +00005160If the network interface stores some valid MAC address (for instance
5161in SROM), this is used as default address if there is NO correspon-
5162ding setting in the environment; if the corresponding environment
5163variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165o If the SROM has a valid MAC address, and there is no address in the
5166 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005167
wdenk6c59edc2004-05-03 20:45:30 +00005168o If there is no valid address in the SROM, and a definition in the
5169 environment exists, then the value from the environment variable is
5170 used.
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk6c59edc2004-05-03 20:45:30 +00005172o If both the SROM and the environment contain a MAC address, and
5173 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk6c59edc2004-05-03 20:45:30 +00005175o If both the SROM and the environment contain a MAC address, and the
5176 addresses differ, the value from the environment is used and a
5177 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005178
wdenk6c59edc2004-05-03 20:45:30 +00005179o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005180 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5181 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005182
Ben Warren6db991a2010-04-26 11:11:46 -07005183If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005184will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005185may be skipped by setting the appropriate 'ethmacskip' environment variable.
5186The naming convention is as follows:
5187"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk6c59edc2004-05-03 20:45:30 +00005189Image Formats:
5190==============
wdenkc6097192002-11-03 00:24:07 +00005191
Marian Balakowicz18710b82008-03-12 12:13:13 +01005192U-Boot is capable of booting (and performing other auxiliary operations on)
5193images in two formats:
5194
5195New uImage format (FIT)
5196-----------------------
5197
5198Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5199to Flattened Device Tree). It allows the use of images with multiple
5200components (several kernels, ramdisks, etc.), with contents protected by
5201SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5202
5203
5204Old uImage format
5205-----------------
5206
5207Old image format is based on binary files which can be basically anything,
5208preceded by a special header; see the definitions in include/image.h for
5209details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005210
wdenk6c59edc2004-05-03 20:45:30 +00005211* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5212 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005213 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5214 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5215 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005216* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005217 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5218 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005219* Compression Type (uncompressed, gzip, bzip2)
5220* Load Address
5221* Entry Point
5222* Image Name
5223* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005224
wdenk6c59edc2004-05-03 20:45:30 +00005225The header is marked by a special Magic Number, and both the header
5226and the data portions of the image are secured against corruption by
5227CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005228
wdenkc6097192002-11-03 00:24:07 +00005229
wdenk6c59edc2004-05-03 20:45:30 +00005230Linux Support:
5231==============
wdenkc6097192002-11-03 00:24:07 +00005232
wdenk6c59edc2004-05-03 20:45:30 +00005233Although U-Boot should support any OS or standalone application
5234easily, the main focus has always been on Linux during the design of
5235U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005236
wdenk6c59edc2004-05-03 20:45:30 +00005237U-Boot includes many features that so far have been part of some
5238special "boot loader" code within the Linux kernel. Also, any
5239"initrd" images to be used are no longer part of one big Linux image;
5240instead, kernel and "initrd" are separate images. This implementation
5241serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005242
wdenk6c59edc2004-05-03 20:45:30 +00005243- the same features can be used for other OS or standalone
5244 applications (for instance: using compressed images to reduce the
5245 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005246
wdenk6c59edc2004-05-03 20:45:30 +00005247- it becomes much easier to port new Linux kernel versions because
5248 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005249
wdenk6c59edc2004-05-03 20:45:30 +00005250- the same Linux kernel image can now be used with different "initrd"
5251 images; of course this also means that different kernel images can
5252 be run with the same "initrd". This makes testing easier (you don't
5253 have to build a new "zImage.initrd" Linux image when you just
5254 change a file in your "initrd"). Also, a field-upgrade of the
5255 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005256
wdenkc6097192002-11-03 00:24:07 +00005257
wdenk6c59edc2004-05-03 20:45:30 +00005258Linux HOWTO:
5259============
wdenkc6097192002-11-03 00:24:07 +00005260
wdenk6c59edc2004-05-03 20:45:30 +00005261Porting Linux to U-Boot based systems:
5262---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005263
wdenk6c59edc2004-05-03 20:45:30 +00005264U-Boot cannot save you from doing all the necessary modifications to
5265configure the Linux device drivers for use with your target hardware
5266(no, we don't intend to provide a full virtual machine interface to
5267Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005268
Stefan Roese88fbf932010-04-15 16:07:28 +02005269But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005270
wdenk6c59edc2004-05-03 20:45:30 +00005271Just make sure your machine specific header file (for instance
5272include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005273Information structure as we define in include/asm-<arch>/u-boot.h,
5274and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005275as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005276
Simon Glassd097e592014-06-11 23:29:46 -06005277Note that U-Boot now has a driver model, a unified model for drivers.
5278If you are adding a new driver, plumb it into driver model. If there
5279is no uclass available, you are encouraged to create one. See
5280doc/driver-model.
5281
wdenkc6097192002-11-03 00:24:07 +00005282
wdenk6c59edc2004-05-03 20:45:30 +00005283Configuring the Linux kernel:
5284-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk6c59edc2004-05-03 20:45:30 +00005286No specific requirements for U-Boot. Make sure you have some root
5287device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005288
wdenkc6097192002-11-03 00:24:07 +00005289
wdenk6c59edc2004-05-03 20:45:30 +00005290Building a Linux Image:
5291-----------------------
wdenkc6097192002-11-03 00:24:07 +00005292
wdenk6c59edc2004-05-03 20:45:30 +00005293With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5294not used. If you use recent kernel source, a new build target
5295"uImage" will exist which automatically builds an image usable by
5296U-Boot. Most older kernels also have support for a "pImage" target,
5297which was introduced for our predecessor project PPCBoot and uses a
5298100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005299
wdenk6c59edc2004-05-03 20:45:30 +00005300Example:
wdenkc6097192002-11-03 00:24:07 +00005301
Holger Freyther7ba4e572014-08-04 09:26:05 +02005302 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005303 make oldconfig
5304 make dep
5305 make uImage
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk6c59edc2004-05-03 20:45:30 +00005307The "uImage" build target uses a special tool (in 'tools/mkimage') to
5308encapsulate a compressed Linux kernel image with header information,
5309CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005310
wdenk6c59edc2004-05-03 20:45:30 +00005311* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk6c59edc2004-05-03 20:45:30 +00005313* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005314
wdenk6c59edc2004-05-03 20:45:30 +00005315 ${CROSS_COMPILE}-objcopy -O binary \
5316 -R .note -R .comment \
5317 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005318
wdenk6c59edc2004-05-03 20:45:30 +00005319* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005320
wdenk6c59edc2004-05-03 20:45:30 +00005321 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005324
wdenk6c59edc2004-05-03 20:45:30 +00005325 mkimage -A ppc -O linux -T kernel -C gzip \
5326 -a 0 -e 0 -n "Linux Kernel Image" \
5327 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005328
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330The "mkimage" tool can also be used to create ramdisk images for use
5331with U-Boot, either separated from the Linux kernel image, or
5332combined into one file. "mkimage" encapsulates the images with a 64
5333byte header containing information about target architecture,
5334operating system, image type, compression method, entry points, time
5335stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005336
wdenk6c59edc2004-05-03 20:45:30 +00005337"mkimage" can be called in two ways: to verify existing images and
5338print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005339
wdenk6c59edc2004-05-03 20:45:30 +00005340In the first form (with "-l" option) mkimage lists the information
5341contained in the header of an existing U-Boot image; this includes
5342checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005343
wdenk6c59edc2004-05-03 20:45:30 +00005344 tools/mkimage -l image
5345 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005346
wdenk6c59edc2004-05-03 20:45:30 +00005347The second form (with "-d" option) is used to build a U-Boot image
5348from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005349
wdenk6c59edc2004-05-03 20:45:30 +00005350 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5351 -n name -d data_file image
5352 -A ==> set architecture to 'arch'
5353 -O ==> set operating system to 'os'
5354 -T ==> set image type to 'type'
5355 -C ==> set compression type 'comp'
5356 -a ==> set load address to 'addr' (hex)
5357 -e ==> set entry point to 'ep' (hex)
5358 -n ==> set image name to 'name'
5359 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005360
wdenkcd914452004-05-29 16:53:29 +00005361Right now, all Linux kernels for PowerPC systems use the same load
5362address (0x00000000), but the entry point address depends on the
5363kernel version:
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk6c59edc2004-05-03 20:45:30 +00005365- 2.2.x kernels have the entry point at 0x0000000C,
5366- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005367
wdenk6c59edc2004-05-03 20:45:30 +00005368So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005369
wdenk6c59edc2004-05-03 20:45:30 +00005370 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5371 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005372 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005373 > examples/uImage.TQM850L
5374 Image Name: 2.4.4 kernel for TQM850L
5375 Created: Wed Jul 19 02:34:59 2000
5376 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5377 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5378 Load Address: 0x00000000
5379 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005380
wdenk6c59edc2004-05-03 20:45:30 +00005381To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005382
wdenk6c59edc2004-05-03 20:45:30 +00005383 -> tools/mkimage -l examples/uImage.TQM850L
5384 Image Name: 2.4.4 kernel for TQM850L
5385 Created: Wed Jul 19 02:34:59 2000
5386 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5387 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5388 Load Address: 0x00000000
5389 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391NOTE: for embedded systems where boot time is critical you can trade
5392speed for memory and install an UNCOMPRESSED image instead: this
5393needs more space in Flash, but boots much faster since it does not
5394need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005395
Stefan Roese88fbf932010-04-15 16:07:28 +02005396 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005397 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5398 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005399 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005400 > examples/uImage.TQM850L-uncompressed
5401 Image Name: 2.4.4 kernel for TQM850L
5402 Created: Wed Jul 19 02:34:59 2000
5403 Image Type: PowerPC Linux Kernel Image (uncompressed)
5404 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5405 Load Address: 0x00000000
5406 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005407
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5410when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk6c59edc2004-05-03 20:45:30 +00005412 -> tools/mkimage -n 'Simple Ramdisk Image' \
5413 > -A ppc -O linux -T ramdisk -C gzip \
5414 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5415 Image Name: Simple Ramdisk Image
5416 Created: Wed Jan 12 14:01:50 2000
5417 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5418 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5419 Load Address: 0x00000000
5420 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005421
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005422The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5423option performs the converse operation of the mkimage's second form (the "-d"
5424option). Given an image built by mkimage, the dumpimage extracts a "data file"
5425from the image:
5426
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005427 tools/dumpimage -i image -T type -p position data_file
5428 -i ==> extract from the 'image' a specific 'data_file'
5429 -T ==> set image type to 'type'
5430 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005431
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk6c59edc2004-05-03 20:45:30 +00005433Installing a Linux Image:
5434-------------------------
wdenkc6097192002-11-03 00:24:07 +00005435
wdenk6c59edc2004-05-03 20:45:30 +00005436To downloading a U-Boot image over the serial (console) interface,
5437you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005438
wdenk6c59edc2004-05-03 20:45:30 +00005439 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005440
wdenk6c59edc2004-05-03 20:45:30 +00005441The 'objcopy' does not understand the information in the U-Boot
5442image header, so the resulting S-Record file will be relative to
5443address 0x00000000. To load it to a given address, you need to
5444specify the target address as 'offset' parameter with the 'loads'
5445command.
wdenkc6097192002-11-03 00:24:07 +00005446
wdenk6c59edc2004-05-03 20:45:30 +00005447Example: install the image to address 0x40100000 (which on the
5448TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005449
wdenk6c59edc2004-05-03 20:45:30 +00005450 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005451
wdenk6c59edc2004-05-03 20:45:30 +00005452 .......... done
5453 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005454
wdenk6c59edc2004-05-03 20:45:30 +00005455 => loads 40100000
5456 ## Ready for S-Record download ...
5457 ~>examples/image.srec
5458 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5459 ...
5460 15989 15990 15991 15992
5461 [file transfer complete]
5462 [connected]
5463 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005464
wdenkc6097192002-11-03 00:24:07 +00005465
wdenk6c59edc2004-05-03 20:45:30 +00005466You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005467this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005468corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005469
wdenk6c59edc2004-05-03 20:45:30 +00005470 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005471
wdenk6c59edc2004-05-03 20:45:30 +00005472 ## Checking Image at 40100000 ...
5473 Image Name: 2.2.13 for initrd on TQM850L
5474 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5475 Data Size: 335725 Bytes = 327 kB = 0 MB
5476 Load Address: 00000000
5477 Entry Point: 0000000c
5478 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005479
5480
wdenk6c59edc2004-05-03 20:45:30 +00005481Boot Linux:
5482-----------
wdenkc6097192002-11-03 00:24:07 +00005483
wdenk6c59edc2004-05-03 20:45:30 +00005484The "bootm" command is used to boot an application that is stored in
5485memory (RAM or Flash). In case of a Linux kernel image, the contents
5486of the "bootargs" environment variable is passed to the kernel as
5487parameters. You can check and modify this variable using the
5488"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005489
wdenkc6097192002-11-03 00:24:07 +00005490
wdenk6c59edc2004-05-03 20:45:30 +00005491 => printenv bootargs
5492 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005493
wdenk6c59edc2004-05-03 20:45:30 +00005494 => 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 +00005495
wdenk6c59edc2004-05-03 20:45:30 +00005496 => printenv bootargs
5497 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 +00005498
wdenk6c59edc2004-05-03 20:45:30 +00005499 => bootm 40020000
5500 ## Booting Linux kernel at 40020000 ...
5501 Image Name: 2.2.13 for NFS on TQM850L
5502 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5503 Data Size: 381681 Bytes = 372 kB = 0 MB
5504 Load Address: 00000000
5505 Entry Point: 0000000c
5506 Verifying Checksum ... OK
5507 Uncompressing Kernel Image ... OK
5508 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
5509 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5510 time_init: decrementer frequency = 187500000/60
5511 Calibrating delay loop... 49.77 BogoMIPS
5512 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5513 ...
wdenkc6097192002-11-03 00:24:07 +00005514
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005515If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005516the memory addresses of both the kernel and the initrd image (PPBCOOT
5517format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005518
wdenk6c59edc2004-05-03 20:45:30 +00005519 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005520
wdenk6c59edc2004-05-03 20:45:30 +00005521 ## Checking Image at 40100000 ...
5522 Image Name: 2.2.13 for initrd on TQM850L
5523 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5524 Data Size: 335725 Bytes = 327 kB = 0 MB
5525 Load Address: 00000000
5526 Entry Point: 0000000c
5527 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk6c59edc2004-05-03 20:45:30 +00005529 ## Checking Image at 40200000 ...
5530 Image Name: Simple Ramdisk Image
5531 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5532 Data Size: 566530 Bytes = 553 kB = 0 MB
5533 Load Address: 00000000
5534 Entry Point: 00000000
5535 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537 => bootm 40100000 40200000
5538 ## Booting Linux kernel at 40100000 ...
5539 Image Name: 2.2.13 for initrd on TQM850L
5540 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5541 Data Size: 335725 Bytes = 327 kB = 0 MB
5542 Load Address: 00000000
5543 Entry Point: 0000000c
5544 Verifying Checksum ... OK
5545 Uncompressing Kernel Image ... OK
5546 ## Loading RAMDisk Image at 40200000 ...
5547 Image Name: Simple Ramdisk Image
5548 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5549 Data Size: 566530 Bytes = 553 kB = 0 MB
5550 Load Address: 00000000
5551 Entry Point: 00000000
5552 Verifying Checksum ... OK
5553 Loading Ramdisk ... OK
5554 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
5555 Boot arguments: root=/dev/ram
5556 time_init: decrementer frequency = 187500000/60
5557 Calibrating delay loop... 49.77 BogoMIPS
5558 ...
5559 RAMDISK: Compressed image found at block 0
5560 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk6c59edc2004-05-03 20:45:30 +00005562 bash#
wdenkc6097192002-11-03 00:24:07 +00005563
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005564Boot Linux and pass a flat device tree:
5565-----------
5566
5567First, U-Boot must be compiled with the appropriate defines. See the section
5568titled "Linux Kernel Interface" above for a more in depth explanation. The
5569following is an example of how to start a kernel and pass an updated
5570flat device tree:
5571
5572=> print oftaddr
5573oftaddr=0x300000
5574=> print oft
5575oft=oftrees/mpc8540ads.dtb
5576=> tftp $oftaddr $oft
5577Speed: 1000, full duplex
5578Using TSEC0 device
5579TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5580Filename 'oftrees/mpc8540ads.dtb'.
5581Load address: 0x300000
5582Loading: #
5583done
5584Bytes transferred = 4106 (100a hex)
5585=> tftp $loadaddr $bootfile
5586Speed: 1000, full duplex
5587Using TSEC0 device
5588TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5589Filename 'uImage'.
5590Load address: 0x200000
5591Loading:############
5592done
5593Bytes transferred = 1029407 (fb51f hex)
5594=> print loadaddr
5595loadaddr=200000
5596=> print oftaddr
5597oftaddr=0x300000
5598=> bootm $loadaddr - $oftaddr
5599## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005600 Image Name: Linux-2.6.17-dirty
5601 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5602 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005603 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005604 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005605 Verifying Checksum ... OK
5606 Uncompressing Kernel Image ... OK
5607Booting using flat device tree at 0x300000
5608Using MPC85xx ADS machine description
5609Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5610[snip]
5611
5612
wdenk6c59edc2004-05-03 20:45:30 +00005613More About U-Boot Image Types:
5614------------------------------
wdenkc6097192002-11-03 00:24:07 +00005615
wdenk6c59edc2004-05-03 20:45:30 +00005616U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618 "Standalone Programs" are directly runnable in the environment
5619 provided by U-Boot; it is expected that (if they behave
5620 well) you can continue to work in U-Boot after return from
5621 the Standalone Program.
5622 "OS Kernel Images" are usually images of some Embedded OS which
5623 will take over control completely. Usually these programs
5624 will install their own set of exception handlers, device
5625 drivers, set up the MMU, etc. - this means, that you cannot
5626 expect to re-enter U-Boot except by resetting the CPU.
5627 "RAMDisk Images" are more or less just data blocks, and their
5628 parameters (address, size) are passed to an OS kernel that is
5629 being started.
5630 "Multi-File Images" contain several images, typically an OS
5631 (Linux) kernel image and one or more data images like
5632 RAMDisks. This construct is useful for instance when you want
5633 to boot over the network using BOOTP etc., where the boot
5634 server provides just a single image file, but you want to get
5635 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005636
wdenk6c59edc2004-05-03 20:45:30 +00005637 "Multi-File Images" start with a list of image sizes, each
5638 image size (in bytes) specified by an "uint32_t" in network
5639 byte order. This list is terminated by an "(uint32_t)0".
5640 Immediately after the terminating 0 follow the images, one by
5641 one, all aligned on "uint32_t" boundaries (size rounded up to
5642 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk6c59edc2004-05-03 20:45:30 +00005644 "Firmware Images" are binary images containing firmware (like
5645 U-Boot or FPGA images) which usually will be programmed to
5646 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005647
wdenk6c59edc2004-05-03 20:45:30 +00005648 "Script files" are command sequences that will be executed by
5649 U-Boot's command interpreter; this feature is especially
5650 useful when you configure U-Boot to use a real shell (hush)
5651 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005652
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005653Booting the Linux zImage:
5654-------------------------
5655
5656On some platforms, it's possible to boot Linux zImage. This is done
5657using the "bootz" command. The syntax of "bootz" command is the same
5658as the syntax of "bootm" command.
5659
Tom Rini45f46d12013-05-16 11:40:11 -04005660Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005661kernel with raw initrd images. The syntax is slightly different, the
5662address of the initrd must be augmented by it's size, in the following
5663format: "<initrd addres>:<initrd size>".
5664
stroeseb9c17c52003-04-04 15:53:41 +00005665
wdenk6c59edc2004-05-03 20:45:30 +00005666Standalone HOWTO:
5667=================
stroeseb9c17c52003-04-04 15:53:41 +00005668
wdenk6c59edc2004-05-03 20:45:30 +00005669One of the features of U-Boot is that you can dynamically load and
5670run "standalone" applications, which can use some resources of
5671U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005672
wdenk6c59edc2004-05-03 20:45:30 +00005673Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005674
wdenk6c59edc2004-05-03 20:45:30 +00005675"Hello World" Demo:
5676-------------------
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk6c59edc2004-05-03 20:45:30 +00005678'examples/hello_world.c' contains a small "Hello World" Demo
5679application; it is automatically compiled when you build U-Boot.
5680It's configured to run at address 0x00040004, so you can play with it
5681like that:
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk6c59edc2004-05-03 20:45:30 +00005683 => loads
5684 ## Ready for S-Record download ...
5685 ~>examples/hello_world.srec
5686 1 2 3 4 5 6 7 8 9 10 11 ...
5687 [file transfer complete]
5688 [connected]
5689 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005690
wdenk6c59edc2004-05-03 20:45:30 +00005691 => go 40004 Hello World! This is a test.
5692 ## Starting application at 0x00040004 ...
5693 Hello World
5694 argc = 7
5695 argv[0] = "40004"
5696 argv[1] = "Hello"
5697 argv[2] = "World!"
5698 argv[3] = "This"
5699 argv[4] = "is"
5700 argv[5] = "a"
5701 argv[6] = "test."
5702 argv[7] = "<NULL>"
5703 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk6c59edc2004-05-03 20:45:30 +00005705 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005706
wdenk6c59edc2004-05-03 20:45:30 +00005707Another example, which demonstrates how to register a CPM interrupt
5708handler with the U-Boot code, can be found in 'examples/timer.c'.
5709Here, a CPM timer is set up to generate an interrupt every second.
5710The interrupt service routine is trivial, just printing a '.'
5711character, but this is just a demo program. The application can be
5712controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005713
wdenk6c59edc2004-05-03 20:45:30 +00005714 ? - print current values og the CPM Timer registers
5715 b - enable interrupts and start timer
5716 e - stop timer and disable interrupts
5717 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005718
wdenk6c59edc2004-05-03 20:45:30 +00005719 => loads
5720 ## Ready for S-Record download ...
5721 ~>examples/timer.srec
5722 1 2 3 4 5 6 7 8 9 10 11 ...
5723 [file transfer complete]
5724 [connected]
5725 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727 => go 40004
5728 ## Starting application at 0x00040004 ...
5729 TIMERS=0xfff00980
5730 Using timer 1
5731 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk6c59edc2004-05-03 20:45:30 +00005733Hit 'b':
5734 [q, b, e, ?] Set interval 1000000 us
5735 Enabling timer
5736Hit '?':
5737 [q, b, e, ?] ........
5738 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5739Hit '?':
5740 [q, b, e, ?] .
5741 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5742Hit '?':
5743 [q, b, e, ?] .
5744 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5745Hit '?':
5746 [q, b, e, ?] .
5747 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5748Hit 'e':
5749 [q, b, e, ?] ...Stopping timer
5750Hit 'q':
5751 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005752
wdenkc6097192002-11-03 00:24:07 +00005753
wdenk6c59edc2004-05-03 20:45:30 +00005754Minicom warning:
5755================
wdenkc6097192002-11-03 00:24:07 +00005756
wdenk6c59edc2004-05-03 20:45:30 +00005757Over time, many people have reported problems when trying to use the
5758"minicom" terminal emulation program for serial download. I (wd)
5759consider minicom to be broken, and recommend not to use it. Under
5760Unix, I recommend to use C-Kermit for general purpose use (and
5761especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005762use "cu" for S-Record download ("loads" command). See
5763http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5764for help with kermit.
5765
wdenkc6097192002-11-03 00:24:07 +00005766
wdenk6c59edc2004-05-03 20:45:30 +00005767Nevertheless, if you absolutely want to use it try adding this
5768configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005769
wdenk6c59edc2004-05-03 20:45:30 +00005770 Name Program Name U/D FullScr IO-Red. Multi
5771 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5772 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005773
wdenk8dba0502003-03-31 16:34:49 +00005774
wdenk6c59edc2004-05-03 20:45:30 +00005775NetBSD Notes:
5776=============
wdenkc6097192002-11-03 00:24:07 +00005777
wdenk6c59edc2004-05-03 20:45:30 +00005778Starting at version 0.9.2, U-Boot supports NetBSD both as host
5779(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005780
wdenk6c59edc2004-05-03 20:45:30 +00005781Building requires a cross environment; it is known to work on
5782NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5783need gmake since the Makefiles are not compatible with BSD make).
5784Note that the cross-powerpc package does not install include files;
5785attempting to build U-Boot will fail because <machine/ansi.h> is
5786missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005787
wdenk6c59edc2004-05-03 20:45:30 +00005788 # cd /usr/pkg/cross/powerpc-netbsd/include
5789 # mkdir powerpc
5790 # ln -s powerpc machine
5791 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5792 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005793
wdenk6c59edc2004-05-03 20:45:30 +00005794Native builds *don't* work due to incompatibilities between native
5795and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005796
wdenk6c59edc2004-05-03 20:45:30 +00005797Booting assumes that (the first part of) the image booted is a
5798stage-2 loader which in turn loads and then invokes the kernel
5799proper. Loader sources will eventually appear in the NetBSD source
5800tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005801meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005802
wdenkc6097192002-11-03 00:24:07 +00005803
wdenk6c59edc2004-05-03 20:45:30 +00005804Implementation Internals:
5805=========================
wdenkc6097192002-11-03 00:24:07 +00005806
wdenk6c59edc2004-05-03 20:45:30 +00005807The following is not intended to be a complete description of every
5808implementation detail. However, it should help to understand the
5809inner workings of U-Boot and make it easier to port it to custom
5810hardware.
wdenkc6097192002-11-03 00:24:07 +00005811
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk6c59edc2004-05-03 20:45:30 +00005813Initial Stack, Global Data:
5814---------------------------
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816The implementation of U-Boot is complicated by the fact that U-Boot
5817starts running out of ROM (flash memory), usually without access to
5818system RAM (because the memory controller is not initialized yet).
5819This means that we don't have writable Data or BSS segments, and BSS
5820is not initialized as zero. To be able to get a C environment working
5821at all, we have to allocate at least a minimal stack. Implementation
5822options for this are defined and restricted by the CPU used: Some CPU
5823models provide on-chip memory (like the IMMR area on MPC8xx and
5824MPC826x processors), on others (parts of) the data cache can be
5825locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005826
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005827 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005828 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005829
wdenk6c59edc2004-05-03 20:45:30 +00005830 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5831 From: "Chris Hallinan" <clh@net1plus.com>
5832 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5833 ...
wdenkc6097192002-11-03 00:24:07 +00005834
wdenk6c59edc2004-05-03 20:45:30 +00005835 Correct me if I'm wrong, folks, but the way I understand it
5836 is this: Using DCACHE as initial RAM for Stack, etc, does not
5837 require any physical RAM backing up the cache. The cleverness
5838 is that the cache is being used as a temporary supply of
5839 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005840 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005841 can see how this works by studying the cache architecture and
5842 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005843
wdenk6c59edc2004-05-03 20:45:30 +00005844 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5845 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005846 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005847 option should work for you. Using CS 4 should be fine if your
5848 board designers haven't used it for something that would
5849 cause you grief during the initial boot! It is frequently not
5850 used.
wdenkc6097192002-11-03 00:24:07 +00005851
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005852 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005853 with your processor/board/system design. The default value
5854 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005855 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005856 than your SDRAM module. If you have a 64MB SDRAM module, set
5857 it above 400_0000. Just make sure your board has no resources
5858 that are supposed to respond to that address! That code in
5859 start.S has been around a while and should work as is when
5860 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005861
wdenk6c59edc2004-05-03 20:45:30 +00005862 -Chris Hallinan
5863 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005864
wdenk6c59edc2004-05-03 20:45:30 +00005865It is essential to remember this, since it has some impact on the C
5866code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005867
wdenk6c59edc2004-05-03 20:45:30 +00005868* Initialized global data (data segment) is read-only. Do not attempt
5869 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005870
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005871* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005872 as zero data - BSS segment) at all - this is undefined, initiali-
5873 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005874
wdenk6c59edc2004-05-03 20:45:30 +00005875* Stack space is very limited. Avoid big data buffers or things like
5876 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005877
wdenk6c59edc2004-05-03 20:45:30 +00005878Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005879normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005880turned out that the implementation of U-Boot can be greatly
5881simplified by making a global data structure (gd_t) available to all
5882functions. We could pass a pointer to this data as argument to _all_
5883functions, but this would bloat the code. Instead we use a feature of
5884the GCC compiler (Global Register Variables) to share the data: we
5885place a pointer (gd) to the global data into a register which we
5886reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk6c59edc2004-05-03 20:45:30 +00005888When choosing a register for such a purpose we are restricted by the
5889relevant (E)ABI specifications for the current architecture, and by
5890GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005891
wdenk6c59edc2004-05-03 20:45:30 +00005892For PowerPC, the following registers have specific use:
5893 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005894 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005895 R3-R4: parameter passing and return values
5896 R5-R10: parameter passing
5897 R13: small data area pointer
5898 R30: GOT pointer
5899 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005900
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005901 (U-Boot also uses R12 as internal GOT pointer. r12
5902 is a volatile register so r12 needs to be reset when
5903 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005904
Wolfgang Denk69c09642008-02-14 22:43:22 +01005905 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005906
wdenk6c59edc2004-05-03 20:45:30 +00005907 Note: on PPC, we could use a static initializer (since the
5908 address of the global data structure is known at compile time),
5909 but it turned out that reserving a register results in somewhat
5910 smaller code - although the code savings are not that big (on
5911 average for all boards 752 bytes for the whole U-Boot image,
5912 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005913
Robin Getz2773d5f2009-08-17 15:23:02 +00005914On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05005915 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
5916
Robin Getz2773d5f2009-08-17 15:23:02 +00005917 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05005918
wdenk6c59edc2004-05-03 20:45:30 +00005919On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005920
wdenk6c59edc2004-05-03 20:45:30 +00005921 R0: function argument word/integer result
5922 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005923 R9: platform specific
5924 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005925 R11: argument (frame) pointer
5926 R12: temporary workspace
5927 R13: stack pointer
5928 R14: link register
5929 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005930
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005931 ==> U-Boot will use R9 to hold a pointer to the global data
5932
5933 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005934
Thomas Chou8fa38582010-05-21 11:08:03 +08005935On Nios II, the ABI is documented here:
5936 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5937
5938 ==> U-Boot will use gp to hold a pointer to the global data
5939
5940 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5941 to access small data sections, so gp is free.
5942
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005943On NDS32, the following registers are used:
5944
5945 R0-R1: argument/return
5946 R2-R5: argument
5947 R15: temporary register for assembler
5948 R16: trampoline register
5949 R28: frame pointer (FP)
5950 R29: global pointer (GP)
5951 R30: link register (LP)
5952 R31: stack pointer (SP)
5953 PC: program counter (PC)
5954
5955 ==> U-Boot will use R10 to hold a pointer to the global data
5956
Wolfgang Denk6405a152006-03-31 18:32:53 +02005957NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5958or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005959
wdenk6c59edc2004-05-03 20:45:30 +00005960Memory Management:
5961------------------
wdenkc6097192002-11-03 00:24:07 +00005962
wdenk6c59edc2004-05-03 20:45:30 +00005963U-Boot runs in system state and uses physical addresses, i.e. the
5964MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005965
wdenk6c59edc2004-05-03 20:45:30 +00005966The available memory is mapped to fixed addresses using the memory
5967controller. In this process, a contiguous block is formed for each
5968memory type (Flash, SDRAM, SRAM), even when it consists of several
5969physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005970
wdenk6c59edc2004-05-03 20:45:30 +00005971U-Boot is installed in the first 128 kB of the first Flash bank (on
5972TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5973booting and sizing and initializing DRAM, the code relocates itself
5974to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005975memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005976configuration setting]. Below that, a structure with global Board
5977Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005978
wdenk6c59edc2004-05-03 20:45:30 +00005979Additionally, some exception handler code is copied to the low 8 kB
5980of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005981
wdenk6c59edc2004-05-03 20:45:30 +00005982So a typical memory configuration with 16 MB of DRAM could look like
5983this:
wdenkc6097192002-11-03 00:24:07 +00005984
wdenk6c59edc2004-05-03 20:45:30 +00005985 0x0000 0000 Exception Vector code
5986 :
5987 0x0000 1FFF
5988 0x0000 2000 Free for Application Use
5989 :
5990 :
wdenkc6097192002-11-03 00:24:07 +00005991
wdenk6c59edc2004-05-03 20:45:30 +00005992 :
5993 :
5994 0x00FB FF20 Monitor Stack (Growing downward)
5995 0x00FB FFAC Board Info Data and permanent copy of global data
5996 0x00FC 0000 Malloc Arena
5997 :
5998 0x00FD FFFF
5999 0x00FE 0000 RAM Copy of Monitor Code
6000 ... eventually: LCD or video framebuffer
6001 ... eventually: pRAM (Protected RAM - unchanged by reset)
6002 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006003
wdenkc6097192002-11-03 00:24:07 +00006004
wdenk6c59edc2004-05-03 20:45:30 +00006005System Initialization:
6006----------------------
wdenkc6097192002-11-03 00:24:07 +00006007
wdenk6c59edc2004-05-03 20:45:30 +00006008In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006009(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006010configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006011To be able to re-map memory U-Boot then jumps to its link address.
6012To be able to implement the initialization code in C, a (small!)
6013initial stack is set up in the internal Dual Ported RAM (in case CPUs
6014which provide such a feature like MPC8xx or MPC8260), or in a locked
6015part of the data cache. After that, U-Boot initializes the CPU core,
6016the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006017
wdenk6c59edc2004-05-03 20:45:30 +00006018Next, all (potentially) available memory banks are mapped using a
6019preliminary mapping. For example, we put them on 512 MB boundaries
6020(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6021on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6022programmed for SDRAM access. Using the temporary configuration, a
6023simple memory test is run that determines the size of the SDRAM
6024banks.
wdenkc6097192002-11-03 00:24:07 +00006025
wdenk6c59edc2004-05-03 20:45:30 +00006026When there is more than one SDRAM bank, and the banks are of
6027different size, the largest is mapped first. For equal size, the first
6028bank (CS2#) is mapped first. The first mapping is always for address
60290x00000000, with any additional banks following immediately to create
6030contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006031
wdenk6c59edc2004-05-03 20:45:30 +00006032Then, the monitor installs itself at the upper end of the SDRAM area
6033and allocates memory for use by malloc() and for the global Board
6034Info data; also, the exception vector code is copied to the low RAM
6035pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006036
wdenk6c59edc2004-05-03 20:45:30 +00006037Only after this relocation will you have a "normal" C environment;
6038until that you are restricted in several ways, mostly because you are
6039running from ROM, and because the code will have to be relocated to a
6040new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006041
wdenkc6097192002-11-03 00:24:07 +00006042
wdenk6c59edc2004-05-03 20:45:30 +00006043U-Boot Porting Guide:
6044----------------------
wdenkc6097192002-11-03 00:24:07 +00006045
wdenk6c59edc2004-05-03 20:45:30 +00006046[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6047list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006048
wdenkc6097192002-11-03 00:24:07 +00006049
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006050int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006051{
6052 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006053
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006054 signal(SIGALRM, no_more_time);
6055 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006056
wdenk6c59edc2004-05-03 20:45:30 +00006057 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006058 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006059 return 0;
6060 }
wdenkc6097192002-11-03 00:24:07 +00006061
wdenk6c59edc2004-05-03 20:45:30 +00006062 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006063
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006064 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006065
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006066 if (clueless)
6067 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006068
wdenk6c59edc2004-05-03 20:45:30 +00006069 while (learning) {
6070 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006071 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6072 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006073 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006074 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006075 }
wdenkc6097192002-11-03 00:24:07 +00006076
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006077 if (available_money > toLocalCurrency ($2500))
6078 Buy a BDI3000;
6079 else
wdenk6c59edc2004-05-03 20:45:30 +00006080 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006081
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006082 if (a similar board exists) { /* hopefully... */
6083 cp -a board/<similar> board/<myboard>
6084 cp include/configs/<similar>.h include/configs/<myboard>.h
6085 } else {
6086 Create your own board support subdirectory;
6087 Create your own board include/configs/<myboard>.h file;
6088 }
6089 Edit new board/<myboard> files
6090 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006091
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006092 while (!accepted) {
6093 while (!running) {
6094 do {
6095 Add / modify source code;
6096 } until (compiles);
6097 Debug;
6098 if (clueless)
6099 email("Hi, I am having problems...");
6100 }
6101 Send patch file to the U-Boot email list;
6102 if (reasonable critiques)
6103 Incorporate improvements from email list code review;
6104 else
6105 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006106 }
wdenkc6097192002-11-03 00:24:07 +00006107
wdenk6c59edc2004-05-03 20:45:30 +00006108 return 0;
6109}
wdenkc6097192002-11-03 00:24:07 +00006110
wdenk6c59edc2004-05-03 20:45:30 +00006111void no_more_time (int sig)
6112{
6113 hire_a_guru();
6114}
wdenkc6097192002-11-03 00:24:07 +00006115
wdenkc6097192002-11-03 00:24:07 +00006116
wdenk6c59edc2004-05-03 20:45:30 +00006117Coding Standards:
6118-----------------
wdenkc6097192002-11-03 00:24:07 +00006119
wdenk6c59edc2004-05-03 20:45:30 +00006120All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006121coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006122"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006123
6124Source files originating from a different project (for example the
6125MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006126reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006127sources.
wdenkc6097192002-11-03 00:24:07 +00006128
Detlev Zundelaa63d482006-09-01 15:39:02 +02006129Please note that U-Boot is implemented in C (and to some small parts in
6130Assembler); no C++ is used, so please do not use C++ style comments (//)
6131in your code.
wdenkad276f22004-01-04 16:28:35 +00006132
wdenk6c59edc2004-05-03 20:45:30 +00006133Please also stick to the following formatting rules:
6134- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006135- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006136- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006137- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006138- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006139
wdenk6c59edc2004-05-03 20:45:30 +00006140Submissions which do not conform to the standards may be returned
6141with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006142
wdenkc6097192002-11-03 00:24:07 +00006143
wdenk6c59edc2004-05-03 20:45:30 +00006144Submitting Patches:
6145-------------------
wdenkc6097192002-11-03 00:24:07 +00006146
wdenk6c59edc2004-05-03 20:45:30 +00006147Since the number of patches for U-Boot is growing, we need to
6148establish some rules. Submissions which do not conform to these rules
6149may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006150
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006151Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006152
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006153Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6154see http://lists.denx.de/mailman/listinfo/u-boot
6155
wdenk6c59edc2004-05-03 20:45:30 +00006156When you send a patch, please include the following information with
6157it:
wdenkc6097192002-11-03 00:24:07 +00006158
wdenk6c59edc2004-05-03 20:45:30 +00006159* For bug fixes: a description of the bug and how your patch fixes
6160 this bug. Please try to include a way of demonstrating that the
6161 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006162
wdenk6c59edc2004-05-03 20:45:30 +00006163* For new features: a description of the feature and your
6164 implementation.
wdenkc6097192002-11-03 00:24:07 +00006165
wdenk6c59edc2004-05-03 20:45:30 +00006166* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006167
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006168* For major contributions, add a MAINTAINERS file with your
6169 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006170
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006171* When you add support for a new board, don't forget to add a
6172 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006173
wdenk6c59edc2004-05-03 20:45:30 +00006174* If your patch adds new configuration options, don't forget to
6175 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006176
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006177* The patch itself. If you are using git (which is *strongly*
6178 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006179 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006180 the U-Boot mailing list, you will avoid most of the common problems
6181 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006182
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006183 If you cannot use git, use "diff -purN OLD NEW". If your version of
6184 diff does not support these options, then get the latest version of
6185 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006186
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006187 The current directory when running this command shall be the parent
6188 directory of the U-Boot source tree (i. e. please make sure that
6189 your patch includes sufficient directory information for the
6190 affected files).
6191
6192 We prefer patches as plain text. MIME attachments are discouraged,
6193 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006194
wdenk6c59edc2004-05-03 20:45:30 +00006195* If one logical set of modifications affects or creates several
6196 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006197
wdenk6c59edc2004-05-03 20:45:30 +00006198* Changesets that contain different, unrelated modifications shall be
6199 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006200
wdenkc6097192002-11-03 00:24:07 +00006201
wdenk6c59edc2004-05-03 20:45:30 +00006202Notes:
wdenkc6097192002-11-03 00:24:07 +00006203
Simon Glassdc27def2016-07-27 20:33:08 -06006204* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006205 source tree and make sure that no errors or warnings are reported
6206 for any of the boards.
6207
6208* Keep your modifications to the necessary minimum: A patch
6209 containing several unrelated changes or arbitrary reformats will be
6210 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006211
wdenk6c59edc2004-05-03 20:45:30 +00006212* If you modify existing code, make sure that your new code does not
6213 add to the memory footprint of the code ;-) Small is beautiful!
6214 When adding new features, these should compile conditionally only
6215 (using #ifdef), and the resulting code with the new feature
6216 disabled must not need more memory than the old code without your
6217 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006218
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006219* Remember that there is a size limit of 100 kB per message on the
6220 u-boot mailing list. Bigger patches will be moderated. If they are
6221 reasonable and not too big, they will be acknowledged. But patches
6222 bigger than the size limit should be avoided.