blob: 5ffe14b777177efc67382c7da0bef8727b9976b5 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denkb240aef2008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschin08337f32008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000112
wdenk24ee89b2002-11-03 17:56:27 +0000113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
wdenkc6097192002-11-03 00:24:07 +0000116
wdenk7474aca2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Webere89e6282010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000126
Thomas Webere89e6282010-09-28 08:06:25 +0200127Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
130 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /blackfin Files generic to Analog Devices Blackfin architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500143 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000144 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500145 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400146 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200147 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500148 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149 /sh Files generic to SH architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150 /sparc Files generic to SPARC architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400151 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500152/api Machine/arch independent API for external apps
153/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800154/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500155/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500156/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500157/disk Code for disk drive partition handling
158/doc Documentation (don't expect too much)
159/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400160/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500161/examples Example code for standalone applications, etc.
162/fs Filesystem code (cramfs, ext2, jffs2, etc.)
163/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500164/lib Library routines generic to all architectures
165/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500166/net Networking code
167/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500168/scripts Various build scripts and Makefiles
169/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500170/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000171
wdenkc6097192002-11-03 00:24:07 +0000172Software Configuration:
173=======================
174
175Configuration is usually done using C preprocessor defines; the
176rationale behind that is to avoid dead code whenever possible.
177
178There are two classes of configuration variables:
179
180* Configuration _OPTIONS_:
181 These are selectable by the user and have names beginning with
182 "CONFIG_".
183
184* Configuration _SETTINGS_:
185 These depend on the hardware etc. and should not be meddled with if
186 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200187 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000188
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500189Previously, all configuration was done by hand, which involved creating
190symbolic links and editing configuration files manually. More recently,
191U-Boot has added the Kbuild infrastructure used by the Linux kernel,
192allowing you to use the "make menuconfig" command to configure your
193build.
wdenkc6097192002-11-03 00:24:07 +0000194
195
196Selection of Processor Architecture and Board Type:
197---------------------------------------------------
198
199For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200200configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000201
202Example: For a TQM823L module type:
203
204 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200205 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000206
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500207Note: If you're looking for the default configuration file for a board
208you're sure used to be there but is now missing, check the file
209doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000210
Simon Glass53552c92014-03-22 17:12:59 -0600211Sandbox Environment:
212--------------------
213
214U-Boot can be built natively to run on a Linux host using the 'sandbox'
215board. This allows feature development which is not board- or architecture-
216specific to be undertaken on a native platform. The sandbox is also used to
217run some of U-Boot's tests.
218
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530219See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600220
221
Simon Glassd8711af2015-03-03 08:03:00 -0700222Board Initialisation Flow:
223--------------------------
224
225This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500226SPL and U-Boot proper (i.e. they both follow the same rules).
227
228Note: "SPL" stands for "Secondary Program Loader," which is explained in
229more detail later in this file.
230
231At present, SPL mostly uses a separate code path, but the function names
232and roles of each function are the same. Some boards or architectures
233may not conform to this. At least most ARM boards which use
234CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700235
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500236Execution typically starts with an architecture-specific (and possibly
237CPU-specific) start.S file, such as:
238
239 - arch/arm/cpu/armv7/start.S
240 - arch/powerpc/cpu/mpc83xx/start.S
241 - arch/mips/cpu/start.S
242
243and so on. From there, three functions are called; the purpose and
244limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700245
246lowlevel_init():
247 - purpose: essential init to permit execution to reach board_init_f()
248 - no global_data or BSS
249 - there is no stack (ARMv7 may have one but it will soon be removed)
250 - must not set up SDRAM or use console
251 - must only do the bare minimum to allow execution to continue to
252 board_init_f()
253 - this is almost never needed
254 - return normally from this function
255
256board_init_f():
257 - purpose: set up the machine ready for running board_init_r():
258 i.e. SDRAM and serial UART
259 - global_data is available
260 - stack is in SRAM
261 - BSS is not available, so you cannot use global/static variables,
262 only stack variables and global_data
263
264 Non-SPL-specific notes:
265 - dram_init() is called to set up DRAM. If already done in SPL this
266 can do nothing
267
268 SPL-specific notes:
269 - you can override the entire board_init_f() function with your own
270 version as needed.
271 - preloader_console_init() can be called here in extremis
272 - should set up SDRAM, and anything needed to make the UART work
273 - these is no need to clear BSS, it will be done by crt0.S
274 - must return normally from this function (don't call board_init_r()
275 directly)
276
277Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
278this point the stack and global_data are relocated to below
279CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
280memory.
281
282board_init_r():
283 - purpose: main execution, common code
284 - global_data is available
285 - SDRAM is available
286 - BSS is available, all static/global variables can be used
287 - execution eventually continues to main_loop()
288
289 Non-SPL-specific notes:
290 - U-Boot is relocated to the top of memory and is now running from
291 there.
292
293 SPL-specific notes:
294 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
295 CONFIG_SPL_STACK_R_ADDR points into SDRAM
296 - preloader_console_init() can be called here - typically this is
297 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
298 spl_board_init() function containing this call
299 - loads U-Boot or (in falcon mode) Linux
300
301
302
wdenkc6097192002-11-03 00:24:07 +0000303Configuration Options:
304----------------------
305
306Configuration depends on the combination of board and CPU type; all
307such information is kept in a configuration file
308"include/configs/<board_name>.h".
309
310Example: For a TQM823L module, all configuration settings are in
311"include/configs/TQM823L.h".
312
313
wdenk1272e232002-11-10 22:06:23 +0000314Many of the options are named exactly as the corresponding Linux
315kernel configuration options. The intention is to make it easier to
316build a config tool - later.
317
318
wdenkc6097192002-11-03 00:24:07 +0000319The following options need to be configured:
320
Kim Phillips203fee32007-08-10 13:28:25 -0500321- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000322
Kim Phillips203fee32007-08-10 13:28:25 -0500323- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200324
325- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100326 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000327
Lei Wen20014762011-02-09 18:06:58 +0530328- Marvell Family Member
329 CONFIG_SYS_MVFS - define it if you want to enable
330 multiple fs option at one time
331 for marvell soc family
332
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk20bddb32004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000348
wdenk544e9732004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000355
Heiko Schocher734f0272009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala179b1b22011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood80806962012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800410 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530411
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530412 CONFIG_A008044_WORKAROUND
413 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800414 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530415
Scott Wood80806962012-08-14 10:14:53 +0000416 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
417
418 This is the value to write into CCSR offset 0x18600
419 according to the A004510 workaround.
420
Priyanka Jainc73b9032013-07-02 09:21:04 +0530421 CONFIG_SYS_FSL_DSP_DDR_ADDR
422 This value denotes start offset of DDR memory which is
423 connected exclusively to the DSP cores.
424
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530425 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
426 This value denotes start offset of M2 memory
427 which is directly connected to the DSP core.
428
Priyanka Jainc73b9032013-07-02 09:21:04 +0530429 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
430 This value denotes start offset of M3 memory which is directly
431 connected to the DSP core.
432
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530433 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
434 This value denotes start offset of DSP CCSR space.
435
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530436 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
437 Single Source Clock is clocking mode present in some of FSL SoC's.
438 In this mode, a single differential clock is used to supply
439 clocks to the sysclock, ddrclock and usbclock.
440
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530441 CONFIG_SYS_CPC_REINIT_F
442 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800443 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530444
Tang Yuantiana7364af2014-04-17 15:33:46 +0800445 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800446 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800447 supported, core will start to execute uboot when wakes up.
448
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000449- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700450 CONFIG_SYS_GENERIC_GLOBAL_DATA
451 Defines global data is initialized in generic board board_init_f().
452 If this macro is defined, global data is created and cleared in
453 generic board board_init_f(). Without this macro, architecture/board
454 should initialize global data before calling board_init_f().
455
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000456 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
457
458 Defines the endianess of the CPU. Implementation of those
459 values is arch specific.
460
York Sunf0626592013-09-30 09:22:09 -0700461 CONFIG_SYS_FSL_DDR
462 Freescale DDR driver in use. This type of DDR controller is
463 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
464 SoCs.
465
466 CONFIG_SYS_FSL_DDR_ADDR
467 Freescale DDR memory-mapped register base.
468
469 CONFIG_SYS_FSL_DDR_EMU
470 Specify emulator support for DDR. Some DDR features such as
471 deskew training are not available.
472
473 CONFIG_SYS_FSL_DDRC_GEN1
474 Freescale DDR1 controller.
475
476 CONFIG_SYS_FSL_DDRC_GEN2
477 Freescale DDR2 controller.
478
479 CONFIG_SYS_FSL_DDRC_GEN3
480 Freescale DDR3 controller.
481
York Sun2896cb72014-03-27 17:54:47 -0700482 CONFIG_SYS_FSL_DDRC_GEN4
483 Freescale DDR4 controller.
484
York Sun461c9392013-09-30 14:20:51 -0700485 CONFIG_SYS_FSL_DDRC_ARM_GEN3
486 Freescale DDR3 controller for ARM-based SoCs.
487
York Sunf0626592013-09-30 09:22:09 -0700488 CONFIG_SYS_FSL_DDR1
489 Board config to use DDR1. It can be enabled for SoCs with
490 Freescale DDR1 or DDR2 controllers, depending on the board
491 implemetation.
492
493 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400494 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700495 Freescale DDR2 or DDR3 controllers, depending on the board
496 implementation.
497
498 CONFIG_SYS_FSL_DDR3
499 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700500 Freescale DDR3 or DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR3L
503 Board config to use DDR3L. It can be enabled for SoCs with
504 DDR3L controllers.
505
506 CONFIG_SYS_FSL_DDR4
507 Board config to use DDR4. It can be enabled for SoCs with
508 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700509
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530510 CONFIG_SYS_FSL_IFC_BE
511 Defines the IFC controller register space as Big Endian
512
513 CONFIG_SYS_FSL_IFC_LE
514 Defines the IFC controller register space as Little Endian
515
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530516 CONFIG_SYS_FSL_PBL_PBI
517 It enables addition of RCW (Power on reset configuration) in built image.
518 Please refer doc/README.pblimage for more details
519
520 CONFIG_SYS_FSL_PBL_RCW
521 It adds PBI(pre-boot instructions) commands in u-boot build image.
522 PBI commands can be used to configure SoC before it starts the execution.
523 Please refer doc/README.pblimage for more details
524
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530525 CONFIG_SPL_FSL_PBL
526 It adds a target to create boot binary having SPL binary in PBI format
527 concatenated with u-boot binary.
528
York Sun29647ab2014-02-10 13:59:42 -0800529 CONFIG_SYS_FSL_DDR_BE
530 Defines the DDR controller register space as Big Endian
531
532 CONFIG_SYS_FSL_DDR_LE
533 Defines the DDR controller register space as Little Endian
534
York Sun3a0916d2014-02-10 13:59:43 -0800535 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
536 Physical address from the view of DDR controllers. It is the
537 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
538 it could be different for ARM SoCs.
539
York Sunc459ae62014-02-10 13:59:44 -0800540 CONFIG_SYS_FSL_DDR_INTLV_256B
541 DDR controller interleaving on 256-byte. This is a special
542 interleaving mode, handled by Dickens for Freescale layerscape
543 SoCs with ARM core.
544
York Sun79a779b2014-08-01 15:51:00 -0700545 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
546 Number of controllers used as main memory.
547
548 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
549 Number of controllers used for other than main memory.
550
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530551 CONFIG_SYS_FSL_HAS_DP_DDR
552 Defines the SoC has DP-DDR used for DPAA.
553
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530554 CONFIG_SYS_FSL_SEC_BE
555 Defines the SEC controller register space as Big Endian
556
557 CONFIG_SYS_FSL_SEC_LE
558 Defines the SEC controller register space as Little Endian
559
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200560- MIPS CPU options:
561 CONFIG_SYS_INIT_SP_OFFSET
562
563 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
564 pointer. This is needed for the temporary stack before
565 relocation.
566
567 CONFIG_SYS_MIPS_CACHE_MODE
568
569 Cache operation mode for the MIPS CPU.
570 See also arch/mips/include/asm/mipsregs.h.
571 Possible values are:
572 CONF_CM_CACHABLE_NO_WA
573 CONF_CM_CACHABLE_WA
574 CONF_CM_UNCACHED
575 CONF_CM_CACHABLE_NONCOHERENT
576 CONF_CM_CACHABLE_CE
577 CONF_CM_CACHABLE_COW
578 CONF_CM_CACHABLE_CUW
579 CONF_CM_CACHABLE_ACCELERATED
580
581 CONFIG_SYS_XWAY_EBU_BOOTCFG
582
583 Special option for Lantiq XWAY SoCs for booting from NOR flash.
584 See also arch/mips/cpu/mips32/start.S.
585
586 CONFIG_XWAY_SWAP_BYTES
587
588 Enable compilation of tools/xway-swap-bytes needed for Lantiq
589 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
590 be swapped if a flash programmer is used.
591
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000592- ARM options:
593 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
594
595 Select high exception vectors of the ARM core, e.g., do not
596 clear the V bit of the c1 register of CP15.
597
Aneesh Vb8e40802012-03-08 07:20:19 +0000598 CONFIG_SYS_THUMB_BUILD
599
600 Use this flag to build U-Boot using the Thumb instruction
601 set for ARM architectures. Thumb instruction set provides
602 better code density. For ARM architectures that support
603 Thumb2 this flag will result in Thumb2 code generated by
604 GCC.
605
Stephen Warrenc63c3502013-03-04 13:29:40 +0000606 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000607 CONFIG_ARM_ERRATA_742230
608 CONFIG_ARM_ERRATA_743622
609 CONFIG_ARM_ERRATA_751472
Nitin Garg245defa2014-04-02 08:55:02 -0500610 CONFIG_ARM_ERRATA_761320
Ian Campbell363e4242015-09-29 10:27:09 +0100611 CONFIG_ARM_ERRATA_773022
612 CONFIG_ARM_ERRATA_774769
613 CONFIG_ARM_ERRATA_794072
Stephen Warrene9d59c92013-02-26 12:28:27 +0000614
615 If set, the workarounds for these ARM errata are applied early
616 during U-Boot startup. Note that these options force the
617 workarounds to be applied; no CPU-type/version detection
618 exists, unlike the similar options in the Linux kernel. Do not
619 set these options unless they apply!
620
York Sun77a10972015-03-20 19:28:08 -0700621 COUNTER_FREQUENCY
622 Generic timer clock source frequency.
623
624 COUNTER_FREQUENCY_REAL
625 Generic timer clock source frequency if the real clock is
626 different from COUNTER_FREQUENCY, and can only be determined
627 at run time.
628
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500629 NOTE: The following can be machine specific errata. These
630 do have ability to provide rudimentary version and machine
631 specific checks, but expect no product checks.
Nishanth Menon3f445112015-03-09 17:12:01 -0500632 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500633 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500634 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500635 CONFIG_ARM_ERRATA_798870
Nishanth Menon6e2bd2e2015-07-27 16:26:05 -0500636 CONFIG_ARM_ERRATA_801819
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500637
Stephen Warren8d1fb312015-01-19 16:25:52 -0700638- Tegra SoC options:
639 CONFIG_TEGRA_SUPPORT_NON_SECURE
640
641 Support executing U-Boot in non-secure (NS) mode. Certain
642 impossible actions will be skipped if the CPU is in NS mode,
643 such as ARM architectural timer initialization.
644
wdenk9b7f3842003-10-09 20:09:04 +0000645- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000646 CONFIG_CLOCKS_IN_MHZ
647
648 U-Boot stores all clock information in Hz
649 internally. For binary compatibility with older Linux
650 kernels (which expect the clocks passed in the
651 bd_info data to be in MHz) the environment variable
652 "clocks_in_mhz" can be defined so that U-Boot
653 converts clock data to MHZ before passing it to the
654 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000655 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100656 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000657 default environment.
658
wdenk9b7f3842003-10-09 20:09:04 +0000659 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
660
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800661 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000662 expect it to be in bytes, others in MB.
663 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
664
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400665 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200666
667 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400668 passed using flattened device trees (based on open firmware
669 concepts).
670
671 CONFIG_OF_LIBFDT
672 * New libfdt-based support
673 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500674 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400675
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200676 OF_CPU - The proper name of the cpus node (only required for
677 MPC512X and MPC5xxx based boards).
678 OF_SOC - The proper name of the soc node (only required for
679 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200680 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600681 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200682
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200683 boards with QUICC Engines require OF_QE to set UCC MAC
684 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500685
Kumar Gala1e26aa52006-01-11 13:54:17 -0600686 CONFIG_OF_BOARD_SETUP
687
688 Board code has addition modification that it wants to make
689 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000690
Simon Glass6c0be912014-10-23 18:58:54 -0600691 CONFIG_OF_SYSTEM_SETUP
692
693 Other code has addition modification that it wants to make
694 to the flat device tree before handing it off to the kernel.
695 This causes ft_system_setup() to be called before booting
696 the kernel.
697
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500698 CONFIG_OF_BOOT_CPU
699
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200700 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500701 param header, the default value is zero if undefined.
702
Heiko Schocherffb293a2009-09-23 07:56:08 +0200703 CONFIG_OF_IDE_FIXUP
704
705 U-Boot can detect if an IDE device is present or not.
706 If not, and this new config option is activated, U-Boot
707 removes the ATA node from the DTS before booting Linux,
708 so the Linux IDE driver does not probe the device and
709 crash. This is needed for buggy hardware (uc101) where
710 no pull down resistor is connected to the signal IDE5V_DD7.
711
Igor Grinberg06890672011-07-14 05:45:07 +0000712 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
713
714 This setting is mandatory for all boards that have only one
715 machine type and must be used to specify the machine type
716 number as it appears in the ARM machine registry
717 (see http://www.arm.linux.org.uk/developer/machines/).
718 Only boards that have multiple machine types supported
719 in a single configuration file and the machine type is
720 runtime discoverable, do not have to use this setting.
721
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100722- vxWorks boot parameters:
723
724 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700725 environments variables: bootdev, bootfile, ipaddr, netmask,
726 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100727 It loads the vxWorks image pointed bootfile.
728
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100729 Note: If a "bootargs" environment is defined, it will overwride
730 the defaults discussed just above.
731
Aneesh V960f5c02011-06-16 23:30:47 +0000732- Cache Configuration:
733 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
734 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
735 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
736
Aneesh V686a0752011-06-16 23:30:51 +0000737- Cache Configuration for ARM:
738 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
739 controller
740 CONFIG_SYS_PL310_BASE - Physical base address of PL310
741 controller register space
742
wdenkda04a8b2004-08-02 23:22:59 +0000743- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200744 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000745
746 Define this if you want support for Amba PrimeCell PL010 UARTs.
747
Andreas Engel0813b122008-09-08 14:30:53 +0200748 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000749
750 Define this if you want support for Amba PrimeCell PL011 UARTs.
751
752 CONFIG_PL011_CLOCK
753
754 If you have Amba PrimeCell PL011 UARTs, set this variable to
755 the clock speed of the UARTs.
756
757 CONFIG_PL01x_PORTS
758
759 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
760 define this to a list of base addresses for each (supported)
761 port. See e.g. include/configs/versatile.h
762
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400763 CONFIG_SERIAL_HW_FLOW_CONTROL
764
765 Define this variable to enable hw flow control in serial driver.
766 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000767
wdenkc6097192002-11-03 00:24:07 +0000768- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000769 Depending on board, define exactly one serial port
770 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
771 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
772 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000773
774 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
775 port routines must be defined elsewhere
776 (i.e. serial_init(), serial_getc(), ...)
777
778 CONFIG_CFB_CONSOLE
779 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000780 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000781 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
782 (default big endian)
783 VIDEO_HW_RECTFILL graphic chip supports
784 rectangle fill
785 (cf. smiLynxEM)
786 VIDEO_HW_BITBLT graphic chip supports
787 bit-blit (cf. smiLynxEM)
788 VIDEO_VISIBLE_COLS visible pixel columns
789 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000790 VIDEO_VISIBLE_ROWS visible pixel rows
791 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000792 VIDEO_DATA_FORMAT graphic data format
793 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000794 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000795 VIDEO_KBD_INIT_FCT keyboard int fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700796 (i.e. rx51_kp_init())
wdenkc6097192002-11-03 00:24:07 +0000797 VIDEO_TSTC_FCT test char fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700798 (i.e. rx51_kp_tstc)
wdenkc6097192002-11-03 00:24:07 +0000799 VIDEO_GETC_FCT get char fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700800 (i.e. rx51_kp_getc)
wdenkc6097192002-11-03 00:24:07 +0000801 CONFIG_VIDEO_LOGO display Linux logo in
802 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000803 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
804 linux_logo.h for logo.
805 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000806 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200807 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000808 the logo
Tim Harvey98899462016-05-24 14:59:59 -0700809 CONFIG_HIDE_LOGO_VERSION
810 do not display bootloader
811 version string
wdenkc6097192002-11-03 00:24:07 +0000812
Pali Rohár4a57da32012-10-19 13:30:09 +0000813 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
814 a limited number of ANSI escape sequences (cursor control,
815 erase functions and limited graphics rendition control).
816
wdenk4a5c8a72003-03-06 00:02:04 +0000817 When CONFIG_CFB_CONSOLE is defined, video console is
818 default i/o. Serial console can be forced with
819 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000820
wdenk1ebf41e2004-01-02 14:00:00 +0000821 When CONFIG_SILENT_CONSOLE is defined, all console
822 messages (by U-Boot and Linux!) can be silenced with
823 the "silent" environment variable. See
824 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000825
Heiko Schocher62759562013-10-22 11:06:06 +0200826 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
827 is 0x00.
828 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
829 is 0xa0.
830
wdenkc6097192002-11-03 00:24:07 +0000831- Console Baudrate:
832 CONFIG_BAUDRATE - in bps
833 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200834 CONFIG_SYS_BAUDRATE_TABLE, see below.
835 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000836
Heiko Schocher327480a2009-01-30 12:55:38 +0100837- Console Rx buffer length
838 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
839 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100840 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100841 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
842 must be defined, to setup the maximum idle timeout for
843 the SMC.
844
Graeme Russ3c28f482011-09-01 00:48:27 +0000845- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200846 Prior to the console being initialised (i.e. serial UART
847 initialised etc) all console output is silently discarded.
848 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
849 buffer any console messages prior to the console being
850 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
851 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
852 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200853 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200854 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000855
Hans de Goedee355da02015-05-05 13:13:36 +0200856 Note that when printing the buffer a copy is made on the
857 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
858
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200859 'Sane' compilers will generate smaller code if
860 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000861
wdenkc6097192002-11-03 00:24:07 +0000862- Autoboot Command:
863 CONFIG_BOOTCOMMAND
864 Only needed when CONFIG_BOOTDELAY is enabled;
865 define a command string that is automatically executed
866 when no character is read on the console interface
867 within "Boot Delay" after reset.
868
869 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000870 This can be used to pass arguments to the bootm
871 command. The value of CONFIG_BOOTARGS goes into the
872 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000873
874 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000875 The value of these goes into the environment as
876 "ramboot" and "nfsboot" respectively, and can be used
877 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200878 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000879
Heiko Schocher040c5c32013-11-04 14:04:59 +0100880- Bootcount:
881 CONFIG_BOOTCOUNT_LIMIT
882 Implements a mechanism for detecting a repeating reboot
883 cycle, see:
884 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
885
886 CONFIG_BOOTCOUNT_ENV
887 If no softreset save registers are found on the hardware
888 "bootcount" is stored in the environment. To prevent a
889 saveenv on all reboots, the environment variable
890 "upgrade_available" is used. If "upgrade_available" is
891 0, "bootcount" is always 0, if "upgrade_available" is
892 1 "bootcount" is incremented in the environment.
893 So the Userspace Applikation must set the "upgrade_available"
894 and "bootcount" variable to 0, if a boot was successfully.
895
wdenkc6097192002-11-03 00:24:07 +0000896- Pre-Boot Commands:
897 CONFIG_PREBOOT
898
899 When this option is #defined, the existence of the
900 environment variable "preboot" will be checked
901 immediately before starting the CONFIG_BOOTDELAY
902 countdown and/or running the auto-boot command resp.
903 entering interactive mode.
904
905 This feature is especially useful when "preboot" is
906 automatically generated or modified. For an example
907 see the LWMON board specific code: here "preboot" is
908 modified when the user holds down a certain
909 combination of keys on the (special) keyboard when
910 booting the systems
911
912- Serial Download Echo Mode:
913 CONFIG_LOADS_ECHO
914 If defined to 1, all characters received during a
915 serial download (using the "loads" command) are
916 echoed back. This might be needed by some terminal
917 emulations (like "cu"), but may as well just take
918 time on others. This setting #define's the initial
919 value of the "loads_echo" environment variable.
920
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500921- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000922 CONFIG_KGDB_BAUDRATE
923 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200924 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000925
926- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500927 Monitor commands can be included or excluded
928 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000929 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500930 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000931
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500932 The default command configuration includes all commands
933 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000934
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100935 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500936 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500937 CONFIG_CMD_BDI bdinfo
938 CONFIG_CMD_BEDBUG * Include BedBug Debugger
939 CONFIG_CMD_BMP * BMP support
940 CONFIG_CMD_BSP * Board specific commands
941 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400942 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500943 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800944 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500945 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500946 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500947 CONFIG_CMD_DATE * support for RTC, date/time...
948 CONFIG_CMD_DHCP * DHCP support
949 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600950 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
951 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
952 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
953 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500954 CONFIG_CMD_DTT * Digital Therm and Thermostat
955 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500956 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500957 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanov37dda1c2016-04-16 17:55:03 +0300958 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500959 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600960 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600961 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500962 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500963 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000964 CONFIG_CMD_EXT2 * ext2 command support
965 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700966 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
967 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100968 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500969 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500970 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000971 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500972 CONFIG_CMD_FLASH flinfo, erase, protect
973 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200974 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000975 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500976 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000977 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000978 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500979 CONFIG_CMD_I2C * I2C serial bus support
980 CONFIG_CMD_IDE * IDE harddisk support
981 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000982 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200983 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500984 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -0600985 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500986 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000987 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500988 CONFIG_CMD_IRQ * irqinfo
989 CONFIG_CMD_ITEST Integer/string test of 2 values
990 CONFIG_CMD_JFFS2 * JFFS2 Support
991 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200992 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000993 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
994 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500995 CONFIG_CMD_LOADB loadb
996 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200997 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400998 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000999 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001000 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001001 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001002 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001003 CONFIG_CMD_MISC Misc functions like sleep etc
1004 CONFIG_CMD_MMC * MMC memory mapped support
1005 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001006 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001007 CONFIG_CMD_NAND * NAND support
1008 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001009 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001010 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001011 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001012 CONFIG_CMD_PCI * pciinfo
1013 CONFIG_CMD_PCMCIA * PCMCIA support
1014 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1015 host
1016 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001017 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001018 CONFIG_CMD_REGINFO * Register dump
1019 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001020 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001021 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -06001022 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001023 CONFIG_CMD_SDRAM * print SDRAM configuration information
1024 (requires CONFIG_CMD_I2C)
1025 CONFIG_CMD_SETGETDCR Support for DCR Register access
1026 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001027 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001028 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001029 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001030 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001031 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001032 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001033 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001034 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001035 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1036 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001037 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001038 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001039 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001040 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001041 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001042
1043 EXAMPLE: If you want all functions except of network
1044 support you can write:
1045
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001046 #include "config_cmd_all.h"
1047 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001048
Gerald Van Barend6abef42007-03-31 12:23:51 -04001049 Other Commands:
1050 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001051
1052 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001053 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001054 what you (and your U-Boot users) are doing. Data
1055 cache cannot be enabled on systems like the 8xx or
1056 8260 (where accesses to the IMMR region must be
1057 uncached), and it cannot be disabled on all other
1058 systems where we (mis-) use the data cache to hold an
1059 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001060
1061
1062 XXX - this list needs to get updated!
1063
Simon Glassaa34ef22016-03-13 19:07:28 -06001064- Removal of commands
1065 If no commands are needed to boot, you can disable
1066 CONFIG_CMDLINE to remove them. In this case, the command line
1067 will not be available, and when U-Boot wants to execute the
1068 boot command (on start-up) it will call board_run_command()
1069 instead. This can reduce image size significantly for very
1070 simple boot procedures.
1071
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001072- Regular expression support:
1073 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001074 If this variable is defined, U-Boot is linked against
1075 the SLRE (Super Light Regular Expression) library,
1076 which adds regex support to some commands, as for
1077 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001078
Simon Glass3d686442011-10-15 05:48:20 +00001079- Device tree:
1080 CONFIG_OF_CONTROL
1081 If this variable is defined, U-Boot will use a device tree
1082 to configure its devices, instead of relying on statically
1083 compiled #defines in the board file. This option is
1084 experimental and only available on a few boards. The device
1085 tree is available in the global data as gd->fdt_blob.
1086
Simon Glass5cb34db2011-10-24 19:15:31 +00001087 U-Boot needs to get its device tree from somewhere. This can
1088 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001089
1090 CONFIG_OF_EMBED
1091 If this variable is defined, U-Boot will embed a device tree
1092 binary in its image. This device tree file should be in the
1093 board directory and called <soc>-<board>.dts. The binary file
1094 is then picked up in board_init_f() and made available through
1095 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001096
Simon Glass5cb34db2011-10-24 19:15:31 +00001097 CONFIG_OF_SEPARATE
1098 If this variable is defined, U-Boot will build a device tree
1099 binary. It will be called u-boot.dtb. Architecture-specific
1100 code will locate it at run-time. Generally this works by:
1101
1102 cat u-boot.bin u-boot.dtb >image.bin
1103
1104 and in fact, U-Boot does this for you, creating a file called
1105 u-boot-dtb.bin which is useful in the common case. You can
1106 still use the individual files if you need something more
1107 exotic.
1108
wdenkc6097192002-11-03 00:24:07 +00001109- Watchdog:
1110 CONFIG_WATCHDOG
1111 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001112 support for the SoC. There must be support in the SoC
1113 specific code for a watchdog. For the 8xx and 8260
1114 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1115 register. When supported for a specific SoC is
1116 available, then no further board specific code should
1117 be needed to use it.
1118
1119 CONFIG_HW_WATCHDOG
1120 When using a watchdog circuitry external to the used
1121 SoC, then define this variable and provide board
1122 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001123
Heiko Schocher735326c2015-01-21 08:38:22 +01001124 CONFIG_AT91_HW_WDT_TIMEOUT
1125 specify the timeout in seconds. default 2 seconds.
1126
stroeseb9c17c52003-04-04 15:53:41 +00001127- U-Boot Version:
1128 CONFIG_VERSION_VARIABLE
1129 If this variable is defined, an environment variable
1130 named "ver" is created by U-Boot showing the U-Boot
1131 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001132 Any change to this variable will be reverted at the
1133 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001134
wdenkc6097192002-11-03 00:24:07 +00001135- Real-Time Clock:
1136
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001137 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001138 has to be selected, too. Define exactly one of the
1139 following options:
1140
1141 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1142 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001143 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001144 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001145 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001146 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001147 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001148 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001149 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001150 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001151 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001152 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001153 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1154 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001155
wdenkb9bbd242003-06-30 16:24:52 +00001156 Note that if the RTC uses I2C, then the I2C interface
1157 must also be configured. See I2C Support, below.
1158
Peter Tyser9902e422008-12-17 16:36:21 -06001159- GPIO Support:
1160 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001161
Chris Packham9b383202010-12-19 10:12:13 +00001162 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1163 chip-ngpio pairs that tell the PCA953X driver the number of
1164 pins supported by a particular chip.
1165
Peter Tyser9902e422008-12-17 16:36:21 -06001166 Note that if the GPIO device uses I2C, then the I2C interface
1167 must also be configured. See I2C Support, below.
1168
Simon Glass4dc47ca2014-06-11 23:29:41 -06001169- I/O tracing:
1170 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1171 accesses and can checksum them or write a list of them out
1172 to memory. See the 'iotrace' command for details. This is
1173 useful for testing device drivers since it can confirm that
1174 the driver behaves the same way before and after a code
1175 change. Currently this is supported on sandbox and arm. To
1176 add support for your architecture, add '#include <iotrace.h>'
1177 to the bottom of arch/<arch>/include/asm/io.h and test.
1178
1179 Example output from the 'iotrace stats' command is below.
1180 Note that if the trace buffer is exhausted, the checksum will
1181 still continue to operate.
1182
1183 iotrace is enabled
1184 Start: 10000000 (buffer start address)
1185 Size: 00010000 (buffer size)
1186 Offset: 00000120 (current buffer offset)
1187 Output: 10000120 (start + offset)
1188 Count: 00000018 (number of trace records)
1189 CRC32: 9526fb66 (CRC32 of all trace records)
1190
wdenkc6097192002-11-03 00:24:07 +00001191- Timestamp Support:
1192
wdenk4a5c8a72003-03-06 00:02:04 +00001193 When CONFIG_TIMESTAMP is selected, the timestamp
1194 (date and time) of an image is printed by image
1195 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001196 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001197
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001198- Partition Labels (disklabels) Supported:
1199 Zero or more of the following:
1200 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1201 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1202 Intel architecture, USB sticks, etc.
1203 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1204 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1205 bootloader. Note 2TB partition limit; see
1206 disk/part_efi.c
1207 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001208
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001209 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001210 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001211 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001212
1213- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001214 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1215 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001216
wdenk369d43d2004-03-14 14:09:05 +00001217 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1218 be performed by calling the function
1219 ide_set_reset(int reset)
1220 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001221
1222- ATAPI Support:
1223 CONFIG_ATAPI
1224
1225 Set this to enable ATAPI support.
1226
wdenkf602aa02004-03-13 23:29:43 +00001227- LBA48 Support
1228 CONFIG_LBA48
1229
1230 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001231 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001232 Whithout these , LBA48 support uses 32bit variables and will 'only'
1233 support disks up to 2.1TB.
1234
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001235 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001236 When enabled, makes the IDE subsystem use 64bit sector addresses.
1237 Default is 32bit.
1238
wdenkc6097192002-11-03 00:24:07 +00001239- SCSI Support:
1240 At the moment only there is only support for the
1241 SYM53C8XX SCSI controller; define
1242 CONFIG_SCSI_SYM53C8XX to enable it.
1243
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001244 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1245 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1246 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001247 maximum numbers of LUNs, SCSI ID's and target
1248 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001249 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001250
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001251 The environment variable 'scsidevs' is set to the number of
1252 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001253
wdenkc6097192002-11-03 00:24:07 +00001254- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001255 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001256 Support for Intel 8254x/8257x gigabit chips.
1257
1258 CONFIG_E1000_SPI
1259 Utility code for direct access to the SPI bus on Intel 8257x.
1260 This does not do anything useful unless you set at least one
1261 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1262
1263 CONFIG_E1000_SPI_GENERIC
1264 Allow generic access to the SPI bus on the Intel 8257x, for
1265 example with the "sspi" command.
1266
1267 CONFIG_CMD_E1000
1268 Management command for E1000 devices. When used on devices
1269 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001270
wdenkc6097192002-11-03 00:24:07 +00001271 CONFIG_EEPRO100
1272 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001273 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001274 write routine for first time initialisation.
1275
1276 CONFIG_TULIP
1277 Support for Digital 2114x chips.
1278 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1279 modem chip initialisation (KS8761/QS6611).
1280
1281 CONFIG_NATSEMI
1282 Support for National dp83815 chips.
1283
1284 CONFIG_NS8382X
1285 Support for National dp8382[01] gigabit chips.
1286
wdenkaa603362003-05-12 21:50:16 +00001287- NETWORK Support (other):
1288
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001289 CONFIG_DRIVER_AT91EMAC
1290 Support for AT91RM9200 EMAC.
1291
1292 CONFIG_RMII
1293 Define this to use reduced MII inteface
1294
1295 CONFIG_DRIVER_AT91EMAC_QUIET
1296 If this defined, the driver is quiet.
1297 The driver doen't show link status messages.
1298
Rob Herringc9830dc2011-12-15 11:15:49 +00001299 CONFIG_CALXEDA_XGMAC
1300 Support for the Calxeda XGMAC device
1301
Ashok93fb8722012-10-15 06:20:47 +00001302 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001303 Support for SMSC's LAN91C96 chips.
1304
1305 CONFIG_LAN91C96_BASE
1306 Define this to hold the physical address
1307 of the LAN91C96's I/O space
1308
1309 CONFIG_LAN91C96_USE_32_BIT
1310 Define this to enable 32 bit addressing
1311
Ashok93fb8722012-10-15 06:20:47 +00001312 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001313 Support for SMSC's LAN91C111 chip
1314
1315 CONFIG_SMC91111_BASE
1316 Define this to hold the physical address
1317 of the device (I/O space)
1318
1319 CONFIG_SMC_USE_32_BIT
1320 Define this if data bus is 32 bits
1321
1322 CONFIG_SMC_USE_IOFUNCS
1323 Define this to use i/o functions instead of macros
1324 (some hardware wont work with macros)
1325
Heiko Schocher7d037f72011-11-15 10:00:04 -05001326 CONFIG_DRIVER_TI_EMAC
1327 Support for davinci emac
1328
1329 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1330 Define this if you have more then 3 PHYs.
1331
Macpaul Lin199c6252010-12-21 16:59:46 +08001332 CONFIG_FTGMAC100
1333 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1334
1335 CONFIG_FTGMAC100_EGIGA
1336 Define this to use GE link update with gigabit PHY.
1337 Define this if FTGMAC100 is connected to gigabit PHY.
1338 If your system has 10/100 PHY only, it might not occur
1339 wrong behavior. Because PHY usually return timeout or
1340 useless data when polling gigabit status and gigabit
1341 control registers. This behavior won't affect the
1342 correctnessof 10/100 link speed update.
1343
Mike Rapoportf4761af2009-11-11 10:03:03 +02001344 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001345 Support for SMSC's LAN911x and LAN921x chips
1346
Mike Rapoportf4761af2009-11-11 10:03:03 +02001347 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001348 Define this to hold the physical address
1349 of the device (I/O space)
1350
Mike Rapoportf4761af2009-11-11 10:03:03 +02001351 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001352 Define this if data bus is 32 bits
1353
Mike Rapoportf4761af2009-11-11 10:03:03 +02001354 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001355 Define this if data bus is 16 bits. If your processor
1356 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001357 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001358
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001359 CONFIG_SH_ETHER
1360 Support for Renesas on-chip Ethernet controller
1361
1362 CONFIG_SH_ETHER_USE_PORT
1363 Define the number of ports to be used
1364
1365 CONFIG_SH_ETHER_PHY_ADDR
1366 Define the ETH PHY's address
1367
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001368 CONFIG_SH_ETHER_CACHE_WRITEBACK
1369 If this option is set, the driver enables cache flush.
1370
Heiko Schocher2b387762014-07-18 06:07:19 +02001371- PWM Support:
1372 CONFIG_PWM_IMX
1373 Support for PWM modul on the imx6.
1374
Vadim Bendeburydac69642011-10-17 08:36:14 +00001375- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001376 CONFIG_TPM
1377 Support TPM devices.
1378
Christophe Ricard8759ff82015-10-06 22:54:41 +02001379 CONFIG_TPM_TIS_INFINEON
1380 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001381 per system is supported at this time.
1382
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001383 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1384 Define the burst count bytes upper limit
1385
Christophe Ricard88249232016-01-21 23:27:13 +01001386 CONFIG_TPM_ST33ZP24
1387 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1388
1389 CONFIG_TPM_ST33ZP24_I2C
1390 Support for STMicroelectronics ST33ZP24 I2C devices.
1391 Requires TPM_ST33ZP24 and I2C.
1392
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001393 CONFIG_TPM_ST33ZP24_SPI
1394 Support for STMicroelectronics ST33ZP24 SPI devices.
1395 Requires TPM_ST33ZP24 and SPI.
1396
Dirk Eibach20489092013-06-26 15:55:15 +02001397 CONFIG_TPM_ATMEL_TWI
1398 Support for Atmel TWI TPM device. Requires I2C support.
1399
Che-liang Chiouacea5702013-04-12 11:04:34 +00001400 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001401 Support for generic parallel port TPM devices. Only one device
1402 per system is supported at this time.
1403
1404 CONFIG_TPM_TIS_BASE_ADDRESS
1405 Base address where the generic TPM device is mapped
1406 to. Contemporary x86 systems usually map it at
1407 0xfed40000.
1408
Reinhard Pfau4fece432013-06-26 15:55:13 +02001409 CONFIG_CMD_TPM
1410 Add tpm monitor functions.
1411 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1412 provides monitor access to authorized functions.
1413
1414 CONFIG_TPM
1415 Define this to enable the TPM support library which provides
1416 functional interfaces to some TPM commands.
1417 Requires support for a TPM device.
1418
1419 CONFIG_TPM_AUTH_SESSIONS
1420 Define this to enable authorized functions in the TPM library.
1421 Requires CONFIG_TPM and CONFIG_SHA1.
1422
wdenkc6097192002-11-03 00:24:07 +00001423- USB Support:
1424 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001425 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001426 CONFIG_USB_UHCI to enable it.
1427 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001428 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001429 storage devices.
1430 Note:
1431 Supported are USB Keyboards and USB Floppy drives
1432 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001433 MPC5200 USB requires additional defines:
1434 CONFIG_USB_CLOCK
1435 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001436 CONFIG_PSC3_USB
1437 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001438 CONFIG_USB_CONFIG
1439 for differential drivers: 0x00001000
1440 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001441 for differential drivers on PSC3: 0x00000100
1442 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001443 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001444 May be defined to allow interrupt polling
1445 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001446
Simon Glass5978cdb2012-02-27 10:52:47 +00001447 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1448 txfilltuning field in the EHCI controller on reset.
1449
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001450 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1451 HW module registers.
1452
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001453- USB Device:
1454 Define the below if you wish to use the USB console.
1455 Once firmware is rebuilt from a serial console issue the
1456 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001457 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001458 it has found a new device. The environment variable usbtty
1459 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001460 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001461 Common Device Class Abstract Control Model serial device.
1462 If you select usbtty = gserial you should be able to enumerate
1463 a Linux host by
1464 # modprobe usbserial vendor=0xVendorID product=0xProductID
1465 else if using cdc_acm, simply setting the environment
1466 variable usbtty to be cdc_acm should suffice. The following
1467 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001468
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001469 CONFIG_USB_DEVICE
1470 Define this to build a UDC device
1471
1472 CONFIG_USB_TTY
1473 Define this to have a tty type of device available to
1474 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001475
Vipin KUMARbdb17702012-03-26 15:38:06 +05301476 CONFIG_USBD_HS
1477 Define this to enable the high speed support for usb
1478 device and usbtty. If this feature is enabled, a routine
1479 int is_usbd_high_speed(void)
1480 also needs to be defined by the driver to dynamically poll
1481 whether the enumeration has succeded at high speed or full
1482 speed.
1483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001484 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001485 Define this if you want stdin, stdout &/or stderr to
1486 be set to usbtty.
1487
1488 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001489 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001490 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001491 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001492
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001493 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001494 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001495 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001496
Wolfgang Denke2601822006-06-14 18:14:56 +02001497 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001498 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001499 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001500 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1501 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1502 should pretend to be a Linux device to it's target host.
1503
1504 CONFIG_USBD_MANUFACTURER
1505 Define this string as the name of your company for
1506 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001507
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001508 CONFIG_USBD_PRODUCT_NAME
1509 Define this string as the name of your product
1510 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001511
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001512 CONFIG_USBD_VENDORID
1513 Define this as your assigned Vendor ID from the USB
1514 Implementors Forum. This *must* be a genuine Vendor ID
1515 to avoid polluting the USB namespace.
1516 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001517
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001518 CONFIG_USBD_PRODUCTID
1519 Define this as the unique Product ID
1520 for your device
1521 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001522
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001523- ULPI Layer Support:
1524 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1525 the generic ULPI layer. The generic layer accesses the ULPI PHY
1526 via the platform viewport, so you need both the genric layer and
1527 the viewport enabled. Currently only Chipidea/ARC based
1528 viewport is supported.
1529 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1530 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001531 If your ULPI phy needs a different reference clock than the
1532 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1533 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001534
wdenk7a428cc2003-06-15 22:40:42 +00001535- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001536 The MMC controller on the Intel PXA is supported. To
1537 enable this define CONFIG_MMC. The MMC can be
1538 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001539 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001540 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1541 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001542
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001543 CONFIG_SH_MMCIF
1544 Support for Renesas on-chip MMCIF controller
1545
1546 CONFIG_SH_MMCIF_ADDR
1547 Define the base address of MMCIF registers
1548
1549 CONFIG_SH_MMCIF_CLK
1550 Define the clock frequency for MMCIF
1551
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001552 CONFIG_GENERIC_MMC
1553 Enable the generic MMC driver
1554
1555 CONFIG_SUPPORT_EMMC_BOOT
1556 Enable some additional features of the eMMC boot partitions.
1557
1558 CONFIG_SUPPORT_EMMC_RPMB
1559 Enable the commands for reading, writing and programming the
1560 key for the Replay Protection Memory Block partition in eMMC.
1561
Tom Rini58a8d322013-03-14 05:32:47 +00001562- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001563 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001564 This enables the USB portion of the DFU USB class
1565
1566 CONFIG_CMD_DFU
1567 This enables the command "dfu" which is used to have
1568 U-Boot create a DFU class device via USB. This command
1569 requires that the "dfu_alt_info" environment variable be
1570 set and define the alt settings to expose to the host.
1571
1572 CONFIG_DFU_MMC
1573 This enables support for exposing (e)MMC devices via DFU.
1574
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001575 CONFIG_DFU_NAND
1576 This enables support for exposing NAND devices via DFU.
1577
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301578 CONFIG_DFU_RAM
1579 This enables support for exposing RAM via DFU.
1580 Note: DFU spec refer to non-volatile memory usage, but
1581 allow usages beyond the scope of spec - here RAM usage,
1582 one that would help mostly the developer.
1583
Heiko Schochera2f831e2013-06-12 06:05:51 +02001584 CONFIG_SYS_DFU_DATA_BUF_SIZE
1585 Dfu transfer uses a buffer before writing data to the
1586 raw storage device. Make the size (in bytes) of this buffer
1587 configurable. The size of this buffer is also configurable
1588 through the "dfu_bufsiz" environment variable.
1589
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001590 CONFIG_SYS_DFU_MAX_FILE_SIZE
1591 When updating files rather than the raw storage device,
1592 we use a static buffer to copy the file into and then write
1593 the buffer once we've been given the whole file. Define
1594 this to the maximum filesize (in bytes) for the buffer.
1595 Default is 4 MiB if undefined.
1596
Heiko Schochere1ba1512014-03-18 08:09:56 +01001597 DFU_DEFAULT_POLL_TIMEOUT
1598 Poll timeout [ms], is the timeout a device can send to the
1599 host. The host must wait for this timeout before sending
1600 a subsequent DFU_GET_STATUS request to the device.
1601
1602 DFU_MANIFEST_POLL_TIMEOUT
1603 Poll timeout [ms], which the device sends to the host when
1604 entering dfuMANIFEST state. Host waits this timeout, before
1605 sending again an USB request to the device.
1606
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001607- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001608 CONFIG_USB_FUNCTION_FASTBOOT
1609 This enables the USB part of the fastboot gadget
1610
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001611 CONFIG_CMD_FASTBOOT
1612 This enables the command "fastboot" which enables the Android
1613 fastboot mode for the platform's USB device. Fastboot is a USB
1614 protocol for downloading images, flashing and device control
1615 used on Android devices.
1616 See doc/README.android-fastboot for more information.
1617
1618 CONFIG_ANDROID_BOOT_IMAGE
1619 This enables support for booting images which use the Android
1620 image format header.
1621
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001622 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001623 The fastboot protocol requires a large memory buffer for
1624 downloads. Define this to the starting RAM address to use for
1625 downloaded images.
1626
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001627 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001628 The fastboot protocol requires a large memory buffer for
1629 downloads. This buffer should be as large as possible for a
1630 platform. Define this to the size available RAM for fastboot.
1631
Steve Raebfb9ba42014-08-26 11:47:28 -07001632 CONFIG_FASTBOOT_FLASH
1633 The fastboot protocol includes a "flash" command for writing
1634 the downloaded image to a non-volatile storage device. Define
1635 this to enable the "fastboot flash" command.
1636
1637 CONFIG_FASTBOOT_FLASH_MMC_DEV
1638 The fastboot "flash" command requires additional information
1639 regarding the non-volatile storage device. Define this to
1640 the eMMC device that fastboot should use to store the image.
1641
Steve Rae7d059342014-12-12 15:51:54 -08001642 CONFIG_FASTBOOT_GPT_NAME
1643 The fastboot "flash" command supports writing the downloaded
1644 image to the Protective MBR and the Primary GUID Partition
1645 Table. (Additionally, this downloaded image is post-processed
1646 to generate and write the Backup GUID Partition Table.)
1647 This occurs when the specified "partition name" on the
1648 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001649 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001650
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001651 CONFIG_FASTBOOT_MBR_NAME
1652 The fastboot "flash" command supports writing the downloaded
1653 image to DOS MBR.
1654 This occurs when the "partition name" specified on the
1655 "fastboot flash" command line matches this value.
1656 If not defined the default value "mbr" is used.
1657
wdenkda04a8b2004-08-02 23:22:59 +00001658- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001659 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001660 Define these for a default partition on a NAND device
1661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001662 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1663 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001664 Define these for a default partition on a NOR device
1665
Donggeun Kim8f814002011-10-24 21:15:28 +00001666- FAT(File Allocation Table) filesystem write function support:
1667 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001668
1669 Define this to enable support for saving memory data as a
1670 file in FAT formatted partition.
1671
1672 This will also enable the command "fatwrite" enabling the
1673 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001674
Gabe Black7f8574c2012-10-12 14:26:11 +00001675CBFS (Coreboot Filesystem) support
1676 CONFIG_CMD_CBFS
1677
1678 Define this to enable support for reading from a Coreboot
1679 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1680 and cbfsload.
1681
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301682- FAT(File Allocation Table) filesystem cluster size:
1683 CONFIG_FS_FAT_MAX_CLUSTSIZE
1684
1685 Define the max cluster size for fat operations else
1686 a default value of 65536 will be defined.
1687
wdenkc6097192002-11-03 00:24:07 +00001688- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001689 See Kconfig help for available keyboard drivers.
1690
1691 CONFIG_KEYBOARD
1692
1693 Define this to enable a custom keyboard support.
1694 This simply calls drv_keyboard_init() which must be
1695 defined in your board-specific files. This option is deprecated
1696 and is only used by novena. For new boards, use driver model
1697 instead.
wdenkc6097192002-11-03 00:24:07 +00001698
1699- Video support:
1700 CONFIG_VIDEO
1701
1702 Define this to enable video support (for output to
1703 video).
1704
1705 CONFIG_VIDEO_CT69000
1706
1707 Enable Chips & Technologies 69000 Video chip
1708
1709 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001710 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001711 video output is selected via environment 'videoout'
1712 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1713 assumed.
wdenkc6097192002-11-03 00:24:07 +00001714
wdenkd3602132004-03-25 15:14:43 +00001715 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001716 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001717 are possible:
1718 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001719 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001720
1721 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1722 -------------+---------------------------------------------
1723 8 bits | 0x301* 0x303 0x305 0x161 0x307
1724 15 bits | 0x310 0x313 0x316 0x162 0x319
1725 16 bits | 0x311 0x314 0x317 0x163 0x31A
1726 24 bits | 0x312 0x315 0x318 ? 0x31B
1727 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001728 (i.e. setenv videomode 317; saveenv; reset;)
1729
wdenkd3602132004-03-25 15:14:43 +00001730 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001731 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001732
1733
stroeseb9c17c52003-04-04 15:53:41 +00001734 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001735 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001736 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1737 or CONFIG_VIDEO_SED13806_16BPP
1738
Timur Tabi020edd22011-02-15 17:09:19 -06001739 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001740 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001741 SOCs that have a DIU should define this macro to enable DIU
1742 support, and should also define these other macros:
1743
1744 CONFIG_SYS_DIU_ADDR
1745 CONFIG_VIDEO
1746 CONFIG_CMD_BMP
1747 CONFIG_CFB_CONSOLE
1748 CONFIG_VIDEO_SW_CURSOR
1749 CONFIG_VGA_AS_SINGLE_DEVICE
1750 CONFIG_VIDEO_LOGO
1751 CONFIG_VIDEO_BMP_LOGO
1752
Timur Tabi32f709e2011-04-11 14:18:22 -05001753 The DIU driver will look for the 'video-mode' environment
1754 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001755 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001756 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001757
wdenkc6097192002-11-03 00:24:07 +00001758- LCD Support: CONFIG_LCD
1759
1760 Define this to enable LCD support (for output to LCD
1761 display); also select one of the supported displays
1762 by defining one of these:
1763
Stelian Popf6f86652008-05-09 21:57:18 +02001764 CONFIG_ATMEL_LCD:
1765
1766 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1767
wdenkc0d54ae2003-11-25 16:55:19 +00001768 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001769
wdenkc0d54ae2003-11-25 16:55:19 +00001770 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001771
wdenkc0d54ae2003-11-25 16:55:19 +00001772 CONFIG_NEC_NL6448BC20
1773
1774 NEC NL6448BC20-08. 6.5", 640x480.
1775 Active, color, single scan.
1776
1777 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001778
wdenkc0d54ae2003-11-25 16:55:19 +00001779 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001780 Active, color, single scan.
1781
1782 CONFIG_SHARP_16x9
1783
1784 Sharp 320x240. Active, color, single scan.
1785 It isn't 16x9, and I am not sure what it is.
1786
1787 CONFIG_SHARP_LQ64D341
1788
1789 Sharp LQ64D341 display, 640x480.
1790 Active, color, single scan.
1791
1792 CONFIG_HLD1045
1793
1794 HLD1045 display, 640x480.
1795 Active, color, single scan.
1796
1797 CONFIG_OPTREX_BW
1798
1799 Optrex CBL50840-2 NF-FW 99 22 M5
1800 or
1801 Hitachi LMG6912RPFC-00T
1802 or
1803 Hitachi SP14Q002
1804
1805 320x240. Black & white.
1806
1807 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001808 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001809
Simon Glass599a4df2012-10-17 13:24:54 +00001810 CONFIG_LCD_ALIGNMENT
1811
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001812 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001813 defined then the LCD will be aligned to this value instead.
1814 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1815 here, since it is cheaper to change data cache settings on
1816 a per-section basis.
1817
Simon Glassaf3e2802012-10-17 13:24:59 +00001818 CONFIG_CONSOLE_SCROLL_LINES
1819
1820 When the console need to be scrolled, this is the number of
1821 lines to scroll by. It defaults to 1. Increasing this makes
1822 the console jump but can help speed up operation when scrolling
1823 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001824
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001825 CONFIG_LCD_ROTATION
1826
1827 Sometimes, for example if the display is mounted in portrait
1828 mode or even if it's mounted landscape but rotated by 180degree,
1829 we need to rotate our content of the display relative to the
1830 framebuffer, so that user can read the messages which are
1831 printed out.
1832 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1833 initialized with a given rotation from "vl_rot" out of
1834 "vidinfo_t" which is provided by the board specific code.
1835 The value for vl_rot is coded as following (matching to
1836 fbcon=rotate:<n> linux-kernel commandline):
1837 0 = no rotation respectively 0 degree
1838 1 = 90 degree rotation
1839 2 = 180 degree rotation
1840 3 = 270 degree rotation
1841
1842 If CONFIG_LCD_ROTATION is not defined, the console will be
1843 initialized with 0degree rotation.
1844
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001845 CONFIG_LCD_BMP_RLE8
1846
1847 Support drawing of RLE8-compressed bitmaps on the LCD.
1848
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001849 CONFIG_I2C_EDID
1850
1851 Enables an 'i2c edid' command which can read EDID
1852 information over I2C from an attached LCD display.
1853
wdenkeb20ad32003-09-05 23:19:14 +00001854- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001855
wdenk57b2d802003-06-27 21:31:46 +00001856 If this option is set, the environment is checked for
1857 a variable "splashimage". If found, the usual display
1858 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001859 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001860 specified in "splashimage" is loaded instead. The
1861 console is redirected to the "nulldev", too. This
1862 allows for a "silent" boot where a splash screen is
1863 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001864
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001865 CONFIG_SPLASHIMAGE_GUARD
1866
1867 If this option is set, then U-Boot will prevent the environment
1868 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001869 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001870 This option is useful for targets where, due to alignment
1871 restrictions, an improperly aligned BMP image will cause a data
1872 abort. If you think you will not have problems with unaligned
1873 accesses (for example because your toolchain prevents them)
1874 there is no need to set this option.
1875
Matthias Weisser53884182009-07-09 16:07:30 +02001876 CONFIG_SPLASH_SCREEN_ALIGN
1877
1878 If this option is set the splash image can be freely positioned
1879 on the screen. Environment variable "splashpos" specifies the
1880 position as "x,y". If a positive number is given it is used as
1881 number of pixel from left/top. If a negative number is given it
1882 is used as number of pixel from right/bottom. You can also
1883 specify 'm' for centering the image.
1884
1885 Example:
1886 setenv splashpos m,m
1887 => image at center of screen
1888
1889 setenv splashpos 30,20
1890 => image at x = 30 and y = 20
1891
1892 setenv splashpos -10,m
1893 => vertically centered image
1894 at x = dspWidth - bmpWidth - 9
1895
Stefan Roesed9d97742005-09-22 09:04:17 +02001896- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1897
1898 If this option is set, additionally to standard BMP
1899 images, gzipped BMP images can be displayed via the
1900 splashscreen support or the bmp command.
1901
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001902- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1903
1904 If this option is set, 8-bit RLE compressed BMP images
1905 can be displayed via the splashscreen support or the
1906 bmp command.
1907
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001908- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001909 CONFIG_CMD_ZIP
1910
1911 If this option is set, it would use zlib deflate method
1912 to compress the specified memory at its best effort.
1913
wdenk710e3502003-08-29 20:57:53 +00001914- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001915 CONFIG_GZIP
1916
1917 Enabled by default to support gzip compressed images.
1918
wdenk710e3502003-08-29 20:57:53 +00001919 CONFIG_BZIP2
1920
1921 If this option is set, support for bzip2 compressed
1922 images is included. If not, only uncompressed and gzip
1923 compressed images are supported.
1924
wdenk9c53f402003-10-15 23:53:47 +00001925 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001926 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001927 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001928
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001929 CONFIG_LZMA
1930
1931 If this option is set, support for lzma compressed
1932 images is included.
1933
1934 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1935 requires an amount of dynamic memory that is given by the
1936 formula:
1937
1938 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1939
1940 Where lc and lp stand for, respectively, Literal context bits
1941 and Literal pos bits.
1942
1943 This value is upper-bounded by 14MB in the worst case. Anyway,
1944 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1945 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1946 a very small buffer.
1947
1948 Use the lzmainfo tool to determinate the lc and lp values and
1949 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001950 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001951
Kees Cook5b06e642013-08-16 07:59:12 -07001952 CONFIG_LZO
1953
1954 If this option is set, support for LZO compressed images
1955 is included.
1956
wdenk0e2bd9c2004-06-06 21:51:03 +00001957- MII/PHY support:
1958 CONFIG_PHY_ADDR
1959
1960 The address of PHY on MII bus.
1961
1962 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1963
1964 The clock frequency of the MII bus
1965
1966 CONFIG_PHY_GIGE
1967
1968 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001969 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001970
1971 CONFIG_PHY_RESET_DELAY
1972
1973 Some PHY like Intel LXT971A need extra delay after
1974 reset before any MII register access is possible.
1975 For such PHY, set this option to the usec delay
1976 required. (minimum 300usec for LXT971A)
1977
1978 CONFIG_PHY_CMD_DELAY (ppc4xx)
1979
1980 Some PHY like Intel LXT971A need extra delay after
1981 command issued before MII status register can be read
1982
wdenkc6097192002-11-03 00:24:07 +00001983- IP address:
1984 CONFIG_IPADDR
1985
1986 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001987 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001988 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001989 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001990
1991- Server IP address:
1992 CONFIG_SERVERIP
1993
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001994 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001995 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001996 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001997
Robin Getz470a6d42009-07-21 12:15:28 -04001998 CONFIG_KEEP_SERVERADDR
1999
2000 Keeps the server's MAC address, in the env 'serveraddr'
2001 for passing to bootargs (like Linux's netconsole option)
2002
Wolfgang Denk26da2992011-10-26 10:21:22 +00002003- Gateway IP address:
2004 CONFIG_GATEWAYIP
2005
2006 Defines a default value for the IP address of the
2007 default router where packets to other networks are
2008 sent to.
2009 (Environment variable "gatewayip")
2010
2011- Subnet mask:
2012 CONFIG_NETMASK
2013
2014 Defines a default value for the subnet mask (or
2015 routing prefix) which is used to determine if an IP
2016 address belongs to the local subnet or needs to be
2017 forwarded through a router.
2018 (Environment variable "netmask")
2019
David Updegraff7280da72007-06-11 10:41:07 -05002020- Multicast TFTP Mode:
2021 CONFIG_MCAST_TFTP
2022
2023 Defines whether you want to support multicast TFTP as per
2024 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002025 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002026 driver in use must provide a function: mcast() to join/leave a
2027 multicast group.
2028
wdenkc6097192002-11-03 00:24:07 +00002029- BOOTP Recovery Mode:
2030 CONFIG_BOOTP_RANDOM_DELAY
2031
2032 If you have many targets in a network that try to
2033 boot using BOOTP, you may want to avoid that all
2034 systems send out BOOTP requests at precisely the same
2035 moment (which would happen for instance at recovery
2036 from a power failure, when all systems will try to
2037 boot, thus flooding the BOOTP server. Defining
2038 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2039 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002040 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002041
2042 1st BOOTP request: delay 0 ... 1 sec
2043 2nd BOOTP request: delay 0 ... 2 sec
2044 3rd BOOTP request: delay 0 ... 4 sec
2045 4th and following
2046 BOOTP requests: delay 0 ... 8 sec
2047
Thierry Reding8977cda2014-08-19 10:21:24 +02002048 CONFIG_BOOTP_ID_CACHE_SIZE
2049
2050 BOOTP packets are uniquely identified using a 32-bit ID. The
2051 server will copy the ID from client requests to responses and
2052 U-Boot will use this to determine if it is the destination of
2053 an incoming response. Some servers will check that addresses
2054 aren't in use before handing them out (usually using an ARP
2055 ping) and therefore take up to a few hundred milliseconds to
2056 respond. Network congestion may also influence the time it
2057 takes for a response to make it back to the client. If that
2058 time is too long, U-Boot will retransmit requests. In order
2059 to allow earlier responses to still be accepted after these
2060 retransmissions, U-Boot's BOOTP client keeps a small cache of
2061 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2062 cache. The default is to keep IDs for up to four outstanding
2063 requests. Increasing this will allow U-Boot to accept offers
2064 from a BOOTP client in networks with unusually high latency.
2065
stroesee0aadfb2003-08-28 14:17:32 +00002066- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002067 You can fine tune the DHCP functionality by defining
2068 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002069
Jon Loeliger5336a762007-07-09 22:08:34 -05002070 CONFIG_BOOTP_SUBNETMASK
2071 CONFIG_BOOTP_GATEWAY
2072 CONFIG_BOOTP_HOSTNAME
2073 CONFIG_BOOTP_NISDOMAIN
2074 CONFIG_BOOTP_BOOTPATH
2075 CONFIG_BOOTP_BOOTFILESIZE
2076 CONFIG_BOOTP_DNS
2077 CONFIG_BOOTP_DNS2
2078 CONFIG_BOOTP_SEND_HOSTNAME
2079 CONFIG_BOOTP_NTPSERVER
2080 CONFIG_BOOTP_TIMEOFFSET
2081 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002082 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002083
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002084 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2085 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002086
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002087 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2088 after the configured retry count, the call will fail
2089 instead of starting over. This can be used to fail over
2090 to Link-local IP address configuration if the DHCP server
2091 is not available.
2092
stroesee0aadfb2003-08-28 14:17:32 +00002093 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2094 serverip from a DHCP server, it is possible that more
2095 than one DNS serverip is offered to the client.
2096 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2097 serverip will be stored in the additional environment
2098 variable "dnsip2". The first DNS serverip is always
2099 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002100 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002101
2102 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2103 to do a dynamic update of a DNS server. To do this, they
2104 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002105 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002106 of the "hostname" environment variable is passed as
2107 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002108
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002109 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2110
2111 A 32bit value in microseconds for a delay between
2112 receiving a "DHCP Offer" and sending the "DHCP Request".
2113 This fixes a problem with certain DHCP servers that don't
2114 respond 100% of the time to a "DHCP request". E.g. On an
2115 AT91RM9200 processor running at 180MHz, this delay needed
2116 to be *at least* 15,000 usec before a Windows Server 2003
2117 DHCP server would reply 100% of the time. I recommend at
2118 least 50,000 usec to be safe. The alternative is to hope
2119 that one of the retries will be successful but note that
2120 the DHCP timeout and retry process takes a longer than
2121 this delay.
2122
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002123 - Link-local IP address negotiation:
2124 Negotiate with other link-local clients on the local network
2125 for an address that doesn't require explicit configuration.
2126 This is especially useful if a DHCP server cannot be guaranteed
2127 to exist in all environments that the device must operate.
2128
2129 See doc/README.link-local for more information.
2130
wdenk145d2c12004-04-15 21:48:45 +00002131 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002132 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002133
2134 The device id used in CDP trigger frames.
2135
2136 CONFIG_CDP_DEVICE_ID_PREFIX
2137
2138 A two character string which is prefixed to the MAC address
2139 of the device.
2140
2141 CONFIG_CDP_PORT_ID
2142
2143 A printf format string which contains the ascii name of
2144 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002145 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002146
2147 CONFIG_CDP_CAPABILITIES
2148
2149 A 32bit integer which indicates the device capabilities;
2150 0x00000010 for a normal host which does not forwards.
2151
2152 CONFIG_CDP_VERSION
2153
2154 An ascii string containing the version of the software.
2155
2156 CONFIG_CDP_PLATFORM
2157
2158 An ascii string containing the name of the platform.
2159
2160 CONFIG_CDP_TRIGGER
2161
2162 A 32bit integer sent on the trigger.
2163
2164 CONFIG_CDP_POWER_CONSUMPTION
2165
2166 A 16bit integer containing the power consumption of the
2167 device in .1 of milliwatts.
2168
2169 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2170
2171 A byte containing the id of the VLAN.
2172
wdenkc6097192002-11-03 00:24:07 +00002173- Status LED: CONFIG_STATUS_LED
2174
2175 Several configurations allow to display the current
2176 status using a LED. For instance, the LED will blink
2177 fast while running U-Boot code, stop blinking as
2178 soon as a reply to a BOOTP request was received, and
2179 start blinking slow once the Linux kernel is running
2180 (supported by a status LED driver in the Linux
2181 kernel). Defining CONFIG_STATUS_LED enables this
2182 feature in U-Boot.
2183
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002184 Additional options:
2185
2186 CONFIG_GPIO_LED
2187 The status LED can be connected to a GPIO pin.
2188 In such cases, the gpio_led driver can be used as a
2189 status LED backend implementation. Define CONFIG_GPIO_LED
2190 to include the gpio_led driver in the U-Boot binary.
2191
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002192 CONFIG_GPIO_LED_INVERTED_TABLE
2193 Some GPIO connected LEDs may have inverted polarity in which
2194 case the GPIO high value corresponds to LED off state and
2195 GPIO low value corresponds to LED on state.
2196 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2197 with a list of GPIO LEDs that have inverted polarity.
2198
wdenkc6097192002-11-03 00:24:07 +00002199- CAN Support: CONFIG_CAN_DRIVER
2200
2201 Defining CONFIG_CAN_DRIVER enables CAN driver support
2202 on those systems that support this (optional)
2203 feature, like the TQM8xxL modules.
2204
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002205- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002206
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002207 This enable the NEW i2c subsystem, and will allow you to use
2208 i2c commands at the u-boot command line (as long as you set
2209 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2210 based realtime clock chips or other i2c devices. See
2211 common/cmd_i2c.c for a description of the command line
2212 interface.
2213
2214 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002215 - drivers/i2c/soft_i2c.c:
2216 - activate first bus with CONFIG_SYS_I2C_SOFT define
2217 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2218 for defining speed and slave address
2219 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2220 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2221 for defining speed and slave address
2222 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2223 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2224 for defining speed and slave address
2225 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2226 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2227 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002228
Heiko Schocherf2850742012-10-24 13:48:22 +02002229 - drivers/i2c/fsl_i2c.c:
2230 - activate i2c driver with CONFIG_SYS_I2C_FSL
2231 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2232 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2233 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2234 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002235 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002236 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2237 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2238 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2239 second bus.
2240
Simon Glass026fefb2012-10-30 07:28:53 +00002241 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002242 - activate this driver with CONFIG_SYS_I2C_TEGRA
2243 - This driver adds 4 i2c buses with a fix speed from
2244 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002245
Dirk Eibach42b204f2013-04-25 02:40:01 +00002246 - drivers/i2c/ppc4xx_i2c.c
2247 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2248 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2249 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2250
trema49f40a2013-09-21 18:13:35 +02002251 - drivers/i2c/i2c_mxc.c
2252 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002253 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2254 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2255 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2256 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002257 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2258 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2259 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2260 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2261 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2262 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002263 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2264 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002265 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002266 for speed, and 0 for slave.
2267
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002268 - drivers/i2c/rcar_i2c.c:
2269 - activate this driver with CONFIG_SYS_I2C_RCAR
2270 - This driver adds 4 i2c buses
2271
2272 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2273 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2274 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2275 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2276 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2277 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2278 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2279 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2280 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2281
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002282 - drivers/i2c/sh_i2c.c:
2283 - activate this driver with CONFIG_SYS_I2C_SH
2284 - This driver adds from 2 to 5 i2c buses
2285
2286 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2287 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2288 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2289 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2290 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2291 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2292 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2293 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2294 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2295 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2296 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2297 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002298 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002299
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002300 - drivers/i2c/omap24xx_i2c.c
2301 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2302 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2303 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2304 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2305 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2306 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2307 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2308 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2309 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2310 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2311 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2312
Heiko Schocher465819a2013-11-08 07:30:53 +01002313 - drivers/i2c/zynq_i2c.c
2314 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2315 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2316 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2317
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302318 - drivers/i2c/s3c24x0_i2c.c:
2319 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2320 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2321 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2322 with a fix speed from 100000 and the slave addr 0!
2323
Dirk Eibachb9577432014-07-03 09:28:18 +02002324 - drivers/i2c/ihs_i2c.c
2325 - activate this driver with CONFIG_SYS_I2C_IHS
2326 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2327 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2328 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2329 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2330 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2331 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2332 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2333 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2334 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2335 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2336 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2337 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002338 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2339 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2340 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2341 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2342 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2343 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2344 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2345 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2346 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002347
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002348 additional defines:
2349
2350 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002351 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002352 don't use/have i2c muxes on your i2c bus, this
2353 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2354 omit this define.
2355
2356 CONFIG_SYS_I2C_DIRECT_BUS
2357 define this, if you don't use i2c muxes on your hardware.
2358 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2359 omit this define.
2360
2361 CONFIG_SYS_I2C_MAX_HOPS
2362 define how many muxes are maximal consecutively connected
2363 on one i2c bus. If you not use i2c muxes, omit this
2364 define.
2365
2366 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002367 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002368 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2369 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2370 CONFIG_SYS_NUM_I2C_BUSES = 9:
2371
2372 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2373 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2374 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2375 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2376 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2377 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2378 {1, {I2C_NULL_HOP}}, \
2379 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2380 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2381 }
2382
2383 which defines
2384 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002385 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2386 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2387 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2388 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2389 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002390 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002391 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2392 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002393
2394 If you do not have i2c muxes on your board, omit this define.
2395
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002396- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002397
2398 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2399 provides the following compelling advantages:
2400
2401 - more than one i2c adapter is usable
2402 - approved multibus support
2403 - better i2c mux support
2404
2405 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002406
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002407 These enable legacy I2C serial bus commands. Defining
2408 CONFIG_HARD_I2C will include the appropriate I2C driver
2409 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002410
wdenk21136db2003-07-16 21:53:01 +00002411 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002412 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002413 CONFIG_COMMANDS) and communicate with i2c based realtime
2414 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002415 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002416
Ben Warren45657152006-09-07 16:50:54 -04002417 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002418
wdenk21136db2003-07-16 21:53:01 +00002419 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002420 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002421
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002422 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002423 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002424 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002425 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002426
Peter Tysere4d1abc2010-04-12 22:28:21 -05002427 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002428 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002429 and so its address should therefore be cleared to 0 (See,
2430 eg, MPC823e User's Manual p.16-473). So, set
2431 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002432
Eric Millbrandt12990a42009-09-03 08:09:44 -05002433 CONFIG_SYS_I2C_INIT_MPC5XXX
2434
2435 When a board is reset during an i2c bus transfer
2436 chips might think that the current transfer is still
2437 in progress. Reset the slave devices by sending start
2438 commands until the slave device responds.
2439
wdenk21136db2003-07-16 21:53:01 +00002440 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002441
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002442 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002443 then the following macros need to be defined (examples are
2444 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002445
2446 I2C_INIT
2447
wdenkb9bbd242003-06-30 16:24:52 +00002448 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002449 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002450
wdenk544e9732004-02-06 23:19:44 +00002451 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002452
wdenkc6097192002-11-03 00:24:07 +00002453 I2C_PORT
2454
wdenk4a5c8a72003-03-06 00:02:04 +00002455 (Only for MPC8260 CPU). The I/O port to use (the code
2456 assumes both bits are on the same port). Valid values
2457 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002458
2459 I2C_ACTIVE
2460
2461 The code necessary to make the I2C data line active
2462 (driven). If the data line is open collector, this
2463 define can be null.
2464
wdenkb9bbd242003-06-30 16:24:52 +00002465 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2466
wdenkc6097192002-11-03 00:24:07 +00002467 I2C_TRISTATE
2468
2469 The code necessary to make the I2C data line tri-stated
2470 (inactive). If the data line is open collector, this
2471 define can be null.
2472
wdenkb9bbd242003-06-30 16:24:52 +00002473 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2474
wdenkc6097192002-11-03 00:24:07 +00002475 I2C_READ
2476
York Sun4a598092013-04-01 11:29:11 -07002477 Code that returns true if the I2C data line is high,
2478 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002479
wdenkb9bbd242003-06-30 16:24:52 +00002480 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2481
wdenkc6097192002-11-03 00:24:07 +00002482 I2C_SDA(bit)
2483
York Sun4a598092013-04-01 11:29:11 -07002484 If <bit> is true, sets the I2C data line high. If it
2485 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002486
wdenkb9bbd242003-06-30 16:24:52 +00002487 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002488 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002489 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002490
wdenkc6097192002-11-03 00:24:07 +00002491 I2C_SCL(bit)
2492
York Sun4a598092013-04-01 11:29:11 -07002493 If <bit> is true, sets the I2C clock line high. If it
2494 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002495
wdenkb9bbd242003-06-30 16:24:52 +00002496 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002497 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002498 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002499
wdenkc6097192002-11-03 00:24:07 +00002500 I2C_DELAY
2501
2502 This delay is invoked four times per clock cycle so this
2503 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002504 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002505 like:
2506
wdenkb9bbd242003-06-30 16:24:52 +00002507 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002508
Mike Frysingeree12d542010-07-21 13:38:02 -04002509 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2510
2511 If your arch supports the generic GPIO framework (asm/gpio.h),
2512 then you may alternatively define the two GPIOs that are to be
2513 used as SCL / SDA. Any of the previous I2C_xxx macros will
2514 have GPIO-based defaults assigned to them as appropriate.
2515
2516 You should define these to the GPIO value as given directly to
2517 the generic GPIO functions.
2518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002519 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002520
wdenk57b2d802003-06-27 21:31:46 +00002521 When a board is reset during an i2c bus transfer
2522 chips might think that the current transfer is still
2523 in progress. On some boards it is possible to access
2524 the i2c SCLK line directly, either by using the
2525 processor pin as a GPIO or by having a second pin
2526 connected to the bus. If this option is defined a
2527 custom i2c_init_board() routine in boards/xxx/board.c
2528 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002529
Richard Retanubundf0149c2010-04-12 15:08:17 -04002530 CONFIG_SYS_I2C_BOARD_LATE_INIT
2531
2532 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2533 defined a custom i2c_board_late_init() routine in
2534 boards/xxx/board.c is run AFTER the operations in i2c_init()
2535 is completed. This callpoint can be used to unreset i2c bus
2536 using CPU i2c controller register accesses for CPUs whose i2c
2537 controller provide such a method. It is called at the end of
2538 i2c_init() to allow i2c_init operations to setup the i2c bus
2539 controller on the CPU (e.g. setting bus speed & slave address).
2540
wdenk0e2bd9c2004-06-06 21:51:03 +00002541 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2542
2543 This option enables configuration of bi_iic_fast[] flags
2544 in u-boot bd_info structure based on u-boot environment
2545 variable "i2cfast". (see also i2cfast)
2546
Ben Warren45657152006-09-07 16:50:54 -04002547 CONFIG_I2C_MULTI_BUS
2548
2549 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002550 must have a controller. At any point in time, only one bus is
2551 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002552 Note that bus numbering is zero-based.
2553
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002554 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002555
2556 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002557 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002558 is set, specify a list of bus-device pairs. Otherwise, specify
2559 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002560
2561 e.g.
2562 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002563 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002564
2565 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2566
Wolfgang Denk092ae952011-10-26 10:21:21 +00002567 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002568 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002569
2570 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2571
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002572 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002573
2574 If defined, then this indicates the I2C bus number for DDR SPD.
2575 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2576
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002577 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002578
2579 If defined, then this indicates the I2C bus number for the RTC.
2580 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2581
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002582 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002583
2584 If defined, then this indicates the I2C bus number for the DTT.
2585 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2586
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002587 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002588
2589 If defined, specifies the I2C address of the DTT device.
2590 If not defined, then U-Boot uses predefined value for
2591 specified DTT device.
2592
Andrew Dyer58c41f92008-12-29 17:36:01 -06002593 CONFIG_SOFT_I2C_READ_REPEATED_START
2594
2595 defining this will force the i2c_read() function in
2596 the soft_i2c driver to perform an I2C repeated start
2597 between writing the address pointer and reading the
2598 data. If this define is omitted the default behaviour
2599 of doing a stop-start sequence will be used. Most I2C
2600 devices can use either method, but some require one or
2601 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002602
wdenkc6097192002-11-03 00:24:07 +00002603- SPI Support: CONFIG_SPI
2604
2605 Enables SPI driver (so far only tested with
2606 SPI EEPROM, also an instance works with Crystal A/D and
2607 D/As on the SACSng board)
2608
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002609 CONFIG_SH_SPI
2610
2611 Enables the driver for SPI controller on SuperH. Currently
2612 only SH7757 is supported.
2613
wdenkc6097192002-11-03 00:24:07 +00002614 CONFIG_SOFT_SPI
2615
wdenk4a5c8a72003-03-06 00:02:04 +00002616 Enables a software (bit-bang) SPI driver rather than
2617 using hardware support. This is a general purpose
2618 driver that only requires three general I/O port pins
2619 (two outputs, one input) to function. If this is
2620 defined, the board configuration must define several
2621 SPI configuration items (port pins to use, etc). For
2622 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002623
Ben Warren7efe9272008-01-16 22:37:35 -05002624 CONFIG_HARD_SPI
2625
2626 Enables a hardware SPI driver for general-purpose reads
2627 and writes. As with CONFIG_SOFT_SPI, the board configuration
2628 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002629 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002630 example, see include/configs/mpc8349emds.h.
2631
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002632 CONFIG_MXC_SPI
2633
2634 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002635 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002636
Heiko Schocherb77c8882014-07-14 10:22:11 +02002637 CONFIG_SYS_SPI_MXC_WAIT
2638 Timeout for waiting until spi transfer completed.
2639 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2640
Matthias Fuchsa4400872007-12-27 17:12:34 +01002641- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002642
Matthias Fuchsa4400872007-12-27 17:12:34 +01002643 Enables FPGA subsystem.
2644
2645 CONFIG_FPGA_<vendor>
2646
2647 Enables support for specific chip vendors.
2648 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002649
Matthias Fuchsa4400872007-12-27 17:12:34 +01002650 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002651
Matthias Fuchsa4400872007-12-27 17:12:34 +01002652 Enables support for FPGA family.
2653 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2654
2655 CONFIG_FPGA_COUNT
2656
2657 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002658
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302659 CONFIG_CMD_FPGA_LOADMK
2660
2661 Enable support for fpga loadmk command
2662
Michal Simek64c70982014-05-02 13:43:39 +02002663 CONFIG_CMD_FPGA_LOADP
2664
2665 Enable support for fpga loadp command - load partial bitstream
2666
2667 CONFIG_CMD_FPGA_LOADBP
2668
2669 Enable support for fpga loadbp command - load partial bitstream
2670 (Xilinx only)
2671
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002672 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002673
wdenk57b2d802003-06-27 21:31:46 +00002674 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002675
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002676 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002677
wdenk4a5c8a72003-03-06 00:02:04 +00002678 Enable checks on FPGA configuration interface busy
2679 status by the configuration function. This option
2680 will require a board or device specific function to
2681 be written.
wdenkc6097192002-11-03 00:24:07 +00002682
2683 CONFIG_FPGA_DELAY
2684
2685 If defined, a function that provides delays in the FPGA
2686 configuration driver.
2687
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002688 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002689 Allow Control-C to interrupt FPGA configuration
2690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002691 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002692
wdenk4a5c8a72003-03-06 00:02:04 +00002693 Check for configuration errors during FPGA bitfile
2694 loading. For example, abort during Virtex II
2695 configuration if the INIT_B line goes low (which
2696 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002697
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002698 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002699
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002700 Maximum time to wait for the INIT_B line to de-assert
2701 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002702 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002703 ms.
wdenkc6097192002-11-03 00:24:07 +00002704
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002705 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002706
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002707 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002708 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002710 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002711
wdenk4a5c8a72003-03-06 00:02:04 +00002712 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002713 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002714
2715- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002716 CONFIG_BUILD_TARGET
2717
2718 Some SoCs need special image types (e.g. U-Boot binary
2719 with a special header) as build targets. By defining
2720 CONFIG_BUILD_TARGET in the SoC / board header, this
2721 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002722 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002723
wdenkc6097192002-11-03 00:24:07 +00002724 CONFIG_IDENT_STRING
2725
wdenk4a5c8a72003-03-06 00:02:04 +00002726 If defined, this string will be added to the U-Boot
2727 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002728
2729- Vendor Parameter Protection:
2730
wdenk4a5c8a72003-03-06 00:02:04 +00002731 U-Boot considers the values of the environment
2732 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002733 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002734 are set once by the board vendor / manufacturer, and
2735 protects these variables from casual modification by
2736 the user. Once set, these variables are read-only,
2737 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002738 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002739
2740 If CONFIG_ENV_OVERWRITE is #defined in your config
2741 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002742 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002743 these parameters.
2744
Joe Hershberger76f353e2015-05-04 14:55:14 -05002745 Alternatively, if you define _both_ an ethaddr in the
2746 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002747 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002748 which can be changed exactly ONCE by the user. [The
2749 serial# is unaffected by this, i. e. it remains
2750 read-only.]
2751
Joe Hershberger71497d02012-12-11 22:16:31 -06002752 The same can be accomplished in a more flexible way
2753 for any variable by configuring the type of access
2754 to allow for those variables in the ".flags" variable
2755 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2756
wdenkc6097192002-11-03 00:24:07 +00002757- Protected RAM:
2758 CONFIG_PRAM
2759
2760 Define this variable to enable the reservation of
2761 "protected RAM", i. e. RAM which is not overwritten
2762 by U-Boot. Define CONFIG_PRAM to hold the number of
2763 kB you want to reserve for pRAM. You can overwrite
2764 this default value by defining an environment
2765 variable "pram" to the number of kB you want to
2766 reserve. Note that the board info structure will
2767 still show the full amount of RAM. If pRAM is
2768 reserved, a new environment variable "mem" will
2769 automatically be defined to hold the amount of
2770 remaining RAM in a form that can be passed as boot
2771 argument to Linux, for instance like that:
2772
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002773 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002774 saveenv
2775
2776 This way you can tell Linux not to use this memory,
2777 either, which results in a memory region that will
2778 not be affected by reboots.
2779
2780 *WARNING* If your board configuration uses automatic
2781 detection of the RAM size, you must make sure that
2782 this memory test is non-destructive. So far, the
2783 following board configurations are known to be
2784 "pRAM-clean":
2785
Wolfgang Denk90326762012-10-24 02:36:15 +00002786 IVMS8, IVML24, SPD8xx, TQM8xxL,
2787 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002788 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002789
Gabe Blacka2f3a932012-12-02 04:55:18 +00002790- Access to physical memory region (> 4GB)
2791 Some basic support is provided for operations on memory not
2792 normally accessible to U-Boot - e.g. some architectures
2793 support access to more than 4GB of memory on 32-bit
2794 machines using physical address extension or similar.
2795 Define CONFIG_PHYSMEM to access this basic support, which
2796 currently only supports clearing the memory.
2797
wdenkc6097192002-11-03 00:24:07 +00002798- Error Recovery:
2799 CONFIG_PANIC_HANG
2800
2801 Define this variable to stop the system in case of a
2802 fatal error, so that you have to reset it manually.
2803 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002804 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002805 automatically as fast as possible, but it may be
2806 useful during development since you can try to debug
2807 the conditions that lead to the situation.
2808
2809 CONFIG_NET_RETRY_COUNT
2810
wdenk4a5c8a72003-03-06 00:02:04 +00002811 This variable defines the number of retries for
2812 network operations like ARP, RARP, TFTP, or BOOTP
2813 before giving up the operation. If not defined, a
2814 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002815
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002816 CONFIG_ARP_TIMEOUT
2817
2818 Timeout waiting for an ARP reply in milliseconds.
2819
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002820 CONFIG_NFS_TIMEOUT
2821
2822 Timeout in milliseconds used in NFS protocol.
2823 If you encounter "ERROR: Cannot umount" in nfs command,
2824 try longer timeout such as
2825 #define CONFIG_NFS_TIMEOUT 10000UL
2826
wdenkc6097192002-11-03 00:24:07 +00002827- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002828 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002829
2830 Enable auto completion of commands using TAB.
2831
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002832 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002833
2834 This defines the secondary prompt string, which is
2835 printed when the command interpreter needs more input
2836 to complete a command. Usually "> ".
2837
2838 Note:
2839
wdenk57b2d802003-06-27 21:31:46 +00002840 In the current implementation, the local variables
2841 space and global environment variables space are
2842 separated. Local variables are those you define by
2843 simply typing `name=value'. To access a local
2844 variable later on, you have write `$name' or
2845 `${name}'; to execute the contents of a variable
2846 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002847
wdenk4a5c8a72003-03-06 00:02:04 +00002848 Global environment variables are those you use
2849 setenv/printenv to work with. To run a command stored
2850 in such a variable, you need to use the run command,
2851 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002852
2853 To store commands and special characters in a
2854 variable, please use double quotation marks
2855 surrounding the whole text of the variable, instead
2856 of the backslashes before semicolons and special
2857 symbols.
2858
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002859- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002860 CONFIG_CMDLINE_EDITING
2861
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002862 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002863 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002864
Marek Vasut734fb042016-01-27 04:47:55 +01002865- Command Line PS1/PS2 support:
2866 CONFIG_CMDLINE_PS_SUPPORT
2867
2868 Enable support for changing the command prompt string
2869 at run-time. Only static string is supported so far.
2870 The string is obtained from environment variables PS1
2871 and PS2.
2872
wdenkc0aa5c52003-12-06 19:49:23 +00002873- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002874 CONFIG_EXTRA_ENV_SETTINGS
2875
wdenk4a5c8a72003-03-06 00:02:04 +00002876 Define this to contain any number of null terminated
2877 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002878 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002879
wdenk4a5c8a72003-03-06 00:02:04 +00002880 For example, place something like this in your
2881 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002882
2883 #define CONFIG_EXTRA_ENV_SETTINGS \
2884 "myvar1=value1\0" \
2885 "myvar2=value2\0"
2886
wdenk4a5c8a72003-03-06 00:02:04 +00002887 Warning: This method is based on knowledge about the
2888 internal format how the environment is stored by the
2889 U-Boot code. This is NOT an official, exported
2890 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002891 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002892 You better know what you are doing here.
2893
wdenk4a5c8a72003-03-06 00:02:04 +00002894 Note: overly (ab)use of the default environment is
2895 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002896 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002897 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002898
Stephen Warren1465d5f2012-05-22 09:21:54 +00002899 CONFIG_ENV_VARS_UBOOT_CONFIG
2900
2901 Define this in order to add variables describing the
2902 U-Boot build configuration to the default environment.
2903 These will be named arch, cpu, board, vendor, and soc.
2904
2905 Enabling this option will cause the following to be defined:
2906
2907 - CONFIG_SYS_ARCH
2908 - CONFIG_SYS_CPU
2909 - CONFIG_SYS_BOARD
2910 - CONFIG_SYS_VENDOR
2911 - CONFIG_SYS_SOC
2912
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002913 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2914
2915 Define this in order to add variables describing certain
2916 run-time determined information about the hardware to the
2917 environment. These will be named board_name, board_rev.
2918
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002919 CONFIG_DELAY_ENVIRONMENT
2920
2921 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002922 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002923 that so that the environment is not available until
2924 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2925 this is instead controlled by the value of
2926 /config/load-environment.
2927
Chris Packham2216ddb2015-06-19 20:25:59 +12002928- Parallel Flash support:
2929 CONFIG_SYS_NO_FLASH
2930
Bin Meng75574052016-02-05 19:30:11 -08002931 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham2216ddb2015-06-19 20:25:59 +12002932 flash. This option is used to disable support for parallel NOR
2933 flash. This option should be defined if the board does not have
2934 parallel flash.
2935
2936 If this option is not defined one of the generic flash drivers
2937 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2938 selected or the board must provide an implementation of the
2939 flash API (see include/flash.h).
2940
wdenkc0aa5c52003-12-06 19:49:23 +00002941- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002942 CONFIG_HAS_DATAFLASH
2943
wdenk57b2d802003-06-27 21:31:46 +00002944 Defining this option enables DataFlash features and
2945 allows to read/write in Dataflash via the standard
2946 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002947
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002948- Serial Flash support
2949 CONFIG_CMD_SF
2950
2951 Defining this option enables SPI flash commands
2952 'sf probe/read/write/erase/update'.
2953
2954 Usage requires an initial 'probe' to define the serial
2955 flash parameters, followed by read/write/erase/update
2956 commands.
2957
2958 The following defaults may be provided by the platform
2959 to handle the common case when only a single serial
2960 flash is present on the system.
2961
2962 CONFIG_SF_DEFAULT_BUS Bus identifier
2963 CONFIG_SF_DEFAULT_CS Chip-select
2964 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2965 CONFIG_SF_DEFAULT_SPEED in Hz
2966
Simon Glass4b5545e2012-10-08 13:16:02 +00002967 CONFIG_CMD_SF_TEST
2968
2969 Define this option to include a destructive SPI flash
2970 test ('sf test').
2971
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302972 CONFIG_SF_DUAL_FLASH Dual flash memories
2973
2974 Define this option to use dual flash support where two flash
2975 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002976 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302977
wdenkef893942004-02-23 16:11:30 +00002978- SystemACE Support:
2979 CONFIG_SYSTEMACE
2980
2981 Adding this option adds support for Xilinx SystemACE
2982 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002983 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002984 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002985
2986 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002987 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002988
2989 When SystemACE support is added, the "ace" device type
2990 becomes available to the fat commands, i.e. fatls.
2991
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002992- TFTP Fixed UDP Port:
2993 CONFIG_TFTP_PORT
2994
Wolfgang Denk227b5192005-09-24 23:25:46 +02002995 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002996 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002997 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002998 number generator is used.
2999
Wolfgang Denk227b5192005-09-24 23:25:46 +02003000 Also, the environment variable tftpdstp is used to supply
3001 the TFTP UDP destination port value. If tftpdstp isn't
3002 defined, the normal port 69 is used.
3003
3004 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003005 blindly start the TFTP transfer using the pre-configured
3006 target IP address and UDP port. This has the effect of
3007 "punching through" the (Windows XP) firewall, allowing
3008 the remainder of the TFTP transfer to proceed normally.
3009 A better solution is to properly configure the firewall,
3010 but sometimes that is not allowed.
3011
Simon Glass058bb8d2012-12-05 14:46:38 +00003012- Hashing support:
3013 CONFIG_CMD_HASH
3014
3015 This enables a generic 'hash' command which can produce
3016 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3017
3018 CONFIG_HASH_VERIFY
3019
3020 Enable the hash verify command (hash -v). This adds to code
3021 size a little.
3022
gaurav ranaef201592015-02-20 12:51:46 +05303023 CONFIG_SHA1 - This option enables support of hashing using SHA1
3024 algorithm. The hash is calculated in software.
3025 CONFIG_SHA256 - This option enables support of hashing using
3026 SHA256 algorithm. The hash is calculated in software.
3027 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3028 for SHA1/SHA256 hashing.
3029 This affects the 'hash' command and also the
3030 hash_lookup_algo() function.
3031 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3032 hardware-acceleration for SHA1/SHA256 progressive hashing.
3033 Data can be streamed in a block at a time and the hashing
3034 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003035
3036 Note: There is also a sha1sum command, which should perhaps
3037 be deprecated in favour of 'hash sha1'.
3038
Robert Winkler765ccf42013-07-24 17:57:06 -07003039- Freescale i.MX specific commands:
3040 CONFIG_CMD_HDMIDETECT
3041 This enables 'hdmidet' command which returns true if an
3042 HDMI monitor is detected. This command is i.MX 6 specific.
3043
3044 CONFIG_CMD_BMODE
3045 This enables the 'bmode' (bootmode) command for forcing
3046 a boot from specific media.
3047
3048 This is useful for forcing the ROM's usb downloader to
3049 activate upon a watchdog reset which is nice when iterating
3050 on U-Boot. Using the reset button or running bmode normal
3051 will set it back to normal. This command currently
3052 supports i.MX53 and i.MX6.
3053
Heiko Schocher443ca402014-01-25 07:27:13 +01003054- bootcount support:
3055 CONFIG_BOOTCOUNT_LIMIT
3056
3057 This enables the bootcounter support, see:
3058 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3059
3060 CONFIG_AT91SAM9XE
3061 enable special bootcounter support on at91sam9xe based boards.
3062 CONFIG_BLACKFIN
3063 enable special bootcounter support on blackfin based boards.
3064 CONFIG_SOC_DA8XX
3065 enable special bootcounter support on da850 based boards.
3066 CONFIG_BOOTCOUNT_RAM
3067 enable support for the bootcounter in RAM
3068 CONFIG_BOOTCOUNT_I2C
3069 enable support for the bootcounter on an i2c (like RTC) device.
3070 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3071 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3072 the bootcounter.
3073 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003074
wdenkc0aa5c52003-12-06 19:49:23 +00003075- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003076 CONFIG_SHOW_BOOT_PROGRESS
3077
wdenk4a5c8a72003-03-06 00:02:04 +00003078 Defining this option allows to add some board-
3079 specific code (calling a user-provided function
3080 "show_boot_progress(int)") that enables you to show
3081 the system's boot progress on some display (for
3082 example, some LED's) on your board. At the moment,
3083 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003084
Simon Glass0fa36a42012-09-28 08:56:37 +00003085
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003086Legacy uImage format:
3087
wdenkc6097192002-11-03 00:24:07 +00003088 Arg Where When
3089 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003090 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003091 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003092 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003093 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003094 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003095 4 common/cmd_bootm.c Image data has correct checksum
3096 -4 common/cmd_bootm.c Image is for unsupported architecture
3097 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003098 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003099 6 common/cmd_bootm.c Image Type check OK
3100 -6 common/cmd_bootm.c gunzip uncompression error
3101 -7 common/cmd_bootm.c Unimplemented compression type
3102 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003103 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003104 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003105
3106 9 common/image.c Start initial ramdisk verification
3107 -10 common/image.c Ramdisk header has bad magic number
3108 -11 common/image.c Ramdisk header has bad checksum
3109 10 common/image.c Ramdisk header is OK
3110 -12 common/image.c Ramdisk data has bad checksum
3111 11 common/image.c Ramdisk data has correct checksum
3112 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003113 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003114 13 common/image.c Start multifile image verification
3115 14 common/image.c No initial ramdisk, no multifile, continue.
3116
Wolfgang Denk092ae952011-10-26 10:21:21 +00003117 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003118
Stefan Roese88fbf932010-04-15 16:07:28 +02003119 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003120 -31 post/post.c POST test failed, detected by post_output_backlog()
3121 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003122
Heiko Schocher633e03a2007-06-22 19:11:54 +02003123 34 common/cmd_doc.c before loading a Image from a DOC device
3124 -35 common/cmd_doc.c Bad usage of "doc" command
3125 35 common/cmd_doc.c correct usage of "doc" command
3126 -36 common/cmd_doc.c No boot device
3127 36 common/cmd_doc.c correct boot device
3128 -37 common/cmd_doc.c Unknown Chip ID on boot device
3129 37 common/cmd_doc.c correct chip ID found, device available
3130 -38 common/cmd_doc.c Read Error on boot device
3131 38 common/cmd_doc.c reading Image header from DOC device OK
3132 -39 common/cmd_doc.c Image header has bad magic number
3133 39 common/cmd_doc.c Image header has correct magic number
3134 -40 common/cmd_doc.c Error reading Image from DOC device
3135 40 common/cmd_doc.c Image header has correct magic number
3136 41 common/cmd_ide.c before loading a Image from a IDE device
3137 -42 common/cmd_ide.c Bad usage of "ide" command
3138 42 common/cmd_ide.c correct usage of "ide" command
3139 -43 common/cmd_ide.c No boot device
3140 43 common/cmd_ide.c boot device found
3141 -44 common/cmd_ide.c Device not available
3142 44 common/cmd_ide.c Device available
3143 -45 common/cmd_ide.c wrong partition selected
3144 45 common/cmd_ide.c partition selected
3145 -46 common/cmd_ide.c Unknown partition table
3146 46 common/cmd_ide.c valid partition table found
3147 -47 common/cmd_ide.c Invalid partition type
3148 47 common/cmd_ide.c correct partition type
3149 -48 common/cmd_ide.c Error reading Image Header on boot device
3150 48 common/cmd_ide.c reading Image Header from IDE device OK
3151 -49 common/cmd_ide.c Image header has bad magic number
3152 49 common/cmd_ide.c Image header has correct magic number
3153 -50 common/cmd_ide.c Image header has bad checksum
3154 50 common/cmd_ide.c Image header has correct checksum
3155 -51 common/cmd_ide.c Error reading Image from IDE device
3156 51 common/cmd_ide.c reading Image from IDE device OK
3157 52 common/cmd_nand.c before loading a Image from a NAND device
3158 -53 common/cmd_nand.c Bad usage of "nand" command
3159 53 common/cmd_nand.c correct usage of "nand" command
3160 -54 common/cmd_nand.c No boot device
3161 54 common/cmd_nand.c boot device found
3162 -55 common/cmd_nand.c Unknown Chip ID on boot device
3163 55 common/cmd_nand.c correct chip ID found, device available
3164 -56 common/cmd_nand.c Error reading Image Header on boot device
3165 56 common/cmd_nand.c reading Image Header from NAND device OK
3166 -57 common/cmd_nand.c Image header has bad magic number
3167 57 common/cmd_nand.c Image header has correct magic number
3168 -58 common/cmd_nand.c Error reading Image from NAND device
3169 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003170
Heiko Schocher633e03a2007-06-22 19:11:54 +02003171 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003172
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003173 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003174 -64 net/eth.c no Ethernet found.
3175 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003176
Heiko Schocher633e03a2007-06-22 19:11:54 +02003177 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003178 80 common/cmd_net.c before calling net_loop()
3179 -81 common/cmd_net.c some error in net_loop() occurred
3180 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003181 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3182 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003183 83 common/cmd_net.c running "source" command
3184 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003185 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003186
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003187FIT uImage format:
3188
3189 Arg Where When
3190 100 common/cmd_bootm.c Kernel FIT Image has correct format
3191 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3192 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3193 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3194 102 common/cmd_bootm.c Kernel unit name specified
3195 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003196 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003197 104 common/cmd_bootm.c Got kernel subimage node offset
3198 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3199 105 common/cmd_bootm.c Kernel subimage hash verification OK
3200 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3201 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003202 -106 common/cmd_bootm.c Kernel subimage has wrong type
3203 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003204 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3205 108 common/cmd_bootm.c Got kernel subimage data/size
3206 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3207 -109 common/cmd_bootm.c Can't get kernel subimage type
3208 -110 common/cmd_bootm.c Can't get kernel subimage comp
3209 -111 common/cmd_bootm.c Can't get kernel subimage os
3210 -112 common/cmd_bootm.c Can't get kernel subimage load address
3211 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3212
3213 120 common/image.c Start initial ramdisk verification
3214 -120 common/image.c Ramdisk FIT image has incorrect format
3215 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003216 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003217 -122 common/image.c Can't get configuration for ramdisk subimage
3218 123 common/image.c Ramdisk unit name specified
3219 -124 common/image.c Can't get ramdisk subimage node offset
3220 125 common/image.c Got ramdisk subimage node offset
3221 -125 common/image.c Ramdisk subimage hash verification failed
3222 126 common/image.c Ramdisk subimage hash verification OK
3223 -126 common/image.c Ramdisk subimage for unsupported architecture
3224 127 common/image.c Architecture check OK
3225 -127 common/image.c Can't get ramdisk subimage data/size
3226 128 common/image.c Got ramdisk subimage data/size
3227 129 common/image.c Can't get ramdisk load address
3228 -129 common/image.c Got ramdisk load address
3229
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003230 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003231 131 common/cmd_doc.c FIT image format OK
3232
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003233 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003234 141 common/cmd_ide.c FIT image format OK
3235
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003236 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003237 151 common/cmd_nand.c FIT image format OK
3238
Heiko Schocher515eb122014-05-28 11:33:33 +02003239- legacy image format:
3240 CONFIG_IMAGE_FORMAT_LEGACY
3241 enables the legacy image format support in U-Boot.
3242
3243 Default:
3244 enabled if CONFIG_FIT_SIGNATURE is not defined.
3245
3246 CONFIG_DISABLE_IMAGE_LEGACY
3247 disable the legacy image format
3248
3249 This define is introduced, as the legacy image format is
3250 enabled per default for backward compatibility.
3251
Gabe Blackd572e162012-10-25 16:31:10 +00003252- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003253 CONFIG_FIT_DISABLE_SHA256
3254 Supporting SHA256 hashes has quite an impact on binary size.
3255 For constrained systems sha256 hash support can be disabled
3256 with this option.
3257
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003258 TODO(sjg@chromium.org): Adjust this option to be positive,
3259 and move it to Kconfig
3260
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003261- Standalone program support:
3262 CONFIG_STANDALONE_LOAD_ADDR
3263
Wolfgang Denk23f78482011-10-09 21:06:34 +02003264 This option defines a board specific value for the
3265 address where standalone program gets loaded, thus
3266 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003267 settings.
3268
3269- Frame Buffer Address:
3270 CONFIG_FB_ADDR
3271
3272 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003273 address for frame buffer. This is typically the case
3274 when using a graphics controller has separate video
3275 memory. U-Boot will then place the frame buffer at
3276 the given address instead of dynamically reserving it
3277 in system RAM by calling lcd_setmem(), which grabs
3278 the memory for the frame buffer depending on the
3279 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003280
3281 Please see board_init_f function.
3282
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003283- Automatic software updates via TFTP server
3284 CONFIG_UPDATE_TFTP
3285 CONFIG_UPDATE_TFTP_CNT_MAX
3286 CONFIG_UPDATE_TFTP_MSEC_MAX
3287
3288 These options enable and control the auto-update feature;
3289 for a more detailed description refer to doc/README.update.
3290
3291- MTD Support (mtdparts command, UBI support)
3292 CONFIG_MTD_DEVICE
3293
3294 Adds the MTD device infrastructure from the Linux kernel.
3295 Needed for mtdparts command support.
3296
3297 CONFIG_MTD_PARTITIONS
3298
3299 Adds the MTD partitioning infrastructure from the Linux
3300 kernel. Needed for UBI support.
3301
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003302- UBI support
3303 CONFIG_CMD_UBI
3304
3305 Adds commands for interacting with MTD partitions formatted
3306 with the UBI flash translation layer
3307
3308 Requires also defining CONFIG_RBTREE
3309
Joe Hershberger47550fc2013-04-08 10:32:49 +00003310 CONFIG_UBI_SILENCE_MSG
3311
3312 Make the verbose messages from UBI stop printing. This leaves
3313 warnings and errors enabled.
3314
Heiko Schocherf5895d12014-06-24 10:10:04 +02003315
3316 CONFIG_MTD_UBI_WL_THRESHOLD
3317 This parameter defines the maximum difference between the highest
3318 erase counter value and the lowest erase counter value of eraseblocks
3319 of UBI devices. When this threshold is exceeded, UBI starts performing
3320 wear leveling by means of moving data from eraseblock with low erase
3321 counter to eraseblocks with high erase counter.
3322
3323 The default value should be OK for SLC NAND flashes, NOR flashes and
3324 other flashes which have eraseblock life-cycle 100000 or more.
3325 However, in case of MLC NAND flashes which typically have eraseblock
3326 life-cycle less than 10000, the threshold should be lessened (e.g.,
3327 to 128 or 256, although it does not have to be power of 2).
3328
3329 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003330
Heiko Schocherf5895d12014-06-24 10:10:04 +02003331 CONFIG_MTD_UBI_BEB_LIMIT
3332 This option specifies the maximum bad physical eraseblocks UBI
3333 expects on the MTD device (per 1024 eraseblocks). If the
3334 underlying flash does not admit of bad eraseblocks (e.g. NOR
3335 flash), this value is ignored.
3336
3337 NAND datasheets often specify the minimum and maximum NVM
3338 (Number of Valid Blocks) for the flashes' endurance lifetime.
3339 The maximum expected bad eraseblocks per 1024 eraseblocks
3340 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3341 which gives 20 for most NANDs (MaxNVB is basically the total
3342 count of eraseblocks on the chip).
3343
3344 To put it differently, if this value is 20, UBI will try to
3345 reserve about 1.9% of physical eraseblocks for bad blocks
3346 handling. And that will be 1.9% of eraseblocks on the entire
3347 NAND chip, not just the MTD partition UBI attaches. This means
3348 that if you have, say, a NAND flash chip admits maximum 40 bad
3349 eraseblocks, and it is split on two MTD partitions of the same
3350 size, UBI will reserve 40 eraseblocks when attaching a
3351 partition.
3352
3353 default: 20
3354
3355 CONFIG_MTD_UBI_FASTMAP
3356 Fastmap is a mechanism which allows attaching an UBI device
3357 in nearly constant time. Instead of scanning the whole MTD device it
3358 only has to locate a checkpoint (called fastmap) on the device.
3359 The on-flash fastmap contains all information needed to attach
3360 the device. Using fastmap makes only sense on large devices where
3361 attaching by scanning takes long. UBI will not automatically install
3362 a fastmap on old images, but you can set the UBI parameter
3363 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3364 that fastmap-enabled images are still usable with UBI implementations
3365 without fastmap support. On typical flash devices the whole fastmap
3366 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3367
3368 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3369 Set this parameter to enable fastmap automatically on images
3370 without a fastmap.
3371 default: 0
3372
Heiko Schocher94b66de2015-10-22 06:19:21 +02003373 CONFIG_MTD_UBI_FM_DEBUG
3374 Enable UBI fastmap debug
3375 default: 0
3376
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003377- UBIFS support
3378 CONFIG_CMD_UBIFS
3379
3380 Adds commands for interacting with UBI volumes formatted as
3381 UBIFS. UBIFS is read-only in u-boot.
3382
3383 Requires UBI support as well as CONFIG_LZO
3384
Joe Hershberger47550fc2013-04-08 10:32:49 +00003385 CONFIG_UBIFS_SILENCE_MSG
3386
3387 Make the verbose messages from UBIFS stop printing. This leaves
3388 warnings and errors enabled.
3389
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003390- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003391 CONFIG_SPL
3392 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003393
Tom Rini36853852012-02-14 07:29:40 +00003394 CONFIG_SPL_LDSCRIPT
3395 LDSCRIPT for linking the SPL binary.
3396
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003397 CONFIG_SPL_MAX_FOOTPRINT
3398 Maximum size in memory allocated to the SPL, BSS included.
3399 When defined, the linker checks that the actual memory
3400 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003401 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003402 must not be both defined at the same time.
3403
Tom Rini36853852012-02-14 07:29:40 +00003404 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003405 Maximum size of the SPL image (text, data, rodata, and
3406 linker lists sections), BSS excluded.
3407 When defined, the linker checks that the actual size does
3408 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003409
Wolfgang Denk825223d2011-09-11 21:24:09 +02003410 CONFIG_SPL_TEXT_BASE
3411 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003412
Scott Woodc4f0d002012-09-20 19:05:12 -05003413 CONFIG_SPL_RELOC_TEXT_BASE
3414 Address to relocate to. If unspecified, this is equal to
3415 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3416
Tom Rini36853852012-02-14 07:29:40 +00003417 CONFIG_SPL_BSS_START_ADDR
3418 Link address for the BSS within the SPL binary.
3419
3420 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003421 Maximum size in memory allocated to the SPL BSS.
3422 When defined, the linker checks that the actual memory used
3423 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003424 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003425 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003426
3427 CONFIG_SPL_STACK
3428 Adress of the start of the stack SPL will use
3429
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003430 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3431 When defined, SPL will panic() if the image it has
3432 loaded does not have a signature.
3433 Defining this is useful when code which loads images
3434 in SPL cannot guarantee that absolutely all read errors
3435 will be caught.
3436 An example is the LPC32XX MLC NAND driver, which will
3437 consider that a completely unreadable NAND block is bad,
3438 and thus should be skipped silently.
3439
Marek Vasutbf541b22016-04-29 00:44:55 +02003440 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3441 When defined, SPL will proceed to another boot method
3442 if the image it has loaded does not have a signature.
3443
Scott Woodc4f0d002012-09-20 19:05:12 -05003444 CONFIG_SPL_RELOC_STACK
3445 Adress of the start of the stack SPL will use after
3446 relocation. If unspecified, this is equal to
3447 CONFIG_SPL_STACK.
3448
Tom Rini36853852012-02-14 07:29:40 +00003449 CONFIG_SYS_SPL_MALLOC_START
3450 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003451 When this option is set the full malloc is used in SPL and
3452 it is set up by spl_init() and before that, the simple malloc()
3453 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003454
3455 CONFIG_SYS_SPL_MALLOC_SIZE
3456 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003457
Tom Rini28591df2012-08-13 12:03:19 -07003458 CONFIG_SPL_FRAMEWORK
3459 Enable the SPL framework under common/. This framework
3460 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3461 NAND loading of the Linux Kernel.
3462
Tom Rinic2b76002014-03-28 12:03:39 -04003463 CONFIG_SPL_OS_BOOT
3464 Enable booting directly to an OS from SPL.
3465 See also: doc/README.falcon
3466
Tom Rinife3b0c72012-08-13 11:37:56 -07003467 CONFIG_SPL_DISPLAY_PRINT
3468 For ARM, enable an optional function to print more information
3469 about the running system.
3470
Scott Wood7c810902012-09-20 16:35:21 -05003471 CONFIG_SPL_INIT_MINIMAL
3472 Arch init code should be built for a very small image
3473
Tom Rini36853852012-02-14 07:29:40 +00003474 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3475 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003476 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003477 when the MMC is being used in raw mode.
3478
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003479 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3480 Partition on the MMC to load U-Boot from when the MMC is being
3481 used in raw mode
3482
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003483 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3484 Sector to load kernel uImage from when MMC is being
3485 used in raw mode (for Falcon mode)
3486
3487 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3488 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3489 Sector and number of sectors to load kernel argument
3490 parameters from when MMC is being used in raw mode
3491 (for falcon mode)
3492
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003493 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3494 Partition on the MMC to load U-Boot from when the MMC is being
3495 used in fs mode
3496
Guillaume GARDET5065b712014-10-15 17:53:13 +02003497 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3498 Filename to read to load U-Boot when reading from filesystem
3499
3500 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003501 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003502 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003503
Guillaume GARDET5065b712014-10-15 17:53:13 +02003504 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003505 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003506 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003507
Scott Wood2b36fbb2012-12-06 13:33:17 +00003508 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3509 Set this for NAND SPL on PPC mpc83xx targets, so that
3510 start.S waits for the rest of the SPL to load before
3511 continuing (the hardware starts execution after just
3512 loading the first page rather than the full 4K).
3513
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303514 CONFIG_SPL_SKIP_RELOCATE
3515 Avoid SPL relocation
3516
Scott Woodc352a0c2012-09-20 19:09:07 -05003517 CONFIG_SPL_NAND_BASE
3518 Include nand_base.c in the SPL. Requires
3519 CONFIG_SPL_NAND_DRIVERS.
3520
3521 CONFIG_SPL_NAND_DRIVERS
3522 SPL uses normal NAND drivers, not minimal drivers.
3523
3524 CONFIG_SPL_NAND_ECC
3525 Include standard software ECC in the SPL
3526
Tom Rini36853852012-02-14 07:29:40 +00003527 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003528 Support for NAND boot using simple NAND drivers that
3529 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003530
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003531 CONFIG_SPL_UBI
3532 Support for a lightweight UBI (fastmap) scanner and
3533 loader
3534
Heiko Schochercf000272014-10-31 08:31:00 +01003535 CONFIG_SPL_NAND_RAW_ONLY
3536 Support to boot only raw u-boot.bin images. Use this only
3537 if you need to save space.
3538
Ying Zhangdfb2b152013-08-16 15:16:12 +08003539 CONFIG_SPL_COMMON_INIT_DDR
3540 Set for common ddr init with serial presence detect in
3541 SPL binary.
3542
Tom Rini36853852012-02-14 07:29:40 +00003543 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3544 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3545 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3546 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3547 CONFIG_SYS_NAND_ECCBYTES
3548 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003549 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003550
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303551 CONFIG_SPL_NAND_BOOT
3552 Add support NAND boot
3553
Tom Rini36853852012-02-14 07:29:40 +00003554 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003555 Location in NAND to read U-Boot from
3556
3557 CONFIG_SYS_NAND_U_BOOT_DST
3558 Location in memory to load U-Boot to
3559
3560 CONFIG_SYS_NAND_U_BOOT_SIZE
3561 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003562
3563 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003564 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003565
3566 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3567 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003568 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003569
3570 CONFIG_SPL_OMAP3_ID_NAND
3571 Support for an OMAP3-specific set of functions to return the
3572 ID and MFR of the first attached NAND chip, if present.
3573
Pavel Machekde997252012-08-30 22:42:11 +02003574 CONFIG_SPL_RAM_DEVICE
3575 Support for running image already present in ram, in SPL binary
3576
Scott Woodeb7bd972012-12-06 13:33:16 +00003577 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003578 Image offset to which the SPL should be padded before appending
3579 the SPL payload. By default, this is defined as
3580 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3581 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3582 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003583
Scott Woodf147eb72012-09-21 16:27:32 -05003584 CONFIG_SPL_TARGET
3585 Final target image containing SPL and payload. Some SPLs
3586 use an arch-specific makefile fragment instead, for
3587 example if more than one image needs to be produced.
3588
Simon Glass82d94532013-05-08 08:05:59 +00003589 CONFIG_FIT_SPL_PRINT
3590 Printing information about a FIT image adds quite a bit of
3591 code to SPL. So this is normally disabled in SPL. Use this
3592 option to re-enable it. This will affect the output of the
3593 bootm command when booting a FIT image.
3594
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003595- TPL framework
3596 CONFIG_TPL
3597 Enable building of TPL globally.
3598
3599 CONFIG_TPL_PAD_TO
3600 Image offset to which the TPL should be padded before appending
3601 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003602 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3603 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3604 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003605
wdenkc0aa5c52003-12-06 19:49:23 +00003606- Interrupt support (PPC):
3607
wdenk1ebf41e2004-01-02 14:00:00 +00003608 There are common interrupt_init() and timer_interrupt()
3609 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003610 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003611 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003612 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003613 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003614 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003615 specific handling. If board has watchdog / status_led
3616 / other_activity_monitor it works automatically from
3617 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003618
wdenkc6097192002-11-03 00:24:07 +00003619
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003620Board initialization settings:
3621------------------------------
3622
3623During Initialization u-boot calls a number of board specific functions
3624to allow the preparation of board specific prerequisites, e.g. pin setup
3625before drivers are initialized. To enable these callbacks the
3626following configuration macros have to be defined. Currently this is
3627architecture specific, so please check arch/your_architecture/lib/board.c
3628typically in board_init_f() and board_init_r().
3629
3630- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3631- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3632- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3633- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003634
wdenkc6097192002-11-03 00:24:07 +00003635Configuration Settings:
3636-----------------------
3637
York Sun6c480012014-02-26 17:03:19 -08003638- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3639 Optionally it can be defined to support 64-bit memory commands.
3640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003641- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003642 undefine this when you're short of memory.
3643
Peter Tyserdfb72b82009-01-27 18:03:12 -06003644- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3645 width of the commands listed in the 'help' command output.
3646
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003647- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003648 prompt for user input.
3649
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003650- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003651
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003652- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003653
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003654- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003655
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003656- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003657 the application (usually a Linux kernel) when it is
3658 booted
3659
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003660- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003661 List of legal baudrate settings for this board.
3662
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003663- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003664 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003665
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003666- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003667 If the board specific function
3668 extern int overwrite_console (void);
3669 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003670 serial port, else the settings in the environment are used.
3671
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003672- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003673 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003674
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003675- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003676 Enable overwrite of previous console environment settings.
3677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003678- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003679 Begin and End addresses of the area used by the
3680 simple memory test.
3681
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003682- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003683 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003685- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003686 Scratch address used by the alternate memory test
3687 You only need to set this if address zero isn't writeable
3688
York Sun5d286cd2015-12-04 11:57:07 -08003689- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003690 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003691 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3692 is substracted from total RAM and won't be reported to OS.
3693 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003694 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003695 the RAM base is not zero, or RAM is divided into banks,
3696 this variable needs to be recalcuated to get the address.
3697
York Sun50739372015-12-07 11:05:29 -08003698- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003699 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003700 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003701 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003702 fixing up gd->ram_size the Linux kernel should gets passed
3703 the now "corrected" memory size and won't touch it either.
3704 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003705 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003706 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003707 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003708
3709 This option can be used as a workaround for the 440EPx/GRx
3710 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3711 be touched.
3712
3713 WARNING: Please make sure that this value is a multiple of
3714 the Linux page size (normally 4k). If this is not the case,
3715 then the end address of the Linux memory will be located at a
3716 non page size aligned address and this could cause major
3717 problems.
3718
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003719- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003720 Enable temporary baudrate change while serial download
3721
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003722- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003723 Physical start address of SDRAM. _Must_ be 0 here.
3724
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003725- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003726 Physical start address of Flash memory.
3727
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003728- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003729 Physical start address of boot monitor code (set by
3730 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003731 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003732 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003733
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003734- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003735 Size of memory reserved for monitor code, used to
3736 determine _at_compile_time_ (!) if the environment is
3737 embedded within the U-Boot image, or in a separate
3738 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003739
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003740- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003741 Size of DRAM reserved for malloc() use.
3742
Simon Glass863e4042014-07-10 22:23:28 -06003743- CONFIG_SYS_MALLOC_F_LEN
3744 Size of the malloc() pool for use before relocation. If
3745 this is defined, then a very simple malloc() implementation
3746 will become available before relocation. The address is just
3747 below the global data, and the stack is moved down to make
3748 space.
3749
3750 This feature allocates regions with increasing addresses
3751 within the region. calloc() is supported, but realloc()
3752 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003753 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003754 U-Boot relocates itself.
3755
Simon Glass9fa901b2014-11-10 17:16:54 -07003756- CONFIG_SYS_MALLOC_SIMPLE
3757 Provides a simple and small malloc() and calloc() for those
3758 boards which do not use the full malloc in SPL (which is
3759 enabled with CONFIG_SYS_SPL_MALLOC_START).
3760
Thierry Redingc97d9742014-12-09 22:25:22 -07003761- CONFIG_SYS_NONCACHED_MEMORY:
3762 Size of non-cached memory area. This area of memory will be
3763 typically located right below the malloc() area and mapped
3764 uncached in the MMU. This is useful for drivers that would
3765 otherwise require a lot of explicit cache maintenance. For
3766 some drivers it's also impossible to properly maintain the
3767 cache. For example if the regions that need to be flushed
3768 are not a multiple of the cache-line size, *and* padding
3769 cannot be allocated between the regions to align them (i.e.
3770 if the HW requires a contiguous array of regions, and the
3771 size of each region is not cache-aligned), then a flush of
3772 one region may result in overwriting data that hardware has
3773 written to another region in the same cache-line. This can
3774 happen for example in network drivers where descriptors for
3775 buffers are typically smaller than the CPU cache-line (e.g.
3776 16 bytes vs. 32 or 64 bytes).
3777
3778 Non-cached memory is only supported on 32-bit ARM at present.
3779
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003780- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003781 Normally compressed uImages are limited to an
3782 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003783 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003784 to adjust this setting to your needs.
3785
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003786- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003787 Maximum size of memory mapped by the startup code of
3788 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003789 the Linux kernel (bd_info, boot arguments, FDT blob if
3790 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003791 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003792 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003793 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003794 variable "bootm_mapsize" will override the value of
3795 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3796 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003797
John Rigbyeea8e692010-10-13 13:57:35 -06003798- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3799 Enable initrd_high functionality. If defined then the
3800 initrd_high feature is enabled and the bootm ramdisk subcommand
3801 is enabled.
3802
3803- CONFIG_SYS_BOOT_GET_CMDLINE:
3804 Enables allocating and saving kernel cmdline in space between
3805 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3806
3807- CONFIG_SYS_BOOT_GET_KBD:
3808 Enables allocating and saving a kernel copy of the bd_info in
3809 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3810
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003811- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003812 Max number of Flash memory banks
3813
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003814- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003815 Max number of sectors on a Flash chip
3816
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003817- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003818 Timeout for Flash erase operations (in ms)
3819
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003820- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003821 Timeout for Flash write operations (in ms)
3822
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003823- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003824 Timeout for Flash set sector lock bit operation (in ms)
3825
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003826- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003827 Timeout for Flash clear lock bits operation (in ms)
3828
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003829- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003830 If defined, hardware flash sectors protection is used
3831 instead of U-Boot software protection.
3832
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003833- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003834
3835 Enable TFTP transfers directly to flash memory;
3836 without this option such a download has to be
3837 performed in two steps: (1) download to RAM, and (2)
3838 copy from RAM to flash.
3839
3840 The two-step approach is usually more reliable, since
3841 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003842 the flash, but in some situations (when system RAM is
3843 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003844 downloaded image) this option may be very useful.
3845
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003846- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003847 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003848 common flash structure for storing flash geometry.
3849
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003850- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003851 This option also enables the building of the cfi_flash driver
3852 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003853
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003854- CONFIG_FLASH_CFI_MTD
3855 This option enables the building of the cfi_mtd driver
3856 in the drivers directory. The driver exports CFI flash
3857 to the MTD layer.
3858
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003859- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003860 Use buffered writes to flash.
3861
3862- CONFIG_FLASH_SPANSION_S29WS_N
3863 s29ws-n MirrorBit flash has non-standard addresses for buffered
3864 write commands.
3865
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003866- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003867 If this option is defined, the common CFI flash doesn't
3868 print it's warning upon not recognized FLASH banks. This
3869 is useful, if some of the configured banks are only
3870 optionally available.
3871
Jerry Van Barenaae73572008-03-08 13:48:01 -05003872- CONFIG_FLASH_SHOW_PROGRESS
3873 If defined (must be an integer), print out countdown
3874 digits and dots. Recommended value: 45 (9..1) for 80
3875 column displays, 15 (3..1) for 40 column displays.
3876
Stefan Roesed20cba52013-04-04 15:53:14 +02003877- CONFIG_FLASH_VERIFY
3878 If defined, the content of the flash (destination) is compared
3879 against the source after the write operation. An error message
3880 will be printed when the contents are not identical.
3881 Please note that this option is useless in nearly all cases,
3882 since such flash programming errors usually are detected earlier
3883 while unprotecting/erasing/programming. Please only enable
3884 this option if you really know what you are doing.
3885
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003886- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003887 Defines the number of Ethernet receive buffers. On some
3888 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003889 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3890 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003891 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003892 Defaults to 4 if not defined.
3893
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003894- CONFIG_ENV_MAX_ENTRIES
3895
Wolfgang Denk1136f692010-10-27 22:48:30 +02003896 Maximum number of entries in the hash table that is used
3897 internally to store the environment settings. The default
3898 setting is supposed to be generous and should work in most
3899 cases. This setting can be used to tune behaviour; see
3900 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003901
Joe Hershberger71497d02012-12-11 22:16:31 -06003902- CONFIG_ENV_FLAGS_LIST_DEFAULT
3903- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003904 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003905 calling env set. Variables can be restricted to only decimal,
3906 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3907 the variables can also be restricted to IP address or MAC address.
3908
3909 The format of the list is:
3910 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003911 access_attribute = [a|r|o|c]
3912 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003913 entry = variable_name[:attributes]
3914 list = entry[,list]
3915
3916 The type attributes are:
3917 s - String (default)
3918 d - Decimal
3919 x - Hexadecimal
3920 b - Boolean ([1yYtT|0nNfF])
3921 i - IP address
3922 m - MAC address
3923
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003924 The access attributes are:
3925 a - Any (default)
3926 r - Read-only
3927 o - Write-once
3928 c - Change-default
3929
Joe Hershberger71497d02012-12-11 22:16:31 -06003930 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3931 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003932 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003933
3934 - CONFIG_ENV_FLAGS_LIST_STATIC
3935 Define this to a list (string) to define validation that
3936 should be done if an entry is not found in the ".flags"
3937 environment variable. To override a setting in the static
3938 list, simply add an entry for the same variable name to the
3939 ".flags" variable.
3940
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003941 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3942 regular expression. This allows multiple variables to define the same
3943 flags without explicitly listing them for each variable.
3944
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003945- CONFIG_ENV_ACCESS_IGNORE_FORCE
3946 If defined, don't allow the -f switch to env set override variable
3947 access flags.
3948
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003949- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3950 This is set by OMAP boards for the max time that reset should
3951 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003952 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003953
Gabe Black3687fe42014-10-15 04:38:30 -06003954- CONFIG_USE_STDINT
3955 If stdint.h is available with your toolchain you can define this
3956 option to enable it. You can provide option 'USE_STDINT=1' when
3957 building U-Boot to enable this.
3958
wdenkc6097192002-11-03 00:24:07 +00003959The following definitions that deal with the placement and management
3960of environment data (variable area); in general, we support the
3961following configurations:
3962
Mike Frysinger63b8f122011-07-08 10:44:25 +00003963- CONFIG_BUILD_ENVCRC:
3964
3965 Builds up envcrc with the target environment so that external utils
3966 may easily extract it and embed it in final U-Boot images.
3967
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003968- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003969
3970 Define this if the environment is in flash memory.
3971
3972 a) The environment occupies one whole flash sector, which is
3973 "embedded" in the text segment with the U-Boot code. This
3974 happens usually with "bottom boot sector" or "top boot
3975 sector" type flash chips, which have several smaller
3976 sectors at the start or the end. For instance, such a
3977 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3978 such a case you would place the environment in one of the
3979 4 kB sectors - with U-Boot code before and after it. With
3980 "top boot sector" type flash chips, you would put the
3981 environment in one of the last sectors, leaving a gap
3982 between U-Boot and the environment.
3983
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003984 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003985
3986 Offset of environment data (variable area) to the
3987 beginning of flash memory; for instance, with bottom boot
3988 type flash chips the second sector can be used: the offset
3989 for this sector is given here.
3990
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003991 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003992
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003993 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003994
3995 This is just another way to specify the start address of
3996 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003997 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003998
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003999 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004000
4001 Size of the sector containing the environment.
4002
4003
4004 b) Sometimes flash chips have few, equal sized, BIG sectors.
4005 In such a case you don't want to spend a whole sector for
4006 the environment.
4007
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004008 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004009
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004010 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004011 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004012 of this flash sector for the environment. This saves
4013 memory for the RAM copy of the environment.
4014
4015 It may also save flash memory if you decide to use this
4016 when your environment is "embedded" within U-Boot code,
4017 since then the remainder of the flash sector could be used
4018 for U-Boot code. It should be pointed out that this is
4019 STRONGLY DISCOURAGED from a robustness point of view:
4020 updating the environment in flash makes it always
4021 necessary to erase the WHOLE sector. If something goes
4022 wrong before the contents has been restored from a copy in
4023 RAM, your target system will be dead.
4024
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004025 - CONFIG_ENV_ADDR_REDUND
4026 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004027
wdenk4a5c8a72003-03-06 00:02:04 +00004028 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004029 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004030 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004031 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004032
4033BE CAREFUL! Any changes to the flash layout, and some changes to the
4034source code will make it necessary to adapt <board>/u-boot.lds*
4035accordingly!
4036
4037
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004038- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004039
4040 Define this if you have some non-volatile memory device
4041 (NVRAM, battery buffered SRAM) which you want to use for the
4042 environment.
4043
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004044 - CONFIG_ENV_ADDR:
4045 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004046
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004047 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004048 want to use for environment. It is assumed that this memory
4049 can just be read and written to, without any special
4050 provision.
4051
4052BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004053in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004054console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004055U-Boot will hang.
4056
4057Please note that even with NVRAM we still use a copy of the
4058environment in RAM: we could work on NVRAM directly, but we want to
4059keep settings there always unmodified except somebody uses "saveenv"
4060to save the current settings.
4061
4062
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004063- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004064
4065 Use this if you have an EEPROM or similar serial access
4066 device and a driver for it.
4067
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004068 - CONFIG_ENV_OFFSET:
4069 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004070
4071 These two #defines specify the offset and size of the
4072 environment area within the total memory of your EEPROM.
4073
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004074 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004075 If defined, specified the chip address of the EEPROM device.
4076 The default address is zero.
4077
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004078 - CONFIG_SYS_I2C_EEPROM_BUS:
4079 If defined, specified the i2c bus of the EEPROM device.
4080
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004081 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004082 If defined, the number of bits used to address bytes in a
4083 single page in the EEPROM device. A 64 byte page, for example
4084 would require six bits.
4085
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004086 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004087 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004088 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004089
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004090 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004091 The length in bytes of the EEPROM memory array address. Note
4092 that this is NOT the chip address length!
4093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004094 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004095 EEPROM chips that implement "address overflow" are ones
4096 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4097 address and the extra bits end up in the "chip address" bit
4098 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4099 byte chips.
4100
4101 Note that we consider the length of the address field to
4102 still be one byte because the extra address bits are hidden
4103 in the chip address.
4104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004105 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004106 The size in bytes of the EEPROM device.
4107
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004108 - CONFIG_ENV_EEPROM_IS_ON_I2C
4109 define this, if you have I2C and SPI activated, and your
4110 EEPROM, which holds the environment, is on the I2C bus.
4111
4112 - CONFIG_I2C_ENV_EEPROM_BUS
4113 if you have an Environment on an EEPROM reached over
4114 I2C muxes, you can define here, how to reach this
4115 EEPROM. For example:
4116
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004117 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004118
4119 EEPROM which holds the environment, is reached over
4120 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004121
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004122- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004123
wdenk1ebf41e2004-01-02 14:00:00 +00004124 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004125 want to use for the environment.
4126
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004127 - CONFIG_ENV_OFFSET:
4128 - CONFIG_ENV_ADDR:
4129 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004130
4131 These three #defines specify the offset and size of the
4132 environment area within the total memory of your DataFlash placed
4133 at the specified address.
4134
Wu, Josh76db7bf2014-07-01 19:30:13 +08004135- CONFIG_ENV_IS_IN_SPI_FLASH:
4136
4137 Define this if you have a SPI Flash memory device which you
4138 want to use for the environment.
4139
4140 - CONFIG_ENV_OFFSET:
4141 - CONFIG_ENV_SIZE:
4142
4143 These two #defines specify the offset and size of the
4144 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4145 aligned to an erase sector boundary.
4146
4147 - CONFIG_ENV_SECT_SIZE:
4148
4149 Define the SPI flash's sector size.
4150
4151 - CONFIG_ENV_OFFSET_REDUND (optional):
4152
4153 This setting describes a second storage area of CONFIG_ENV_SIZE
4154 size used to hold a redundant copy of the environment data, so
4155 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06004156 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08004157 aligned to an erase sector boundary.
4158
4159 - CONFIG_ENV_SPI_BUS (optional):
4160 - CONFIG_ENV_SPI_CS (optional):
4161
4162 Define the SPI bus and chip select. If not defined they will be 0.
4163
4164 - CONFIG_ENV_SPI_MAX_HZ (optional):
4165
4166 Define the SPI max work clock. If not defined then use 1MHz.
4167
4168 - CONFIG_ENV_SPI_MODE (optional):
4169
4170 Define the SPI work mode. If not defined then use SPI_MODE_3.
4171
Liu Gang85bcd732012-03-08 00:33:20 +00004172- CONFIG_ENV_IS_IN_REMOTE:
4173
4174 Define this if you have a remote memory space which you
4175 want to use for the local device's environment.
4176
4177 - CONFIG_ENV_ADDR:
4178 - CONFIG_ENV_SIZE:
4179
4180 These two #defines specify the address and size of the
4181 environment area within the remote memory space. The
4182 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004183 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004184
4185BE CAREFUL! For some special cases, the local device can not use
4186"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004187environment stored in a remote NOR flash by SRIO or PCIE link,
4188but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004189
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004190- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004191
4192 Define this if you have a NAND device which you want to use
4193 for the environment.
4194
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004195 - CONFIG_ENV_OFFSET:
4196 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004197
4198 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004199 area within the first NAND device. CONFIG_ENV_OFFSET must be
4200 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004201
Scott Wood08239322010-09-17 14:38:37 -05004202 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004203
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004204 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004205 size used to hold a redundant copy of the environment data, so
4206 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06004207 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004208 aligned to an erase block boundary.
4209
4210 - CONFIG_ENV_RANGE (optional):
4211
4212 Specifies the length of the region in which the environment
4213 can be written. This should be a multiple of the NAND device's
4214 block size. Specifying a range with more erase blocks than
4215 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4216 the range to be avoided.
4217
4218 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004219
Scott Wood08239322010-09-17 14:38:37 -05004220 Enables support for dynamically retrieving the offset of the
4221 environment from block zero's out-of-band data. The
4222 "nand env.oob" command can be used to record this offset.
4223 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4224 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004225
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004226- CONFIG_NAND_ENV_DST
4227
4228 Defines address in RAM to which the nand_spl code should copy the
4229 environment. If redundant environment is used, it will be copied to
4230 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4231
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004232- CONFIG_ENV_IS_IN_UBI:
4233
4234 Define this if you have an UBI volume that you want to use for the
4235 environment. This has the benefit of wear-leveling the environment
4236 accesses, which is important on NAND.
4237
4238 - CONFIG_ENV_UBI_PART:
4239
4240 Define this to a string that is the mtd partition containing the UBI.
4241
4242 - CONFIG_ENV_UBI_VOLUME:
4243
4244 Define this to the name of the volume that you want to store the
4245 environment in.
4246
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004247 - CONFIG_ENV_UBI_VOLUME_REDUND:
4248
4249 Define this to the name of another volume to store a second copy of
4250 the environment in. This will enable redundant environments in UBI.
4251 It is assumed that both volumes are in the same MTD partition.
4252
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004253 - CONFIG_UBI_SILENCE_MSG
4254 - CONFIG_UBIFS_SILENCE_MSG
4255
4256 You will probably want to define these to avoid a really noisy system
4257 when storing the env in UBI.
4258
Wu, Josha7d0c872014-06-24 17:31:03 +08004259- CONFIG_ENV_IS_IN_FAT:
4260 Define this if you want to use the FAT file system for the environment.
4261
4262 - FAT_ENV_INTERFACE:
4263
4264 Define this to a string that is the name of the block device.
4265
4266 - FAT_ENV_DEV_AND_PART:
4267
4268 Define this to a string to specify the partition of the device. It can
4269 be as following:
4270
4271 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4272 - "D:P": device D partition P. Error occurs if device D has no
4273 partition table.
4274 - "D:0": device D.
4275 - "D" or "D:": device D partition 1 if device D has partition
4276 table, or the whole device D if has no partition
4277 table.
4278 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004279 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004280 partition table then means device D.
4281
4282 - FAT_ENV_FILE:
4283
4284 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004285 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004286
4287 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004288 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004289
Stephen Warreneedcacd2013-06-11 15:14:00 -06004290- CONFIG_ENV_IS_IN_MMC:
4291
4292 Define this if you have an MMC device which you want to use for the
4293 environment.
4294
4295 - CONFIG_SYS_MMC_ENV_DEV:
4296
4297 Specifies which MMC device the environment is stored in.
4298
4299 - CONFIG_SYS_MMC_ENV_PART (optional):
4300
4301 Specifies which MMC partition the environment is stored in. If not
4302 set, defaults to partition 0, the user area. Common values might be
4303 1 (first MMC boot partition), 2 (second MMC boot partition).
4304
4305 - CONFIG_ENV_OFFSET:
4306 - CONFIG_ENV_SIZE:
4307
4308 These two #defines specify the offset and size of the environment
4309 area within the specified MMC device.
4310
Stephen Warren24dc2032013-06-11 15:14:02 -06004311 If offset is positive (the usual case), it is treated as relative to
4312 the start of the MMC partition. If offset is negative, it is treated
4313 as relative to the end of the MMC partition. This can be useful if
4314 your board may be fitted with different MMC devices, which have
4315 different sizes for the MMC partitions, and you always want the
4316 environment placed at the very end of the partition, to leave the
4317 maximum possible space before it, to store other data.
4318
Stephen Warreneedcacd2013-06-11 15:14:00 -06004319 These two values are in units of bytes, but must be aligned to an
4320 MMC sector boundary.
4321
4322 - CONFIG_ENV_OFFSET_REDUND (optional):
4323
4324 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4325 hold a redundant copy of the environment data. This provides a
4326 valid backup copy in case the other copy is corrupted, e.g. due
4327 to a power failure during a "saveenv" operation.
4328
Stephen Warren24dc2032013-06-11 15:14:02 -06004329 This value may also be positive or negative; this is handled in the
4330 same way as CONFIG_ENV_OFFSET.
4331
Stephen Warreneedcacd2013-06-11 15:14:00 -06004332 This value is also in units of bytes, but must also be aligned to
4333 an MMC sector boundary.
4334
4335 - CONFIG_ENV_SIZE_REDUND (optional):
4336
4337 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4338 set. If this value is set, it must be set to the same value as
4339 CONFIG_ENV_SIZE.
4340
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004341- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004342
4343 Defines offset to the initial SPI buffer area in DPRAM. The
4344 area is used at an early stage (ROM part) if the environment
4345 is configured to reside in the SPI EEPROM: We need a 520 byte
4346 scratch DPRAM area. It is used between the two initialization
4347 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4348 to be a good choice since it makes it far enough from the
4349 start of the data area as well as from the stack pointer.
4350
Bruce Adleredecc942007-11-02 13:15:42 -07004351Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004352has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004353created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004354until then to read environment variables.
4355
wdenk8dba0502003-03-31 16:34:49 +00004356The environment is protected by a CRC32 checksum. Before the monitor
4357is relocated into RAM, as a result of a bad CRC you will be working
4358with the compiled-in default environment - *silently*!!! [This is
4359necessary, because the first environment variable we need is the
4360"baudrate" setting for the console - if we have a bad CRC, we don't
4361have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004362
4363Note: once the monitor has been relocated, then it will complain if
4364the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004365use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004366
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004367- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004368 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004369
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004370 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004371 also needs to be defined.
4372
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004373- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004374 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004375
Ron Madriddfa028a2009-02-18 14:30:44 -08004376- CONFIG_NS16550_MIN_FUNCTIONS:
4377 Define this if you desire to only have use of the NS16550_init
4378 and NS16550_putc functions for the serial driver located at
4379 drivers/serial/ns16550.c. This option is useful for saving
4380 space for already greatly restricted images, including but not
4381 limited to NAND_SPL configurations.
4382
Simon Glass28a9e332012-11-30 13:01:18 +00004383- CONFIG_DISPLAY_BOARDINFO
4384 Display information about the board that U-Boot is running on
4385 when U-Boot starts up. The board function checkboard() is called
4386 to do this.
4387
Simon Glasse8822012012-11-30 13:01:19 +00004388- CONFIG_DISPLAY_BOARDINFO_LATE
4389 Similar to the previous option, but display this information
4390 later, once stdio is running and output goes to the LCD, if
4391 present.
4392
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004393- CONFIG_BOARD_SIZE_LIMIT:
4394 Maximum size of the U-Boot image. When defined, the
4395 build system checks that the actual size does not
4396 exceed it.
4397
wdenkc6097192002-11-03 00:24:07 +00004398Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004399---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004400
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004401- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004402 Cache Line Size of the CPU.
4403
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004404- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004405 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004406
wdenk9c53f402003-10-15 23:53:47 +00004407 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4408 and RPXsuper) to be able to adjust the position of
4409 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004410
Timur Tabid8f341c2011-08-04 18:03:41 -05004411- CONFIG_SYS_CCSRBAR_DEFAULT:
4412 Default (power-on reset) physical address of CCSR on Freescale
4413 PowerPC SOCs.
4414
4415- CONFIG_SYS_CCSRBAR:
4416 Virtual address of CCSR. On a 32-bit build, this is typically
4417 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4418
4419 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4420 for cross-platform code that uses that macro instead.
4421
4422- CONFIG_SYS_CCSRBAR_PHYS:
4423 Physical address of CCSR. CCSR can be relocated to a new
4424 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004425 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004426 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4427 is typically relocated on 36-bit builds. It is recommended
4428 that this macro be defined via the _HIGH and _LOW macros:
4429
4430 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4431 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4432
4433- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004434 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4435 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004436 used in assembly code, so it must not contain typecasts or
4437 integer size suffixes (e.g. "ULL").
4438
4439- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4440 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4441 used in assembly code, so it must not contain typecasts or
4442 integer size suffixes (e.g. "ULL").
4443
4444- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4445 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4446 forced to a value that ensures that CCSR is not relocated.
4447
wdenk1272e232002-11-10 22:06:23 +00004448- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004449 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004450
4451 the default drive number (default value 0)
4452
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004453 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004454
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004455 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004456 (default value 1)
4457
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004458 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004459
wdenk4a5c8a72003-03-06 00:02:04 +00004460 defines the offset of register from address. It
4461 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004462 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004463
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004464 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4465 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004466 default value.
wdenk1272e232002-11-10 22:06:23 +00004467
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004468 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004469 fdc_hw_init() is called at the beginning of the FDC
4470 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004471 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004472 initializations.
wdenk1272e232002-11-10 22:06:23 +00004473
Macpaul Lind1e49942011-04-11 20:45:32 +00004474- CONFIG_IDE_AHB:
4475 Most IDE controllers were designed to be connected with PCI
4476 interface. Only few of them were designed for AHB interface.
4477 When software is doing ATA command and data transfer to
4478 IDE devices through IDE-AHB controller, some additional
4479 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004480 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004482- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004483 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004484 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004485
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004486- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004487
wdenkeb20ad32003-09-05 23:19:14 +00004488 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004489 initial data and stack; please note that this must be
4490 writable memory that is working WITHOUT special
4491 initialization, i. e. you CANNOT use normal RAM which
4492 will become available only after programming the
4493 memory controller and running certain initialization
4494 sequences.
4495
4496 U-Boot uses the following memory types:
4497 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4498 - MPC824X: data cache
4499 - PPC4xx: data cache
4500
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004501- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004502
4503 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004504 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4505 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004506 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004507 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004508 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4509 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4510 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004511
4512 Note:
4513 On the MPC824X (or other systems that use the data
4514 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004515 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004516 point to an otherwise UNUSED address space between
4517 the top of RAM and the start of the PCI space.
4518
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004519- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004520
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004521- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004522
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004523- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004524
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004525- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004526
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004527- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004528
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004529- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004530
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004531- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004532 SDRAM timing
4533
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004534- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004535 periodic timer for refresh
4536
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004537- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004538
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004539- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4540 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4541 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4542 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004543 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4544
4545- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004546 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4547 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004548 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4549
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004550- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4551 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004552 Machine Mode Register and Memory Periodic Timer
4553 Prescaler definitions (SDRAM timing)
4554
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004555- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004556 enable I2C microcode relocation patch (MPC8xx);
4557 define relocation offset in DPRAM [DSP2]
4558
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004559- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004560 enable SMC microcode relocation patch (MPC8xx);
4561 define relocation offset in DPRAM [SMC1]
4562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004563- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004564 enable SPI microcode relocation patch (MPC8xx);
4565 define relocation offset in DPRAM [SCC4]
4566
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004567- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004568 Use OSCM clock mode on MBX8xx board. Be careful,
4569 wrong setting might damage your board. Read
4570 doc/README.MBX before setting this variable!
4571
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004572- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004573 Offset of the bootmode word in DPRAM used by post
4574 (Power On Self Tests). This definition overrides
4575 #define'd default value in commproc.h resp.
4576 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004577
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004578- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4579 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4580 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4581 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4582 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4583 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4584 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4585 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004586 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004587
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004588- CONFIG_PCI_DISABLE_PCIE:
4589 Disable PCI-Express on systems where it is supported but not
4590 required.
4591
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004592- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004593 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004594 Don't do any setup work, presumably because someone or
4595 something has already done it, and we don't need to do it
4596 a second time. Useful for platforms that are pre-booted
4597 by coreboot or similar.
4598
Gabor Juhosb4458732013-05-30 07:06:12 +00004599- CONFIG_PCI_INDIRECT_BRIDGE:
4600 Enable support for indirect PCI bridges.
4601
Kumar Gala8975d7a2010-12-30 12:09:53 -06004602- CONFIG_SYS_SRIO:
4603 Chip has SRIO or not
4604
4605- CONFIG_SRIO1:
4606 Board has SRIO 1 port available
4607
4608- CONFIG_SRIO2:
4609 Board has SRIO 2 port available
4610
Liu Gang27afb9c2013-05-07 16:30:46 +08004611- CONFIG_SRIO_PCIE_BOOT_MASTER
4612 Board can support master function for Boot from SRIO and PCIE
4613
Kumar Gala8975d7a2010-12-30 12:09:53 -06004614- CONFIG_SYS_SRIOn_MEM_VIRT:
4615 Virtual Address of SRIO port 'n' memory region
4616
4617- CONFIG_SYS_SRIOn_MEM_PHYS:
4618 Physical Address of SRIO port 'n' memory region
4619
4620- CONFIG_SYS_SRIOn_MEM_SIZE:
4621 Size of SRIO port 'n' memory region
4622
Fabio Estevamf17e8782013-04-11 09:35:34 +00004623- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4624 Defined to tell the NAND controller that the NAND chip is using
4625 a 16 bit bus.
4626 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004627 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004628 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004629 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004630
4631- CONFIG_SYS_NDFC_EBC0_CFG
4632 Sets the EBC0_CFG register for the NDFC. If not defined
4633 a default value will be used.
4634
Ben Warren45657152006-09-07 16:50:54 -04004635- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004636 Get DDR timing information from an I2C EEPROM. Common
4637 with pluggable memory modules such as SODIMMs
4638
Ben Warren45657152006-09-07 16:50:54 -04004639 SPD_EEPROM_ADDRESS
4640 I2C address of the SPD EEPROM
4641
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004642- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004643 If SPD EEPROM is on an I2C bus other than the first
4644 one, specify here. Note that the value must resolve
4645 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004646
York Sune73cc042011-06-07 09:42:16 +08004647- CONFIG_SYS_DDR_RAW_TIMING
4648 Get DDR timing information from other than SPD. Common with
4649 soldered DDR chips onboard without SPD. DDR raw timing
4650 parameters are extracted from datasheet and hard-coded into
4651 header files or board specific files.
4652
York Sunbd495cf2011-09-16 13:21:35 -07004653- CONFIG_FSL_DDR_INTERACTIVE
4654 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4655
York Sun8ced0502015-01-06 13:18:55 -08004656- CONFIG_FSL_DDR_SYNC_REFRESH
4657 Enable sync of refresh for multiple controllers.
4658
York Sunb6a35f82015-03-19 09:30:28 -07004659- CONFIG_FSL_DDR_BIST
4660 Enable built-in memory test for Freescale DDR controllers.
4661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004662- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004663 Only for 83xx systems. If specified, then DDR should
4664 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004665
wdenk6203e402004-04-18 10:13:26 +00004666- CONFIG_ETHER_ON_FEC[12]
4667 Define to enable FEC[12] on a 8xx series processor.
4668
4669- CONFIG_FEC[12]_PHY
4670 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004671 to the given FEC; i. e.
4672 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004673 means that the PHY with address 4 is connected to FEC1
4674
4675 When set to -1, means to probe for first available.
4676
4677- CONFIG_FEC[12]_PHY_NORXERR
4678 The PHY does not have a RXERR line (RMII only).
4679 (so program the FEC to ignore it).
4680
4681- CONFIG_RMII
4682 Enable RMII mode for all FECs.
4683 Note that this is a global option, we can't
4684 have one FEC in standard MII mode and another in RMII mode.
4685
wdenk20c98a62004-04-23 20:32:05 +00004686- CONFIG_CRC32_VERIFY
4687 Add a verify option to the crc32 command.
4688 The syntax is:
4689
4690 => crc32 -v <address> <count> <crc32>
4691
4692 Where address/count indicate a memory area
4693 and crc32 is the correct crc32 which the
4694 area should have.
4695
wdenk64519362004-07-11 17:40:54 +00004696- CONFIG_LOOPW
4697 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004698 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004699
stroesecc3af832004-12-16 18:46:55 +00004700- CONFIG_MX_CYCLIC
4701 Add the "mdc" and "mwc" memory commands. These are cyclic
4702 "md/mw" commands.
4703 Examples:
4704
wdenk07d7e6b2004-12-16 21:44:03 +00004705 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004706 This command will print 4 bytes (10,11,12,13) each 500 ms.
4707
wdenk07d7e6b2004-12-16 21:44:03 +00004708 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004709 This command will write 12345678 to address 100 all 10 ms.
4710
wdenk07d7e6b2004-12-16 21:44:03 +00004711 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004712 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004713
wdenk3d3d99f2005-04-04 12:44:11 +00004714- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004715 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004716 low level initializations (like setting up the memory
4717 controller) are omitted and/or U-Boot does not
4718 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004719
Wolfgang Denk302141d2010-11-27 23:30:56 +01004720 Normally this variable MUST NOT be defined. The only
4721 exception is when U-Boot is loaded (to RAM) by some
4722 other boot loader or by a debugger which performs
4723 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004724
Simon Glass90844072016-05-05 07:28:06 -06004725- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4726 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004727 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004728 instruction cache) is still performed.
4729
Aneesh V552a3192011-07-13 05:11:07 +00004730- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004731 Modifies the behaviour of start.S when compiling a loader
4732 that is executed before the actual U-Boot. E.g. when
4733 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004734
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004735- CONFIG_TPL_BUILD
4736 Modifies the behaviour of start.S when compiling a loader
4737 that is executed after the SPL and before the actual U-Boot.
4738 It is loaded by the SPL.
4739
Ying Zhang0d4f5442013-05-20 14:07:23 +08004740- CONFIG_SYS_MPC85XX_NO_RESETVEC
4741 Only for 85xx systems. If this variable is specified, the section
4742 .resetvec is not kept and the section .bootpg is placed in the
4743 previous 4k of the .text section.
4744
Simon Glass17dabf02013-02-24 17:33:14 +00004745- CONFIG_ARCH_MAP_SYSMEM
4746 Generally U-Boot (and in particular the md command) uses
4747 effective address. It is therefore not necessary to regard
4748 U-Boot address as virtual addresses that need to be translated
4749 to physical addresses. However, sandbox requires this, since
4750 it maintains its own little RAM buffer which contains all
4751 addressable memory. This option causes some memory accesses
4752 to be mapped through map_sysmem() / unmap_sysmem().
4753
Matthias Weisser93416c12011-03-10 21:36:32 +00004754- CONFIG_USE_ARCH_MEMCPY
4755 CONFIG_USE_ARCH_MEMSET
4756 If these options are used a optimized version of memcpy/memset will
4757 be used if available. These functions may be faster under some
4758 conditions but may increase the binary size.
4759
Simon Glassbfb59802013-02-14 04:18:54 +00004760- CONFIG_X86_RESET_VECTOR
4761 If defined, the x86 reset vector code is included. This is not
4762 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004763
Mark Jackson52b003c2013-03-04 01:27:20 +00004764- CONFIG_SYS_MPUCLK
4765 Defines the MPU clock speed (in MHz).
4766
4767 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004768
Heiko Schocher2233e462013-11-04 14:05:00 +01004769- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4770 Enables the RTC32K OSC on AM33xx based plattforms
4771
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004772- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4773 Option to disable subpage write in NAND driver
4774 driver that uses this:
4775 drivers/mtd/nand/davinci_nand.c
4776
Timur Tabi275f4bb2011-11-22 09:21:25 -06004777Freescale QE/FMAN Firmware Support:
4778-----------------------------------
4779
4780The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4781loading of "firmware", which is encoded in the QE firmware binary format.
4782This firmware often needs to be loaded during U-Boot booting, so macros
4783are used to identify the storage device (NOR flash, SPI, etc) and the address
4784within that device.
4785
Zhao Qiang83a90842014-03-21 16:21:44 +08004786- CONFIG_SYS_FMAN_FW_ADDR
4787 The address in the storage device where the FMAN microcode is located. The
4788 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4789 is also specified.
4790
4791- CONFIG_SYS_QE_FW_ADDR
4792 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004793 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4794 is also specified.
4795
4796- CONFIG_SYS_QE_FMAN_FW_LENGTH
4797 The maximum possible size of the firmware. The firmware binary format
4798 has a field that specifies the actual size of the firmware, but it
4799 might not be possible to read any part of the firmware unless some
4800 local storage is allocated to hold the entire firmware first.
4801
4802- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4803 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4804 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4805 virtual address in NOR flash.
4806
4807- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4808 Specifies that QE/FMAN firmware is located in NAND flash.
4809 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4810
4811- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4812 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4813 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4814
4815- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4816 Specifies that QE/FMAN firmware is located on the primary SPI
4817 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4818
Liu Gang1e084582012-03-08 00:33:18 +00004819- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4820 Specifies that QE/FMAN firmware is located in the remote (master)
4821 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004822 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4823 window->master inbound window->master LAW->the ucode address in
4824 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004825
J. German Rivera8ff14b72014-06-23 15:15:55 -07004826Freescale Layerscape Management Complex Firmware Support:
4827---------------------------------------------------------
4828The Freescale Layerscape Management Complex (MC) supports the loading of
4829"firmware".
4830This firmware often needs to be loaded during U-Boot booting, so macros
4831are used to identify the storage device (NOR flash, SPI, etc) and the address
4832within that device.
4833
4834- CONFIG_FSL_MC_ENET
4835 Enable the MC driver for Layerscape SoCs.
4836
4837- CONFIG_SYS_LS_MC_FW_ADDR
4838 The address in the storage device where the firmware is located. The
4839 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4840 is also specified.
4841
4842- CONFIG_SYS_LS_MC_FW_LENGTH
4843 The maximum possible size of the firmware. The firmware binary format
4844 has a field that specifies the actual size of the firmware, but it
4845 might not be possible to read any part of the firmware unless some
4846 local storage is allocated to hold the entire firmware first.
4847
4848- CONFIG_SYS_LS_MC_FW_IN_NOR
4849 Specifies that MC firmware is located in NOR flash, mapped as
4850 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4851 virtual address in NOR flash.
4852
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304853Freescale Layerscape Debug Server Support:
4854-------------------------------------------
4855The Freescale Layerscape Debug Server Support supports the loading of
4856"Debug Server firmware" and triggering SP boot-rom.
4857This firmware often needs to be loaded during U-Boot booting.
4858
York Sun928b6812015-12-07 11:08:58 -08004859- CONFIG_SYS_MC_RSV_MEM_ALIGN
4860 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304861
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004862Reproducible builds
4863-------------------
4864
4865In order to achieve reproducible builds, timestamps used in the U-Boot build
4866process have to be set to a fixed value.
4867
4868This is done using the SOURCE_DATE_EPOCH environment variable.
4869SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4870option for U-Boot or an environment variable in U-Boot.
4871
4872SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4873
wdenkc6097192002-11-03 00:24:07 +00004874Building the Software:
4875======================
4876
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004877Building U-Boot has been tested in several native build environments
4878and in many different cross environments. Of course we cannot support
4879all possibly existing versions of cross development tools in all
4880(potentially obsolete) versions. In case of tool chain problems we
4881recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4882which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004883
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004884If you are not using a native environment, it is assumed that you
4885have GNU cross compiling tools available in your path. In this case,
4886you must set the environment variable CROSS_COMPILE in your shell.
4887Note that no changes to the Makefile or any other source files are
4888necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004889
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004890 $ CROSS_COMPILE=ppc_4xx-
4891 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004892
Peter Tyserb06976d2009-03-13 18:54:51 -05004893Note: If you wish to generate Windows versions of the utilities in
4894 the tools directory you can use the MinGW toolchain
4895 (http://www.mingw.org). Set your HOST tools to the MinGW
4896 toolchain and execute 'make tools'. For example:
4897
4898 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4899
4900 Binaries such as tools/mkimage.exe will be created which can
4901 be executed on computers running Windows.
4902
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004903U-Boot is intended to be simple to build. After installing the
4904sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004905is done by typing:
4906
Holger Freyther7ba4e572014-08-04 09:26:05 +02004907 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004908
Holger Freyther7ba4e572014-08-04 09:26:05 +02004909where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004910rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004911
wdenk6c59edc2004-05-03 20:45:30 +00004912Note: for some board special configuration names may exist; check if
4913 additional information is available from the board vendor; for
4914 instance, the TQM823L systems are available without (standard)
4915 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004916 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004917
Holger Freyther7ba4e572014-08-04 09:26:05 +02004918 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004919 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004920
Holger Freyther7ba4e572014-08-04 09:26:05 +02004921 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004922 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004923
wdenk6c59edc2004-05-03 20:45:30 +00004924 etc.
wdenkc6097192002-11-03 00:24:07 +00004925
wdenkc6097192002-11-03 00:24:07 +00004926
wdenk6c59edc2004-05-03 20:45:30 +00004927Finally, type "make all", and you should get some working U-Boot
4928images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004929
wdenk6c59edc2004-05-03 20:45:30 +00004930- "u-boot.bin" is a raw binary image
4931- "u-boot" is an image in ELF binary format
4932- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004933
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004934By default the build is performed locally and the objects are saved
4935in the source directory. One of the two methods can be used to change
4936this behavior and build U-Boot to some external directory:
4937
49381. Add O= to the make command line invocations:
4939
4940 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004941 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004942 make O=/tmp/build all
4943
Timo Ketolac8c67602014-11-06 14:39:05 +020049442. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004945
Timo Ketolac8c67602014-11-06 14:39:05 +02004946 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004947 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004948 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004949 make all
4950
Timo Ketolac8c67602014-11-06 14:39:05 +02004951Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004952variable.
4953
wdenkc6097192002-11-03 00:24:07 +00004954
wdenk6c59edc2004-05-03 20:45:30 +00004955Please be aware that the Makefiles assume you are using GNU make, so
4956for instance on NetBSD you might need to use "gmake" instead of
4957native "make".
wdenkc6097192002-11-03 00:24:07 +00004958
wdenkc6097192002-11-03 00:24:07 +00004959
wdenk6c59edc2004-05-03 20:45:30 +00004960If the system board that you have is not listed, then you will need
4961to port U-Boot to your hardware platform. To do this, follow these
4962steps:
wdenkc6097192002-11-03 00:24:07 +00004963
Phil Sutterc77b4882015-12-25 14:41:18 +010049641. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004965 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004966 the "Makefile" and a "<board>.c".
49672. Create a new configuration file "include/configs/<board>.h" for
4968 your board.
wdenk6c59edc2004-05-03 20:45:30 +000049693. If you're porting U-Boot to a new CPU, then also create a new
4970 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020049714. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000049725. Type "make", and you should get a working "u-boot.srec" file
4973 to be installed on your target system.
49746. Debug and solve any problems that might arise.
4975 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004976
wdenkc6097192002-11-03 00:24:07 +00004977
wdenk6c59edc2004-05-03 20:45:30 +00004978Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4979==============================================================
wdenkc6097192002-11-03 00:24:07 +00004980
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004981If you have modified U-Boot sources (for instance added a new board
4982or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004983provide feedback to the other developers. The feedback normally takes
4984the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004985official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004986
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004987But before you submit such a patch, please verify that your modifi-
4988cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004989the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004990just run the buildman script (tools/buildman/buildman), which will
4991configure and build U-Boot for ALL supported system. Be warned, this
4992will take a while. Please see the buildman README, or run 'buildman -H'
4993for documentation.
wdenkc6097192002-11-03 00:24:07 +00004994
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004995
wdenk6c59edc2004-05-03 20:45:30 +00004996See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004997
wdenkc6097192002-11-03 00:24:07 +00004998
wdenk6c59edc2004-05-03 20:45:30 +00004999Monitor Commands - Overview:
5000============================
wdenkc6097192002-11-03 00:24:07 +00005001
wdenk6c59edc2004-05-03 20:45:30 +00005002go - start application at address 'addr'
5003run - run commands in an environment variable
5004bootm - boot application image from memory
5005bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005006bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005007tftpboot- boot image via network using TFTP protocol
5008 and env variables "ipaddr" and "serverip"
5009 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005010tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005011rarpboot- boot image via network using RARP/TFTP protocol
5012diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5013loads - load S-Record file over serial line
5014loadb - load binary file over serial line (kermit mode)
5015md - memory display
5016mm - memory modify (auto-incrementing)
5017nm - memory modify (constant address)
5018mw - memory write (fill)
5019cp - memory copy
5020cmp - memory compare
5021crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005022i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005023sspi - SPI utility commands
5024base - print or set address offset
5025printenv- print environment variables
5026setenv - set environment variables
5027saveenv - save environment variables to persistent storage
5028protect - enable or disable FLASH write protection
5029erase - erase FLASH memory
5030flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005031nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005032bdinfo - print Board Info structure
5033iminfo - print header information for application image
5034coninfo - print console devices and informations
5035ide - IDE sub-system
5036loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005037loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005038mtest - simple RAM test
5039icache - enable or disable instruction cache
5040dcache - enable or disable data cache
5041reset - Perform RESET of the CPU
5042echo - echo args to console
5043version - print monitor version
5044help - print online help
5045? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005046
wdenkc6097192002-11-03 00:24:07 +00005047
wdenk6c59edc2004-05-03 20:45:30 +00005048Monitor Commands - Detailed Description:
5049========================================
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051TODO.
wdenkc6097192002-11-03 00:24:07 +00005052
wdenk6c59edc2004-05-03 20:45:30 +00005053For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005054
5055
wdenk6c59edc2004-05-03 20:45:30 +00005056Environment Variables:
5057======================
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk6c59edc2004-05-03 20:45:30 +00005059U-Boot supports user configuration using Environment Variables which
5060can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062Environment Variables are set using "setenv", printed using
5063"printenv", and saved to Flash using "saveenv". Using "setenv"
5064without a value can be used to delete a variable from the
5065environment. As long as you don't save the environment you are
5066working with an in-memory copy. In case the Flash area containing the
5067environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005068
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005069Some configuration options can be set using Environment Variables.
5070
5071List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005072
wdenk6c59edc2004-05-03 20:45:30 +00005073 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005074
wdenk6c59edc2004-05-03 20:45:30 +00005075 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk6c59edc2004-05-03 20:45:30 +00005077 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005078
wdenk6c59edc2004-05-03 20:45:30 +00005079 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005080
wdenk6c59edc2004-05-03 20:45:30 +00005081 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005082
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005083 bootm_low - Memory range available for image processing in the bootm
5084 command can be restricted. This variable is given as
5085 a hexadecimal number and defines lowest address allowed
5086 for use by the bootm command. See also "bootm_size"
5087 environment variable. Address defined by "bootm_low" is
5088 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005089 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5090 bootm_mapsize.
5091
Wolfgang Denk092ae952011-10-26 10:21:21 +00005092 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005093 This variable is given as a hexadecimal number and it
5094 defines the size of the memory region starting at base
5095 address bootm_low that is accessible by the Linux kernel
5096 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5097 as the default value if it is defined, and bootm_size is
5098 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005099
5100 bootm_size - Memory range available for image processing in the bootm
5101 command can be restricted. This variable is given as
5102 a hexadecimal number and defines the size of the region
5103 allowed for use by the bootm command. See also "bootm_low"
5104 environment variable.
5105
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005106 updatefile - Location of the software update file on a TFTP server, used
5107 by the automatic software update feature. Please refer to
5108 documentation in doc/README.update for more details.
5109
wdenk6c59edc2004-05-03 20:45:30 +00005110 autoload - if set to "no" (any string beginning with 'n'),
5111 "bootp" will just load perform a lookup of the
5112 configuration from the BOOTP server, but not try to
5113 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk6c59edc2004-05-03 20:45:30 +00005115 autostart - if set to "yes", an image loaded using the "bootp",
5116 "rarpboot", "tftpboot" or "diskboot" commands will
5117 be automatically started (by internally calling
5118 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk6c59edc2004-05-03 20:45:30 +00005120 If set to "no", a standalone image passed to the
5121 "bootm" command will be copied to the load address
5122 (and eventually uncompressed), but NOT be started.
5123 This can be used to load and uncompress arbitrary
5124 data.
wdenkc6097192002-11-03 00:24:07 +00005125
David A. Longd558a4e2011-07-09 16:40:19 -04005126 fdt_high - if set this restricts the maximum address that the
5127 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005128 For example, if you have a system with 1 GB memory
5129 at physical address 0x10000000, while Linux kernel
5130 only recognizes the first 704 MB as low memory, you
5131 may need to set fdt_high as 0x3C000000 to have the
5132 device tree blob be copied to the maximum address
5133 of the 704 MB low memory, so that Linux kernel can
5134 access it during the boot procedure.
5135
David A. Longd558a4e2011-07-09 16:40:19 -04005136 If this is set to the special value 0xFFFFFFFF then
5137 the fdt will not be copied at all on boot. For this
5138 to work it must reside in writable memory, have
5139 sufficient padding on the end of it for u-boot to
5140 add the information it needs into it, and the memory
5141 must be accessible by the kernel.
5142
Simon Glassdc6fa642011-10-24 19:15:34 +00005143 fdtcontroladdr- if set this is the address of the control flattened
5144 device tree used by U-Boot when CONFIG_OF_CONTROL is
5145 defined.
5146
wdenk0e2bd9c2004-06-06 21:51:03 +00005147 i2cfast - (PPC405GP|PPC405EP only)
5148 if set to 'y' configures Linux I2C driver for fast
5149 mode (400kHZ). This environment variable is used in
5150 initialization code. So, for changes to be effective
5151 it must be saved and board must be reset.
5152
wdenk6c59edc2004-05-03 20:45:30 +00005153 initrd_high - restrict positioning of initrd images:
5154 If this variable is not set, initrd images will be
5155 copied to the highest possible address in RAM; this
5156 is usually what you want since it allows for
5157 maximum initrd size. If for some reason you want to
5158 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005159 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005160 variable to a value of "no" or "off" or "0".
5161 Alternatively, you can set it to a maximum upper
5162 address to use (U-Boot will still check that it
5163 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165 For instance, when you have a system with 16 MB
5166 RAM, and want to reserve 4 MB from use by Linux,
5167 you can do this by adding "mem=12M" to the value of
5168 the "bootargs" variable. However, now you must make
5169 sure that the initrd image is placed in the first
5170 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk6c59edc2004-05-03 20:45:30 +00005172 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk6c59edc2004-05-03 20:45:30 +00005174 If you set initrd_high to 0xFFFFFFFF, this is an
5175 indication to U-Boot that all addresses are legal
5176 for the Linux kernel, including addresses in flash
5177 memory. In this case U-Boot will NOT COPY the
5178 ramdisk at all. This may be useful to reduce the
5179 boot time on your system, but requires that this
5180 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184 loadaddr - Default load address for commands like "bootp",
5185 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005186
wdenk6c59edc2004-05-03 20:45:30 +00005187 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk6c59edc2004-05-03 20:45:30 +00005189 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005190
wdenk6c59edc2004-05-03 20:45:30 +00005191 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005192
wdenk6c59edc2004-05-03 20:45:30 +00005193 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk6c59edc2004-05-03 20:45:30 +00005195 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005196
Mike Frysingera23230c2011-10-02 10:01:27 +00005197 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005198
Mike Frysingera23230c2011-10-02 10:01:27 +00005199 ethact - controls which interface is currently active.
5200 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005201
Heiko Schocherc5e84052010-07-20 17:45:02 +02005202 => setenv ethact FEC
5203 => ping 192.168.0.1 # traffic sent on FEC
5204 => setenv ethact SCC
5205 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005206
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005207 ethrotate - When set to "no" U-Boot does not go through all
5208 available network interfaces.
5209 It just stays at the currently selected interface.
5210
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005211 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005212 either succeed or fail without retrying.
5213 When set to "once" the network operation will
5214 fail when all the available network interfaces
5215 are tried once without success.
5216 Useful on scripts which control the retry operation
5217 themselves.
wdenkc6097192002-11-03 00:24:07 +00005218
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005219 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005220
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005221 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005222 changing the console to be empty. If "yes" it will be
5223 made silent. If "no" it will not be made silent. If
5224 unset, then it will be made silent if the U-Boot console
5225 is silent.
5226
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005227 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005228 UDP source port.
5229
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005230 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005231 destination port instead of the Well Know Port 69.
5232
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005233 tftpblocksize - Block size to use for TFTP transfers; if not set,
5234 we use the TFTP server's default block size
5235
5236 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5237 seconds, minimum value is 1000 = 1 second). Defines
5238 when a packet is considered to be lost so it has to
5239 be retransmitted. The default is 5000 = 5 seconds.
5240 Lowering this value may make downloads succeed
5241 faster in networks with high packet loss rates or
5242 with unreliable TFTP servers.
5243
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005244 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5245 unit, minimum value = 0). Defines how many timeouts
5246 can happen during a single file transfer before that
5247 transfer is aborted. The default is 10, and 0 means
5248 'no timeouts allowed'. Increasing this value may help
5249 downloads succeed with high packet loss rates, or with
5250 unreliable TFTP servers or client hardware.
5251
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005252 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005253 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005254 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005255
Alexandre Messier15971322016-02-01 17:08:57 -05005256 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5257 Unsigned value, in milliseconds. If not set, the period will
5258 be either the default (28000), or a value based on
5259 CONFIG_NET_RETRY_COUNT, if defined. This value has
5260 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5261
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005262The following image location variables contain the location of images
5263used in booting. The "Image" column gives the role of the image and is
5264not an environment variable name. The other columns are environment
5265variable names. "File Name" gives the name of the file on a TFTP
5266server, "RAM Address" gives the location in RAM the image will be
5267loaded to, and "Flash Location" gives the image's address in NOR
5268flash or offset in NAND flash.
5269
5270*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005271boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005272boards use these variables for other purposes.
5273
Wolfgang Denk092ae952011-10-26 10:21:21 +00005274Image File Name RAM Address Flash Location
5275----- --------- ----------- --------------
5276u-boot u-boot u-boot_addr_r u-boot_addr
5277Linux kernel bootfile kernel_addr_r kernel_addr
5278device tree blob fdtfile fdt_addr_r fdt_addr
5279ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005280
wdenk6c59edc2004-05-03 20:45:30 +00005281The following environment variables may be used and automatically
5282updated by the network boot commands ("bootp" and "rarpboot"),
5283depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005284
wdenk6c59edc2004-05-03 20:45:30 +00005285 bootfile - see above
5286 dnsip - IP address of your Domain Name Server
5287 dnsip2 - IP address of your secondary Domain Name Server
5288 gatewayip - IP address of the Gateway (Router) to use
5289 hostname - Target hostname
5290 ipaddr - see above
5291 netmask - Subnet Mask
5292 rootpath - Pathname of the root filesystem on the NFS server
5293 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005294
wdenk145d2c12004-04-15 21:48:45 +00005295
wdenk6c59edc2004-05-03 20:45:30 +00005296There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005297
wdenk6c59edc2004-05-03 20:45:30 +00005298 serial# - contains hardware identification information such
5299 as type string and/or serial number
5300 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005301
wdenk6c59edc2004-05-03 20:45:30 +00005302These variables can be set only once (usually during manufacturing of
5303the board). U-Boot refuses to delete or overwrite these variables
5304once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005305
5306
wdenk6c59edc2004-05-03 20:45:30 +00005307Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005308
wdenk6c59edc2004-05-03 20:45:30 +00005309 ver - Contains the U-Boot version string as printed
5310 with the "version" command. This variable is
5311 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005312
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk6c59edc2004-05-03 20:45:30 +00005314Please note that changes to some configuration parameters may take
5315only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005316
stroeseb9c17c52003-04-04 15:53:41 +00005317
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005318Callback functions for environment variables:
5319---------------------------------------------
5320
5321For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005322when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005323be associated with arbitrary variables. On creation, overwrite, or
5324deletion, the callback will provide the opportunity for some side
5325effect to happen or for the change to be rejected.
5326
5327The callbacks are named and associated with a function using the
5328U_BOOT_ENV_CALLBACK macro in your board or driver code.
5329
5330These callbacks are associated with variables in one of two ways. The
5331static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5332in the board configuration to a string that defines a list of
5333associations. The list must be in the following format:
5334
5335 entry = variable_name[:callback_name]
5336 list = entry[,list]
5337
5338If the callback name is not specified, then the callback is deleted.
5339Spaces are also allowed anywhere in the list.
5340
5341Callbacks can also be associated by defining the ".callbacks" variable
5342with the same list format above. Any association in ".callbacks" will
5343override any association in the static list. You can define
5344CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005345".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005346
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005347If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5348regular expression. This allows multiple variables to be connected to
5349the same callback without explicitly listing them all out.
5350
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005351
wdenk6c59edc2004-05-03 20:45:30 +00005352Command Line Parsing:
5353=====================
stroeseb9c17c52003-04-04 15:53:41 +00005354
wdenk6c59edc2004-05-03 20:45:30 +00005355There are two different command line parsers available with U-Boot:
5356the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358Old, simple command line parser:
5359--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005360
wdenk6c59edc2004-05-03 20:45:30 +00005361- supports environment variables (through setenv / saveenv commands)
5362- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005363- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005364- special characters ('$', ';') can be escaped by prefixing with '\',
5365 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005366 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005367- You can also escape text by enclosing in single apostrophes, for example:
5368 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005369
wdenk6c59edc2004-05-03 20:45:30 +00005370Hush shell:
5371-----------
wdenkf4688a22003-05-28 08:06:31 +00005372
wdenk6c59edc2004-05-03 20:45:30 +00005373- similar to Bourne shell, with control structures like
5374 if...then...else...fi, for...do...done; while...do...done,
5375 until...do...done, ...
5376- supports environment ("global") variables (through setenv / saveenv
5377 commands) and local shell variables (through standard shell syntax
5378 "name=value"); only environment variables can be used with "run"
5379 command
wdenkf4688a22003-05-28 08:06:31 +00005380
wdenk6c59edc2004-05-03 20:45:30 +00005381General rules:
5382--------------
wdenkf4688a22003-05-28 08:06:31 +00005383
wdenk6c59edc2004-05-03 20:45:30 +00005384(1) If a command line (or an environment variable executed by a "run"
5385 command) contains several commands separated by semicolon, and
5386 one of these commands fails, then the remaining commands will be
5387 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005388
wdenk6c59edc2004-05-03 20:45:30 +00005389(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005390 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005391 command will cause "run" to terminate, i. e. the remaining
5392 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394Note for Redundant Ethernet Interfaces:
5395=======================================
wdenkf4688a22003-05-28 08:06:31 +00005396
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005397Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005398such configurations and is capable of automatic selection of a
5399"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005400
wdenk6c59edc2004-05-03 20:45:30 +00005401Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5402MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5403"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005404
wdenk6c59edc2004-05-03 20:45:30 +00005405If the network interface stores some valid MAC address (for instance
5406in SROM), this is used as default address if there is NO correspon-
5407ding setting in the environment; if the corresponding environment
5408variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410o If the SROM has a valid MAC address, and there is no address in the
5411 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005412
wdenk6c59edc2004-05-03 20:45:30 +00005413o If there is no valid address in the SROM, and a definition in the
5414 environment exists, then the value from the environment variable is
5415 used.
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417o If both the SROM and the environment contain a MAC address, and
5418 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420o If both the SROM and the environment contain a MAC address, and the
5421 addresses differ, the value from the environment is used and a
5422 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005423
wdenk6c59edc2004-05-03 20:45:30 +00005424o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005425 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5426 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005427
Ben Warren6db991a2010-04-26 11:11:46 -07005428If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005429will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005430may be skipped by setting the appropriate 'ethmacskip' environment variable.
5431The naming convention is as follows:
5432"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005433
wdenk6c59edc2004-05-03 20:45:30 +00005434Image Formats:
5435==============
wdenkc6097192002-11-03 00:24:07 +00005436
Marian Balakowicz18710b82008-03-12 12:13:13 +01005437U-Boot is capable of booting (and performing other auxiliary operations on)
5438images in two formats:
5439
5440New uImage format (FIT)
5441-----------------------
5442
5443Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5444to Flattened Device Tree). It allows the use of images with multiple
5445components (several kernels, ramdisks, etc.), with contents protected by
5446SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5447
5448
5449Old uImage format
5450-----------------
5451
5452Old image format is based on binary files which can be basically anything,
5453preceded by a special header; see the definitions in include/image.h for
5454details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005455
wdenk6c59edc2004-05-03 20:45:30 +00005456* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5457 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005458 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5459 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5460 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005461* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005462 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5463 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005464* Compression Type (uncompressed, gzip, bzip2)
5465* Load Address
5466* Entry Point
5467* Image Name
5468* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005469
wdenk6c59edc2004-05-03 20:45:30 +00005470The header is marked by a special Magic Number, and both the header
5471and the data portions of the image are secured against corruption by
5472CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005473
wdenkc6097192002-11-03 00:24:07 +00005474
wdenk6c59edc2004-05-03 20:45:30 +00005475Linux Support:
5476==============
wdenkc6097192002-11-03 00:24:07 +00005477
wdenk6c59edc2004-05-03 20:45:30 +00005478Although U-Boot should support any OS or standalone application
5479easily, the main focus has always been on Linux during the design of
5480U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005481
wdenk6c59edc2004-05-03 20:45:30 +00005482U-Boot includes many features that so far have been part of some
5483special "boot loader" code within the Linux kernel. Also, any
5484"initrd" images to be used are no longer part of one big Linux image;
5485instead, kernel and "initrd" are separate images. This implementation
5486serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005487
wdenk6c59edc2004-05-03 20:45:30 +00005488- the same features can be used for other OS or standalone
5489 applications (for instance: using compressed images to reduce the
5490 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005491
wdenk6c59edc2004-05-03 20:45:30 +00005492- it becomes much easier to port new Linux kernel versions because
5493 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005494
wdenk6c59edc2004-05-03 20:45:30 +00005495- the same Linux kernel image can now be used with different "initrd"
5496 images; of course this also means that different kernel images can
5497 be run with the same "initrd". This makes testing easier (you don't
5498 have to build a new "zImage.initrd" Linux image when you just
5499 change a file in your "initrd"). Also, a field-upgrade of the
5500 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005501
wdenkc6097192002-11-03 00:24:07 +00005502
wdenk6c59edc2004-05-03 20:45:30 +00005503Linux HOWTO:
5504============
wdenkc6097192002-11-03 00:24:07 +00005505
wdenk6c59edc2004-05-03 20:45:30 +00005506Porting Linux to U-Boot based systems:
5507---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005508
wdenk6c59edc2004-05-03 20:45:30 +00005509U-Boot cannot save you from doing all the necessary modifications to
5510configure the Linux device drivers for use with your target hardware
5511(no, we don't intend to provide a full virtual machine interface to
5512Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005513
Stefan Roese88fbf932010-04-15 16:07:28 +02005514But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005515
wdenk6c59edc2004-05-03 20:45:30 +00005516Just make sure your machine specific header file (for instance
5517include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005518Information structure as we define in include/asm-<arch>/u-boot.h,
5519and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005520as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005521
Simon Glassd097e592014-06-11 23:29:46 -06005522Note that U-Boot now has a driver model, a unified model for drivers.
5523If you are adding a new driver, plumb it into driver model. If there
5524is no uclass available, you are encouraged to create one. See
5525doc/driver-model.
5526
wdenkc6097192002-11-03 00:24:07 +00005527
wdenk6c59edc2004-05-03 20:45:30 +00005528Configuring the Linux kernel:
5529-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk6c59edc2004-05-03 20:45:30 +00005531No specific requirements for U-Boot. Make sure you have some root
5532device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005533
wdenkc6097192002-11-03 00:24:07 +00005534
wdenk6c59edc2004-05-03 20:45:30 +00005535Building a Linux Image:
5536-----------------------
wdenkc6097192002-11-03 00:24:07 +00005537
wdenk6c59edc2004-05-03 20:45:30 +00005538With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5539not used. If you use recent kernel source, a new build target
5540"uImage" will exist which automatically builds an image usable by
5541U-Boot. Most older kernels also have support for a "pImage" target,
5542which was introduced for our predecessor project PPCBoot and uses a
5543100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005544
wdenk6c59edc2004-05-03 20:45:30 +00005545Example:
wdenkc6097192002-11-03 00:24:07 +00005546
Holger Freyther7ba4e572014-08-04 09:26:05 +02005547 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005548 make oldconfig
5549 make dep
5550 make uImage
wdenkc6097192002-11-03 00:24:07 +00005551
wdenk6c59edc2004-05-03 20:45:30 +00005552The "uImage" build target uses a special tool (in 'tools/mkimage') to
5553encapsulate a compressed Linux kernel image with header information,
5554CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005557
wdenk6c59edc2004-05-03 20:45:30 +00005558* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005559
wdenk6c59edc2004-05-03 20:45:30 +00005560 ${CROSS_COMPILE}-objcopy -O binary \
5561 -R .note -R .comment \
5562 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005563
wdenk6c59edc2004-05-03 20:45:30 +00005564* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005565
wdenk6c59edc2004-05-03 20:45:30 +00005566 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005567
wdenk6c59edc2004-05-03 20:45:30 +00005568* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005569
wdenk6c59edc2004-05-03 20:45:30 +00005570 mkimage -A ppc -O linux -T kernel -C gzip \
5571 -a 0 -e 0 -n "Linux Kernel Image" \
5572 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005573
wdenkc6097192002-11-03 00:24:07 +00005574
wdenk6c59edc2004-05-03 20:45:30 +00005575The "mkimage" tool can also be used to create ramdisk images for use
5576with U-Boot, either separated from the Linux kernel image, or
5577combined into one file. "mkimage" encapsulates the images with a 64
5578byte header containing information about target architecture,
5579operating system, image type, compression method, entry points, time
5580stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005581
wdenk6c59edc2004-05-03 20:45:30 +00005582"mkimage" can be called in two ways: to verify existing images and
5583print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005584
wdenk6c59edc2004-05-03 20:45:30 +00005585In the first form (with "-l" option) mkimage lists the information
5586contained in the header of an existing U-Boot image; this includes
5587checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005588
wdenk6c59edc2004-05-03 20:45:30 +00005589 tools/mkimage -l image
5590 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005591
wdenk6c59edc2004-05-03 20:45:30 +00005592The second form (with "-d" option) is used to build a U-Boot image
5593from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005594
wdenk6c59edc2004-05-03 20:45:30 +00005595 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5596 -n name -d data_file image
5597 -A ==> set architecture to 'arch'
5598 -O ==> set operating system to 'os'
5599 -T ==> set image type to 'type'
5600 -C ==> set compression type 'comp'
5601 -a ==> set load address to 'addr' (hex)
5602 -e ==> set entry point to 'ep' (hex)
5603 -n ==> set image name to 'name'
5604 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005605
wdenkcd914452004-05-29 16:53:29 +00005606Right now, all Linux kernels for PowerPC systems use the same load
5607address (0x00000000), but the entry point address depends on the
5608kernel version:
wdenkc6097192002-11-03 00:24:07 +00005609
wdenk6c59edc2004-05-03 20:45:30 +00005610- 2.2.x kernels have the entry point at 0x0000000C,
5611- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005612
wdenk6c59edc2004-05-03 20:45:30 +00005613So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5616 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005617 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005618 > examples/uImage.TQM850L
5619 Image Name: 2.4.4 kernel for TQM850L
5620 Created: Wed Jul 19 02:34:59 2000
5621 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5622 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5623 Load Address: 0x00000000
5624 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005625
wdenk6c59edc2004-05-03 20:45:30 +00005626To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005627
wdenk6c59edc2004-05-03 20:45:30 +00005628 -> tools/mkimage -l examples/uImage.TQM850L
5629 Image Name: 2.4.4 kernel for TQM850L
5630 Created: Wed Jul 19 02:34:59 2000
5631 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5632 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5633 Load Address: 0x00000000
5634 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636NOTE: for embedded systems where boot time is critical you can trade
5637speed for memory and install an UNCOMPRESSED image instead: this
5638needs more space in Flash, but boots much faster since it does not
5639need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005640
Stefan Roese88fbf932010-04-15 16:07:28 +02005641 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005642 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5643 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005644 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005645 > examples/uImage.TQM850L-uncompressed
5646 Image Name: 2.4.4 kernel for TQM850L
5647 Created: Wed Jul 19 02:34:59 2000
5648 Image Type: PowerPC Linux Kernel Image (uncompressed)
5649 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5650 Load Address: 0x00000000
5651 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005652
wdenkc6097192002-11-03 00:24:07 +00005653
wdenk6c59edc2004-05-03 20:45:30 +00005654Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5655when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005656
wdenk6c59edc2004-05-03 20:45:30 +00005657 -> tools/mkimage -n 'Simple Ramdisk Image' \
5658 > -A ppc -O linux -T ramdisk -C gzip \
5659 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5660 Image Name: Simple Ramdisk Image
5661 Created: Wed Jan 12 14:01:50 2000
5662 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5663 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5664 Load Address: 0x00000000
5665 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005666
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005667The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5668option performs the converse operation of the mkimage's second form (the "-d"
5669option). Given an image built by mkimage, the dumpimage extracts a "data file"
5670from the image:
5671
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005672 tools/dumpimage -i image -T type -p position data_file
5673 -i ==> extract from the 'image' a specific 'data_file'
5674 -T ==> set image type to 'type'
5675 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005676
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk6c59edc2004-05-03 20:45:30 +00005678Installing a Linux Image:
5679-------------------------
wdenkc6097192002-11-03 00:24:07 +00005680
wdenk6c59edc2004-05-03 20:45:30 +00005681To downloading a U-Boot image over the serial (console) interface,
5682you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk6c59edc2004-05-03 20:45:30 +00005684 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk6c59edc2004-05-03 20:45:30 +00005686The 'objcopy' does not understand the information in the U-Boot
5687image header, so the resulting S-Record file will be relative to
5688address 0x00000000. To load it to a given address, you need to
5689specify the target address as 'offset' parameter with the 'loads'
5690command.
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk6c59edc2004-05-03 20:45:30 +00005692Example: install the image to address 0x40100000 (which on the
5693TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk6c59edc2004-05-03 20:45:30 +00005695 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005696
wdenk6c59edc2004-05-03 20:45:30 +00005697 .......... done
5698 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005699
wdenk6c59edc2004-05-03 20:45:30 +00005700 => loads 40100000
5701 ## Ready for S-Record download ...
5702 ~>examples/image.srec
5703 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5704 ...
5705 15989 15990 15991 15992
5706 [file transfer complete]
5707 [connected]
5708 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005709
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk6c59edc2004-05-03 20:45:30 +00005711You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005712this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005713corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005714
wdenk6c59edc2004-05-03 20:45:30 +00005715 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk6c59edc2004-05-03 20:45:30 +00005717 ## Checking Image at 40100000 ...
5718 Image Name: 2.2.13 for initrd on TQM850L
5719 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5720 Data Size: 335725 Bytes = 327 kB = 0 MB
5721 Load Address: 00000000
5722 Entry Point: 0000000c
5723 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005724
5725
wdenk6c59edc2004-05-03 20:45:30 +00005726Boot Linux:
5727-----------
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk6c59edc2004-05-03 20:45:30 +00005729The "bootm" command is used to boot an application that is stored in
5730memory (RAM or Flash). In case of a Linux kernel image, the contents
5731of the "bootargs" environment variable is passed to the kernel as
5732parameters. You can check and modify this variable using the
5733"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005734
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk6c59edc2004-05-03 20:45:30 +00005736 => printenv bootargs
5737 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk6c59edc2004-05-03 20:45:30 +00005739 => 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 +00005740
wdenk6c59edc2004-05-03 20:45:30 +00005741 => printenv bootargs
5742 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 +00005743
wdenk6c59edc2004-05-03 20:45:30 +00005744 => bootm 40020000
5745 ## Booting Linux kernel at 40020000 ...
5746 Image Name: 2.2.13 for NFS on TQM850L
5747 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5748 Data Size: 381681 Bytes = 372 kB = 0 MB
5749 Load Address: 00000000
5750 Entry Point: 0000000c
5751 Verifying Checksum ... OK
5752 Uncompressing Kernel Image ... OK
5753 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
5754 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5755 time_init: decrementer frequency = 187500000/60
5756 Calibrating delay loop... 49.77 BogoMIPS
5757 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5758 ...
wdenkc6097192002-11-03 00:24:07 +00005759
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005760If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005761the memory addresses of both the kernel and the initrd image (PPBCOOT
5762format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk6c59edc2004-05-03 20:45:30 +00005764 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005765
wdenk6c59edc2004-05-03 20:45:30 +00005766 ## Checking Image at 40100000 ...
5767 Image Name: 2.2.13 for initrd on TQM850L
5768 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5769 Data Size: 335725 Bytes = 327 kB = 0 MB
5770 Load Address: 00000000
5771 Entry Point: 0000000c
5772 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005773
wdenk6c59edc2004-05-03 20:45:30 +00005774 ## Checking Image at 40200000 ...
5775 Image Name: Simple Ramdisk Image
5776 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5777 Data Size: 566530 Bytes = 553 kB = 0 MB
5778 Load Address: 00000000
5779 Entry Point: 00000000
5780 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005781
wdenk6c59edc2004-05-03 20:45:30 +00005782 => bootm 40100000 40200000
5783 ## Booting Linux kernel at 40100000 ...
5784 Image Name: 2.2.13 for initrd on TQM850L
5785 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5786 Data Size: 335725 Bytes = 327 kB = 0 MB
5787 Load Address: 00000000
5788 Entry Point: 0000000c
5789 Verifying Checksum ... OK
5790 Uncompressing Kernel Image ... OK
5791 ## Loading RAMDisk Image at 40200000 ...
5792 Image Name: Simple Ramdisk Image
5793 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5794 Data Size: 566530 Bytes = 553 kB = 0 MB
5795 Load Address: 00000000
5796 Entry Point: 00000000
5797 Verifying Checksum ... OK
5798 Loading Ramdisk ... OK
5799 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
5800 Boot arguments: root=/dev/ram
5801 time_init: decrementer frequency = 187500000/60
5802 Calibrating delay loop... 49.77 BogoMIPS
5803 ...
5804 RAMDISK: Compressed image found at block 0
5805 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005806
wdenk6c59edc2004-05-03 20:45:30 +00005807 bash#
wdenkc6097192002-11-03 00:24:07 +00005808
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005809Boot Linux and pass a flat device tree:
5810-----------
5811
5812First, U-Boot must be compiled with the appropriate defines. See the section
5813titled "Linux Kernel Interface" above for a more in depth explanation. The
5814following is an example of how to start a kernel and pass an updated
5815flat device tree:
5816
5817=> print oftaddr
5818oftaddr=0x300000
5819=> print oft
5820oft=oftrees/mpc8540ads.dtb
5821=> tftp $oftaddr $oft
5822Speed: 1000, full duplex
5823Using TSEC0 device
5824TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5825Filename 'oftrees/mpc8540ads.dtb'.
5826Load address: 0x300000
5827Loading: #
5828done
5829Bytes transferred = 4106 (100a hex)
5830=> tftp $loadaddr $bootfile
5831Speed: 1000, full duplex
5832Using TSEC0 device
5833TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5834Filename 'uImage'.
5835Load address: 0x200000
5836Loading:############
5837done
5838Bytes transferred = 1029407 (fb51f hex)
5839=> print loadaddr
5840loadaddr=200000
5841=> print oftaddr
5842oftaddr=0x300000
5843=> bootm $loadaddr - $oftaddr
5844## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005845 Image Name: Linux-2.6.17-dirty
5846 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5847 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005848 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005849 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005850 Verifying Checksum ... OK
5851 Uncompressing Kernel Image ... OK
5852Booting using flat device tree at 0x300000
5853Using MPC85xx ADS machine description
5854Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5855[snip]
5856
5857
wdenk6c59edc2004-05-03 20:45:30 +00005858More About U-Boot Image Types:
5859------------------------------
wdenkc6097192002-11-03 00:24:07 +00005860
wdenk6c59edc2004-05-03 20:45:30 +00005861U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005862
wdenk6c59edc2004-05-03 20:45:30 +00005863 "Standalone Programs" are directly runnable in the environment
5864 provided by U-Boot; it is expected that (if they behave
5865 well) you can continue to work in U-Boot after return from
5866 the Standalone Program.
5867 "OS Kernel Images" are usually images of some Embedded OS which
5868 will take over control completely. Usually these programs
5869 will install their own set of exception handlers, device
5870 drivers, set up the MMU, etc. - this means, that you cannot
5871 expect to re-enter U-Boot except by resetting the CPU.
5872 "RAMDisk Images" are more or less just data blocks, and their
5873 parameters (address, size) are passed to an OS kernel that is
5874 being started.
5875 "Multi-File Images" contain several images, typically an OS
5876 (Linux) kernel image and one or more data images like
5877 RAMDisks. This construct is useful for instance when you want
5878 to boot over the network using BOOTP etc., where the boot
5879 server provides just a single image file, but you want to get
5880 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005881
wdenk6c59edc2004-05-03 20:45:30 +00005882 "Multi-File Images" start with a list of image sizes, each
5883 image size (in bytes) specified by an "uint32_t" in network
5884 byte order. This list is terminated by an "(uint32_t)0".
5885 Immediately after the terminating 0 follow the images, one by
5886 one, all aligned on "uint32_t" boundaries (size rounded up to
5887 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005888
wdenk6c59edc2004-05-03 20:45:30 +00005889 "Firmware Images" are binary images containing firmware (like
5890 U-Boot or FPGA images) which usually will be programmed to
5891 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005892
wdenk6c59edc2004-05-03 20:45:30 +00005893 "Script files" are command sequences that will be executed by
5894 U-Boot's command interpreter; this feature is especially
5895 useful when you configure U-Boot to use a real shell (hush)
5896 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005897
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005898Booting the Linux zImage:
5899-------------------------
5900
5901On some platforms, it's possible to boot Linux zImage. This is done
5902using the "bootz" command. The syntax of "bootz" command is the same
5903as the syntax of "bootm" command.
5904
Tom Rini45f46d12013-05-16 11:40:11 -04005905Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005906kernel with raw initrd images. The syntax is slightly different, the
5907address of the initrd must be augmented by it's size, in the following
5908format: "<initrd addres>:<initrd size>".
5909
stroeseb9c17c52003-04-04 15:53:41 +00005910
wdenk6c59edc2004-05-03 20:45:30 +00005911Standalone HOWTO:
5912=================
stroeseb9c17c52003-04-04 15:53:41 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914One of the features of U-Boot is that you can dynamically load and
5915run "standalone" applications, which can use some resources of
5916U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005917
wdenk6c59edc2004-05-03 20:45:30 +00005918Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005919
wdenk6c59edc2004-05-03 20:45:30 +00005920"Hello World" Demo:
5921-------------------
wdenkc6097192002-11-03 00:24:07 +00005922
wdenk6c59edc2004-05-03 20:45:30 +00005923'examples/hello_world.c' contains a small "Hello World" Demo
5924application; it is automatically compiled when you build U-Boot.
5925It's configured to run at address 0x00040004, so you can play with it
5926like that:
wdenkc6097192002-11-03 00:24:07 +00005927
wdenk6c59edc2004-05-03 20:45:30 +00005928 => loads
5929 ## Ready for S-Record download ...
5930 ~>examples/hello_world.srec
5931 1 2 3 4 5 6 7 8 9 10 11 ...
5932 [file transfer complete]
5933 [connected]
5934 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005935
wdenk6c59edc2004-05-03 20:45:30 +00005936 => go 40004 Hello World! This is a test.
5937 ## Starting application at 0x00040004 ...
5938 Hello World
5939 argc = 7
5940 argv[0] = "40004"
5941 argv[1] = "Hello"
5942 argv[2] = "World!"
5943 argv[3] = "This"
5944 argv[4] = "is"
5945 argv[5] = "a"
5946 argv[6] = "test."
5947 argv[7] = "<NULL>"
5948 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005949
wdenk6c59edc2004-05-03 20:45:30 +00005950 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005951
wdenk6c59edc2004-05-03 20:45:30 +00005952Another example, which demonstrates how to register a CPM interrupt
5953handler with the U-Boot code, can be found in 'examples/timer.c'.
5954Here, a CPM timer is set up to generate an interrupt every second.
5955The interrupt service routine is trivial, just printing a '.'
5956character, but this is just a demo program. The application can be
5957controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005958
wdenk6c59edc2004-05-03 20:45:30 +00005959 ? - print current values og the CPM Timer registers
5960 b - enable interrupts and start timer
5961 e - stop timer and disable interrupts
5962 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005963
wdenk6c59edc2004-05-03 20:45:30 +00005964 => loads
5965 ## Ready for S-Record download ...
5966 ~>examples/timer.srec
5967 1 2 3 4 5 6 7 8 9 10 11 ...
5968 [file transfer complete]
5969 [connected]
5970 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005971
wdenk6c59edc2004-05-03 20:45:30 +00005972 => go 40004
5973 ## Starting application at 0x00040004 ...
5974 TIMERS=0xfff00980
5975 Using timer 1
5976 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005977
wdenk6c59edc2004-05-03 20:45:30 +00005978Hit 'b':
5979 [q, b, e, ?] Set interval 1000000 us
5980 Enabling timer
5981Hit '?':
5982 [q, b, e, ?] ........
5983 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5984Hit '?':
5985 [q, b, e, ?] .
5986 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5987Hit '?':
5988 [q, b, e, ?] .
5989 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5990Hit '?':
5991 [q, b, e, ?] .
5992 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5993Hit 'e':
5994 [q, b, e, ?] ...Stopping timer
5995Hit 'q':
5996 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005997
wdenkc6097192002-11-03 00:24:07 +00005998
wdenk6c59edc2004-05-03 20:45:30 +00005999Minicom warning:
6000================
wdenkc6097192002-11-03 00:24:07 +00006001
wdenk6c59edc2004-05-03 20:45:30 +00006002Over time, many people have reported problems when trying to use the
6003"minicom" terminal emulation program for serial download. I (wd)
6004consider minicom to be broken, and recommend not to use it. Under
6005Unix, I recommend to use C-Kermit for general purpose use (and
6006especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006007use "cu" for S-Record download ("loads" command). See
6008http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6009for help with kermit.
6010
wdenkc6097192002-11-03 00:24:07 +00006011
wdenk6c59edc2004-05-03 20:45:30 +00006012Nevertheless, if you absolutely want to use it try adding this
6013configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006014
wdenk6c59edc2004-05-03 20:45:30 +00006015 Name Program Name U/D FullScr IO-Red. Multi
6016 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6017 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006018
wdenk8dba0502003-03-31 16:34:49 +00006019
wdenk6c59edc2004-05-03 20:45:30 +00006020NetBSD Notes:
6021=============
wdenkc6097192002-11-03 00:24:07 +00006022
wdenk6c59edc2004-05-03 20:45:30 +00006023Starting at version 0.9.2, U-Boot supports NetBSD both as host
6024(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006025
wdenk6c59edc2004-05-03 20:45:30 +00006026Building requires a cross environment; it is known to work on
6027NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6028need gmake since the Makefiles are not compatible with BSD make).
6029Note that the cross-powerpc package does not install include files;
6030attempting to build U-Boot will fail because <machine/ansi.h> is
6031missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006032
wdenk6c59edc2004-05-03 20:45:30 +00006033 # cd /usr/pkg/cross/powerpc-netbsd/include
6034 # mkdir powerpc
6035 # ln -s powerpc machine
6036 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6037 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006038
wdenk6c59edc2004-05-03 20:45:30 +00006039Native builds *don't* work due to incompatibilities between native
6040and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006041
wdenk6c59edc2004-05-03 20:45:30 +00006042Booting assumes that (the first part of) the image booted is a
6043stage-2 loader which in turn loads and then invokes the kernel
6044proper. Loader sources will eventually appear in the NetBSD source
6045tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006046meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006047
wdenkc6097192002-11-03 00:24:07 +00006048
wdenk6c59edc2004-05-03 20:45:30 +00006049Implementation Internals:
6050=========================
wdenkc6097192002-11-03 00:24:07 +00006051
wdenk6c59edc2004-05-03 20:45:30 +00006052The following is not intended to be a complete description of every
6053implementation detail. However, it should help to understand the
6054inner workings of U-Boot and make it easier to port it to custom
6055hardware.
wdenkc6097192002-11-03 00:24:07 +00006056
wdenkc6097192002-11-03 00:24:07 +00006057
wdenk6c59edc2004-05-03 20:45:30 +00006058Initial Stack, Global Data:
6059---------------------------
wdenkc6097192002-11-03 00:24:07 +00006060
wdenk6c59edc2004-05-03 20:45:30 +00006061The implementation of U-Boot is complicated by the fact that U-Boot
6062starts running out of ROM (flash memory), usually without access to
6063system RAM (because the memory controller is not initialized yet).
6064This means that we don't have writable Data or BSS segments, and BSS
6065is not initialized as zero. To be able to get a C environment working
6066at all, we have to allocate at least a minimal stack. Implementation
6067options for this are defined and restricted by the CPU used: Some CPU
6068models provide on-chip memory (like the IMMR area on MPC8xx and
6069MPC826x processors), on others (parts of) the data cache can be
6070locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006071
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006072 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006073 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006074
wdenk6c59edc2004-05-03 20:45:30 +00006075 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6076 From: "Chris Hallinan" <clh@net1plus.com>
6077 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6078 ...
wdenkc6097192002-11-03 00:24:07 +00006079
wdenk6c59edc2004-05-03 20:45:30 +00006080 Correct me if I'm wrong, folks, but the way I understand it
6081 is this: Using DCACHE as initial RAM for Stack, etc, does not
6082 require any physical RAM backing up the cache. The cleverness
6083 is that the cache is being used as a temporary supply of
6084 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006085 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006086 can see how this works by studying the cache architecture and
6087 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006088
wdenk6c59edc2004-05-03 20:45:30 +00006089 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6090 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006091 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006092 option should work for you. Using CS 4 should be fine if your
6093 board designers haven't used it for something that would
6094 cause you grief during the initial boot! It is frequently not
6095 used.
wdenkc6097192002-11-03 00:24:07 +00006096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006097 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006098 with your processor/board/system design. The default value
6099 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006100 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006101 than your SDRAM module. If you have a 64MB SDRAM module, set
6102 it above 400_0000. Just make sure your board has no resources
6103 that are supposed to respond to that address! That code in
6104 start.S has been around a while and should work as is when
6105 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006106
wdenk6c59edc2004-05-03 20:45:30 +00006107 -Chris Hallinan
6108 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006109
wdenk6c59edc2004-05-03 20:45:30 +00006110It is essential to remember this, since it has some impact on the C
6111code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006112
wdenk6c59edc2004-05-03 20:45:30 +00006113* Initialized global data (data segment) is read-only. Do not attempt
6114 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006115
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006116* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006117 as zero data - BSS segment) at all - this is undefined, initiali-
6118 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006119
wdenk6c59edc2004-05-03 20:45:30 +00006120* Stack space is very limited. Avoid big data buffers or things like
6121 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006122
wdenk6c59edc2004-05-03 20:45:30 +00006123Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006124normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006125turned out that the implementation of U-Boot can be greatly
6126simplified by making a global data structure (gd_t) available to all
6127functions. We could pass a pointer to this data as argument to _all_
6128functions, but this would bloat the code. Instead we use a feature of
6129the GCC compiler (Global Register Variables) to share the data: we
6130place a pointer (gd) to the global data into a register which we
6131reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006132
wdenk6c59edc2004-05-03 20:45:30 +00006133When choosing a register for such a purpose we are restricted by the
6134relevant (E)ABI specifications for the current architecture, and by
6135GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006136
wdenk6c59edc2004-05-03 20:45:30 +00006137For PowerPC, the following registers have specific use:
6138 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006139 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006140 R3-R4: parameter passing and return values
6141 R5-R10: parameter passing
6142 R13: small data area pointer
6143 R30: GOT pointer
6144 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006145
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006146 (U-Boot also uses R12 as internal GOT pointer. r12
6147 is a volatile register so r12 needs to be reset when
6148 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006149
Wolfgang Denk69c09642008-02-14 22:43:22 +01006150 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006151
wdenk6c59edc2004-05-03 20:45:30 +00006152 Note: on PPC, we could use a static initializer (since the
6153 address of the global data structure is known at compile time),
6154 but it turned out that reserving a register results in somewhat
6155 smaller code - although the code savings are not that big (on
6156 average for all boards 752 bytes for the whole U-Boot image,
6157 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006158
Robin Getz2773d5f2009-08-17 15:23:02 +00006159On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006160 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6161
Robin Getz2773d5f2009-08-17 15:23:02 +00006162 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006163
wdenk6c59edc2004-05-03 20:45:30 +00006164On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006165
wdenk6c59edc2004-05-03 20:45:30 +00006166 R0: function argument word/integer result
6167 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006168 R9: platform specific
6169 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006170 R11: argument (frame) pointer
6171 R12: temporary workspace
6172 R13: stack pointer
6173 R14: link register
6174 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006175
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006176 ==> U-Boot will use R9 to hold a pointer to the global data
6177
6178 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006179
Thomas Chou8fa38582010-05-21 11:08:03 +08006180On Nios II, the ABI is documented here:
6181 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6182
6183 ==> U-Boot will use gp to hold a pointer to the global data
6184
6185 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6186 to access small data sections, so gp is free.
6187
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006188On NDS32, the following registers are used:
6189
6190 R0-R1: argument/return
6191 R2-R5: argument
6192 R15: temporary register for assembler
6193 R16: trampoline register
6194 R28: frame pointer (FP)
6195 R29: global pointer (GP)
6196 R30: link register (LP)
6197 R31: stack pointer (SP)
6198 PC: program counter (PC)
6199
6200 ==> U-Boot will use R10 to hold a pointer to the global data
6201
Wolfgang Denk6405a152006-03-31 18:32:53 +02006202NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6203or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006204
wdenk6c59edc2004-05-03 20:45:30 +00006205Memory Management:
6206------------------
wdenkc6097192002-11-03 00:24:07 +00006207
wdenk6c59edc2004-05-03 20:45:30 +00006208U-Boot runs in system state and uses physical addresses, i.e. the
6209MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006210
wdenk6c59edc2004-05-03 20:45:30 +00006211The available memory is mapped to fixed addresses using the memory
6212controller. In this process, a contiguous block is formed for each
6213memory type (Flash, SDRAM, SRAM), even when it consists of several
6214physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006215
wdenk6c59edc2004-05-03 20:45:30 +00006216U-Boot is installed in the first 128 kB of the first Flash bank (on
6217TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6218booting and sizing and initializing DRAM, the code relocates itself
6219to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006220memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006221configuration setting]. Below that, a structure with global Board
6222Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006223
wdenk6c59edc2004-05-03 20:45:30 +00006224Additionally, some exception handler code is copied to the low 8 kB
6225of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006226
wdenk6c59edc2004-05-03 20:45:30 +00006227So a typical memory configuration with 16 MB of DRAM could look like
6228this:
wdenkc6097192002-11-03 00:24:07 +00006229
wdenk6c59edc2004-05-03 20:45:30 +00006230 0x0000 0000 Exception Vector code
6231 :
6232 0x0000 1FFF
6233 0x0000 2000 Free for Application Use
6234 :
6235 :
wdenkc6097192002-11-03 00:24:07 +00006236
wdenk6c59edc2004-05-03 20:45:30 +00006237 :
6238 :
6239 0x00FB FF20 Monitor Stack (Growing downward)
6240 0x00FB FFAC Board Info Data and permanent copy of global data
6241 0x00FC 0000 Malloc Arena
6242 :
6243 0x00FD FFFF
6244 0x00FE 0000 RAM Copy of Monitor Code
6245 ... eventually: LCD or video framebuffer
6246 ... eventually: pRAM (Protected RAM - unchanged by reset)
6247 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006248
wdenkc6097192002-11-03 00:24:07 +00006249
wdenk6c59edc2004-05-03 20:45:30 +00006250System Initialization:
6251----------------------
wdenkc6097192002-11-03 00:24:07 +00006252
wdenk6c59edc2004-05-03 20:45:30 +00006253In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006254(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006255configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006256To be able to re-map memory U-Boot then jumps to its link address.
6257To be able to implement the initialization code in C, a (small!)
6258initial stack is set up in the internal Dual Ported RAM (in case CPUs
6259which provide such a feature like MPC8xx or MPC8260), or in a locked
6260part of the data cache. After that, U-Boot initializes the CPU core,
6261the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006262
wdenk6c59edc2004-05-03 20:45:30 +00006263Next, all (potentially) available memory banks are mapped using a
6264preliminary mapping. For example, we put them on 512 MB boundaries
6265(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6266on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6267programmed for SDRAM access. Using the temporary configuration, a
6268simple memory test is run that determines the size of the SDRAM
6269banks.
wdenkc6097192002-11-03 00:24:07 +00006270
wdenk6c59edc2004-05-03 20:45:30 +00006271When there is more than one SDRAM bank, and the banks are of
6272different size, the largest is mapped first. For equal size, the first
6273bank (CS2#) is mapped first. The first mapping is always for address
62740x00000000, with any additional banks following immediately to create
6275contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006276
wdenk6c59edc2004-05-03 20:45:30 +00006277Then, the monitor installs itself at the upper end of the SDRAM area
6278and allocates memory for use by malloc() and for the global Board
6279Info data; also, the exception vector code is copied to the low RAM
6280pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006281
wdenk6c59edc2004-05-03 20:45:30 +00006282Only after this relocation will you have a "normal" C environment;
6283until that you are restricted in several ways, mostly because you are
6284running from ROM, and because the code will have to be relocated to a
6285new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006286
wdenkc6097192002-11-03 00:24:07 +00006287
wdenk6c59edc2004-05-03 20:45:30 +00006288U-Boot Porting Guide:
6289----------------------
wdenkc6097192002-11-03 00:24:07 +00006290
wdenk6c59edc2004-05-03 20:45:30 +00006291[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6292list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006293
wdenkc6097192002-11-03 00:24:07 +00006294
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006295int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006296{
6297 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006298
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006299 signal(SIGALRM, no_more_time);
6300 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006301
wdenk6c59edc2004-05-03 20:45:30 +00006302 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006303 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006304 return 0;
6305 }
wdenkc6097192002-11-03 00:24:07 +00006306
wdenk6c59edc2004-05-03 20:45:30 +00006307 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006308
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006309 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006310
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006311 if (clueless)
6312 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006313
wdenk6c59edc2004-05-03 20:45:30 +00006314 while (learning) {
6315 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006316 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6317 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006318 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006319 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006320 }
wdenkc6097192002-11-03 00:24:07 +00006321
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006322 if (available_money > toLocalCurrency ($2500))
6323 Buy a BDI3000;
6324 else
wdenk6c59edc2004-05-03 20:45:30 +00006325 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006326
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006327 if (a similar board exists) { /* hopefully... */
6328 cp -a board/<similar> board/<myboard>
6329 cp include/configs/<similar>.h include/configs/<myboard>.h
6330 } else {
6331 Create your own board support subdirectory;
6332 Create your own board include/configs/<myboard>.h file;
6333 }
6334 Edit new board/<myboard> files
6335 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006336
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006337 while (!accepted) {
6338 while (!running) {
6339 do {
6340 Add / modify source code;
6341 } until (compiles);
6342 Debug;
6343 if (clueless)
6344 email("Hi, I am having problems...");
6345 }
6346 Send patch file to the U-Boot email list;
6347 if (reasonable critiques)
6348 Incorporate improvements from email list code review;
6349 else
6350 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006351 }
wdenkc6097192002-11-03 00:24:07 +00006352
wdenk6c59edc2004-05-03 20:45:30 +00006353 return 0;
6354}
wdenkc6097192002-11-03 00:24:07 +00006355
wdenk6c59edc2004-05-03 20:45:30 +00006356void no_more_time (int sig)
6357{
6358 hire_a_guru();
6359}
wdenkc6097192002-11-03 00:24:07 +00006360
wdenkc6097192002-11-03 00:24:07 +00006361
wdenk6c59edc2004-05-03 20:45:30 +00006362Coding Standards:
6363-----------------
wdenkc6097192002-11-03 00:24:07 +00006364
wdenk6c59edc2004-05-03 20:45:30 +00006365All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006366coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006367"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006368
6369Source files originating from a different project (for example the
6370MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006371reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006372sources.
wdenkc6097192002-11-03 00:24:07 +00006373
Detlev Zundelaa63d482006-09-01 15:39:02 +02006374Please note that U-Boot is implemented in C (and to some small parts in
6375Assembler); no C++ is used, so please do not use C++ style comments (//)
6376in your code.
wdenkad276f22004-01-04 16:28:35 +00006377
wdenk6c59edc2004-05-03 20:45:30 +00006378Please also stick to the following formatting rules:
6379- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006380- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006381- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006382- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006383- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006384
wdenk6c59edc2004-05-03 20:45:30 +00006385Submissions which do not conform to the standards may be returned
6386with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006387
wdenkc6097192002-11-03 00:24:07 +00006388
wdenk6c59edc2004-05-03 20:45:30 +00006389Submitting Patches:
6390-------------------
wdenkc6097192002-11-03 00:24:07 +00006391
wdenk6c59edc2004-05-03 20:45:30 +00006392Since the number of patches for U-Boot is growing, we need to
6393establish some rules. Submissions which do not conform to these rules
6394may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006395
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006396Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006397
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006398Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6399see http://lists.denx.de/mailman/listinfo/u-boot
6400
wdenk6c59edc2004-05-03 20:45:30 +00006401When you send a patch, please include the following information with
6402it:
wdenkc6097192002-11-03 00:24:07 +00006403
wdenk6c59edc2004-05-03 20:45:30 +00006404* For bug fixes: a description of the bug and how your patch fixes
6405 this bug. Please try to include a way of demonstrating that the
6406 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006407
wdenk6c59edc2004-05-03 20:45:30 +00006408* For new features: a description of the feature and your
6409 implementation.
wdenkc6097192002-11-03 00:24:07 +00006410
wdenk6c59edc2004-05-03 20:45:30 +00006411* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006412
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006413* For major contributions, add a MAINTAINERS file with your
6414 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006415
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006416* When you add support for a new board, don't forget to add a
6417 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006418
wdenk6c59edc2004-05-03 20:45:30 +00006419* If your patch adds new configuration options, don't forget to
6420 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006421
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006422* The patch itself. If you are using git (which is *strongly*
6423 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006424 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006425 the U-Boot mailing list, you will avoid most of the common problems
6426 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006427
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006428 If you cannot use git, use "diff -purN OLD NEW". If your version of
6429 diff does not support these options, then get the latest version of
6430 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006431
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006432 The current directory when running this command shall be the parent
6433 directory of the U-Boot source tree (i. e. please make sure that
6434 your patch includes sufficient directory information for the
6435 affected files).
6436
6437 We prefer patches as plain text. MIME attachments are discouraged,
6438 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006439
wdenk6c59edc2004-05-03 20:45:30 +00006440* If one logical set of modifications affects or creates several
6441 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006442
wdenk6c59edc2004-05-03 20:45:30 +00006443* Changesets that contain different, unrelated modifications shall be
6444 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006445
wdenkc6097192002-11-03 00:24:07 +00006446
wdenk6c59edc2004-05-03 20:45:30 +00006447Notes:
wdenkc6097192002-11-03 00:24:07 +00006448
Simon Glassdc27def2016-07-27 20:33:08 -06006449* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006450 source tree and make sure that no errors or warnings are reported
6451 for any of the boards.
6452
6453* Keep your modifications to the necessary minimum: A patch
6454 containing several unrelated changes or arbitrary reformats will be
6455 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006456
wdenk6c59edc2004-05-03 20:45:30 +00006457* If you modify existing code, make sure that your new code does not
6458 add to the memory footprint of the code ;-) Small is beautiful!
6459 When adding new features, these should compile conditionally only
6460 (using #ifdef), and the resulting code with the new feature
6461 disabled must not need more memory than the old code without your
6462 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006463
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006464* Remember that there is a size limit of 100 kB per message on the
6465 u-boot mailing list. Bigger patches will be moderated. If they are
6466 reasonable and not too big, they will be acknowledged. But patches
6467 bigger than the size limit should be avoided.