blob: cb8a02fac82774416785943d2abbfda061748ffc [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denkb240aef2008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschin08337f32008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000112
wdenk24ee89b2002-11-03 17:56:27 +0000113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
wdenkc6097192002-11-03 00:24:07 +0000116
wdenk7474aca2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Webere89e6282010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000126
Thomas Webere89e6282010-09-28 08:06:25 +0200127Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000143 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500144 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400145 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200146 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500147 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400149 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150/api Machine/arch independent API for external apps
151/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800152/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500153/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500154/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500155/disk Code for disk drive partition handling
156/doc Documentation (don't expect too much)
157/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400158/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500159/examples Example code for standalone applications, etc.
160/fs Filesystem code (cramfs, ext2, jffs2, etc.)
161/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500162/lib Library routines generic to all architectures
163/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500164/net Networking code
165/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500166/scripts Various build scripts and Makefiles
167/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500168/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000169
wdenkc6097192002-11-03 00:24:07 +0000170Software Configuration:
171=======================
172
173Configuration is usually done using C preprocessor defines; the
174rationale behind that is to avoid dead code whenever possible.
175
176There are two classes of configuration variables:
177
178* Configuration _OPTIONS_:
179 These are selectable by the user and have names beginning with
180 "CONFIG_".
181
182* Configuration _SETTINGS_:
183 These depend on the hardware etc. and should not be meddled with if
184 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200185 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000186
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500187Previously, all configuration was done by hand, which involved creating
188symbolic links and editing configuration files manually. More recently,
189U-Boot has added the Kbuild infrastructure used by the Linux kernel,
190allowing you to use the "make menuconfig" command to configure your
191build.
wdenkc6097192002-11-03 00:24:07 +0000192
193
194Selection of Processor Architecture and Board Type:
195---------------------------------------------------
196
197For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200198configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000199
200Example: For a TQM823L module type:
201
202 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200203 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000204
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500205Note: If you're looking for the default configuration file for a board
206you're sure used to be there but is now missing, check the file
207doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000208
Simon Glass53552c92014-03-22 17:12:59 -0600209Sandbox Environment:
210--------------------
211
212U-Boot can be built natively to run on a Linux host using the 'sandbox'
213board. This allows feature development which is not board- or architecture-
214specific to be undertaken on a native platform. The sandbox is also used to
215run some of U-Boot's tests.
216
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530217See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600218
219
Simon Glassd8711af2015-03-03 08:03:00 -0700220Board Initialisation Flow:
221--------------------------
222
223This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500224SPL and U-Boot proper (i.e. they both follow the same rules).
225
226Note: "SPL" stands for "Secondary Program Loader," which is explained in
227more detail later in this file.
228
229At present, SPL mostly uses a separate code path, but the function names
230and roles of each function are the same. Some boards or architectures
231may not conform to this. At least most ARM boards which use
232CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700233
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500234Execution typically starts with an architecture-specific (and possibly
235CPU-specific) start.S file, such as:
236
237 - arch/arm/cpu/armv7/start.S
238 - arch/powerpc/cpu/mpc83xx/start.S
239 - arch/mips/cpu/start.S
240
241and so on. From there, three functions are called; the purpose and
242limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700243
244lowlevel_init():
245 - purpose: essential init to permit execution to reach board_init_f()
246 - no global_data or BSS
247 - there is no stack (ARMv7 may have one but it will soon be removed)
248 - must not set up SDRAM or use console
249 - must only do the bare minimum to allow execution to continue to
250 board_init_f()
251 - this is almost never needed
252 - return normally from this function
253
254board_init_f():
255 - purpose: set up the machine ready for running board_init_r():
256 i.e. SDRAM and serial UART
257 - global_data is available
258 - stack is in SRAM
259 - BSS is not available, so you cannot use global/static variables,
260 only stack variables and global_data
261
262 Non-SPL-specific notes:
263 - dram_init() is called to set up DRAM. If already done in SPL this
264 can do nothing
265
266 SPL-specific notes:
267 - you can override the entire board_init_f() function with your own
268 version as needed.
269 - preloader_console_init() can be called here in extremis
270 - should set up SDRAM, and anything needed to make the UART work
271 - these is no need to clear BSS, it will be done by crt0.S
272 - must return normally from this function (don't call board_init_r()
273 directly)
274
275Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
276this point the stack and global_data are relocated to below
277CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
278memory.
279
280board_init_r():
281 - purpose: main execution, common code
282 - global_data is available
283 - SDRAM is available
284 - BSS is available, all static/global variables can be used
285 - execution eventually continues to main_loop()
286
287 Non-SPL-specific notes:
288 - U-Boot is relocated to the top of memory and is now running from
289 there.
290
291 SPL-specific notes:
292 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
293 CONFIG_SPL_STACK_R_ADDR points into SDRAM
294 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800295 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700296 spl_board_init() function containing this call
297 - loads U-Boot or (in falcon mode) Linux
298
299
300
wdenkc6097192002-11-03 00:24:07 +0000301Configuration Options:
302----------------------
303
304Configuration depends on the combination of board and CPU type; all
305such information is kept in a configuration file
306"include/configs/<board_name>.h".
307
308Example: For a TQM823L module, all configuration settings are in
309"include/configs/TQM823L.h".
310
311
wdenk1272e232002-11-10 22:06:23 +0000312Many of the options are named exactly as the corresponding Linux
313kernel configuration options. The intention is to make it easier to
314build a config tool - later.
315
316
wdenkc6097192002-11-03 00:24:07 +0000317The following options need to be configured:
318
Kim Phillips203fee32007-08-10 13:28:25 -0500319- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000320
Kim Phillips203fee32007-08-10 13:28:25 -0500321- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200322
323- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100324 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000325
Lei Wen20014762011-02-09 18:06:58 +0530326- Marvell Family Member
327 CONFIG_SYS_MVFS - define it if you want to enable
328 multiple fs option at one time
329 for marvell soc family
330
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200331- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
333 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000334 e.g. if there is no 32KHz
335 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
337 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000338
wdenk20bddb32004-09-28 17:59:53 +0000339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200340 CONFIG_SYS_8xx_CPUCLK_MIN
341 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000342 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000343 See doc/README.MPC866
344
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200345 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000346
wdenk544e9732004-02-06 23:19:44 +0000347 Define this to measure the actual CPU clock instead
348 of relying on the correctness of the configured
349 values. Mostly useful for board bringup to make sure
350 the PLL is locked at the intended frequency. Note
351 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200352 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000353
Heiko Schocher734f0272009-03-12 07:37:15 +0100354 CONFIG_SYS_DELAYED_ICACHE
355
356 Define this option if you want to enable the
357 ICache only when Code runs from RAM.
358
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600359- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000360 CONFIG_SYS_PPC64
361
362 Specifies that the core is a 64-bit PowerPC implementation (implements
363 the "64" category of the Power ISA). This is necessary for ePAPR
364 compliance, among other possible reasons.
365
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala179b1b22011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Scott Wood80806962012-08-14 10:14:53 +0000377 CONFIG_SYS_FSL_ERRATUM_A004510
378
379 Enables a workaround for erratum A004510. If set,
380 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
381 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
382
383 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
384 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
385
386 Defines one or two SoC revisions (low 8 bits of SVR)
387 for which the A004510 workaround should be applied.
388
389 The rest of SVR is either not relevant to the decision
390 of whether the erratum is present (e.g. p2040 versus
391 p2041) or is implied by the build target, which controls
392 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
393
394 See Freescale App Note 4493 for more information about
395 this erratum.
396
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530397 CONFIG_A003399_NOR_WORKAROUND
398 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800399 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530400
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530401 CONFIG_A008044_WORKAROUND
402 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800403 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530404
Scott Wood80806962012-08-14 10:14:53 +0000405 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
406
407 This is the value to write into CCSR offset 0x18600
408 according to the A004510 workaround.
409
Priyanka Jainc73b9032013-07-02 09:21:04 +0530410 CONFIG_SYS_FSL_DSP_DDR_ADDR
411 This value denotes start offset of DDR memory which is
412 connected exclusively to the DSP cores.
413
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530414 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
415 This value denotes start offset of M2 memory
416 which is directly connected to the DSP core.
417
Priyanka Jainc73b9032013-07-02 09:21:04 +0530418 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
419 This value denotes start offset of M3 memory which is directly
420 connected to the DSP core.
421
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530422 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423 This value denotes start offset of DSP CCSR space.
424
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530425 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
426 Single Source Clock is clocking mode present in some of FSL SoC's.
427 In this mode, a single differential clock is used to supply
428 clocks to the sysclock, ddrclock and usbclock.
429
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530430 CONFIG_SYS_CPC_REINIT_F
431 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800432 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530433
Tang Yuantiana7364af2014-04-17 15:33:46 +0800434 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800435 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800436 supported, core will start to execute uboot when wakes up.
437
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000438- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700439 CONFIG_SYS_GENERIC_GLOBAL_DATA
440 Defines global data is initialized in generic board board_init_f().
441 If this macro is defined, global data is created and cleared in
442 generic board board_init_f(). Without this macro, architecture/board
443 should initialize global data before calling board_init_f().
444
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000445 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
446
447 Defines the endianess of the CPU. Implementation of those
448 values is arch specific.
449
York Sunf0626592013-09-30 09:22:09 -0700450 CONFIG_SYS_FSL_DDR
451 Freescale DDR driver in use. This type of DDR controller is
452 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
453 SoCs.
454
455 CONFIG_SYS_FSL_DDR_ADDR
456 Freescale DDR memory-mapped register base.
457
458 CONFIG_SYS_FSL_DDR_EMU
459 Specify emulator support for DDR. Some DDR features such as
460 deskew training are not available.
461
462 CONFIG_SYS_FSL_DDRC_GEN1
463 Freescale DDR1 controller.
464
465 CONFIG_SYS_FSL_DDRC_GEN2
466 Freescale DDR2 controller.
467
468 CONFIG_SYS_FSL_DDRC_GEN3
469 Freescale DDR3 controller.
470
York Sun2896cb72014-03-27 17:54:47 -0700471 CONFIG_SYS_FSL_DDRC_GEN4
472 Freescale DDR4 controller.
473
York Sun461c9392013-09-30 14:20:51 -0700474 CONFIG_SYS_FSL_DDRC_ARM_GEN3
475 Freescale DDR3 controller for ARM-based SoCs.
476
York Sunf0626592013-09-30 09:22:09 -0700477 CONFIG_SYS_FSL_DDR1
478 Board config to use DDR1. It can be enabled for SoCs with
479 Freescale DDR1 or DDR2 controllers, depending on the board
480 implemetation.
481
482 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400483 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700484 Freescale DDR2 or DDR3 controllers, depending on the board
485 implementation.
486
487 CONFIG_SYS_FSL_DDR3
488 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700489 Freescale DDR3 or DDR3L controllers.
490
491 CONFIG_SYS_FSL_DDR3L
492 Board config to use DDR3L. It can be enabled for SoCs with
493 DDR3L controllers.
494
495 CONFIG_SYS_FSL_DDR4
496 Board config to use DDR4. It can be enabled for SoCs with
497 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700498
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530499 CONFIG_SYS_FSL_IFC_BE
500 Defines the IFC controller register space as Big Endian
501
502 CONFIG_SYS_FSL_IFC_LE
503 Defines the IFC controller register space as Little Endian
504
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530505 CONFIG_SYS_FSL_IFC_CLK_DIV
506 Defines divider of platform clock(clock input to IFC controller).
507
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530508 CONFIG_SYS_FSL_LBC_CLK_DIV
509 Defines divider of platform clock(clock input to eLBC controller).
510
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530511 CONFIG_SYS_FSL_PBL_PBI
512 It enables addition of RCW (Power on reset configuration) in built image.
513 Please refer doc/README.pblimage for more details
514
515 CONFIG_SYS_FSL_PBL_RCW
516 It adds PBI(pre-boot instructions) commands in u-boot build image.
517 PBI commands can be used to configure SoC before it starts the execution.
518 Please refer doc/README.pblimage for more details
519
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530520 CONFIG_SPL_FSL_PBL
521 It adds a target to create boot binary having SPL binary in PBI format
522 concatenated with u-boot binary.
523
York Sun29647ab2014-02-10 13:59:42 -0800524 CONFIG_SYS_FSL_DDR_BE
525 Defines the DDR controller register space as Big Endian
526
527 CONFIG_SYS_FSL_DDR_LE
528 Defines the DDR controller register space as Little Endian
529
York Sun3a0916d2014-02-10 13:59:43 -0800530 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
531 Physical address from the view of DDR controllers. It is the
532 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
533 it could be different for ARM SoCs.
534
York Sunc459ae62014-02-10 13:59:44 -0800535 CONFIG_SYS_FSL_DDR_INTLV_256B
536 DDR controller interleaving on 256-byte. This is a special
537 interleaving mode, handled by Dickens for Freescale layerscape
538 SoCs with ARM core.
539
York Sun79a779b2014-08-01 15:51:00 -0700540 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
541 Number of controllers used as main memory.
542
543 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
544 Number of controllers used for other than main memory.
545
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530546 CONFIG_SYS_FSL_HAS_DP_DDR
547 Defines the SoC has DP-DDR used for DPAA.
548
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530549 CONFIG_SYS_FSL_SEC_BE
550 Defines the SEC controller register space as Big Endian
551
552 CONFIG_SYS_FSL_SEC_LE
553 Defines the SEC controller register space as Little Endian
554
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200555- MIPS CPU options:
556 CONFIG_SYS_INIT_SP_OFFSET
557
558 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
559 pointer. This is needed for the temporary stack before
560 relocation.
561
562 CONFIG_SYS_MIPS_CACHE_MODE
563
564 Cache operation mode for the MIPS CPU.
565 See also arch/mips/include/asm/mipsregs.h.
566 Possible values are:
567 CONF_CM_CACHABLE_NO_WA
568 CONF_CM_CACHABLE_WA
569 CONF_CM_UNCACHED
570 CONF_CM_CACHABLE_NONCOHERENT
571 CONF_CM_CACHABLE_CE
572 CONF_CM_CACHABLE_COW
573 CONF_CM_CACHABLE_CUW
574 CONF_CM_CACHABLE_ACCELERATED
575
576 CONFIG_SYS_XWAY_EBU_BOOTCFG
577
578 Special option for Lantiq XWAY SoCs for booting from NOR flash.
579 See also arch/mips/cpu/mips32/start.S.
580
581 CONFIG_XWAY_SWAP_BYTES
582
583 Enable compilation of tools/xway-swap-bytes needed for Lantiq
584 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
585 be swapped if a flash programmer is used.
586
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000587- ARM options:
588 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589
590 Select high exception vectors of the ARM core, e.g., do not
591 clear the V bit of the c1 register of CP15.
592
York Sun77a10972015-03-20 19:28:08 -0700593 COUNTER_FREQUENCY
594 Generic timer clock source frequency.
595
596 COUNTER_FREQUENCY_REAL
597 Generic timer clock source frequency if the real clock is
598 different from COUNTER_FREQUENCY, and can only be determined
599 at run time.
600
Stephen Warren8d1fb312015-01-19 16:25:52 -0700601- Tegra SoC options:
602 CONFIG_TEGRA_SUPPORT_NON_SECURE
603
604 Support executing U-Boot in non-secure (NS) mode. Certain
605 impossible actions will be skipped if the CPU is in NS mode,
606 such as ARM architectural timer initialization.
607
wdenk9b7f3842003-10-09 20:09:04 +0000608- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000609 CONFIG_CLOCKS_IN_MHZ
610
611 U-Boot stores all clock information in Hz
612 internally. For binary compatibility with older Linux
613 kernels (which expect the clocks passed in the
614 bd_info data to be in MHz) the environment variable
615 "clocks_in_mhz" can be defined so that U-Boot
616 converts clock data to MHZ before passing it to the
617 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000618 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100619 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000620 default environment.
621
wdenk9b7f3842003-10-09 20:09:04 +0000622 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
623
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800624 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000625 expect it to be in bytes, others in MB.
626 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
627
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400628 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200629
630 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400631 passed using flattened device trees (based on open firmware
632 concepts).
633
634 CONFIG_OF_LIBFDT
635 * New libfdt-based support
636 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500637 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400638
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200639 OF_CPU - The proper name of the cpus node (only required for
640 MPC512X and MPC5xxx based boards).
641 OF_SOC - The proper name of the soc node (only required for
642 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200643 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600644 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200645
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200646 boards with QUICC Engines require OF_QE to set UCC MAC
647 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500648
Kumar Gala1e26aa52006-01-11 13:54:17 -0600649 CONFIG_OF_BOARD_SETUP
650
651 Board code has addition modification that it wants to make
652 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000653
Simon Glass6c0be912014-10-23 18:58:54 -0600654 CONFIG_OF_SYSTEM_SETUP
655
656 Other code has addition modification that it wants to make
657 to the flat device tree before handing it off to the kernel.
658 This causes ft_system_setup() to be called before booting
659 the kernel.
660
Heiko Schocherffb293a2009-09-23 07:56:08 +0200661 CONFIG_OF_IDE_FIXUP
662
663 U-Boot can detect if an IDE device is present or not.
664 If not, and this new config option is activated, U-Boot
665 removes the ATA node from the DTS before booting Linux,
666 so the Linux IDE driver does not probe the device and
667 crash. This is needed for buggy hardware (uc101) where
668 no pull down resistor is connected to the signal IDE5V_DD7.
669
Igor Grinberg06890672011-07-14 05:45:07 +0000670 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
671
672 This setting is mandatory for all boards that have only one
673 machine type and must be used to specify the machine type
674 number as it appears in the ARM machine registry
675 (see http://www.arm.linux.org.uk/developer/machines/).
676 Only boards that have multiple machine types supported
677 in a single configuration file and the machine type is
678 runtime discoverable, do not have to use this setting.
679
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100680- vxWorks boot parameters:
681
682 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700683 environments variables: bootdev, bootfile, ipaddr, netmask,
684 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100685 It loads the vxWorks image pointed bootfile.
686
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100687 Note: If a "bootargs" environment is defined, it will overwride
688 the defaults discussed just above.
689
Aneesh V960f5c02011-06-16 23:30:47 +0000690- Cache Configuration:
691 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
692 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
693 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
694
Aneesh V686a0752011-06-16 23:30:51 +0000695- Cache Configuration for ARM:
696 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
697 controller
698 CONFIG_SYS_PL310_BASE - Physical base address of PL310
699 controller register space
700
wdenkda04a8b2004-08-02 23:22:59 +0000701- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200702 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000703
704 Define this if you want support for Amba PrimeCell PL010 UARTs.
705
Andreas Engel0813b122008-09-08 14:30:53 +0200706 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000707
708 Define this if you want support for Amba PrimeCell PL011 UARTs.
709
710 CONFIG_PL011_CLOCK
711
712 If you have Amba PrimeCell PL011 UARTs, set this variable to
713 the clock speed of the UARTs.
714
715 CONFIG_PL01x_PORTS
716
717 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
718 define this to a list of base addresses for each (supported)
719 port. See e.g. include/configs/versatile.h
720
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400721 CONFIG_SERIAL_HW_FLOW_CONTROL
722
723 Define this variable to enable hw flow control in serial driver.
724 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000725
wdenkc6097192002-11-03 00:24:07 +0000726- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000727 Depending on board, define exactly one serial port
728 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
729 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
730 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000731
732 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
733 port routines must be defined elsewhere
734 (i.e. serial_init(), serial_getc(), ...)
735
wdenkc6097192002-11-03 00:24:07 +0000736- Console Baudrate:
737 CONFIG_BAUDRATE - in bps
738 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200739 CONFIG_SYS_BAUDRATE_TABLE, see below.
740 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000741
Heiko Schocher327480a2009-01-30 12:55:38 +0100742- Console Rx buffer length
743 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
744 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100745 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100746 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
747 must be defined, to setup the maximum idle timeout for
748 the SMC.
749
wdenkc6097192002-11-03 00:24:07 +0000750- Autoboot Command:
751 CONFIG_BOOTCOMMAND
752 Only needed when CONFIG_BOOTDELAY is enabled;
753 define a command string that is automatically executed
754 when no character is read on the console interface
755 within "Boot Delay" after reset.
756
757 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000758 This can be used to pass arguments to the bootm
759 command. The value of CONFIG_BOOTARGS goes into the
760 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000761
762 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000763 The value of these goes into the environment as
764 "ramboot" and "nfsboot" respectively, and can be used
765 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200766 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000767
Heiko Schocher040c5c32013-11-04 14:04:59 +0100768- Bootcount:
769 CONFIG_BOOTCOUNT_LIMIT
770 Implements a mechanism for detecting a repeating reboot
771 cycle, see:
772 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
773
774 CONFIG_BOOTCOUNT_ENV
775 If no softreset save registers are found on the hardware
776 "bootcount" is stored in the environment. To prevent a
777 saveenv on all reboots, the environment variable
778 "upgrade_available" is used. If "upgrade_available" is
779 0, "bootcount" is always 0, if "upgrade_available" is
780 1 "bootcount" is incremented in the environment.
781 So the Userspace Applikation must set the "upgrade_available"
782 and "bootcount" variable to 0, if a boot was successfully.
783
wdenkc6097192002-11-03 00:24:07 +0000784- Pre-Boot Commands:
785 CONFIG_PREBOOT
786
787 When this option is #defined, the existence of the
788 environment variable "preboot" will be checked
789 immediately before starting the CONFIG_BOOTDELAY
790 countdown and/or running the auto-boot command resp.
791 entering interactive mode.
792
793 This feature is especially useful when "preboot" is
794 automatically generated or modified. For an example
795 see the LWMON board specific code: here "preboot" is
796 modified when the user holds down a certain
797 combination of keys on the (special) keyboard when
798 booting the systems
799
800- Serial Download Echo Mode:
801 CONFIG_LOADS_ECHO
802 If defined to 1, all characters received during a
803 serial download (using the "loads" command) are
804 echoed back. This might be needed by some terminal
805 emulations (like "cu"), but may as well just take
806 time on others. This setting #define's the initial
807 value of the "loads_echo" environment variable.
808
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500809- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000810 CONFIG_KGDB_BAUDRATE
811 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200812 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000813
814- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500815 Monitor commands can be included or excluded
816 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000817 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500818 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000819
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500820 The default command configuration includes all commands
821 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000822
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100823 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500824 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500825 CONFIG_CMD_BDI bdinfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500826 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400827 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500828 CONFIG_CMD_CACHE * icache, dcache
829 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500830 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500831 CONFIG_CMD_DHCP * DHCP support
832 CONFIG_CMD_DIAG * Diagnostics
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500833 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500834 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500835 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder94463402013-10-22 19:07:34 -0500836 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500837 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000838 CONFIG_CMD_EXT2 * ext2 command support
839 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700840 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
841 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100842 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500843 CONFIG_CMD_SAVEENV saveenv
Stephen Warren4f8662d2012-10-22 06:43:50 +0000844 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500845 CONFIG_CMD_FLASH flinfo, erase, protect
846 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysinger2ed02412010-12-26 23:32:22 -0500847 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000848 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500849 CONFIG_CMD_I2C * I2C serial bus support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500850 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000851 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200852 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500853 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000854 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500855 CONFIG_CMD_IRQ * irqinfo
856 CONFIG_CMD_ITEST Integer/string test of 2 values
857 CONFIG_CMD_JFFS2 * JFFS2 Support
858 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200859 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000860 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
861 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_LOADB loadb
863 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200864 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400865 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000866 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500867 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000868 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200869 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500870 CONFIG_CMD_MISC Misc functions like sleep etc
871 CONFIG_CMD_MMC * MMC memory mapped support
872 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100873 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500874 CONFIG_CMD_NAND * NAND support
875 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200876 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600877 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000878 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500879 CONFIG_CMD_PCI * pciinfo
880 CONFIG_CMD_PCMCIA * PCMCIA support
881 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
882 host
883 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000884 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500885 CONFIG_CMD_REGINFO * Register dump
886 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000887 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500888 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600889 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500890 CONFIG_CMD_SDRAM * print SDRAM configuration information
891 (requires CONFIG_CMD_I2C)
892 CONFIG_CMD_SETGETDCR Support for DCR Register access
893 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700894 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200895 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400896 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800897 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200898 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500899 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000900 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000901 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000902 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
903 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500904 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500905 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000906 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200907 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200908 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000909
910 EXAMPLE: If you want all functions except of network
911 support you can write:
912
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500913 #include "config_cmd_all.h"
914 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000915
Gerald Van Barend6abef42007-03-31 12:23:51 -0400916 Other Commands:
917 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000918
919 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500920 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000921 what you (and your U-Boot users) are doing. Data
922 cache cannot be enabled on systems like the 8xx or
923 8260 (where accesses to the IMMR region must be
924 uncached), and it cannot be disabled on all other
925 systems where we (mis-) use the data cache to hold an
926 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000927
928
929 XXX - this list needs to get updated!
930
Simon Glassaa34ef22016-03-13 19:07:28 -0600931- Removal of commands
932 If no commands are needed to boot, you can disable
933 CONFIG_CMDLINE to remove them. In this case, the command line
934 will not be available, and when U-Boot wants to execute the
935 boot command (on start-up) it will call board_run_command()
936 instead. This can reduce image size significantly for very
937 simple boot procedures.
938
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000939- Regular expression support:
940 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200941 If this variable is defined, U-Boot is linked against
942 the SLRE (Super Light Regular Expression) library,
943 which adds regex support to some commands, as for
944 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000945
Simon Glass3d686442011-10-15 05:48:20 +0000946- Device tree:
947 CONFIG_OF_CONTROL
948 If this variable is defined, U-Boot will use a device tree
949 to configure its devices, instead of relying on statically
950 compiled #defines in the board file. This option is
951 experimental and only available on a few boards. The device
952 tree is available in the global data as gd->fdt_blob.
953
Simon Glass5cb34db2011-10-24 19:15:31 +0000954 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700955 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000956
957 CONFIG_OF_EMBED
958 If this variable is defined, U-Boot will embed a device tree
959 binary in its image. This device tree file should be in the
960 board directory and called <soc>-<board>.dts. The binary file
961 is then picked up in board_init_f() and made available through
962 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000963
Simon Glass5cb34db2011-10-24 19:15:31 +0000964 CONFIG_OF_SEPARATE
965 If this variable is defined, U-Boot will build a device tree
966 binary. It will be called u-boot.dtb. Architecture-specific
967 code will locate it at run-time. Generally this works by:
968
969 cat u-boot.bin u-boot.dtb >image.bin
970
971 and in fact, U-Boot does this for you, creating a file called
972 u-boot-dtb.bin which is useful in the common case. You can
973 still use the individual files if you need something more
974 exotic.
975
Alex Deymo5b661ec2017-04-02 01:25:20 -0700976 CONFIG_OF_BOARD
977 If this variable is defined, U-Boot will use the device tree
978 provided by the board at runtime instead of embedding one with
979 the image. Only boards defining board_fdt_blob_setup() support
980 this option (see include/fdtdec.h file).
981
wdenkc6097192002-11-03 00:24:07 +0000982- Watchdog:
983 CONFIG_WATCHDOG
984 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000985 support for the SoC. There must be support in the SoC
986 specific code for a watchdog. For the 8xx and 8260
987 CPUs, the SIU Watchdog feature is enabled in the SYPCR
988 register. When supported for a specific SoC is
989 available, then no further board specific code should
990 be needed to use it.
991
992 CONFIG_HW_WATCHDOG
993 When using a watchdog circuitry external to the used
994 SoC, then define this variable and provide board
995 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000996
Heiko Schocher735326c2015-01-21 08:38:22 +0100997 CONFIG_AT91_HW_WDT_TIMEOUT
998 specify the timeout in seconds. default 2 seconds.
999
stroeseb9c17c52003-04-04 15:53:41 +00001000- U-Boot Version:
1001 CONFIG_VERSION_VARIABLE
1002 If this variable is defined, an environment variable
1003 named "ver" is created by U-Boot showing the U-Boot
1004 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001005 Any change to this variable will be reverted at the
1006 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001007
wdenkc6097192002-11-03 00:24:07 +00001008- Real-Time Clock:
1009
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001010 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001011 has to be selected, too. Define exactly one of the
1012 following options:
1013
1014 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1015 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001016 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001017 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001018 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001019 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001020 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001021 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001022 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001023 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001024 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001025 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001026 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1027 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001028
wdenkb9bbd242003-06-30 16:24:52 +00001029 Note that if the RTC uses I2C, then the I2C interface
1030 must also be configured. See I2C Support, below.
1031
Peter Tyser9902e422008-12-17 16:36:21 -06001032- GPIO Support:
1033 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001034
Chris Packham9b383202010-12-19 10:12:13 +00001035 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1036 chip-ngpio pairs that tell the PCA953X driver the number of
1037 pins supported by a particular chip.
1038
Peter Tyser9902e422008-12-17 16:36:21 -06001039 Note that if the GPIO device uses I2C, then the I2C interface
1040 must also be configured. See I2C Support, below.
1041
Simon Glass4dc47ca2014-06-11 23:29:41 -06001042- I/O tracing:
1043 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1044 accesses and can checksum them or write a list of them out
1045 to memory. See the 'iotrace' command for details. This is
1046 useful for testing device drivers since it can confirm that
1047 the driver behaves the same way before and after a code
1048 change. Currently this is supported on sandbox and arm. To
1049 add support for your architecture, add '#include <iotrace.h>'
1050 to the bottom of arch/<arch>/include/asm/io.h and test.
1051
1052 Example output from the 'iotrace stats' command is below.
1053 Note that if the trace buffer is exhausted, the checksum will
1054 still continue to operate.
1055
1056 iotrace is enabled
1057 Start: 10000000 (buffer start address)
1058 Size: 00010000 (buffer size)
1059 Offset: 00000120 (current buffer offset)
1060 Output: 10000120 (start + offset)
1061 Count: 00000018 (number of trace records)
1062 CRC32: 9526fb66 (CRC32 of all trace records)
1063
wdenkc6097192002-11-03 00:24:07 +00001064- Timestamp Support:
1065
wdenk4a5c8a72003-03-06 00:02:04 +00001066 When CONFIG_TIMESTAMP is selected, the timestamp
1067 (date and time) of an image is printed by image
1068 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001069 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001070
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001071- Partition Labels (disklabels) Supported:
1072 Zero or more of the following:
1073 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1074 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1075 Intel architecture, USB sticks, etc.
1076 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1077 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1078 bootloader. Note 2TB partition limit; see
1079 disk/part_efi.c
1080 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001081
Simon Glassb569a012017-05-17 03:25:30 -06001082 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001083 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001084 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001085
1086- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001087 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1088 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001089
wdenk369d43d2004-03-14 14:09:05 +00001090 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1091 be performed by calling the function
1092 ide_set_reset(int reset)
1093 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001094
1095- ATAPI Support:
1096 CONFIG_ATAPI
1097
1098 Set this to enable ATAPI support.
1099
wdenkf602aa02004-03-13 23:29:43 +00001100- LBA48 Support
1101 CONFIG_LBA48
1102
1103 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001104 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001105 Whithout these , LBA48 support uses 32bit variables and will 'only'
1106 support disks up to 2.1TB.
1107
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001108 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001109 When enabled, makes the IDE subsystem use 64bit sector addresses.
1110 Default is 32bit.
1111
wdenkc6097192002-11-03 00:24:07 +00001112- SCSI Support:
1113 At the moment only there is only support for the
1114 SYM53C8XX SCSI controller; define
1115 CONFIG_SCSI_SYM53C8XX to enable it.
1116
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001117 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1118 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1119 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001120 maximum numbers of LUNs, SCSI ID's and target
1121 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001122 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001123
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001124 The environment variable 'scsidevs' is set to the number of
1125 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001126
wdenkc6097192002-11-03 00:24:07 +00001127- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001128 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001129 Support for Intel 8254x/8257x gigabit chips.
1130
1131 CONFIG_E1000_SPI
1132 Utility code for direct access to the SPI bus on Intel 8257x.
1133 This does not do anything useful unless you set at least one
1134 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1135
1136 CONFIG_E1000_SPI_GENERIC
1137 Allow generic access to the SPI bus on the Intel 8257x, for
1138 example with the "sspi" command.
1139
1140 CONFIG_CMD_E1000
1141 Management command for E1000 devices. When used on devices
1142 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001143
wdenkc6097192002-11-03 00:24:07 +00001144 CONFIG_EEPRO100
1145 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001146 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001147 write routine for first time initialisation.
1148
1149 CONFIG_TULIP
1150 Support for Digital 2114x chips.
1151 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1152 modem chip initialisation (KS8761/QS6611).
1153
1154 CONFIG_NATSEMI
1155 Support for National dp83815 chips.
1156
1157 CONFIG_NS8382X
1158 Support for National dp8382[01] gigabit chips.
1159
wdenkaa603362003-05-12 21:50:16 +00001160- NETWORK Support (other):
1161
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001162 CONFIG_DRIVER_AT91EMAC
1163 Support for AT91RM9200 EMAC.
1164
1165 CONFIG_RMII
1166 Define this to use reduced MII inteface
1167
1168 CONFIG_DRIVER_AT91EMAC_QUIET
1169 If this defined, the driver is quiet.
1170 The driver doen't show link status messages.
1171
Rob Herringc9830dc2011-12-15 11:15:49 +00001172 CONFIG_CALXEDA_XGMAC
1173 Support for the Calxeda XGMAC device
1174
Ashok93fb8722012-10-15 06:20:47 +00001175 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001176 Support for SMSC's LAN91C96 chips.
1177
wdenkaa603362003-05-12 21:50:16 +00001178 CONFIG_LAN91C96_USE_32_BIT
1179 Define this to enable 32 bit addressing
1180
Ashok93fb8722012-10-15 06:20:47 +00001181 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001182 Support for SMSC's LAN91C111 chip
1183
1184 CONFIG_SMC91111_BASE
1185 Define this to hold the physical address
1186 of the device (I/O space)
1187
1188 CONFIG_SMC_USE_32_BIT
1189 Define this if data bus is 32 bits
1190
1191 CONFIG_SMC_USE_IOFUNCS
1192 Define this to use i/o functions instead of macros
1193 (some hardware wont work with macros)
1194
Heiko Schocher7d037f72011-11-15 10:00:04 -05001195 CONFIG_DRIVER_TI_EMAC
1196 Support for davinci emac
1197
1198 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1199 Define this if you have more then 3 PHYs.
1200
Macpaul Lin199c6252010-12-21 16:59:46 +08001201 CONFIG_FTGMAC100
1202 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1203
1204 CONFIG_FTGMAC100_EGIGA
1205 Define this to use GE link update with gigabit PHY.
1206 Define this if FTGMAC100 is connected to gigabit PHY.
1207 If your system has 10/100 PHY only, it might not occur
1208 wrong behavior. Because PHY usually return timeout or
1209 useless data when polling gigabit status and gigabit
1210 control registers. This behavior won't affect the
1211 correctnessof 10/100 link speed update.
1212
Mike Rapoportf4761af2009-11-11 10:03:03 +02001213 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001214 Support for SMSC's LAN911x and LAN921x chips
1215
Mike Rapoportf4761af2009-11-11 10:03:03 +02001216 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001217 Define this to hold the physical address
1218 of the device (I/O space)
1219
Mike Rapoportf4761af2009-11-11 10:03:03 +02001220 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001221 Define this if data bus is 32 bits
1222
Mike Rapoportf4761af2009-11-11 10:03:03 +02001223 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001224 Define this if data bus is 16 bits. If your processor
1225 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001226 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001227
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001228 CONFIG_SH_ETHER
1229 Support for Renesas on-chip Ethernet controller
1230
1231 CONFIG_SH_ETHER_USE_PORT
1232 Define the number of ports to be used
1233
1234 CONFIG_SH_ETHER_PHY_ADDR
1235 Define the ETH PHY's address
1236
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001237 CONFIG_SH_ETHER_CACHE_WRITEBACK
1238 If this option is set, the driver enables cache flush.
1239
Heiko Schocher2b387762014-07-18 06:07:19 +02001240- PWM Support:
1241 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001242 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001243
Vadim Bendeburydac69642011-10-17 08:36:14 +00001244- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001245 CONFIG_TPM
1246 Support TPM devices.
1247
Christophe Ricard8759ff82015-10-06 22:54:41 +02001248 CONFIG_TPM_TIS_INFINEON
1249 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001250 per system is supported at this time.
1251
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001252 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1253 Define the burst count bytes upper limit
1254
Christophe Ricard88249232016-01-21 23:27:13 +01001255 CONFIG_TPM_ST33ZP24
1256 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1257
1258 CONFIG_TPM_ST33ZP24_I2C
1259 Support for STMicroelectronics ST33ZP24 I2C devices.
1260 Requires TPM_ST33ZP24 and I2C.
1261
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001262 CONFIG_TPM_ST33ZP24_SPI
1263 Support for STMicroelectronics ST33ZP24 SPI devices.
1264 Requires TPM_ST33ZP24 and SPI.
1265
Dirk Eibach20489092013-06-26 15:55:15 +02001266 CONFIG_TPM_ATMEL_TWI
1267 Support for Atmel TWI TPM device. Requires I2C support.
1268
Che-liang Chiouacea5702013-04-12 11:04:34 +00001269 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001270 Support for generic parallel port TPM devices. Only one device
1271 per system is supported at this time.
1272
1273 CONFIG_TPM_TIS_BASE_ADDRESS
1274 Base address where the generic TPM device is mapped
1275 to. Contemporary x86 systems usually map it at
1276 0xfed40000.
1277
Reinhard Pfau4fece432013-06-26 15:55:13 +02001278 CONFIG_CMD_TPM
1279 Add tpm monitor functions.
1280 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1281 provides monitor access to authorized functions.
1282
1283 CONFIG_TPM
1284 Define this to enable the TPM support library which provides
1285 functional interfaces to some TPM commands.
1286 Requires support for a TPM device.
1287
1288 CONFIG_TPM_AUTH_SESSIONS
1289 Define this to enable authorized functions in the TPM library.
1290 Requires CONFIG_TPM and CONFIG_SHA1.
1291
wdenkc6097192002-11-03 00:24:07 +00001292- USB Support:
1293 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001294 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001295 CONFIG_USB_UHCI to enable it.
1296 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001297 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001298 storage devices.
1299 Note:
1300 Supported are USB Keyboards and USB Floppy drives
1301 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001302 MPC5200 USB requires additional defines:
1303 CONFIG_USB_CLOCK
1304 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001305 CONFIG_PSC3_USB
1306 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001307 CONFIG_USB_CONFIG
1308 for differential drivers: 0x00001000
1309 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001310 for differential drivers on PSC3: 0x00000100
1311 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001312 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001313 May be defined to allow interrupt polling
1314 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001315
Simon Glass5978cdb2012-02-27 10:52:47 +00001316 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1317 txfilltuning field in the EHCI controller on reset.
1318
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001319 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1320 HW module registers.
1321
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001322- USB Device:
1323 Define the below if you wish to use the USB console.
1324 Once firmware is rebuilt from a serial console issue the
1325 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001326 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001327 it has found a new device. The environment variable usbtty
1328 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001329 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001330 Common Device Class Abstract Control Model serial device.
1331 If you select usbtty = gserial you should be able to enumerate
1332 a Linux host by
1333 # modprobe usbserial vendor=0xVendorID product=0xProductID
1334 else if using cdc_acm, simply setting the environment
1335 variable usbtty to be cdc_acm should suffice. The following
1336 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001337
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001338 CONFIG_USB_DEVICE
1339 Define this to build a UDC device
1340
1341 CONFIG_USB_TTY
1342 Define this to have a tty type of device available to
1343 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001344
Vipin KUMARbdb17702012-03-26 15:38:06 +05301345 CONFIG_USBD_HS
1346 Define this to enable the high speed support for usb
1347 device and usbtty. If this feature is enabled, a routine
1348 int is_usbd_high_speed(void)
1349 also needs to be defined by the driver to dynamically poll
1350 whether the enumeration has succeded at high speed or full
1351 speed.
1352
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001353 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001354 Define this if you want stdin, stdout &/or stderr to
1355 be set to usbtty.
1356
1357 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001358 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001359 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001360 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001361
Wolfgang Denke2601822006-06-14 18:14:56 +02001362 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001363 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001364 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001365 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1366 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1367 should pretend to be a Linux device to it's target host.
1368
1369 CONFIG_USBD_MANUFACTURER
1370 Define this string as the name of your company for
1371 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001372
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001373 CONFIG_USBD_PRODUCT_NAME
1374 Define this string as the name of your product
1375 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001376
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001377 CONFIG_USBD_VENDORID
1378 Define this as your assigned Vendor ID from the USB
1379 Implementors Forum. This *must* be a genuine Vendor ID
1380 to avoid polluting the USB namespace.
1381 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001382
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001383 CONFIG_USBD_PRODUCTID
1384 Define this as the unique Product ID
1385 for your device
1386 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001387
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001388- ULPI Layer Support:
1389 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1390 the generic ULPI layer. The generic layer accesses the ULPI PHY
1391 via the platform viewport, so you need both the genric layer and
1392 the viewport enabled. Currently only Chipidea/ARC based
1393 viewport is supported.
1394 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1395 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001396 If your ULPI phy needs a different reference clock than the
1397 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1398 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001399
wdenk7a428cc2003-06-15 22:40:42 +00001400- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001401 The MMC controller on the Intel PXA is supported. To
1402 enable this define CONFIG_MMC. The MMC can be
1403 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001404 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001405 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1406 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001407
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001408 CONFIG_SH_MMCIF
1409 Support for Renesas on-chip MMCIF controller
1410
1411 CONFIG_SH_MMCIF_ADDR
1412 Define the base address of MMCIF registers
1413
1414 CONFIG_SH_MMCIF_CLK
1415 Define the clock frequency for MMCIF
1416
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001417 CONFIG_SUPPORT_EMMC_BOOT
1418 Enable some additional features of the eMMC boot partitions.
1419
1420 CONFIG_SUPPORT_EMMC_RPMB
1421 Enable the commands for reading, writing and programming the
1422 key for the Replay Protection Memory Block partition in eMMC.
1423
Tom Rini58a8d322013-03-14 05:32:47 +00001424- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001425 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001426 This enables the USB portion of the DFU USB class
1427
1428 CONFIG_CMD_DFU
1429 This enables the command "dfu" which is used to have
1430 U-Boot create a DFU class device via USB. This command
1431 requires that the "dfu_alt_info" environment variable be
1432 set and define the alt settings to expose to the host.
1433
1434 CONFIG_DFU_MMC
1435 This enables support for exposing (e)MMC devices via DFU.
1436
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001437 CONFIG_DFU_NAND
1438 This enables support for exposing NAND devices via DFU.
1439
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301440 CONFIG_DFU_RAM
1441 This enables support for exposing RAM via DFU.
1442 Note: DFU spec refer to non-volatile memory usage, but
1443 allow usages beyond the scope of spec - here RAM usage,
1444 one that would help mostly the developer.
1445
Heiko Schochera2f831e2013-06-12 06:05:51 +02001446 CONFIG_SYS_DFU_DATA_BUF_SIZE
1447 Dfu transfer uses a buffer before writing data to the
1448 raw storage device. Make the size (in bytes) of this buffer
1449 configurable. The size of this buffer is also configurable
1450 through the "dfu_bufsiz" environment variable.
1451
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001452 CONFIG_SYS_DFU_MAX_FILE_SIZE
1453 When updating files rather than the raw storage device,
1454 we use a static buffer to copy the file into and then write
1455 the buffer once we've been given the whole file. Define
1456 this to the maximum filesize (in bytes) for the buffer.
1457 Default is 4 MiB if undefined.
1458
Heiko Schochere1ba1512014-03-18 08:09:56 +01001459 DFU_DEFAULT_POLL_TIMEOUT
1460 Poll timeout [ms], is the timeout a device can send to the
1461 host. The host must wait for this timeout before sending
1462 a subsequent DFU_GET_STATUS request to the device.
1463
1464 DFU_MANIFEST_POLL_TIMEOUT
1465 Poll timeout [ms], which the device sends to the host when
1466 entering dfuMANIFEST state. Host waits this timeout, before
1467 sending again an USB request to the device.
1468
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001469- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001470 CONFIG_USB_FUNCTION_FASTBOOT
1471 This enables the USB part of the fastboot gadget
1472
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001473 CONFIG_CMD_FASTBOOT
1474 This enables the command "fastboot" which enables the Android
1475 fastboot mode for the platform's USB device. Fastboot is a USB
1476 protocol for downloading images, flashing and device control
1477 used on Android devices.
1478 See doc/README.android-fastboot for more information.
1479
1480 CONFIG_ANDROID_BOOT_IMAGE
1481 This enables support for booting images which use the Android
1482 image format header.
1483
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001484 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001485 The fastboot protocol requires a large memory buffer for
1486 downloads. Define this to the starting RAM address to use for
1487 downloaded images.
1488
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001489 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001490 The fastboot protocol requires a large memory buffer for
1491 downloads. This buffer should be as large as possible for a
1492 platform. Define this to the size available RAM for fastboot.
1493
Steve Raebfb9ba42014-08-26 11:47:28 -07001494 CONFIG_FASTBOOT_FLASH
1495 The fastboot protocol includes a "flash" command for writing
1496 the downloaded image to a non-volatile storage device. Define
1497 this to enable the "fastboot flash" command.
1498
1499 CONFIG_FASTBOOT_FLASH_MMC_DEV
1500 The fastboot "flash" command requires additional information
1501 regarding the non-volatile storage device. Define this to
1502 the eMMC device that fastboot should use to store the image.
1503
Steve Rae7d059342014-12-12 15:51:54 -08001504 CONFIG_FASTBOOT_GPT_NAME
1505 The fastboot "flash" command supports writing the downloaded
1506 image to the Protective MBR and the Primary GUID Partition
1507 Table. (Additionally, this downloaded image is post-processed
1508 to generate and write the Backup GUID Partition Table.)
1509 This occurs when the specified "partition name" on the
1510 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001511 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001512
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001513 CONFIG_FASTBOOT_MBR_NAME
1514 The fastboot "flash" command supports writing the downloaded
1515 image to DOS MBR.
1516 This occurs when the "partition name" specified on the
1517 "fastboot flash" command line matches this value.
1518 If not defined the default value "mbr" is used.
1519
wdenkda04a8b2004-08-02 23:22:59 +00001520- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001521 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001522 Define these for a default partition on a NAND device
1523
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001524 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1525 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001526 Define these for a default partition on a NOR device
1527
Donggeun Kim8f814002011-10-24 21:15:28 +00001528- FAT(File Allocation Table) filesystem write function support:
1529 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001530
1531 Define this to enable support for saving memory data as a
1532 file in FAT formatted partition.
1533
1534 This will also enable the command "fatwrite" enabling the
1535 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001536
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301537- FAT(File Allocation Table) filesystem cluster size:
1538 CONFIG_FS_FAT_MAX_CLUSTSIZE
1539
1540 Define the max cluster size for fat operations else
1541 a default value of 65536 will be defined.
1542
wdenkc6097192002-11-03 00:24:07 +00001543- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001544 See Kconfig help for available keyboard drivers.
1545
1546 CONFIG_KEYBOARD
1547
1548 Define this to enable a custom keyboard support.
1549 This simply calls drv_keyboard_init() which must be
1550 defined in your board-specific files. This option is deprecated
1551 and is only used by novena. For new boards, use driver model
1552 instead.
wdenkc6097192002-11-03 00:24:07 +00001553
1554- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001555 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001556 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001557 SOCs that have a DIU should define this macro to enable DIU
1558 support, and should also define these other macros:
1559
1560 CONFIG_SYS_DIU_ADDR
1561 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001562 CONFIG_CFB_CONSOLE
1563 CONFIG_VIDEO_SW_CURSOR
1564 CONFIG_VGA_AS_SINGLE_DEVICE
1565 CONFIG_VIDEO_LOGO
1566 CONFIG_VIDEO_BMP_LOGO
1567
Timur Tabi32f709e2011-04-11 14:18:22 -05001568 The DIU driver will look for the 'video-mode' environment
1569 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001570 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001571 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001572
wdenkc6097192002-11-03 00:24:07 +00001573- LCD Support: CONFIG_LCD
1574
1575 Define this to enable LCD support (for output to LCD
1576 display); also select one of the supported displays
1577 by defining one of these:
1578
Stelian Popf6f86652008-05-09 21:57:18 +02001579 CONFIG_ATMEL_LCD:
1580
1581 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1582
wdenkc0d54ae2003-11-25 16:55:19 +00001583 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001584
wdenkc0d54ae2003-11-25 16:55:19 +00001585 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001586
wdenkc0d54ae2003-11-25 16:55:19 +00001587 CONFIG_NEC_NL6448BC20
1588
1589 NEC NL6448BC20-08. 6.5", 640x480.
1590 Active, color, single scan.
1591
1592 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001593
wdenkc0d54ae2003-11-25 16:55:19 +00001594 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001595 Active, color, single scan.
1596
1597 CONFIG_SHARP_16x9
1598
1599 Sharp 320x240. Active, color, single scan.
1600 It isn't 16x9, and I am not sure what it is.
1601
1602 CONFIG_SHARP_LQ64D341
1603
1604 Sharp LQ64D341 display, 640x480.
1605 Active, color, single scan.
1606
1607 CONFIG_HLD1045
1608
1609 HLD1045 display, 640x480.
1610 Active, color, single scan.
1611
1612 CONFIG_OPTREX_BW
1613
1614 Optrex CBL50840-2 NF-FW 99 22 M5
1615 or
1616 Hitachi LMG6912RPFC-00T
1617 or
1618 Hitachi SP14Q002
1619
1620 320x240. Black & white.
1621
Simon Glass599a4df2012-10-17 13:24:54 +00001622 CONFIG_LCD_ALIGNMENT
1623
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001624 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001625 defined then the LCD will be aligned to this value instead.
1626 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1627 here, since it is cheaper to change data cache settings on
1628 a per-section basis.
1629
1630
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001631 CONFIG_LCD_ROTATION
1632
1633 Sometimes, for example if the display is mounted in portrait
1634 mode or even if it's mounted landscape but rotated by 180degree,
1635 we need to rotate our content of the display relative to the
1636 framebuffer, so that user can read the messages which are
1637 printed out.
1638 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1639 initialized with a given rotation from "vl_rot" out of
1640 "vidinfo_t" which is provided by the board specific code.
1641 The value for vl_rot is coded as following (matching to
1642 fbcon=rotate:<n> linux-kernel commandline):
1643 0 = no rotation respectively 0 degree
1644 1 = 90 degree rotation
1645 2 = 180 degree rotation
1646 3 = 270 degree rotation
1647
1648 If CONFIG_LCD_ROTATION is not defined, the console will be
1649 initialized with 0degree rotation.
1650
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001651 CONFIG_LCD_BMP_RLE8
1652
1653 Support drawing of RLE8-compressed bitmaps on the LCD.
1654
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001655 CONFIG_I2C_EDID
1656
1657 Enables an 'i2c edid' command which can read EDID
1658 information over I2C from an attached LCD display.
1659
wdenkeb20ad32003-09-05 23:19:14 +00001660- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001661
wdenk57b2d802003-06-27 21:31:46 +00001662 If this option is set, the environment is checked for
1663 a variable "splashimage". If found, the usual display
1664 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001665 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001666 specified in "splashimage" is loaded instead. The
1667 console is redirected to the "nulldev", too. This
1668 allows for a "silent" boot where a splash screen is
1669 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001670
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001671 CONFIG_SPLASHIMAGE_GUARD
1672
1673 If this option is set, then U-Boot will prevent the environment
1674 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001675 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001676 This option is useful for targets where, due to alignment
1677 restrictions, an improperly aligned BMP image will cause a data
1678 abort. If you think you will not have problems with unaligned
1679 accesses (for example because your toolchain prevents them)
1680 there is no need to set this option.
1681
Matthias Weisser53884182009-07-09 16:07:30 +02001682 CONFIG_SPLASH_SCREEN_ALIGN
1683
1684 If this option is set the splash image can be freely positioned
1685 on the screen. Environment variable "splashpos" specifies the
1686 position as "x,y". If a positive number is given it is used as
1687 number of pixel from left/top. If a negative number is given it
1688 is used as number of pixel from right/bottom. You can also
1689 specify 'm' for centering the image.
1690
1691 Example:
1692 setenv splashpos m,m
1693 => image at center of screen
1694
1695 setenv splashpos 30,20
1696 => image at x = 30 and y = 20
1697
1698 setenv splashpos -10,m
1699 => vertically centered image
1700 at x = dspWidth - bmpWidth - 9
1701
Stefan Roesed9d97742005-09-22 09:04:17 +02001702- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1703
1704 If this option is set, additionally to standard BMP
1705 images, gzipped BMP images can be displayed via the
1706 splashscreen support or the bmp command.
1707
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001708- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1709
1710 If this option is set, 8-bit RLE compressed BMP images
1711 can be displayed via the splashscreen support or the
1712 bmp command.
1713
wdenk710e3502003-08-29 20:57:53 +00001714- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001715 CONFIG_GZIP
1716
1717 Enabled by default to support gzip compressed images.
1718
wdenk710e3502003-08-29 20:57:53 +00001719 CONFIG_BZIP2
1720
1721 If this option is set, support for bzip2 compressed
1722 images is included. If not, only uncompressed and gzip
1723 compressed images are supported.
1724
wdenk9c53f402003-10-15 23:53:47 +00001725 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001726 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001727 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001728
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001729 CONFIG_LZMA
1730
1731 If this option is set, support for lzma compressed
1732 images is included.
1733
1734 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1735 requires an amount of dynamic memory that is given by the
1736 formula:
1737
1738 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1739
1740 Where lc and lp stand for, respectively, Literal context bits
1741 and Literal pos bits.
1742
1743 This value is upper-bounded by 14MB in the worst case. Anyway,
1744 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1745 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1746 a very small buffer.
1747
1748 Use the lzmainfo tool to determinate the lc and lp values and
1749 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001750 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001751
Kees Cook5b06e642013-08-16 07:59:12 -07001752 CONFIG_LZO
1753
1754 If this option is set, support for LZO compressed images
1755 is included.
1756
wdenk0e2bd9c2004-06-06 21:51:03 +00001757- MII/PHY support:
1758 CONFIG_PHY_ADDR
1759
1760 The address of PHY on MII bus.
1761
1762 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1763
1764 The clock frequency of the MII bus
1765
1766 CONFIG_PHY_GIGE
1767
1768 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001769 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001770
1771 CONFIG_PHY_RESET_DELAY
1772
1773 Some PHY like Intel LXT971A need extra delay after
1774 reset before any MII register access is possible.
1775 For such PHY, set this option to the usec delay
1776 required. (minimum 300usec for LXT971A)
1777
1778 CONFIG_PHY_CMD_DELAY (ppc4xx)
1779
1780 Some PHY like Intel LXT971A need extra delay after
1781 command issued before MII status register can be read
1782
wdenkc6097192002-11-03 00:24:07 +00001783- IP address:
1784 CONFIG_IPADDR
1785
1786 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001787 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001788 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001789 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001790
1791- Server IP address:
1792 CONFIG_SERVERIP
1793
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001794 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001795 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001796 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001797
Robin Getz470a6d42009-07-21 12:15:28 -04001798 CONFIG_KEEP_SERVERADDR
1799
1800 Keeps the server's MAC address, in the env 'serveraddr'
1801 for passing to bootargs (like Linux's netconsole option)
1802
Wolfgang Denk26da2992011-10-26 10:21:22 +00001803- Gateway IP address:
1804 CONFIG_GATEWAYIP
1805
1806 Defines a default value for the IP address of the
1807 default router where packets to other networks are
1808 sent to.
1809 (Environment variable "gatewayip")
1810
1811- Subnet mask:
1812 CONFIG_NETMASK
1813
1814 Defines a default value for the subnet mask (or
1815 routing prefix) which is used to determine if an IP
1816 address belongs to the local subnet or needs to be
1817 forwarded through a router.
1818 (Environment variable "netmask")
1819
David Updegraff7280da72007-06-11 10:41:07 -05001820- Multicast TFTP Mode:
1821 CONFIG_MCAST_TFTP
1822
1823 Defines whether you want to support multicast TFTP as per
1824 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001825 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001826 driver in use must provide a function: mcast() to join/leave a
1827 multicast group.
1828
wdenkc6097192002-11-03 00:24:07 +00001829- BOOTP Recovery Mode:
1830 CONFIG_BOOTP_RANDOM_DELAY
1831
1832 If you have many targets in a network that try to
1833 boot using BOOTP, you may want to avoid that all
1834 systems send out BOOTP requests at precisely the same
1835 moment (which would happen for instance at recovery
1836 from a power failure, when all systems will try to
1837 boot, thus flooding the BOOTP server. Defining
1838 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1839 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001840 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001841
1842 1st BOOTP request: delay 0 ... 1 sec
1843 2nd BOOTP request: delay 0 ... 2 sec
1844 3rd BOOTP request: delay 0 ... 4 sec
1845 4th and following
1846 BOOTP requests: delay 0 ... 8 sec
1847
Thierry Reding8977cda2014-08-19 10:21:24 +02001848 CONFIG_BOOTP_ID_CACHE_SIZE
1849
1850 BOOTP packets are uniquely identified using a 32-bit ID. The
1851 server will copy the ID from client requests to responses and
1852 U-Boot will use this to determine if it is the destination of
1853 an incoming response. Some servers will check that addresses
1854 aren't in use before handing them out (usually using an ARP
1855 ping) and therefore take up to a few hundred milliseconds to
1856 respond. Network congestion may also influence the time it
1857 takes for a response to make it back to the client. If that
1858 time is too long, U-Boot will retransmit requests. In order
1859 to allow earlier responses to still be accepted after these
1860 retransmissions, U-Boot's BOOTP client keeps a small cache of
1861 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1862 cache. The default is to keep IDs for up to four outstanding
1863 requests. Increasing this will allow U-Boot to accept offers
1864 from a BOOTP client in networks with unusually high latency.
1865
stroesee0aadfb2003-08-28 14:17:32 +00001866- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001867 You can fine tune the DHCP functionality by defining
1868 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001869
Jon Loeliger5336a762007-07-09 22:08:34 -05001870 CONFIG_BOOTP_SUBNETMASK
1871 CONFIG_BOOTP_GATEWAY
1872 CONFIG_BOOTP_HOSTNAME
1873 CONFIG_BOOTP_NISDOMAIN
1874 CONFIG_BOOTP_BOOTPATH
1875 CONFIG_BOOTP_BOOTFILESIZE
1876 CONFIG_BOOTP_DNS
1877 CONFIG_BOOTP_DNS2
1878 CONFIG_BOOTP_SEND_HOSTNAME
1879 CONFIG_BOOTP_NTPSERVER
1880 CONFIG_BOOTP_TIMEOFFSET
1881 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001882 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001883
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001884 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1885 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001886
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001887 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1888 after the configured retry count, the call will fail
1889 instead of starting over. This can be used to fail over
1890 to Link-local IP address configuration if the DHCP server
1891 is not available.
1892
stroesee0aadfb2003-08-28 14:17:32 +00001893 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1894 serverip from a DHCP server, it is possible that more
1895 than one DNS serverip is offered to the client.
1896 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1897 serverip will be stored in the additional environment
1898 variable "dnsip2". The first DNS serverip is always
1899 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001900 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001901
1902 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1903 to do a dynamic update of a DNS server. To do this, they
1904 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001905 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001906 of the "hostname" environment variable is passed as
1907 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001908
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001909 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1910
1911 A 32bit value in microseconds for a delay between
1912 receiving a "DHCP Offer" and sending the "DHCP Request".
1913 This fixes a problem with certain DHCP servers that don't
1914 respond 100% of the time to a "DHCP request". E.g. On an
1915 AT91RM9200 processor running at 180MHz, this delay needed
1916 to be *at least* 15,000 usec before a Windows Server 2003
1917 DHCP server would reply 100% of the time. I recommend at
1918 least 50,000 usec to be safe. The alternative is to hope
1919 that one of the retries will be successful but note that
1920 the DHCP timeout and retry process takes a longer than
1921 this delay.
1922
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001923 - Link-local IP address negotiation:
1924 Negotiate with other link-local clients on the local network
1925 for an address that doesn't require explicit configuration.
1926 This is especially useful if a DHCP server cannot be guaranteed
1927 to exist in all environments that the device must operate.
1928
1929 See doc/README.link-local for more information.
1930
wdenk145d2c12004-04-15 21:48:45 +00001931 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001932 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001933
1934 The device id used in CDP trigger frames.
1935
1936 CONFIG_CDP_DEVICE_ID_PREFIX
1937
1938 A two character string which is prefixed to the MAC address
1939 of the device.
1940
1941 CONFIG_CDP_PORT_ID
1942
1943 A printf format string which contains the ascii name of
1944 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001945 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001946
1947 CONFIG_CDP_CAPABILITIES
1948
1949 A 32bit integer which indicates the device capabilities;
1950 0x00000010 for a normal host which does not forwards.
1951
1952 CONFIG_CDP_VERSION
1953
1954 An ascii string containing the version of the software.
1955
1956 CONFIG_CDP_PLATFORM
1957
1958 An ascii string containing the name of the platform.
1959
1960 CONFIG_CDP_TRIGGER
1961
1962 A 32bit integer sent on the trigger.
1963
1964 CONFIG_CDP_POWER_CONSUMPTION
1965
1966 A 16bit integer containing the power consumption of the
1967 device in .1 of milliwatts.
1968
1969 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1970
1971 A byte containing the id of the VLAN.
1972
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001973- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001974
1975 Several configurations allow to display the current
1976 status using a LED. For instance, the LED will blink
1977 fast while running U-Boot code, stop blinking as
1978 soon as a reply to a BOOTP request was received, and
1979 start blinking slow once the Linux kernel is running
1980 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001981 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001982 feature in U-Boot.
1983
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001984 Additional options:
1985
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001986 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001987 The status LED can be connected to a GPIO pin.
1988 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001989 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001990 to include the gpio_led driver in the U-Boot binary.
1991
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001992 CONFIG_GPIO_LED_INVERTED_TABLE
1993 Some GPIO connected LEDs may have inverted polarity in which
1994 case the GPIO high value corresponds to LED off state and
1995 GPIO low value corresponds to LED on state.
1996 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1997 with a list of GPIO LEDs that have inverted polarity.
1998
wdenkc6097192002-11-03 00:24:07 +00001999- CAN Support: CONFIG_CAN_DRIVER
2000
2001 Defining CONFIG_CAN_DRIVER enables CAN driver support
2002 on those systems that support this (optional)
2003 feature, like the TQM8xxL modules.
2004
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002005- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002006
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002007 This enable the NEW i2c subsystem, and will allow you to use
2008 i2c commands at the u-boot command line (as long as you set
2009 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2010 based realtime clock chips or other i2c devices. See
2011 common/cmd_i2c.c for a description of the command line
2012 interface.
2013
2014 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002015 - drivers/i2c/soft_i2c.c:
2016 - activate first bus with CONFIG_SYS_I2C_SOFT define
2017 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2018 for defining speed and slave address
2019 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2020 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2021 for defining speed and slave address
2022 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2023 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2024 for defining speed and slave address
2025 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2026 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2027 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002028
Heiko Schocherf2850742012-10-24 13:48:22 +02002029 - drivers/i2c/fsl_i2c.c:
2030 - activate i2c driver with CONFIG_SYS_I2C_FSL
2031 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2032 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2033 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2034 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002035 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002036 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2037 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2038 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2039 second bus.
2040
Simon Glass026fefb2012-10-30 07:28:53 +00002041 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002042 - activate this driver with CONFIG_SYS_I2C_TEGRA
2043 - This driver adds 4 i2c buses with a fix speed from
2044 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002045
Dirk Eibach42b204f2013-04-25 02:40:01 +00002046 - drivers/i2c/ppc4xx_i2c.c
2047 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2048 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2049 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2050
trema49f40a2013-09-21 18:13:35 +02002051 - drivers/i2c/i2c_mxc.c
2052 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002053 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2054 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2055 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2056 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002057 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2058 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2059 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2060 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2061 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2062 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002063 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2064 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002065 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002066 for speed, and 0 for slave.
2067
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002068 - drivers/i2c/rcar_i2c.c:
2069 - activate this driver with CONFIG_SYS_I2C_RCAR
2070 - This driver adds 4 i2c buses
2071
2072 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2073 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2074 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2075 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2076 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2077 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2078 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2079 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2080 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2081
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002082 - drivers/i2c/sh_i2c.c:
2083 - activate this driver with CONFIG_SYS_I2C_SH
2084 - This driver adds from 2 to 5 i2c buses
2085
2086 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2087 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2088 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2089 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2090 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2091 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2092 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2093 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2094 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2095 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002096 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002097
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002098 - drivers/i2c/omap24xx_i2c.c
2099 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2100 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2101 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2102 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2103 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2104 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2105 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2106 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2107 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2108 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2109 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2110
Heiko Schocher465819a2013-11-08 07:30:53 +01002111 - drivers/i2c/zynq_i2c.c
2112 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2113 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2114 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2115
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302116 - drivers/i2c/s3c24x0_i2c.c:
2117 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2118 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2119 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2120 with a fix speed from 100000 and the slave addr 0!
2121
Dirk Eibachb9577432014-07-03 09:28:18 +02002122 - drivers/i2c/ihs_i2c.c
2123 - activate this driver with CONFIG_SYS_I2C_IHS
2124 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2125 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2126 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2127 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2128 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2129 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2130 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2131 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2132 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2133 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2134 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2135 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002136 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2137 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2138 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2139 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2140 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2141 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2142 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2143 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2144 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002145
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002146 additional defines:
2147
2148 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002149 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002150
2151 CONFIG_SYS_I2C_DIRECT_BUS
2152 define this, if you don't use i2c muxes on your hardware.
2153 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2154 omit this define.
2155
2156 CONFIG_SYS_I2C_MAX_HOPS
2157 define how many muxes are maximal consecutively connected
2158 on one i2c bus. If you not use i2c muxes, omit this
2159 define.
2160
2161 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002162 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002163 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2164 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2165 CONFIG_SYS_NUM_I2C_BUSES = 9:
2166
2167 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2168 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2169 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2170 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2171 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2172 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2173 {1, {I2C_NULL_HOP}}, \
2174 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2175 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2176 }
2177
2178 which defines
2179 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002180 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2181 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2182 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2183 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2184 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002185 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002186 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2187 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002188
2189 If you do not have i2c muxes on your board, omit this define.
2190
Simon Glass3efce392017-05-12 21:10:00 -06002191- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002192 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002193 then the following macros need to be defined (examples are
2194 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002195
2196 I2C_INIT
2197
wdenkb9bbd242003-06-30 16:24:52 +00002198 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002199 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002200
wdenk544e9732004-02-06 23:19:44 +00002201 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002202
wdenkc6097192002-11-03 00:24:07 +00002203 I2C_PORT
2204
wdenk4a5c8a72003-03-06 00:02:04 +00002205 (Only for MPC8260 CPU). The I/O port to use (the code
2206 assumes both bits are on the same port). Valid values
2207 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002208
2209 I2C_ACTIVE
2210
2211 The code necessary to make the I2C data line active
2212 (driven). If the data line is open collector, this
2213 define can be null.
2214
wdenkb9bbd242003-06-30 16:24:52 +00002215 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2216
wdenkc6097192002-11-03 00:24:07 +00002217 I2C_TRISTATE
2218
2219 The code necessary to make the I2C data line tri-stated
2220 (inactive). If the data line is open collector, this
2221 define can be null.
2222
wdenkb9bbd242003-06-30 16:24:52 +00002223 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2224
wdenkc6097192002-11-03 00:24:07 +00002225 I2C_READ
2226
York Sun4a598092013-04-01 11:29:11 -07002227 Code that returns true if the I2C data line is high,
2228 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002229
wdenkb9bbd242003-06-30 16:24:52 +00002230 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2231
wdenkc6097192002-11-03 00:24:07 +00002232 I2C_SDA(bit)
2233
York Sun4a598092013-04-01 11:29:11 -07002234 If <bit> is true, sets the I2C data line high. If it
2235 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002236
wdenkb9bbd242003-06-30 16:24:52 +00002237 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002238 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002239 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002240
wdenkc6097192002-11-03 00:24:07 +00002241 I2C_SCL(bit)
2242
York Sun4a598092013-04-01 11:29:11 -07002243 If <bit> is true, sets the I2C clock line high. If it
2244 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002245
wdenkb9bbd242003-06-30 16:24:52 +00002246 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002247 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002248 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002249
wdenkc6097192002-11-03 00:24:07 +00002250 I2C_DELAY
2251
2252 This delay is invoked four times per clock cycle so this
2253 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002254 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002255 like:
2256
wdenkb9bbd242003-06-30 16:24:52 +00002257 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002258
Mike Frysingeree12d542010-07-21 13:38:02 -04002259 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2260
2261 If your arch supports the generic GPIO framework (asm/gpio.h),
2262 then you may alternatively define the two GPIOs that are to be
2263 used as SCL / SDA. Any of the previous I2C_xxx macros will
2264 have GPIO-based defaults assigned to them as appropriate.
2265
2266 You should define these to the GPIO value as given directly to
2267 the generic GPIO functions.
2268
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002269 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002270
wdenk57b2d802003-06-27 21:31:46 +00002271 When a board is reset during an i2c bus transfer
2272 chips might think that the current transfer is still
2273 in progress. On some boards it is possible to access
2274 the i2c SCLK line directly, either by using the
2275 processor pin as a GPIO or by having a second pin
2276 connected to the bus. If this option is defined a
2277 custom i2c_init_board() routine in boards/xxx/board.c
2278 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002279
Ben Warren45657152006-09-07 16:50:54 -04002280 CONFIG_I2C_MULTI_BUS
2281
2282 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002283 must have a controller. At any point in time, only one bus is
2284 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002285 Note that bus numbering is zero-based.
2286
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002287 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002288
2289 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002290 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002291 is set, specify a list of bus-device pairs. Otherwise, specify
2292 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002293
2294 e.g.
2295 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002296 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002297
2298 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2299
Wolfgang Denk092ae952011-10-26 10:21:21 +00002300 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002301 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002302
2303 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2304
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002305 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002306
2307 If defined, then this indicates the I2C bus number for DDR SPD.
2308 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2309
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002310 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002311
2312 If defined, then this indicates the I2C bus number for the RTC.
2313 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2314
Andrew Dyer58c41f92008-12-29 17:36:01 -06002315 CONFIG_SOFT_I2C_READ_REPEATED_START
2316
2317 defining this will force the i2c_read() function in
2318 the soft_i2c driver to perform an I2C repeated start
2319 between writing the address pointer and reading the
2320 data. If this define is omitted the default behaviour
2321 of doing a stop-start sequence will be used. Most I2C
2322 devices can use either method, but some require one or
2323 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002324
wdenkc6097192002-11-03 00:24:07 +00002325- SPI Support: CONFIG_SPI
2326
2327 Enables SPI driver (so far only tested with
2328 SPI EEPROM, also an instance works with Crystal A/D and
2329 D/As on the SACSng board)
2330
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002331 CONFIG_SH_SPI
2332
2333 Enables the driver for SPI controller on SuperH. Currently
2334 only SH7757 is supported.
2335
wdenkc6097192002-11-03 00:24:07 +00002336 CONFIG_SOFT_SPI
2337
wdenk4a5c8a72003-03-06 00:02:04 +00002338 Enables a software (bit-bang) SPI driver rather than
2339 using hardware support. This is a general purpose
2340 driver that only requires three general I/O port pins
2341 (two outputs, one input) to function. If this is
2342 defined, the board configuration must define several
2343 SPI configuration items (port pins to use, etc). For
2344 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002345
Ben Warren7efe9272008-01-16 22:37:35 -05002346 CONFIG_HARD_SPI
2347
2348 Enables a hardware SPI driver for general-purpose reads
2349 and writes. As with CONFIG_SOFT_SPI, the board configuration
2350 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002351 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002352 example, see include/configs/mpc8349emds.h.
2353
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002354 CONFIG_MXC_SPI
2355
2356 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002357 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002358
Heiko Schocherb77c8882014-07-14 10:22:11 +02002359 CONFIG_SYS_SPI_MXC_WAIT
2360 Timeout for waiting until spi transfer completed.
2361 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2362
Matthias Fuchsa4400872007-12-27 17:12:34 +01002363- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002364
Matthias Fuchsa4400872007-12-27 17:12:34 +01002365 Enables FPGA subsystem.
2366
2367 CONFIG_FPGA_<vendor>
2368
2369 Enables support for specific chip vendors.
2370 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002371
Matthias Fuchsa4400872007-12-27 17:12:34 +01002372 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002373
Matthias Fuchsa4400872007-12-27 17:12:34 +01002374 Enables support for FPGA family.
2375 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2376
2377 CONFIG_FPGA_COUNT
2378
2379 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002380
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002381 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002382
wdenk57b2d802003-06-27 21:31:46 +00002383 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002384
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002385 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002386
wdenk4a5c8a72003-03-06 00:02:04 +00002387 Enable checks on FPGA configuration interface busy
2388 status by the configuration function. This option
2389 will require a board or device specific function to
2390 be written.
wdenkc6097192002-11-03 00:24:07 +00002391
2392 CONFIG_FPGA_DELAY
2393
2394 If defined, a function that provides delays in the FPGA
2395 configuration driver.
2396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002397 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002398 Allow Control-C to interrupt FPGA configuration
2399
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002400 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002401
wdenk4a5c8a72003-03-06 00:02:04 +00002402 Check for configuration errors during FPGA bitfile
2403 loading. For example, abort during Virtex II
2404 configuration if the INIT_B line goes low (which
2405 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002406
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002407 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002408
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002409 Maximum time to wait for the INIT_B line to de-assert
2410 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002411 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002412 ms.
wdenkc6097192002-11-03 00:24:07 +00002413
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002414 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002415
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002416 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002417 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002418
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002419 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002420
wdenk4a5c8a72003-03-06 00:02:04 +00002421 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002422 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002423
2424- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002425 CONFIG_BUILD_TARGET
2426
2427 Some SoCs need special image types (e.g. U-Boot binary
2428 with a special header) as build targets. By defining
2429 CONFIG_BUILD_TARGET in the SoC / board header, this
2430 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002431 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002432
wdenkc6097192002-11-03 00:24:07 +00002433 CONFIG_IDENT_STRING
2434
wdenk4a5c8a72003-03-06 00:02:04 +00002435 If defined, this string will be added to the U-Boot
2436 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002437
2438- Vendor Parameter Protection:
2439
wdenk4a5c8a72003-03-06 00:02:04 +00002440 U-Boot considers the values of the environment
2441 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002442 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002443 are set once by the board vendor / manufacturer, and
2444 protects these variables from casual modification by
2445 the user. Once set, these variables are read-only,
2446 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002447 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002448
2449 If CONFIG_ENV_OVERWRITE is #defined in your config
2450 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002451 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002452 these parameters.
2453
Joe Hershberger76f353e2015-05-04 14:55:14 -05002454 Alternatively, if you define _both_ an ethaddr in the
2455 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002456 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002457 which can be changed exactly ONCE by the user. [The
2458 serial# is unaffected by this, i. e. it remains
2459 read-only.]
2460
Joe Hershberger71497d02012-12-11 22:16:31 -06002461 The same can be accomplished in a more flexible way
2462 for any variable by configuring the type of access
2463 to allow for those variables in the ".flags" variable
2464 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2465
wdenkc6097192002-11-03 00:24:07 +00002466- Protected RAM:
2467 CONFIG_PRAM
2468
2469 Define this variable to enable the reservation of
2470 "protected RAM", i. e. RAM which is not overwritten
2471 by U-Boot. Define CONFIG_PRAM to hold the number of
2472 kB you want to reserve for pRAM. You can overwrite
2473 this default value by defining an environment
2474 variable "pram" to the number of kB you want to
2475 reserve. Note that the board info structure will
2476 still show the full amount of RAM. If pRAM is
2477 reserved, a new environment variable "mem" will
2478 automatically be defined to hold the amount of
2479 remaining RAM in a form that can be passed as boot
2480 argument to Linux, for instance like that:
2481
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002482 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002483 saveenv
2484
2485 This way you can tell Linux not to use this memory,
2486 either, which results in a memory region that will
2487 not be affected by reboots.
2488
2489 *WARNING* If your board configuration uses automatic
2490 detection of the RAM size, you must make sure that
2491 this memory test is non-destructive. So far, the
2492 following board configurations are known to be
2493 "pRAM-clean":
2494
Wolfgang Denk90326762012-10-24 02:36:15 +00002495 IVMS8, IVML24, SPD8xx, TQM8xxL,
2496 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002497 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002498
Gabe Blacka2f3a932012-12-02 04:55:18 +00002499- Access to physical memory region (> 4GB)
2500 Some basic support is provided for operations on memory not
2501 normally accessible to U-Boot - e.g. some architectures
2502 support access to more than 4GB of memory on 32-bit
2503 machines using physical address extension or similar.
2504 Define CONFIG_PHYSMEM to access this basic support, which
2505 currently only supports clearing the memory.
2506
wdenkc6097192002-11-03 00:24:07 +00002507- Error Recovery:
2508 CONFIG_PANIC_HANG
2509
2510 Define this variable to stop the system in case of a
2511 fatal error, so that you have to reset it manually.
2512 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002513 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002514 automatically as fast as possible, but it may be
2515 useful during development since you can try to debug
2516 the conditions that lead to the situation.
2517
2518 CONFIG_NET_RETRY_COUNT
2519
wdenk4a5c8a72003-03-06 00:02:04 +00002520 This variable defines the number of retries for
2521 network operations like ARP, RARP, TFTP, or BOOTP
2522 before giving up the operation. If not defined, a
2523 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002524
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002525 CONFIG_ARP_TIMEOUT
2526
2527 Timeout waiting for an ARP reply in milliseconds.
2528
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002529 CONFIG_NFS_TIMEOUT
2530
2531 Timeout in milliseconds used in NFS protocol.
2532 If you encounter "ERROR: Cannot umount" in nfs command,
2533 try longer timeout such as
2534 #define CONFIG_NFS_TIMEOUT 10000UL
2535
wdenkc6097192002-11-03 00:24:07 +00002536- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002537 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002538
2539 Enable auto completion of commands using TAB.
2540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002541 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002542
2543 This defines the secondary prompt string, which is
2544 printed when the command interpreter needs more input
2545 to complete a command. Usually "> ".
2546
2547 Note:
2548
wdenk57b2d802003-06-27 21:31:46 +00002549 In the current implementation, the local variables
2550 space and global environment variables space are
2551 separated. Local variables are those you define by
2552 simply typing `name=value'. To access a local
2553 variable later on, you have write `$name' or
2554 `${name}'; to execute the contents of a variable
2555 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002556
wdenk4a5c8a72003-03-06 00:02:04 +00002557 Global environment variables are those you use
2558 setenv/printenv to work with. To run a command stored
2559 in such a variable, you need to use the run command,
2560 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002561
2562 To store commands and special characters in a
2563 variable, please use double quotation marks
2564 surrounding the whole text of the variable, instead
2565 of the backslashes before semicolons and special
2566 symbols.
2567
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002568- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002569 CONFIG_CMDLINE_EDITING
2570
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002571 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002572 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002573
Marek Vasut734fb042016-01-27 04:47:55 +01002574- Command Line PS1/PS2 support:
2575 CONFIG_CMDLINE_PS_SUPPORT
2576
2577 Enable support for changing the command prompt string
2578 at run-time. Only static string is supported so far.
2579 The string is obtained from environment variables PS1
2580 and PS2.
2581
wdenkc0aa5c52003-12-06 19:49:23 +00002582- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002583 CONFIG_EXTRA_ENV_SETTINGS
2584
wdenk4a5c8a72003-03-06 00:02:04 +00002585 Define this to contain any number of null terminated
2586 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002587 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002588
wdenk4a5c8a72003-03-06 00:02:04 +00002589 For example, place something like this in your
2590 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002591
2592 #define CONFIG_EXTRA_ENV_SETTINGS \
2593 "myvar1=value1\0" \
2594 "myvar2=value2\0"
2595
wdenk4a5c8a72003-03-06 00:02:04 +00002596 Warning: This method is based on knowledge about the
2597 internal format how the environment is stored by the
2598 U-Boot code. This is NOT an official, exported
2599 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002600 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002601 You better know what you are doing here.
2602
wdenk4a5c8a72003-03-06 00:02:04 +00002603 Note: overly (ab)use of the default environment is
2604 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002605 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002606 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002607
Stephen Warren1465d5f2012-05-22 09:21:54 +00002608 CONFIG_ENV_VARS_UBOOT_CONFIG
2609
2610 Define this in order to add variables describing the
2611 U-Boot build configuration to the default environment.
2612 These will be named arch, cpu, board, vendor, and soc.
2613
2614 Enabling this option will cause the following to be defined:
2615
2616 - CONFIG_SYS_ARCH
2617 - CONFIG_SYS_CPU
2618 - CONFIG_SYS_BOARD
2619 - CONFIG_SYS_VENDOR
2620 - CONFIG_SYS_SOC
2621
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002622 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2623
2624 Define this in order to add variables describing certain
2625 run-time determined information about the hardware to the
2626 environment. These will be named board_name, board_rev.
2627
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002628 CONFIG_DELAY_ENVIRONMENT
2629
2630 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002631 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002632 that so that the environment is not available until
2633 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2634 this is instead controlled by the value of
2635 /config/load-environment.
2636
wdenkc0aa5c52003-12-06 19:49:23 +00002637- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002638 CONFIG_HAS_DATAFLASH
2639
wdenk57b2d802003-06-27 21:31:46 +00002640 Defining this option enables DataFlash features and
2641 allows to read/write in Dataflash via the standard
2642 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002643
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002644- Serial Flash support
2645 CONFIG_CMD_SF
2646
2647 Defining this option enables SPI flash commands
2648 'sf probe/read/write/erase/update'.
2649
2650 Usage requires an initial 'probe' to define the serial
2651 flash parameters, followed by read/write/erase/update
2652 commands.
2653
2654 The following defaults may be provided by the platform
2655 to handle the common case when only a single serial
2656 flash is present on the system.
2657
2658 CONFIG_SF_DEFAULT_BUS Bus identifier
2659 CONFIG_SF_DEFAULT_CS Chip-select
2660 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2661 CONFIG_SF_DEFAULT_SPEED in Hz
2662
Simon Glass4b5545e2012-10-08 13:16:02 +00002663 CONFIG_CMD_SF_TEST
2664
2665 Define this option to include a destructive SPI flash
2666 test ('sf test').
2667
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302668 CONFIG_SF_DUAL_FLASH Dual flash memories
2669
2670 Define this option to use dual flash support where two flash
2671 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002672 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302673
wdenkef893942004-02-23 16:11:30 +00002674- SystemACE Support:
2675 CONFIG_SYSTEMACE
2676
2677 Adding this option adds support for Xilinx SystemACE
2678 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002679 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002680 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002681
2682 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002683 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002684
2685 When SystemACE support is added, the "ace" device type
2686 becomes available to the fat commands, i.e. fatls.
2687
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002688- TFTP Fixed UDP Port:
2689 CONFIG_TFTP_PORT
2690
Wolfgang Denk227b5192005-09-24 23:25:46 +02002691 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002692 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002693 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002694 number generator is used.
2695
Wolfgang Denk227b5192005-09-24 23:25:46 +02002696 Also, the environment variable tftpdstp is used to supply
2697 the TFTP UDP destination port value. If tftpdstp isn't
2698 defined, the normal port 69 is used.
2699
2700 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002701 blindly start the TFTP transfer using the pre-configured
2702 target IP address and UDP port. This has the effect of
2703 "punching through" the (Windows XP) firewall, allowing
2704 the remainder of the TFTP transfer to proceed normally.
2705 A better solution is to properly configure the firewall,
2706 but sometimes that is not allowed.
2707
Simon Glass058bb8d2012-12-05 14:46:38 +00002708- Hashing support:
Simon Glass058bb8d2012-12-05 14:46:38 +00002709 CONFIG_HASH_VERIFY
2710
2711 Enable the hash verify command (hash -v). This adds to code
2712 size a little.
2713
Simon Glass058bb8d2012-12-05 14:46:38 +00002714 Note: There is also a sha1sum command, which should perhaps
2715 be deprecated in favour of 'hash sha1'.
2716
Heiko Schocher443ca402014-01-25 07:27:13 +01002717- bootcount support:
2718 CONFIG_BOOTCOUNT_LIMIT
2719
2720 This enables the bootcounter support, see:
2721 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2722
2723 CONFIG_AT91SAM9XE
2724 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002725 CONFIG_SOC_DA8XX
2726 enable special bootcounter support on da850 based boards.
2727 CONFIG_BOOTCOUNT_RAM
2728 enable support for the bootcounter in RAM
2729 CONFIG_BOOTCOUNT_I2C
2730 enable support for the bootcounter on an i2c (like RTC) device.
2731 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2732 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2733 the bootcounter.
2734 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002735
wdenkc0aa5c52003-12-06 19:49:23 +00002736- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002737 CONFIG_SHOW_BOOT_PROGRESS
2738
wdenk4a5c8a72003-03-06 00:02:04 +00002739 Defining this option allows to add some board-
2740 specific code (calling a user-provided function
2741 "show_boot_progress(int)") that enables you to show
2742 the system's boot progress on some display (for
2743 example, some LED's) on your board. At the moment,
2744 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002745
Simon Glass0fa36a42012-09-28 08:56:37 +00002746
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002747Legacy uImage format:
2748
wdenkc6097192002-11-03 00:24:07 +00002749 Arg Where When
2750 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002751 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002752 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002753 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002754 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002755 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002756 4 common/cmd_bootm.c Image data has correct checksum
2757 -4 common/cmd_bootm.c Image is for unsupported architecture
2758 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002759 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002760 6 common/cmd_bootm.c Image Type check OK
2761 -6 common/cmd_bootm.c gunzip uncompression error
2762 -7 common/cmd_bootm.c Unimplemented compression type
2763 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002764 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002765 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002766
2767 9 common/image.c Start initial ramdisk verification
2768 -10 common/image.c Ramdisk header has bad magic number
2769 -11 common/image.c Ramdisk header has bad checksum
2770 10 common/image.c Ramdisk header is OK
2771 -12 common/image.c Ramdisk data has bad checksum
2772 11 common/image.c Ramdisk data has correct checksum
2773 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002774 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002775 13 common/image.c Start multifile image verification
2776 14 common/image.c No initial ramdisk, no multifile, continue.
2777
Wolfgang Denk092ae952011-10-26 10:21:21 +00002778 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002779
Stefan Roese88fbf932010-04-15 16:07:28 +02002780 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002781 -31 post/post.c POST test failed, detected by post_output_backlog()
2782 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002783
Heiko Schocher633e03a2007-06-22 19:11:54 +02002784 34 common/cmd_doc.c before loading a Image from a DOC device
2785 -35 common/cmd_doc.c Bad usage of "doc" command
2786 35 common/cmd_doc.c correct usage of "doc" command
2787 -36 common/cmd_doc.c No boot device
2788 36 common/cmd_doc.c correct boot device
2789 -37 common/cmd_doc.c Unknown Chip ID on boot device
2790 37 common/cmd_doc.c correct chip ID found, device available
2791 -38 common/cmd_doc.c Read Error on boot device
2792 38 common/cmd_doc.c reading Image header from DOC device OK
2793 -39 common/cmd_doc.c Image header has bad magic number
2794 39 common/cmd_doc.c Image header has correct magic number
2795 -40 common/cmd_doc.c Error reading Image from DOC device
2796 40 common/cmd_doc.c Image header has correct magic number
2797 41 common/cmd_ide.c before loading a Image from a IDE device
2798 -42 common/cmd_ide.c Bad usage of "ide" command
2799 42 common/cmd_ide.c correct usage of "ide" command
2800 -43 common/cmd_ide.c No boot device
2801 43 common/cmd_ide.c boot device found
2802 -44 common/cmd_ide.c Device not available
2803 44 common/cmd_ide.c Device available
2804 -45 common/cmd_ide.c wrong partition selected
2805 45 common/cmd_ide.c partition selected
2806 -46 common/cmd_ide.c Unknown partition table
2807 46 common/cmd_ide.c valid partition table found
2808 -47 common/cmd_ide.c Invalid partition type
2809 47 common/cmd_ide.c correct partition type
2810 -48 common/cmd_ide.c Error reading Image Header on boot device
2811 48 common/cmd_ide.c reading Image Header from IDE device OK
2812 -49 common/cmd_ide.c Image header has bad magic number
2813 49 common/cmd_ide.c Image header has correct magic number
2814 -50 common/cmd_ide.c Image header has bad checksum
2815 50 common/cmd_ide.c Image header has correct checksum
2816 -51 common/cmd_ide.c Error reading Image from IDE device
2817 51 common/cmd_ide.c reading Image from IDE device OK
2818 52 common/cmd_nand.c before loading a Image from a NAND device
2819 -53 common/cmd_nand.c Bad usage of "nand" command
2820 53 common/cmd_nand.c correct usage of "nand" command
2821 -54 common/cmd_nand.c No boot device
2822 54 common/cmd_nand.c boot device found
2823 -55 common/cmd_nand.c Unknown Chip ID on boot device
2824 55 common/cmd_nand.c correct chip ID found, device available
2825 -56 common/cmd_nand.c Error reading Image Header on boot device
2826 56 common/cmd_nand.c reading Image Header from NAND device OK
2827 -57 common/cmd_nand.c Image header has bad magic number
2828 57 common/cmd_nand.c Image header has correct magic number
2829 -58 common/cmd_nand.c Error reading Image from NAND device
2830 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002831
Heiko Schocher633e03a2007-06-22 19:11:54 +02002832 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002833
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002834 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002835 -64 net/eth.c no Ethernet found.
2836 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002837
Heiko Schocher633e03a2007-06-22 19:11:54 +02002838 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002839 80 common/cmd_net.c before calling net_loop()
2840 -81 common/cmd_net.c some error in net_loop() occurred
2841 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002842 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2843 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002844 83 common/cmd_net.c running "source" command
2845 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002846 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002847
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002848FIT uImage format:
2849
2850 Arg Where When
2851 100 common/cmd_bootm.c Kernel FIT Image has correct format
2852 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2853 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2854 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2855 102 common/cmd_bootm.c Kernel unit name specified
2856 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002857 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002858 104 common/cmd_bootm.c Got kernel subimage node offset
2859 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2860 105 common/cmd_bootm.c Kernel subimage hash verification OK
2861 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2862 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002863 -106 common/cmd_bootm.c Kernel subimage has wrong type
2864 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002865 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2866 108 common/cmd_bootm.c Got kernel subimage data/size
2867 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2868 -109 common/cmd_bootm.c Can't get kernel subimage type
2869 -110 common/cmd_bootm.c Can't get kernel subimage comp
2870 -111 common/cmd_bootm.c Can't get kernel subimage os
2871 -112 common/cmd_bootm.c Can't get kernel subimage load address
2872 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2873
2874 120 common/image.c Start initial ramdisk verification
2875 -120 common/image.c Ramdisk FIT image has incorrect format
2876 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002877 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002878 -122 common/image.c Can't get configuration for ramdisk subimage
2879 123 common/image.c Ramdisk unit name specified
2880 -124 common/image.c Can't get ramdisk subimage node offset
2881 125 common/image.c Got ramdisk subimage node offset
2882 -125 common/image.c Ramdisk subimage hash verification failed
2883 126 common/image.c Ramdisk subimage hash verification OK
2884 -126 common/image.c Ramdisk subimage for unsupported architecture
2885 127 common/image.c Architecture check OK
2886 -127 common/image.c Can't get ramdisk subimage data/size
2887 128 common/image.c Got ramdisk subimage data/size
2888 129 common/image.c Can't get ramdisk load address
2889 -129 common/image.c Got ramdisk load address
2890
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002891 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002892 131 common/cmd_doc.c FIT image format OK
2893
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002894 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002895 141 common/cmd_ide.c FIT image format OK
2896
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002897 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002898 151 common/cmd_nand.c FIT image format OK
2899
Heiko Schocher515eb122014-05-28 11:33:33 +02002900- legacy image format:
2901 CONFIG_IMAGE_FORMAT_LEGACY
2902 enables the legacy image format support in U-Boot.
2903
2904 Default:
2905 enabled if CONFIG_FIT_SIGNATURE is not defined.
2906
2907 CONFIG_DISABLE_IMAGE_LEGACY
2908 disable the legacy image format
2909
2910 This define is introduced, as the legacy image format is
2911 enabled per default for backward compatibility.
2912
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002913- Standalone program support:
2914 CONFIG_STANDALONE_LOAD_ADDR
2915
Wolfgang Denk23f78482011-10-09 21:06:34 +02002916 This option defines a board specific value for the
2917 address where standalone program gets loaded, thus
2918 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002919 settings.
2920
2921- Frame Buffer Address:
2922 CONFIG_FB_ADDR
2923
2924 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002925 address for frame buffer. This is typically the case
2926 when using a graphics controller has separate video
2927 memory. U-Boot will then place the frame buffer at
2928 the given address instead of dynamically reserving it
2929 in system RAM by calling lcd_setmem(), which grabs
2930 the memory for the frame buffer depending on the
2931 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002932
2933 Please see board_init_f function.
2934
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002935- Automatic software updates via TFTP server
2936 CONFIG_UPDATE_TFTP
2937 CONFIG_UPDATE_TFTP_CNT_MAX
2938 CONFIG_UPDATE_TFTP_MSEC_MAX
2939
2940 These options enable and control the auto-update feature;
2941 for a more detailed description refer to doc/README.update.
2942
2943- MTD Support (mtdparts command, UBI support)
2944 CONFIG_MTD_DEVICE
2945
2946 Adds the MTD device infrastructure from the Linux kernel.
2947 Needed for mtdparts command support.
2948
2949 CONFIG_MTD_PARTITIONS
2950
2951 Adds the MTD partitioning infrastructure from the Linux
2952 kernel. Needed for UBI support.
2953
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002954- UBI support
2955 CONFIG_CMD_UBI
2956
2957 Adds commands for interacting with MTD partitions formatted
2958 with the UBI flash translation layer
2959
2960 Requires also defining CONFIG_RBTREE
2961
Joe Hershberger47550fc2013-04-08 10:32:49 +00002962 CONFIG_UBI_SILENCE_MSG
2963
2964 Make the verbose messages from UBI stop printing. This leaves
2965 warnings and errors enabled.
2966
Heiko Schocherf5895d12014-06-24 10:10:04 +02002967
2968 CONFIG_MTD_UBI_WL_THRESHOLD
2969 This parameter defines the maximum difference between the highest
2970 erase counter value and the lowest erase counter value of eraseblocks
2971 of UBI devices. When this threshold is exceeded, UBI starts performing
2972 wear leveling by means of moving data from eraseblock with low erase
2973 counter to eraseblocks with high erase counter.
2974
2975 The default value should be OK for SLC NAND flashes, NOR flashes and
2976 other flashes which have eraseblock life-cycle 100000 or more.
2977 However, in case of MLC NAND flashes which typically have eraseblock
2978 life-cycle less than 10000, the threshold should be lessened (e.g.,
2979 to 128 or 256, although it does not have to be power of 2).
2980
2981 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002982
Heiko Schocherf5895d12014-06-24 10:10:04 +02002983 CONFIG_MTD_UBI_BEB_LIMIT
2984 This option specifies the maximum bad physical eraseblocks UBI
2985 expects on the MTD device (per 1024 eraseblocks). If the
2986 underlying flash does not admit of bad eraseblocks (e.g. NOR
2987 flash), this value is ignored.
2988
2989 NAND datasheets often specify the minimum and maximum NVM
2990 (Number of Valid Blocks) for the flashes' endurance lifetime.
2991 The maximum expected bad eraseblocks per 1024 eraseblocks
2992 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2993 which gives 20 for most NANDs (MaxNVB is basically the total
2994 count of eraseblocks on the chip).
2995
2996 To put it differently, if this value is 20, UBI will try to
2997 reserve about 1.9% of physical eraseblocks for bad blocks
2998 handling. And that will be 1.9% of eraseblocks on the entire
2999 NAND chip, not just the MTD partition UBI attaches. This means
3000 that if you have, say, a NAND flash chip admits maximum 40 bad
3001 eraseblocks, and it is split on two MTD partitions of the same
3002 size, UBI will reserve 40 eraseblocks when attaching a
3003 partition.
3004
3005 default: 20
3006
3007 CONFIG_MTD_UBI_FASTMAP
3008 Fastmap is a mechanism which allows attaching an UBI device
3009 in nearly constant time. Instead of scanning the whole MTD device it
3010 only has to locate a checkpoint (called fastmap) on the device.
3011 The on-flash fastmap contains all information needed to attach
3012 the device. Using fastmap makes only sense on large devices where
3013 attaching by scanning takes long. UBI will not automatically install
3014 a fastmap on old images, but you can set the UBI parameter
3015 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3016 that fastmap-enabled images are still usable with UBI implementations
3017 without fastmap support. On typical flash devices the whole fastmap
3018 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3019
3020 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3021 Set this parameter to enable fastmap automatically on images
3022 without a fastmap.
3023 default: 0
3024
Heiko Schocher94b66de2015-10-22 06:19:21 +02003025 CONFIG_MTD_UBI_FM_DEBUG
3026 Enable UBI fastmap debug
3027 default: 0
3028
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003029- UBIFS support
3030 CONFIG_CMD_UBIFS
3031
3032 Adds commands for interacting with UBI volumes formatted as
3033 UBIFS. UBIFS is read-only in u-boot.
3034
3035 Requires UBI support as well as CONFIG_LZO
3036
Joe Hershberger47550fc2013-04-08 10:32:49 +00003037 CONFIG_UBIFS_SILENCE_MSG
3038
3039 Make the verbose messages from UBIFS stop printing. This leaves
3040 warnings and errors enabled.
3041
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003042- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003043 CONFIG_SPL
3044 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003045
Tom Rini36853852012-02-14 07:29:40 +00003046 CONFIG_SPL_LDSCRIPT
3047 LDSCRIPT for linking the SPL binary.
3048
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003049 CONFIG_SPL_MAX_FOOTPRINT
3050 Maximum size in memory allocated to the SPL, BSS included.
3051 When defined, the linker checks that the actual memory
3052 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003053 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003054 must not be both defined at the same time.
3055
Tom Rini36853852012-02-14 07:29:40 +00003056 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003057 Maximum size of the SPL image (text, data, rodata, and
3058 linker lists sections), BSS excluded.
3059 When defined, the linker checks that the actual size does
3060 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003061
Wolfgang Denk825223d2011-09-11 21:24:09 +02003062 CONFIG_SPL_TEXT_BASE
3063 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003064
Scott Woodc4f0d002012-09-20 19:05:12 -05003065 CONFIG_SPL_RELOC_TEXT_BASE
3066 Address to relocate to. If unspecified, this is equal to
3067 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3068
Tom Rini36853852012-02-14 07:29:40 +00003069 CONFIG_SPL_BSS_START_ADDR
3070 Link address for the BSS within the SPL binary.
3071
3072 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003073 Maximum size in memory allocated to the SPL BSS.
3074 When defined, the linker checks that the actual memory used
3075 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003076 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003077 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003078
3079 CONFIG_SPL_STACK
3080 Adress of the start of the stack SPL will use
3081
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003082 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3083 When defined, SPL will panic() if the image it has
3084 loaded does not have a signature.
3085 Defining this is useful when code which loads images
3086 in SPL cannot guarantee that absolutely all read errors
3087 will be caught.
3088 An example is the LPC32XX MLC NAND driver, which will
3089 consider that a completely unreadable NAND block is bad,
3090 and thus should be skipped silently.
3091
Scott Woodc4f0d002012-09-20 19:05:12 -05003092 CONFIG_SPL_RELOC_STACK
3093 Adress of the start of the stack SPL will use after
3094 relocation. If unspecified, this is equal to
3095 CONFIG_SPL_STACK.
3096
Tom Rini36853852012-02-14 07:29:40 +00003097 CONFIG_SYS_SPL_MALLOC_START
3098 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003099 When this option is set the full malloc is used in SPL and
3100 it is set up by spl_init() and before that, the simple malloc()
3101 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003102
3103 CONFIG_SYS_SPL_MALLOC_SIZE
3104 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003105
Tom Rini28591df2012-08-13 12:03:19 -07003106 CONFIG_SPL_FRAMEWORK
3107 Enable the SPL framework under common/. This framework
3108 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3109 NAND loading of the Linux Kernel.
3110
Tom Rinic2b76002014-03-28 12:03:39 -04003111 CONFIG_SPL_OS_BOOT
3112 Enable booting directly to an OS from SPL.
3113 See also: doc/README.falcon
3114
Tom Rinife3b0c72012-08-13 11:37:56 -07003115 CONFIG_SPL_DISPLAY_PRINT
3116 For ARM, enable an optional function to print more information
3117 about the running system.
3118
Scott Wood7c810902012-09-20 16:35:21 -05003119 CONFIG_SPL_INIT_MINIMAL
3120 Arch init code should be built for a very small image
3121
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003122 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3123 Partition on the MMC to load U-Boot from when the MMC is being
3124 used in raw mode
3125
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003126 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3127 Sector to load kernel uImage from when MMC is being
3128 used in raw mode (for Falcon mode)
3129
3130 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3131 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3132 Sector and number of sectors to load kernel argument
3133 parameters from when MMC is being used in raw mode
3134 (for falcon mode)
3135
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003136 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3137 Partition on the MMC to load U-Boot from when the MMC is being
3138 used in fs mode
3139
Guillaume GARDET5065b712014-10-15 17:53:13 +02003140 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3141 Filename to read to load U-Boot when reading from filesystem
3142
3143 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003144 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003145 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003146
Guillaume GARDET5065b712014-10-15 17:53:13 +02003147 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003148 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003149 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003150
Scott Wood2b36fbb2012-12-06 13:33:17 +00003151 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3152 Set this for NAND SPL on PPC mpc83xx targets, so that
3153 start.S waits for the rest of the SPL to load before
3154 continuing (the hardware starts execution after just
3155 loading the first page rather than the full 4K).
3156
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303157 CONFIG_SPL_SKIP_RELOCATE
3158 Avoid SPL relocation
3159
Scott Woodc352a0c2012-09-20 19:09:07 -05003160 CONFIG_SPL_NAND_BASE
3161 Include nand_base.c in the SPL. Requires
3162 CONFIG_SPL_NAND_DRIVERS.
3163
3164 CONFIG_SPL_NAND_DRIVERS
3165 SPL uses normal NAND drivers, not minimal drivers.
3166
3167 CONFIG_SPL_NAND_ECC
3168 Include standard software ECC in the SPL
3169
Tom Rini36853852012-02-14 07:29:40 +00003170 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003171 Support for NAND boot using simple NAND drivers that
3172 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003173
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003174 CONFIG_SPL_UBI
3175 Support for a lightweight UBI (fastmap) scanner and
3176 loader
3177
Heiko Schochercf000272014-10-31 08:31:00 +01003178 CONFIG_SPL_NAND_RAW_ONLY
3179 Support to boot only raw u-boot.bin images. Use this only
3180 if you need to save space.
3181
Ying Zhangdfb2b152013-08-16 15:16:12 +08003182 CONFIG_SPL_COMMON_INIT_DDR
3183 Set for common ddr init with serial presence detect in
3184 SPL binary.
3185
Tom Rini36853852012-02-14 07:29:40 +00003186 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3187 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3188 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3189 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3190 CONFIG_SYS_NAND_ECCBYTES
3191 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003192 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003193
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303194 CONFIG_SPL_NAND_BOOT
3195 Add support NAND boot
3196
Tom Rini36853852012-02-14 07:29:40 +00003197 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003198 Location in NAND to read U-Boot from
3199
3200 CONFIG_SYS_NAND_U_BOOT_DST
3201 Location in memory to load U-Boot to
3202
3203 CONFIG_SYS_NAND_U_BOOT_SIZE
3204 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003205
3206 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003207 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003208
3209 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3210 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003211 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003212
3213 CONFIG_SPL_OMAP3_ID_NAND
3214 Support for an OMAP3-specific set of functions to return the
3215 ID and MFR of the first attached NAND chip, if present.
3216
Pavel Machekde997252012-08-30 22:42:11 +02003217 CONFIG_SPL_RAM_DEVICE
3218 Support for running image already present in ram, in SPL binary
3219
Scott Woodeb7bd972012-12-06 13:33:16 +00003220 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003221 Image offset to which the SPL should be padded before appending
3222 the SPL payload. By default, this is defined as
3223 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3224 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3225 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003226
Scott Woodf147eb72012-09-21 16:27:32 -05003227 CONFIG_SPL_TARGET
3228 Final target image containing SPL and payload. Some SPLs
3229 use an arch-specific makefile fragment instead, for
3230 example if more than one image needs to be produced.
3231
Simon Glass82d94532013-05-08 08:05:59 +00003232 CONFIG_FIT_SPL_PRINT
3233 Printing information about a FIT image adds quite a bit of
3234 code to SPL. So this is normally disabled in SPL. Use this
3235 option to re-enable it. This will affect the output of the
3236 bootm command when booting a FIT image.
3237
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003238- TPL framework
3239 CONFIG_TPL
3240 Enable building of TPL globally.
3241
3242 CONFIG_TPL_PAD_TO
3243 Image offset to which the TPL should be padded before appending
3244 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003245 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3246 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3247 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003248
wdenkc0aa5c52003-12-06 19:49:23 +00003249- Interrupt support (PPC):
3250
wdenk1ebf41e2004-01-02 14:00:00 +00003251 There are common interrupt_init() and timer_interrupt()
3252 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003253 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003254 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003255 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003256 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003257 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003258 specific handling. If board has watchdog / status_led
3259 / other_activity_monitor it works automatically from
3260 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003261
wdenkc6097192002-11-03 00:24:07 +00003262
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003263Board initialization settings:
3264------------------------------
3265
3266During Initialization u-boot calls a number of board specific functions
3267to allow the preparation of board specific prerequisites, e.g. pin setup
3268before drivers are initialized. To enable these callbacks the
3269following configuration macros have to be defined. Currently this is
3270architecture specific, so please check arch/your_architecture/lib/board.c
3271typically in board_init_f() and board_init_r().
3272
3273- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3274- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3275- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3276- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003277
wdenkc6097192002-11-03 00:24:07 +00003278Configuration Settings:
3279-----------------------
3280
York Sun6c480012014-02-26 17:03:19 -08003281- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3282 Optionally it can be defined to support 64-bit memory commands.
3283
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003284- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003285 undefine this when you're short of memory.
3286
Peter Tyserdfb72b82009-01-27 18:03:12 -06003287- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3288 width of the commands listed in the 'help' command output.
3289
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003290- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003291 prompt for user input.
3292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003293- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003294
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003295- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003297- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003298
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003299- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003300 the application (usually a Linux kernel) when it is
3301 booted
3302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003303- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003304 List of legal baudrate settings for this board.
3305
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003306- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003307 Begin and End addresses of the area used by the
3308 simple memory test.
3309
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003310- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003311 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003312
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003313- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003314 Scratch address used by the alternate memory test
3315 You only need to set this if address zero isn't writeable
3316
York Sun5d286cd2015-12-04 11:57:07 -08003317- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003318 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003319 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3320 is substracted from total RAM and won't be reported to OS.
3321 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003322 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003323 the RAM base is not zero, or RAM is divided into banks,
3324 this variable needs to be recalcuated to get the address.
3325
York Sun50739372015-12-07 11:05:29 -08003326- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003327 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003328 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003329 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003330 fixing up gd->ram_size the Linux kernel should gets passed
3331 the now "corrected" memory size and won't touch it either.
3332 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003333 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003334 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003335 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003336
3337 This option can be used as a workaround for the 440EPx/GRx
3338 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3339 be touched.
3340
3341 WARNING: Please make sure that this value is a multiple of
3342 the Linux page size (normally 4k). If this is not the case,
3343 then the end address of the Linux memory will be located at a
3344 non page size aligned address and this could cause major
3345 problems.
3346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003347- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003348 Enable temporary baudrate change while serial download
3349
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003350- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003351 Physical start address of SDRAM. _Must_ be 0 here.
3352
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003353- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003354 Physical start address of Flash memory.
3355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003356- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003357 Physical start address of boot monitor code (set by
3358 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003359 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003360 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003361
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003362- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003363 Size of memory reserved for monitor code, used to
3364 determine _at_compile_time_ (!) if the environment is
3365 embedded within the U-Boot image, or in a separate
3366 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003367
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003368- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003369 Size of DRAM reserved for malloc() use.
3370
Simon Glass863e4042014-07-10 22:23:28 -06003371- CONFIG_SYS_MALLOC_F_LEN
3372 Size of the malloc() pool for use before relocation. If
3373 this is defined, then a very simple malloc() implementation
3374 will become available before relocation. The address is just
3375 below the global data, and the stack is moved down to make
3376 space.
3377
3378 This feature allocates regions with increasing addresses
3379 within the region. calloc() is supported, but realloc()
3380 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003381 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003382 U-Boot relocates itself.
3383
Simon Glass9fa901b2014-11-10 17:16:54 -07003384- CONFIG_SYS_MALLOC_SIMPLE
3385 Provides a simple and small malloc() and calloc() for those
3386 boards which do not use the full malloc in SPL (which is
3387 enabled with CONFIG_SYS_SPL_MALLOC_START).
3388
Thierry Redingc97d9742014-12-09 22:25:22 -07003389- CONFIG_SYS_NONCACHED_MEMORY:
3390 Size of non-cached memory area. This area of memory will be
3391 typically located right below the malloc() area and mapped
3392 uncached in the MMU. This is useful for drivers that would
3393 otherwise require a lot of explicit cache maintenance. For
3394 some drivers it's also impossible to properly maintain the
3395 cache. For example if the regions that need to be flushed
3396 are not a multiple of the cache-line size, *and* padding
3397 cannot be allocated between the regions to align them (i.e.
3398 if the HW requires a contiguous array of regions, and the
3399 size of each region is not cache-aligned), then a flush of
3400 one region may result in overwriting data that hardware has
3401 written to another region in the same cache-line. This can
3402 happen for example in network drivers where descriptors for
3403 buffers are typically smaller than the CPU cache-line (e.g.
3404 16 bytes vs. 32 or 64 bytes).
3405
3406 Non-cached memory is only supported on 32-bit ARM at present.
3407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003408- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003409 Normally compressed uImages are limited to an
3410 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003411 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003412 to adjust this setting to your needs.
3413
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003414- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003415 Maximum size of memory mapped by the startup code of
3416 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003417 the Linux kernel (bd_info, boot arguments, FDT blob if
3418 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003419 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003420 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003421 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003422 variable "bootm_mapsize" will override the value of
3423 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3424 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003425
John Rigbyeea8e692010-10-13 13:57:35 -06003426- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3427 Enable initrd_high functionality. If defined then the
3428 initrd_high feature is enabled and the bootm ramdisk subcommand
3429 is enabled.
3430
3431- CONFIG_SYS_BOOT_GET_CMDLINE:
3432 Enables allocating and saving kernel cmdline in space between
3433 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3434
3435- CONFIG_SYS_BOOT_GET_KBD:
3436 Enables allocating and saving a kernel copy of the bd_info in
3437 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003439- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003440 Max number of Flash memory banks
3441
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003442- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003443 Max number of sectors on a Flash chip
3444
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003445- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003446 Timeout for Flash erase operations (in ms)
3447
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003448- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003449 Timeout for Flash write operations (in ms)
3450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003451- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003452 Timeout for Flash set sector lock bit operation (in ms)
3453
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003454- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003455 Timeout for Flash clear lock bits operation (in ms)
3456
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003457- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003458 If defined, hardware flash sectors protection is used
3459 instead of U-Boot software protection.
3460
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003461- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003462
3463 Enable TFTP transfers directly to flash memory;
3464 without this option such a download has to be
3465 performed in two steps: (1) download to RAM, and (2)
3466 copy from RAM to flash.
3467
3468 The two-step approach is usually more reliable, since
3469 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003470 the flash, but in some situations (when system RAM is
3471 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003472 downloaded image) this option may be very useful.
3473
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003474- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003475 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003476 common flash structure for storing flash geometry.
3477
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003478- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003479 This option also enables the building of the cfi_flash driver
3480 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003481
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003482- CONFIG_FLASH_CFI_MTD
3483 This option enables the building of the cfi_mtd driver
3484 in the drivers directory. The driver exports CFI flash
3485 to the MTD layer.
3486
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003487- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003488 Use buffered writes to flash.
3489
3490- CONFIG_FLASH_SPANSION_S29WS_N
3491 s29ws-n MirrorBit flash has non-standard addresses for buffered
3492 write commands.
3493
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003494- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003495 If this option is defined, the common CFI flash doesn't
3496 print it's warning upon not recognized FLASH banks. This
3497 is useful, if some of the configured banks are only
3498 optionally available.
3499
Jerry Van Barenaae73572008-03-08 13:48:01 -05003500- CONFIG_FLASH_SHOW_PROGRESS
3501 If defined (must be an integer), print out countdown
3502 digits and dots. Recommended value: 45 (9..1) for 80
3503 column displays, 15 (3..1) for 40 column displays.
3504
Stefan Roesed20cba52013-04-04 15:53:14 +02003505- CONFIG_FLASH_VERIFY
3506 If defined, the content of the flash (destination) is compared
3507 against the source after the write operation. An error message
3508 will be printed when the contents are not identical.
3509 Please note that this option is useless in nearly all cases,
3510 since such flash programming errors usually are detected earlier
3511 while unprotecting/erasing/programming. Please only enable
3512 this option if you really know what you are doing.
3513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003514- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003515 Defines the number of Ethernet receive buffers. On some
3516 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003517 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3518 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003519 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003520 Defaults to 4 if not defined.
3521
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003522- CONFIG_ENV_MAX_ENTRIES
3523
Wolfgang Denk1136f692010-10-27 22:48:30 +02003524 Maximum number of entries in the hash table that is used
3525 internally to store the environment settings. The default
3526 setting is supposed to be generous and should work in most
3527 cases. This setting can be used to tune behaviour; see
3528 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003529
Joe Hershberger71497d02012-12-11 22:16:31 -06003530- CONFIG_ENV_FLAGS_LIST_DEFAULT
3531- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003532 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003533 calling env set. Variables can be restricted to only decimal,
3534 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3535 the variables can also be restricted to IP address or MAC address.
3536
3537 The format of the list is:
3538 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003539 access_attribute = [a|r|o|c]
3540 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003541 entry = variable_name[:attributes]
3542 list = entry[,list]
3543
3544 The type attributes are:
3545 s - String (default)
3546 d - Decimal
3547 x - Hexadecimal
3548 b - Boolean ([1yYtT|0nNfF])
3549 i - IP address
3550 m - MAC address
3551
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003552 The access attributes are:
3553 a - Any (default)
3554 r - Read-only
3555 o - Write-once
3556 c - Change-default
3557
Joe Hershberger71497d02012-12-11 22:16:31 -06003558 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3559 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003560 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003561
3562 - CONFIG_ENV_FLAGS_LIST_STATIC
3563 Define this to a list (string) to define validation that
3564 should be done if an entry is not found in the ".flags"
3565 environment variable. To override a setting in the static
3566 list, simply add an entry for the same variable name to the
3567 ".flags" variable.
3568
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003569 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3570 regular expression. This allows multiple variables to define the same
3571 flags without explicitly listing them for each variable.
3572
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003573- CONFIG_ENV_ACCESS_IGNORE_FORCE
3574 If defined, don't allow the -f switch to env set override variable
3575 access flags.
3576
Gabe Black3687fe42014-10-15 04:38:30 -06003577- CONFIG_USE_STDINT
3578 If stdint.h is available with your toolchain you can define this
3579 option to enable it. You can provide option 'USE_STDINT=1' when
3580 building U-Boot to enable this.
3581
wdenkc6097192002-11-03 00:24:07 +00003582The following definitions that deal with the placement and management
3583of environment data (variable area); in general, we support the
3584following configurations:
3585
Mike Frysinger63b8f122011-07-08 10:44:25 +00003586- CONFIG_BUILD_ENVCRC:
3587
3588 Builds up envcrc with the target environment so that external utils
3589 may easily extract it and embed it in final U-Boot images.
3590
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003591- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003592
3593 Define this if the environment is in flash memory.
3594
3595 a) The environment occupies one whole flash sector, which is
3596 "embedded" in the text segment with the U-Boot code. This
3597 happens usually with "bottom boot sector" or "top boot
3598 sector" type flash chips, which have several smaller
3599 sectors at the start or the end. For instance, such a
3600 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3601 such a case you would place the environment in one of the
3602 4 kB sectors - with U-Boot code before and after it. With
3603 "top boot sector" type flash chips, you would put the
3604 environment in one of the last sectors, leaving a gap
3605 between U-Boot and the environment.
3606
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003607 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003608
3609 Offset of environment data (variable area) to the
3610 beginning of flash memory; for instance, with bottom boot
3611 type flash chips the second sector can be used: the offset
3612 for this sector is given here.
3613
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003614 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003615
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003616 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003617
3618 This is just another way to specify the start address of
3619 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003620 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003621
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003622 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003623
3624 Size of the sector containing the environment.
3625
3626
3627 b) Sometimes flash chips have few, equal sized, BIG sectors.
3628 In such a case you don't want to spend a whole sector for
3629 the environment.
3630
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003631 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003632
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003633 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003634 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003635 of this flash sector for the environment. This saves
3636 memory for the RAM copy of the environment.
3637
3638 It may also save flash memory if you decide to use this
3639 when your environment is "embedded" within U-Boot code,
3640 since then the remainder of the flash sector could be used
3641 for U-Boot code. It should be pointed out that this is
3642 STRONGLY DISCOURAGED from a robustness point of view:
3643 updating the environment in flash makes it always
3644 necessary to erase the WHOLE sector. If something goes
3645 wrong before the contents has been restored from a copy in
3646 RAM, your target system will be dead.
3647
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003648 - CONFIG_ENV_ADDR_REDUND
3649 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003650
wdenk4a5c8a72003-03-06 00:02:04 +00003651 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003652 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003653 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003654 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003655
3656BE CAREFUL! Any changes to the flash layout, and some changes to the
3657source code will make it necessary to adapt <board>/u-boot.lds*
3658accordingly!
3659
3660
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003661- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003662
3663 Define this if you have some non-volatile memory device
3664 (NVRAM, battery buffered SRAM) which you want to use for the
3665 environment.
3666
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003667 - CONFIG_ENV_ADDR:
3668 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003669
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003670 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003671 want to use for environment. It is assumed that this memory
3672 can just be read and written to, without any special
3673 provision.
3674
3675BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003676in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003677console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003678U-Boot will hang.
3679
3680Please note that even with NVRAM we still use a copy of the
3681environment in RAM: we could work on NVRAM directly, but we want to
3682keep settings there always unmodified except somebody uses "saveenv"
3683to save the current settings.
3684
3685
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003686- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003687
3688 Use this if you have an EEPROM or similar serial access
3689 device and a driver for it.
3690
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003691 - CONFIG_ENV_OFFSET:
3692 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003693
3694 These two #defines specify the offset and size of the
3695 environment area within the total memory of your EEPROM.
3696
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003697 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003698 If defined, specified the chip address of the EEPROM device.
3699 The default address is zero.
3700
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003701 - CONFIG_SYS_I2C_EEPROM_BUS:
3702 If defined, specified the i2c bus of the EEPROM device.
3703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003704 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003705 If defined, the number of bits used to address bytes in a
3706 single page in the EEPROM device. A 64 byte page, for example
3707 would require six bits.
3708
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003709 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003710 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003711 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003712
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003713 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003714 The length in bytes of the EEPROM memory array address. Note
3715 that this is NOT the chip address length!
3716
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003717 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003718 EEPROM chips that implement "address overflow" are ones
3719 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3720 address and the extra bits end up in the "chip address" bit
3721 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3722 byte chips.
3723
3724 Note that we consider the length of the address field to
3725 still be one byte because the extra address bits are hidden
3726 in the chip address.
3727
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003728 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003729 The size in bytes of the EEPROM device.
3730
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003731 - CONFIG_ENV_EEPROM_IS_ON_I2C
3732 define this, if you have I2C and SPI activated, and your
3733 EEPROM, which holds the environment, is on the I2C bus.
3734
3735 - CONFIG_I2C_ENV_EEPROM_BUS
3736 if you have an Environment on an EEPROM reached over
3737 I2C muxes, you can define here, how to reach this
3738 EEPROM. For example:
3739
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003740 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003741
3742 EEPROM which holds the environment, is reached over
3743 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003744
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003745- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003746
wdenk1ebf41e2004-01-02 14:00:00 +00003747 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003748 want to use for the environment.
3749
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003750 - CONFIG_ENV_OFFSET:
3751 - CONFIG_ENV_ADDR:
3752 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003753
3754 These three #defines specify the offset and size of the
3755 environment area within the total memory of your DataFlash placed
3756 at the specified address.
3757
Wu, Josh76db7bf2014-07-01 19:30:13 +08003758- CONFIG_ENV_IS_IN_SPI_FLASH:
3759
3760 Define this if you have a SPI Flash memory device which you
3761 want to use for the environment.
3762
3763 - CONFIG_ENV_OFFSET:
3764 - CONFIG_ENV_SIZE:
3765
3766 These two #defines specify the offset and size of the
3767 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3768 aligned to an erase sector boundary.
3769
3770 - CONFIG_ENV_SECT_SIZE:
3771
3772 Define the SPI flash's sector size.
3773
3774 - CONFIG_ENV_OFFSET_REDUND (optional):
3775
3776 This setting describes a second storage area of CONFIG_ENV_SIZE
3777 size used to hold a redundant copy of the environment data, so
3778 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003779 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003780 aligned to an erase sector boundary.
3781
3782 - CONFIG_ENV_SPI_BUS (optional):
3783 - CONFIG_ENV_SPI_CS (optional):
3784
3785 Define the SPI bus and chip select. If not defined they will be 0.
3786
3787 - CONFIG_ENV_SPI_MAX_HZ (optional):
3788
3789 Define the SPI max work clock. If not defined then use 1MHz.
3790
3791 - CONFIG_ENV_SPI_MODE (optional):
3792
3793 Define the SPI work mode. If not defined then use SPI_MODE_3.
3794
Liu Gang85bcd732012-03-08 00:33:20 +00003795- CONFIG_ENV_IS_IN_REMOTE:
3796
3797 Define this if you have a remote memory space which you
3798 want to use for the local device's environment.
3799
3800 - CONFIG_ENV_ADDR:
3801 - CONFIG_ENV_SIZE:
3802
3803 These two #defines specify the address and size of the
3804 environment area within the remote memory space. The
3805 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003806 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003807
3808BE CAREFUL! For some special cases, the local device can not use
3809"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003810environment stored in a remote NOR flash by SRIO or PCIE link,
3811but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003812
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003813- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003814
3815 Define this if you have a NAND device which you want to use
3816 for the environment.
3817
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003818 - CONFIG_ENV_OFFSET:
3819 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003820
3821 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003822 area within the first NAND device. CONFIG_ENV_OFFSET must be
3823 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003824
Scott Wood08239322010-09-17 14:38:37 -05003825 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003826
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003827 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003828 size used to hold a redundant copy of the environment data, so
3829 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003830 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003831 aligned to an erase block boundary.
3832
3833 - CONFIG_ENV_RANGE (optional):
3834
3835 Specifies the length of the region in which the environment
3836 can be written. This should be a multiple of the NAND device's
3837 block size. Specifying a range with more erase blocks than
3838 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3839 the range to be avoided.
3840
3841 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003842
Scott Wood08239322010-09-17 14:38:37 -05003843 Enables support for dynamically retrieving the offset of the
3844 environment from block zero's out-of-band data. The
3845 "nand env.oob" command can be used to record this offset.
3846 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3847 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003848
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003849- CONFIG_NAND_ENV_DST
3850
3851 Defines address in RAM to which the nand_spl code should copy the
3852 environment. If redundant environment is used, it will be copied to
3853 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3854
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003855- CONFIG_ENV_IS_IN_UBI:
3856
3857 Define this if you have an UBI volume that you want to use for the
3858 environment. This has the benefit of wear-leveling the environment
3859 accesses, which is important on NAND.
3860
3861 - CONFIG_ENV_UBI_PART:
3862
3863 Define this to a string that is the mtd partition containing the UBI.
3864
3865 - CONFIG_ENV_UBI_VOLUME:
3866
3867 Define this to the name of the volume that you want to store the
3868 environment in.
3869
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003870 - CONFIG_ENV_UBI_VOLUME_REDUND:
3871
3872 Define this to the name of another volume to store a second copy of
3873 the environment in. This will enable redundant environments in UBI.
3874 It is assumed that both volumes are in the same MTD partition.
3875
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003876 - CONFIG_UBI_SILENCE_MSG
3877 - CONFIG_UBIFS_SILENCE_MSG
3878
3879 You will probably want to define these to avoid a really noisy system
3880 when storing the env in UBI.
3881
Wu, Josha7d0c872014-06-24 17:31:03 +08003882- CONFIG_ENV_IS_IN_FAT:
3883 Define this if you want to use the FAT file system for the environment.
3884
3885 - FAT_ENV_INTERFACE:
3886
3887 Define this to a string that is the name of the block device.
3888
Nicolae Rosia86811f22016-11-21 17:33:58 +02003889 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003890
3891 Define this to a string to specify the partition of the device. It can
3892 be as following:
3893
3894 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3895 - "D:P": device D partition P. Error occurs if device D has no
3896 partition table.
3897 - "D:0": device D.
3898 - "D" or "D:": device D partition 1 if device D has partition
3899 table, or the whole device D if has no partition
3900 table.
3901 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003902 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08003903 partition table then means device D.
3904
3905 - FAT_ENV_FILE:
3906
3907 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003908 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08003909
3910 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003911 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08003912
Stephen Warreneedcacd2013-06-11 15:14:00 -06003913- CONFIG_ENV_IS_IN_MMC:
3914
3915 Define this if you have an MMC device which you want to use for the
3916 environment.
3917
3918 - CONFIG_SYS_MMC_ENV_DEV:
3919
3920 Specifies which MMC device the environment is stored in.
3921
3922 - CONFIG_SYS_MMC_ENV_PART (optional):
3923
3924 Specifies which MMC partition the environment is stored in. If not
3925 set, defaults to partition 0, the user area. Common values might be
3926 1 (first MMC boot partition), 2 (second MMC boot partition).
3927
3928 - CONFIG_ENV_OFFSET:
3929 - CONFIG_ENV_SIZE:
3930
3931 These two #defines specify the offset and size of the environment
3932 area within the specified MMC device.
3933
Stephen Warren24dc2032013-06-11 15:14:02 -06003934 If offset is positive (the usual case), it is treated as relative to
3935 the start of the MMC partition. If offset is negative, it is treated
3936 as relative to the end of the MMC partition. This can be useful if
3937 your board may be fitted with different MMC devices, which have
3938 different sizes for the MMC partitions, and you always want the
3939 environment placed at the very end of the partition, to leave the
3940 maximum possible space before it, to store other data.
3941
Stephen Warreneedcacd2013-06-11 15:14:00 -06003942 These two values are in units of bytes, but must be aligned to an
3943 MMC sector boundary.
3944
3945 - CONFIG_ENV_OFFSET_REDUND (optional):
3946
3947 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3948 hold a redundant copy of the environment data. This provides a
3949 valid backup copy in case the other copy is corrupted, e.g. due
3950 to a power failure during a "saveenv" operation.
3951
Stephen Warren24dc2032013-06-11 15:14:02 -06003952 This value may also be positive or negative; this is handled in the
3953 same way as CONFIG_ENV_OFFSET.
3954
Stephen Warreneedcacd2013-06-11 15:14:00 -06003955 This value is also in units of bytes, but must also be aligned to
3956 an MMC sector boundary.
3957
3958 - CONFIG_ENV_SIZE_REDUND (optional):
3959
3960 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3961 set. If this value is set, it must be set to the same value as
3962 CONFIG_ENV_SIZE.
3963
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003964- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003965
3966 Defines offset to the initial SPI buffer area in DPRAM. The
3967 area is used at an early stage (ROM part) if the environment
3968 is configured to reside in the SPI EEPROM: We need a 520 byte
3969 scratch DPRAM area. It is used between the two initialization
3970 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3971 to be a good choice since it makes it far enough from the
3972 start of the data area as well as from the stack pointer.
3973
Bruce Adleredecc942007-11-02 13:15:42 -07003974Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003975has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003976created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003977until then to read environment variables.
3978
wdenk8dba0502003-03-31 16:34:49 +00003979The environment is protected by a CRC32 checksum. Before the monitor
3980is relocated into RAM, as a result of a bad CRC you will be working
3981with the compiled-in default environment - *silently*!!! [This is
3982necessary, because the first environment variable we need is the
3983"baudrate" setting for the console - if we have a bad CRC, we don't
3984have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003985
3986Note: once the monitor has been relocated, then it will complain if
3987the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003988use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003989
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003990- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003991 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003992
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003993 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003994 also needs to be defined.
3995
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003996- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003997 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003998
Ron Madriddfa028a2009-02-18 14:30:44 -08003999- CONFIG_NS16550_MIN_FUNCTIONS:
4000 Define this if you desire to only have use of the NS16550_init
4001 and NS16550_putc functions for the serial driver located at
4002 drivers/serial/ns16550.c. This option is useful for saving
4003 space for already greatly restricted images, including but not
4004 limited to NAND_SPL configurations.
4005
Simon Glass28a9e332012-11-30 13:01:18 +00004006- CONFIG_DISPLAY_BOARDINFO
4007 Display information about the board that U-Boot is running on
4008 when U-Boot starts up. The board function checkboard() is called
4009 to do this.
4010
Simon Glasse8822012012-11-30 13:01:19 +00004011- CONFIG_DISPLAY_BOARDINFO_LATE
4012 Similar to the previous option, but display this information
4013 later, once stdio is running and output goes to the LCD, if
4014 present.
4015
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004016- CONFIG_BOARD_SIZE_LIMIT:
4017 Maximum size of the U-Boot image. When defined, the
4018 build system checks that the actual size does not
4019 exceed it.
4020
wdenkc6097192002-11-03 00:24:07 +00004021Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004022---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004023
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004024- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004025 Cache Line Size of the CPU.
4026
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004027- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004028 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004029
wdenk9c53f402003-10-15 23:53:47 +00004030 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4031 and RPXsuper) to be able to adjust the position of
4032 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004033
Timur Tabid8f341c2011-08-04 18:03:41 -05004034- CONFIG_SYS_CCSRBAR_DEFAULT:
4035 Default (power-on reset) physical address of CCSR on Freescale
4036 PowerPC SOCs.
4037
4038- CONFIG_SYS_CCSRBAR:
4039 Virtual address of CCSR. On a 32-bit build, this is typically
4040 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4041
4042 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4043 for cross-platform code that uses that macro instead.
4044
4045- CONFIG_SYS_CCSRBAR_PHYS:
4046 Physical address of CCSR. CCSR can be relocated to a new
4047 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004048 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004049 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4050 is typically relocated on 36-bit builds. It is recommended
4051 that this macro be defined via the _HIGH and _LOW macros:
4052
4053 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4054 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4055
4056- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004057 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4058 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004059 used in assembly code, so it must not contain typecasts or
4060 integer size suffixes (e.g. "ULL").
4061
4062- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4063 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4064 used in assembly code, so it must not contain typecasts or
4065 integer size suffixes (e.g. "ULL").
4066
4067- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4068 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4069 forced to a value that ensures that CCSR is not relocated.
4070
wdenk1272e232002-11-10 22:06:23 +00004071- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004072 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004073
4074 the default drive number (default value 0)
4075
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004076 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004077
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004078 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004079 (default value 1)
4080
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004081 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004082
wdenk4a5c8a72003-03-06 00:02:04 +00004083 defines the offset of register from address. It
4084 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004085 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004086
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004087 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4088 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004089 default value.
wdenk1272e232002-11-10 22:06:23 +00004090
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004091 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004092 fdc_hw_init() is called at the beginning of the FDC
4093 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004094 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004095 initializations.
wdenk1272e232002-11-10 22:06:23 +00004096
Macpaul Lind1e49942011-04-11 20:45:32 +00004097- CONFIG_IDE_AHB:
4098 Most IDE controllers were designed to be connected with PCI
4099 interface. Only few of them were designed for AHB interface.
4100 When software is doing ATA command and data transfer to
4101 IDE devices through IDE-AHB controller, some additional
4102 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004103 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004105- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004106 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004107 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004108
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004109- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004110
wdenkeb20ad32003-09-05 23:19:14 +00004111 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004112 initial data and stack; please note that this must be
4113 writable memory that is working WITHOUT special
4114 initialization, i. e. you CANNOT use normal RAM which
4115 will become available only after programming the
4116 memory controller and running certain initialization
4117 sequences.
4118
4119 U-Boot uses the following memory types:
4120 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4121 - MPC824X: data cache
4122 - PPC4xx: data cache
4123
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004124- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004125
4126 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004127 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4128 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004129 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004130 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004131 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004132 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4133 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004134
4135 Note:
4136 On the MPC824X (or other systems that use the data
4137 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004138 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004139 point to an otherwise UNUSED address space between
4140 the top of RAM and the start of the PCI space.
4141
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004142- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004143
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004144- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004145
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004146- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004147
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004148- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004149
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004150- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004151
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004152- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004154- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004155 SDRAM timing
4156
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004157- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004158 periodic timer for refresh
4159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004160- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004162- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4163 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4164 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4165 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004166 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4167
4168- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004169 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4170 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004171 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4172
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004173- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4174 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004175 Machine Mode Register and Memory Periodic Timer
4176 Prescaler definitions (SDRAM timing)
4177
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004178- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004179 enable I2C microcode relocation patch (MPC8xx);
4180 define relocation offset in DPRAM [DSP2]
4181
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004182- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004183 enable SMC microcode relocation patch (MPC8xx);
4184 define relocation offset in DPRAM [SMC1]
4185
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004186- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004187 enable SPI microcode relocation patch (MPC8xx);
4188 define relocation offset in DPRAM [SCC4]
4189
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004190- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004191 Offset of the bootmode word in DPRAM used by post
4192 (Power On Self Tests). This definition overrides
4193 #define'd default value in commproc.h resp.
4194 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004195
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004196- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4197 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4198 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4199 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4200 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4201 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4202 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4203 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004204 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004205
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004206- CONFIG_PCI_DISABLE_PCIE:
4207 Disable PCI-Express on systems where it is supported but not
4208 required.
4209
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004210- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004211 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004212 Don't do any setup work, presumably because someone or
4213 something has already done it, and we don't need to do it
4214 a second time. Useful for platforms that are pre-booted
4215 by coreboot or similar.
4216
Gabor Juhosb4458732013-05-30 07:06:12 +00004217- CONFIG_PCI_INDIRECT_BRIDGE:
4218 Enable support for indirect PCI bridges.
4219
Kumar Gala8975d7a2010-12-30 12:09:53 -06004220- CONFIG_SYS_SRIO:
4221 Chip has SRIO or not
4222
4223- CONFIG_SRIO1:
4224 Board has SRIO 1 port available
4225
4226- CONFIG_SRIO2:
4227 Board has SRIO 2 port available
4228
Liu Gang27afb9c2013-05-07 16:30:46 +08004229- CONFIG_SRIO_PCIE_BOOT_MASTER
4230 Board can support master function for Boot from SRIO and PCIE
4231
Kumar Gala8975d7a2010-12-30 12:09:53 -06004232- CONFIG_SYS_SRIOn_MEM_VIRT:
4233 Virtual Address of SRIO port 'n' memory region
4234
4235- CONFIG_SYS_SRIOn_MEM_PHYS:
4236 Physical Address of SRIO port 'n' memory region
4237
4238- CONFIG_SYS_SRIOn_MEM_SIZE:
4239 Size of SRIO port 'n' memory region
4240
Fabio Estevamf17e8782013-04-11 09:35:34 +00004241- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4242 Defined to tell the NAND controller that the NAND chip is using
4243 a 16 bit bus.
4244 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004245 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004246 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004247 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004248
4249- CONFIG_SYS_NDFC_EBC0_CFG
4250 Sets the EBC0_CFG register for the NDFC. If not defined
4251 a default value will be used.
4252
Ben Warren45657152006-09-07 16:50:54 -04004253- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004254 Get DDR timing information from an I2C EEPROM. Common
4255 with pluggable memory modules such as SODIMMs
4256
Ben Warren45657152006-09-07 16:50:54 -04004257 SPD_EEPROM_ADDRESS
4258 I2C address of the SPD EEPROM
4259
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004260- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004261 If SPD EEPROM is on an I2C bus other than the first
4262 one, specify here. Note that the value must resolve
4263 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004264
York Sune73cc042011-06-07 09:42:16 +08004265- CONFIG_SYS_DDR_RAW_TIMING
4266 Get DDR timing information from other than SPD. Common with
4267 soldered DDR chips onboard without SPD. DDR raw timing
4268 parameters are extracted from datasheet and hard-coded into
4269 header files or board specific files.
4270
York Sunbd495cf2011-09-16 13:21:35 -07004271- CONFIG_FSL_DDR_INTERACTIVE
4272 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4273
York Sun8ced0502015-01-06 13:18:55 -08004274- CONFIG_FSL_DDR_SYNC_REFRESH
4275 Enable sync of refresh for multiple controllers.
4276
York Sunb6a35f82015-03-19 09:30:28 -07004277- CONFIG_FSL_DDR_BIST
4278 Enable built-in memory test for Freescale DDR controllers.
4279
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004280- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004281 Only for 83xx systems. If specified, then DDR should
4282 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004283
wdenk6203e402004-04-18 10:13:26 +00004284- CONFIG_ETHER_ON_FEC[12]
4285 Define to enable FEC[12] on a 8xx series processor.
4286
4287- CONFIG_FEC[12]_PHY
4288 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004289 to the given FEC; i. e.
4290 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004291 means that the PHY with address 4 is connected to FEC1
4292
4293 When set to -1, means to probe for first available.
4294
4295- CONFIG_FEC[12]_PHY_NORXERR
4296 The PHY does not have a RXERR line (RMII only).
4297 (so program the FEC to ignore it).
4298
4299- CONFIG_RMII
4300 Enable RMII mode for all FECs.
4301 Note that this is a global option, we can't
4302 have one FEC in standard MII mode and another in RMII mode.
4303
wdenk20c98a62004-04-23 20:32:05 +00004304- CONFIG_CRC32_VERIFY
4305 Add a verify option to the crc32 command.
4306 The syntax is:
4307
4308 => crc32 -v <address> <count> <crc32>
4309
4310 Where address/count indicate a memory area
4311 and crc32 is the correct crc32 which the
4312 area should have.
4313
wdenk64519362004-07-11 17:40:54 +00004314- CONFIG_LOOPW
4315 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004316 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004317
stroesecc3af832004-12-16 18:46:55 +00004318- CONFIG_MX_CYCLIC
4319 Add the "mdc" and "mwc" memory commands. These are cyclic
4320 "md/mw" commands.
4321 Examples:
4322
wdenk07d7e6b2004-12-16 21:44:03 +00004323 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004324 This command will print 4 bytes (10,11,12,13) each 500 ms.
4325
wdenk07d7e6b2004-12-16 21:44:03 +00004326 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004327 This command will write 12345678 to address 100 all 10 ms.
4328
wdenk07d7e6b2004-12-16 21:44:03 +00004329 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004330 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004331
wdenk3d3d99f2005-04-04 12:44:11 +00004332- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004333 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004334 low level initializations (like setting up the memory
4335 controller) are omitted and/or U-Boot does not
4336 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004337
Wolfgang Denk302141d2010-11-27 23:30:56 +01004338 Normally this variable MUST NOT be defined. The only
4339 exception is when U-Boot is loaded (to RAM) by some
4340 other boot loader or by a debugger which performs
4341 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004342
Simon Glass90844072016-05-05 07:28:06 -06004343- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4344 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004345 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004346 instruction cache) is still performed.
4347
Aneesh V552a3192011-07-13 05:11:07 +00004348- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004349 Modifies the behaviour of start.S when compiling a loader
4350 that is executed before the actual U-Boot. E.g. when
4351 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004352
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004353- CONFIG_TPL_BUILD
4354 Modifies the behaviour of start.S when compiling a loader
4355 that is executed after the SPL and before the actual U-Boot.
4356 It is loaded by the SPL.
4357
Ying Zhang0d4f5442013-05-20 14:07:23 +08004358- CONFIG_SYS_MPC85XX_NO_RESETVEC
4359 Only for 85xx systems. If this variable is specified, the section
4360 .resetvec is not kept and the section .bootpg is placed in the
4361 previous 4k of the .text section.
4362
Simon Glass17dabf02013-02-24 17:33:14 +00004363- CONFIG_ARCH_MAP_SYSMEM
4364 Generally U-Boot (and in particular the md command) uses
4365 effective address. It is therefore not necessary to regard
4366 U-Boot address as virtual addresses that need to be translated
4367 to physical addresses. However, sandbox requires this, since
4368 it maintains its own little RAM buffer which contains all
4369 addressable memory. This option causes some memory accesses
4370 to be mapped through map_sysmem() / unmap_sysmem().
4371
Simon Glassbfb59802013-02-14 04:18:54 +00004372- CONFIG_X86_RESET_VECTOR
4373 If defined, the x86 reset vector code is included. This is not
4374 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004375
Heiko Schocher2233e462013-11-04 14:05:00 +01004376- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4377 Enables the RTC32K OSC on AM33xx based plattforms
4378
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004379- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4380 Option to disable subpage write in NAND driver
4381 driver that uses this:
4382 drivers/mtd/nand/davinci_nand.c
4383
Timur Tabi275f4bb2011-11-22 09:21:25 -06004384Freescale QE/FMAN Firmware Support:
4385-----------------------------------
4386
4387The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4388loading of "firmware", which is encoded in the QE firmware binary format.
4389This firmware often needs to be loaded during U-Boot booting, so macros
4390are used to identify the storage device (NOR flash, SPI, etc) and the address
4391within that device.
4392
Zhao Qiang83a90842014-03-21 16:21:44 +08004393- CONFIG_SYS_FMAN_FW_ADDR
4394 The address in the storage device where the FMAN microcode is located. The
4395 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4396 is also specified.
4397
4398- CONFIG_SYS_QE_FW_ADDR
4399 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004400 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4401 is also specified.
4402
4403- CONFIG_SYS_QE_FMAN_FW_LENGTH
4404 The maximum possible size of the firmware. The firmware binary format
4405 has a field that specifies the actual size of the firmware, but it
4406 might not be possible to read any part of the firmware unless some
4407 local storage is allocated to hold the entire firmware first.
4408
4409- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4410 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4411 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4412 virtual address in NOR flash.
4413
4414- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4415 Specifies that QE/FMAN firmware is located in NAND flash.
4416 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4417
4418- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4419 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4420 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4421
Liu Gang1e084582012-03-08 00:33:18 +00004422- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4423 Specifies that QE/FMAN firmware is located in the remote (master)
4424 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004425 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4426 window->master inbound window->master LAW->the ucode address in
4427 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004428
J. German Rivera8ff14b72014-06-23 15:15:55 -07004429Freescale Layerscape Management Complex Firmware Support:
4430---------------------------------------------------------
4431The Freescale Layerscape Management Complex (MC) supports the loading of
4432"firmware".
4433This firmware often needs to be loaded during U-Boot booting, so macros
4434are used to identify the storage device (NOR flash, SPI, etc) and the address
4435within that device.
4436
4437- CONFIG_FSL_MC_ENET
4438 Enable the MC driver for Layerscape SoCs.
4439
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304440Freescale Layerscape Debug Server Support:
4441-------------------------------------------
4442The Freescale Layerscape Debug Server Support supports the loading of
4443"Debug Server firmware" and triggering SP boot-rom.
4444This firmware often needs to be loaded during U-Boot booting.
4445
York Sun928b6812015-12-07 11:08:58 -08004446- CONFIG_SYS_MC_RSV_MEM_ALIGN
4447 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304448
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004449Reproducible builds
4450-------------------
4451
4452In order to achieve reproducible builds, timestamps used in the U-Boot build
4453process have to be set to a fixed value.
4454
4455This is done using the SOURCE_DATE_EPOCH environment variable.
4456SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4457option for U-Boot or an environment variable in U-Boot.
4458
4459SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4460
wdenkc6097192002-11-03 00:24:07 +00004461Building the Software:
4462======================
4463
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004464Building U-Boot has been tested in several native build environments
4465and in many different cross environments. Of course we cannot support
4466all possibly existing versions of cross development tools in all
4467(potentially obsolete) versions. In case of tool chain problems we
4468recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4469which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004470
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004471If you are not using a native environment, it is assumed that you
4472have GNU cross compiling tools available in your path. In this case,
4473you must set the environment variable CROSS_COMPILE in your shell.
4474Note that no changes to the Makefile or any other source files are
4475necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004476
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004477 $ CROSS_COMPILE=ppc_4xx-
4478 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004479
Peter Tyserb06976d2009-03-13 18:54:51 -05004480Note: If you wish to generate Windows versions of the utilities in
4481 the tools directory you can use the MinGW toolchain
4482 (http://www.mingw.org). Set your HOST tools to the MinGW
4483 toolchain and execute 'make tools'. For example:
4484
4485 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4486
4487 Binaries such as tools/mkimage.exe will be created which can
4488 be executed on computers running Windows.
4489
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004490U-Boot is intended to be simple to build. After installing the
4491sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004492is done by typing:
4493
Holger Freyther7ba4e572014-08-04 09:26:05 +02004494 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004495
Holger Freyther7ba4e572014-08-04 09:26:05 +02004496where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004497rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004498
wdenk6c59edc2004-05-03 20:45:30 +00004499Note: for some board special configuration names may exist; check if
4500 additional information is available from the board vendor; for
4501 instance, the TQM823L systems are available without (standard)
4502 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004503 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004504
Holger Freyther7ba4e572014-08-04 09:26:05 +02004505 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004506 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004507
Holger Freyther7ba4e572014-08-04 09:26:05 +02004508 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004509 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004510
wdenk6c59edc2004-05-03 20:45:30 +00004511 etc.
wdenkc6097192002-11-03 00:24:07 +00004512
wdenkc6097192002-11-03 00:24:07 +00004513
wdenk6c59edc2004-05-03 20:45:30 +00004514Finally, type "make all", and you should get some working U-Boot
4515images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004516
wdenk6c59edc2004-05-03 20:45:30 +00004517- "u-boot.bin" is a raw binary image
4518- "u-boot" is an image in ELF binary format
4519- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004520
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004521By default the build is performed locally and the objects are saved
4522in the source directory. One of the two methods can be used to change
4523this behavior and build U-Boot to some external directory:
4524
45251. Add O= to the make command line invocations:
4526
4527 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004528 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004529 make O=/tmp/build all
4530
Timo Ketolac8c67602014-11-06 14:39:05 +020045312. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004532
Timo Ketolac8c67602014-11-06 14:39:05 +02004533 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004534 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004535 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004536 make all
4537
Timo Ketolac8c67602014-11-06 14:39:05 +02004538Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004539variable.
4540
wdenkc6097192002-11-03 00:24:07 +00004541
wdenk6c59edc2004-05-03 20:45:30 +00004542Please be aware that the Makefiles assume you are using GNU make, so
4543for instance on NetBSD you might need to use "gmake" instead of
4544native "make".
wdenkc6097192002-11-03 00:24:07 +00004545
wdenkc6097192002-11-03 00:24:07 +00004546
wdenk6c59edc2004-05-03 20:45:30 +00004547If the system board that you have is not listed, then you will need
4548to port U-Boot to your hardware platform. To do this, follow these
4549steps:
wdenkc6097192002-11-03 00:24:07 +00004550
Phil Sutterc77b4882015-12-25 14:41:18 +010045511. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004552 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004553 the "Makefile" and a "<board>.c".
45542. Create a new configuration file "include/configs/<board>.h" for
4555 your board.
wdenk6c59edc2004-05-03 20:45:30 +000045563. If you're porting U-Boot to a new CPU, then also create a new
4557 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020045584. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000045595. Type "make", and you should get a working "u-boot.srec" file
4560 to be installed on your target system.
45616. Debug and solve any problems that might arise.
4562 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004563
wdenkc6097192002-11-03 00:24:07 +00004564
wdenk6c59edc2004-05-03 20:45:30 +00004565Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4566==============================================================
wdenkc6097192002-11-03 00:24:07 +00004567
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004568If you have modified U-Boot sources (for instance added a new board
4569or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004570provide feedback to the other developers. The feedback normally takes
4571the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004572official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004573
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004574But before you submit such a patch, please verify that your modifi-
4575cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004576the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004577just run the buildman script (tools/buildman/buildman), which will
4578configure and build U-Boot for ALL supported system. Be warned, this
4579will take a while. Please see the buildman README, or run 'buildman -H'
4580for documentation.
wdenkc6097192002-11-03 00:24:07 +00004581
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004582
wdenk6c59edc2004-05-03 20:45:30 +00004583See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004584
wdenkc6097192002-11-03 00:24:07 +00004585
wdenk6c59edc2004-05-03 20:45:30 +00004586Monitor Commands - Overview:
4587============================
wdenkc6097192002-11-03 00:24:07 +00004588
wdenk6c59edc2004-05-03 20:45:30 +00004589go - start application at address 'addr'
4590run - run commands in an environment variable
4591bootm - boot application image from memory
4592bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004593bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004594tftpboot- boot image via network using TFTP protocol
4595 and env variables "ipaddr" and "serverip"
4596 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004597tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004598rarpboot- boot image via network using RARP/TFTP protocol
4599diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4600loads - load S-Record file over serial line
4601loadb - load binary file over serial line (kermit mode)
4602md - memory display
4603mm - memory modify (auto-incrementing)
4604nm - memory modify (constant address)
4605mw - memory write (fill)
4606cp - memory copy
4607cmp - memory compare
4608crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004609i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004610sspi - SPI utility commands
4611base - print or set address offset
4612printenv- print environment variables
4613setenv - set environment variables
4614saveenv - save environment variables to persistent storage
4615protect - enable or disable FLASH write protection
4616erase - erase FLASH memory
4617flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004618nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004619bdinfo - print Board Info structure
4620iminfo - print header information for application image
4621coninfo - print console devices and informations
4622ide - IDE sub-system
4623loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004624loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004625mtest - simple RAM test
4626icache - enable or disable instruction cache
4627dcache - enable or disable data cache
4628reset - Perform RESET of the CPU
4629echo - echo args to console
4630version - print monitor version
4631help - print online help
4632? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004633
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk6c59edc2004-05-03 20:45:30 +00004635Monitor Commands - Detailed Description:
4636========================================
wdenkc6097192002-11-03 00:24:07 +00004637
wdenk6c59edc2004-05-03 20:45:30 +00004638TODO.
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk6c59edc2004-05-03 20:45:30 +00004640For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004641
4642
wdenk6c59edc2004-05-03 20:45:30 +00004643Environment Variables:
4644======================
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk6c59edc2004-05-03 20:45:30 +00004646U-Boot supports user configuration using Environment Variables which
4647can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004648
wdenk6c59edc2004-05-03 20:45:30 +00004649Environment Variables are set using "setenv", printed using
4650"printenv", and saved to Flash using "saveenv". Using "setenv"
4651without a value can be used to delete a variable from the
4652environment. As long as you don't save the environment you are
4653working with an in-memory copy. In case the Flash area containing the
4654environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004655
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004656Some configuration options can be set using Environment Variables.
4657
4658List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004659
wdenk6c59edc2004-05-03 20:45:30 +00004660 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004661
wdenk6c59edc2004-05-03 20:45:30 +00004662 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004663
wdenk6c59edc2004-05-03 20:45:30 +00004664 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004665
wdenk6c59edc2004-05-03 20:45:30 +00004666 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004667
wdenk6c59edc2004-05-03 20:45:30 +00004668 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004669
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004670 bootm_low - Memory range available for image processing in the bootm
4671 command can be restricted. This variable is given as
4672 a hexadecimal number and defines lowest address allowed
4673 for use by the bootm command. See also "bootm_size"
4674 environment variable. Address defined by "bootm_low" is
4675 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004676 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4677 bootm_mapsize.
4678
Wolfgang Denk092ae952011-10-26 10:21:21 +00004679 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004680 This variable is given as a hexadecimal number and it
4681 defines the size of the memory region starting at base
4682 address bootm_low that is accessible by the Linux kernel
4683 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4684 as the default value if it is defined, and bootm_size is
4685 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004686
4687 bootm_size - Memory range available for image processing in the bootm
4688 command can be restricted. This variable is given as
4689 a hexadecimal number and defines the size of the region
4690 allowed for use by the bootm command. See also "bootm_low"
4691 environment variable.
4692
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004693 updatefile - Location of the software update file on a TFTP server, used
4694 by the automatic software update feature. Please refer to
4695 documentation in doc/README.update for more details.
4696
wdenk6c59edc2004-05-03 20:45:30 +00004697 autoload - if set to "no" (any string beginning with 'n'),
4698 "bootp" will just load perform a lookup of the
4699 configuration from the BOOTP server, but not try to
4700 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004701
wdenk6c59edc2004-05-03 20:45:30 +00004702 autostart - if set to "yes", an image loaded using the "bootp",
4703 "rarpboot", "tftpboot" or "diskboot" commands will
4704 be automatically started (by internally calling
4705 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004706
wdenk6c59edc2004-05-03 20:45:30 +00004707 If set to "no", a standalone image passed to the
4708 "bootm" command will be copied to the load address
4709 (and eventually uncompressed), but NOT be started.
4710 This can be used to load and uncompress arbitrary
4711 data.
wdenkc6097192002-11-03 00:24:07 +00004712
David A. Longd558a4e2011-07-09 16:40:19 -04004713 fdt_high - if set this restricts the maximum address that the
4714 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004715 For example, if you have a system with 1 GB memory
4716 at physical address 0x10000000, while Linux kernel
4717 only recognizes the first 704 MB as low memory, you
4718 may need to set fdt_high as 0x3C000000 to have the
4719 device tree blob be copied to the maximum address
4720 of the 704 MB low memory, so that Linux kernel can
4721 access it during the boot procedure.
4722
David A. Longd558a4e2011-07-09 16:40:19 -04004723 If this is set to the special value 0xFFFFFFFF then
4724 the fdt will not be copied at all on boot. For this
4725 to work it must reside in writable memory, have
4726 sufficient padding on the end of it for u-boot to
4727 add the information it needs into it, and the memory
4728 must be accessible by the kernel.
4729
Simon Glassdc6fa642011-10-24 19:15:34 +00004730 fdtcontroladdr- if set this is the address of the control flattened
4731 device tree used by U-Boot when CONFIG_OF_CONTROL is
4732 defined.
4733
wdenk0e2bd9c2004-06-06 21:51:03 +00004734 i2cfast - (PPC405GP|PPC405EP only)
4735 if set to 'y' configures Linux I2C driver for fast
4736 mode (400kHZ). This environment variable is used in
4737 initialization code. So, for changes to be effective
4738 it must be saved and board must be reset.
4739
wdenk6c59edc2004-05-03 20:45:30 +00004740 initrd_high - restrict positioning of initrd images:
4741 If this variable is not set, initrd images will be
4742 copied to the highest possible address in RAM; this
4743 is usually what you want since it allows for
4744 maximum initrd size. If for some reason you want to
4745 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004746 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004747 variable to a value of "no" or "off" or "0".
4748 Alternatively, you can set it to a maximum upper
4749 address to use (U-Boot will still check that it
4750 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004751
wdenk6c59edc2004-05-03 20:45:30 +00004752 For instance, when you have a system with 16 MB
4753 RAM, and want to reserve 4 MB from use by Linux,
4754 you can do this by adding "mem=12M" to the value of
4755 the "bootargs" variable. However, now you must make
4756 sure that the initrd image is placed in the first
4757 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004758
wdenk6c59edc2004-05-03 20:45:30 +00004759 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004760
wdenk6c59edc2004-05-03 20:45:30 +00004761 If you set initrd_high to 0xFFFFFFFF, this is an
4762 indication to U-Boot that all addresses are legal
4763 for the Linux kernel, including addresses in flash
4764 memory. In this case U-Boot will NOT COPY the
4765 ramdisk at all. This may be useful to reduce the
4766 boot time on your system, but requires that this
4767 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004770
wdenk6c59edc2004-05-03 20:45:30 +00004771 loadaddr - Default load address for commands like "bootp",
4772 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004773
wdenk6c59edc2004-05-03 20:45:30 +00004774 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004775
wdenk6c59edc2004-05-03 20:45:30 +00004776 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004777
wdenk6c59edc2004-05-03 20:45:30 +00004778 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004779
wdenk6c59edc2004-05-03 20:45:30 +00004780 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk6c59edc2004-05-03 20:45:30 +00004782 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004783
Mike Frysingera23230c2011-10-02 10:01:27 +00004784 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004785
Mike Frysingera23230c2011-10-02 10:01:27 +00004786 ethact - controls which interface is currently active.
4787 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004788
Heiko Schocherc5e84052010-07-20 17:45:02 +02004789 => setenv ethact FEC
4790 => ping 192.168.0.1 # traffic sent on FEC
4791 => setenv ethact SCC
4792 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004793
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004794 ethrotate - When set to "no" U-Boot does not go through all
4795 available network interfaces.
4796 It just stays at the currently selected interface.
4797
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004798 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004799 either succeed or fail without retrying.
4800 When set to "once" the network operation will
4801 fail when all the available network interfaces
4802 are tried once without success.
4803 Useful on scripts which control the retry operation
4804 themselves.
wdenkc6097192002-11-03 00:24:07 +00004805
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004806 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004807
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004808 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004809 changing the console to be empty. If "yes" it will be
4810 made silent. If "no" it will not be made silent. If
4811 unset, then it will be made silent if the U-Boot console
4812 is silent.
4813
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004814 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004815 UDP source port.
4816
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004817 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004818 destination port instead of the Well Know Port 69.
4819
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004820 tftpblocksize - Block size to use for TFTP transfers; if not set,
4821 we use the TFTP server's default block size
4822
4823 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4824 seconds, minimum value is 1000 = 1 second). Defines
4825 when a packet is considered to be lost so it has to
4826 be retransmitted. The default is 5000 = 5 seconds.
4827 Lowering this value may make downloads succeed
4828 faster in networks with high packet loss rates or
4829 with unreliable TFTP servers.
4830
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004831 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4832 unit, minimum value = 0). Defines how many timeouts
4833 can happen during a single file transfer before that
4834 transfer is aborted. The default is 10, and 0 means
4835 'no timeouts allowed'. Increasing this value may help
4836 downloads succeed with high packet loss rates, or with
4837 unreliable TFTP servers or client hardware.
4838
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004839 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004840 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004841 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004842
Alexandre Messier15971322016-02-01 17:08:57 -05004843 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4844 Unsigned value, in milliseconds. If not set, the period will
4845 be either the default (28000), or a value based on
4846 CONFIG_NET_RETRY_COUNT, if defined. This value has
4847 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4848
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004849The following image location variables contain the location of images
4850used in booting. The "Image" column gives the role of the image and is
4851not an environment variable name. The other columns are environment
4852variable names. "File Name" gives the name of the file on a TFTP
4853server, "RAM Address" gives the location in RAM the image will be
4854loaded to, and "Flash Location" gives the image's address in NOR
4855flash or offset in NAND flash.
4856
4857*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004858boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004859boards use these variables for other purposes.
4860
Wolfgang Denk092ae952011-10-26 10:21:21 +00004861Image File Name RAM Address Flash Location
4862----- --------- ----------- --------------
4863u-boot u-boot u-boot_addr_r u-boot_addr
4864Linux kernel bootfile kernel_addr_r kernel_addr
4865device tree blob fdtfile fdt_addr_r fdt_addr
4866ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004867
wdenk6c59edc2004-05-03 20:45:30 +00004868The following environment variables may be used and automatically
4869updated by the network boot commands ("bootp" and "rarpboot"),
4870depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004871
wdenk6c59edc2004-05-03 20:45:30 +00004872 bootfile - see above
4873 dnsip - IP address of your Domain Name Server
4874 dnsip2 - IP address of your secondary Domain Name Server
4875 gatewayip - IP address of the Gateway (Router) to use
4876 hostname - Target hostname
4877 ipaddr - see above
4878 netmask - Subnet Mask
4879 rootpath - Pathname of the root filesystem on the NFS server
4880 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004881
wdenk145d2c12004-04-15 21:48:45 +00004882
wdenk6c59edc2004-05-03 20:45:30 +00004883There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004884
wdenk6c59edc2004-05-03 20:45:30 +00004885 serial# - contains hardware identification information such
4886 as type string and/or serial number
4887 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk6c59edc2004-05-03 20:45:30 +00004889These variables can be set only once (usually during manufacturing of
4890the board). U-Boot refuses to delete or overwrite these variables
4891once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004892
4893
wdenk6c59edc2004-05-03 20:45:30 +00004894Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004895
wdenk6c59edc2004-05-03 20:45:30 +00004896 ver - Contains the U-Boot version string as printed
4897 with the "version" command. This variable is
4898 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004899
wdenkc6097192002-11-03 00:24:07 +00004900
wdenk6c59edc2004-05-03 20:45:30 +00004901Please note that changes to some configuration parameters may take
4902only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004903
stroeseb9c17c52003-04-04 15:53:41 +00004904
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004905Callback functions for environment variables:
4906---------------------------------------------
4907
4908For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004909when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004910be associated with arbitrary variables. On creation, overwrite, or
4911deletion, the callback will provide the opportunity for some side
4912effect to happen or for the change to be rejected.
4913
4914The callbacks are named and associated with a function using the
4915U_BOOT_ENV_CALLBACK macro in your board or driver code.
4916
4917These callbacks are associated with variables in one of two ways. The
4918static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4919in the board configuration to a string that defines a list of
4920associations. The list must be in the following format:
4921
4922 entry = variable_name[:callback_name]
4923 list = entry[,list]
4924
4925If the callback name is not specified, then the callback is deleted.
4926Spaces are also allowed anywhere in the list.
4927
4928Callbacks can also be associated by defining the ".callbacks" variable
4929with the same list format above. Any association in ".callbacks" will
4930override any association in the static list. You can define
4931CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004932".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004933
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004934If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4935regular expression. This allows multiple variables to be connected to
4936the same callback without explicitly listing them all out.
4937
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004938
wdenk6c59edc2004-05-03 20:45:30 +00004939Command Line Parsing:
4940=====================
stroeseb9c17c52003-04-04 15:53:41 +00004941
wdenk6c59edc2004-05-03 20:45:30 +00004942There are two different command line parsers available with U-Boot:
4943the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk6c59edc2004-05-03 20:45:30 +00004945Old, simple command line parser:
4946--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004947
wdenk6c59edc2004-05-03 20:45:30 +00004948- supports environment variables (through setenv / saveenv commands)
4949- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004950- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004951- special characters ('$', ';') can be escaped by prefixing with '\',
4952 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004953 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004954- You can also escape text by enclosing in single apostrophes, for example:
4955 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004956
wdenk6c59edc2004-05-03 20:45:30 +00004957Hush shell:
4958-----------
wdenkf4688a22003-05-28 08:06:31 +00004959
wdenk6c59edc2004-05-03 20:45:30 +00004960- similar to Bourne shell, with control structures like
4961 if...then...else...fi, for...do...done; while...do...done,
4962 until...do...done, ...
4963- supports environment ("global") variables (through setenv / saveenv
4964 commands) and local shell variables (through standard shell syntax
4965 "name=value"); only environment variables can be used with "run"
4966 command
wdenkf4688a22003-05-28 08:06:31 +00004967
wdenk6c59edc2004-05-03 20:45:30 +00004968General rules:
4969--------------
wdenkf4688a22003-05-28 08:06:31 +00004970
wdenk6c59edc2004-05-03 20:45:30 +00004971(1) If a command line (or an environment variable executed by a "run"
4972 command) contains several commands separated by semicolon, and
4973 one of these commands fails, then the remaining commands will be
4974 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004977 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004978 command will cause "run" to terminate, i. e. the remaining
4979 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004980
wdenk6c59edc2004-05-03 20:45:30 +00004981Note for Redundant Ethernet Interfaces:
4982=======================================
wdenkf4688a22003-05-28 08:06:31 +00004983
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004984Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004985such configurations and is capable of automatic selection of a
4986"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004987
wdenk6c59edc2004-05-03 20:45:30 +00004988Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4989MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4990"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992If the network interface stores some valid MAC address (for instance
4993in SROM), this is used as default address if there is NO correspon-
4994ding setting in the environment; if the corresponding environment
4995variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004996
wdenk6c59edc2004-05-03 20:45:30 +00004997o If the SROM has a valid MAC address, and there is no address in the
4998 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004999
wdenk6c59edc2004-05-03 20:45:30 +00005000o If there is no valid address in the SROM, and a definition in the
5001 environment exists, then the value from the environment variable is
5002 used.
wdenkc6097192002-11-03 00:24:07 +00005003
wdenk6c59edc2004-05-03 20:45:30 +00005004o If both the SROM and the environment contain a MAC address, and
5005 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005006
wdenk6c59edc2004-05-03 20:45:30 +00005007o If both the SROM and the environment contain a MAC address, and the
5008 addresses differ, the value from the environment is used and a
5009 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005010
wdenk6c59edc2004-05-03 20:45:30 +00005011o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005012 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5013 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005014
Ben Warren6db991a2010-04-26 11:11:46 -07005015If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005016will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005017may be skipped by setting the appropriate 'ethmacskip' environment variable.
5018The naming convention is as follows:
5019"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005020
wdenk6c59edc2004-05-03 20:45:30 +00005021Image Formats:
5022==============
wdenkc6097192002-11-03 00:24:07 +00005023
Marian Balakowicz18710b82008-03-12 12:13:13 +01005024U-Boot is capable of booting (and performing other auxiliary operations on)
5025images in two formats:
5026
5027New uImage format (FIT)
5028-----------------------
5029
5030Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5031to Flattened Device Tree). It allows the use of images with multiple
5032components (several kernels, ramdisks, etc.), with contents protected by
5033SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5034
5035
5036Old uImage format
5037-----------------
5038
5039Old image format is based on binary files which can be basically anything,
5040preceded by a special header; see the definitions in include/image.h for
5041details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005042
wdenk6c59edc2004-05-03 20:45:30 +00005043* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5044 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005045 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5046 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5047 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005048* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005049 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5050 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005051* Compression Type (uncompressed, gzip, bzip2)
5052* Load Address
5053* Entry Point
5054* Image Name
5055* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005056
wdenk6c59edc2004-05-03 20:45:30 +00005057The header is marked by a special Magic Number, and both the header
5058and the data portions of the image are secured against corruption by
5059CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005060
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062Linux Support:
5063==============
wdenkc6097192002-11-03 00:24:07 +00005064
wdenk6c59edc2004-05-03 20:45:30 +00005065Although U-Boot should support any OS or standalone application
5066easily, the main focus has always been on Linux during the design of
5067U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069U-Boot includes many features that so far have been part of some
5070special "boot loader" code within the Linux kernel. Also, any
5071"initrd" images to be used are no longer part of one big Linux image;
5072instead, kernel and "initrd" are separate images. This implementation
5073serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005074
wdenk6c59edc2004-05-03 20:45:30 +00005075- the same features can be used for other OS or standalone
5076 applications (for instance: using compressed images to reduce the
5077 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005078
wdenk6c59edc2004-05-03 20:45:30 +00005079- it becomes much easier to port new Linux kernel versions because
5080 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005081
wdenk6c59edc2004-05-03 20:45:30 +00005082- the same Linux kernel image can now be used with different "initrd"
5083 images; of course this also means that different kernel images can
5084 be run with the same "initrd". This makes testing easier (you don't
5085 have to build a new "zImage.initrd" Linux image when you just
5086 change a file in your "initrd"). Also, a field-upgrade of the
5087 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005088
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090Linux HOWTO:
5091============
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk6c59edc2004-05-03 20:45:30 +00005093Porting Linux to U-Boot based systems:
5094---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005095
wdenk6c59edc2004-05-03 20:45:30 +00005096U-Boot cannot save you from doing all the necessary modifications to
5097configure the Linux device drivers for use with your target hardware
5098(no, we don't intend to provide a full virtual machine interface to
5099Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005100
Stefan Roese88fbf932010-04-15 16:07:28 +02005101But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005102
wdenk6c59edc2004-05-03 20:45:30 +00005103Just make sure your machine specific header file (for instance
5104include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005105Information structure as we define in include/asm-<arch>/u-boot.h,
5106and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005107as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005108
Simon Glassd097e592014-06-11 23:29:46 -06005109Note that U-Boot now has a driver model, a unified model for drivers.
5110If you are adding a new driver, plumb it into driver model. If there
5111is no uclass available, you are encouraged to create one. See
5112doc/driver-model.
5113
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk6c59edc2004-05-03 20:45:30 +00005115Configuring the Linux kernel:
5116-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118No specific requirements for U-Boot. Make sure you have some root
5119device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005120
wdenkc6097192002-11-03 00:24:07 +00005121
wdenk6c59edc2004-05-03 20:45:30 +00005122Building a Linux Image:
5123-----------------------
wdenkc6097192002-11-03 00:24:07 +00005124
wdenk6c59edc2004-05-03 20:45:30 +00005125With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5126not used. If you use recent kernel source, a new build target
5127"uImage" will exist which automatically builds an image usable by
5128U-Boot. Most older kernels also have support for a "pImage" target,
5129which was introduced for our predecessor project PPCBoot and uses a
5130100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005131
wdenk6c59edc2004-05-03 20:45:30 +00005132Example:
wdenkc6097192002-11-03 00:24:07 +00005133
Holger Freyther7ba4e572014-08-04 09:26:05 +02005134 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005135 make oldconfig
5136 make dep
5137 make uImage
wdenkc6097192002-11-03 00:24:07 +00005138
wdenk6c59edc2004-05-03 20:45:30 +00005139The "uImage" build target uses a special tool (in 'tools/mkimage') to
5140encapsulate a compressed Linux kernel image with header information,
5141CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005142
wdenk6c59edc2004-05-03 20:45:30 +00005143* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk6c59edc2004-05-03 20:45:30 +00005145* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005146
wdenk6c59edc2004-05-03 20:45:30 +00005147 ${CROSS_COMPILE}-objcopy -O binary \
5148 -R .note -R .comment \
5149 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005150
wdenk6c59edc2004-05-03 20:45:30 +00005151* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005152
wdenk6c59edc2004-05-03 20:45:30 +00005153 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005154
wdenk6c59edc2004-05-03 20:45:30 +00005155* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005156
wdenk6c59edc2004-05-03 20:45:30 +00005157 mkimage -A ppc -O linux -T kernel -C gzip \
5158 -a 0 -e 0 -n "Linux Kernel Image" \
5159 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005160
wdenkc6097192002-11-03 00:24:07 +00005161
wdenk6c59edc2004-05-03 20:45:30 +00005162The "mkimage" tool can also be used to create ramdisk images for use
5163with U-Boot, either separated from the Linux kernel image, or
5164combined into one file. "mkimage" encapsulates the images with a 64
5165byte header containing information about target architecture,
5166operating system, image type, compression method, entry points, time
5167stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk6c59edc2004-05-03 20:45:30 +00005169"mkimage" can be called in two ways: to verify existing images and
5170print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005171
wdenk6c59edc2004-05-03 20:45:30 +00005172In the first form (with "-l" option) mkimage lists the information
5173contained in the header of an existing U-Boot image; this includes
5174checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005175
wdenk6c59edc2004-05-03 20:45:30 +00005176 tools/mkimage -l image
5177 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005178
wdenk6c59edc2004-05-03 20:45:30 +00005179The second form (with "-d" option) is used to build a U-Boot image
5180from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5183 -n name -d data_file image
5184 -A ==> set architecture to 'arch'
5185 -O ==> set operating system to 'os'
5186 -T ==> set image type to 'type'
5187 -C ==> set compression type 'comp'
5188 -a ==> set load address to 'addr' (hex)
5189 -e ==> set entry point to 'ep' (hex)
5190 -n ==> set image name to 'name'
5191 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005192
wdenkcd914452004-05-29 16:53:29 +00005193Right now, all Linux kernels for PowerPC systems use the same load
5194address (0x00000000), but the entry point address depends on the
5195kernel version:
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk6c59edc2004-05-03 20:45:30 +00005197- 2.2.x kernels have the entry point at 0x0000000C,
5198- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005199
wdenk6c59edc2004-05-03 20:45:30 +00005200So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005201
wdenk6c59edc2004-05-03 20:45:30 +00005202 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5203 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005204 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005205 > examples/uImage.TQM850L
5206 Image Name: 2.4.4 kernel for TQM850L
5207 Created: Wed Jul 19 02:34:59 2000
5208 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5209 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5210 Load Address: 0x00000000
5211 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk6c59edc2004-05-03 20:45:30 +00005213To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215 -> tools/mkimage -l examples/uImage.TQM850L
5216 Image Name: 2.4.4 kernel for TQM850L
5217 Created: Wed Jul 19 02:34:59 2000
5218 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5219 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5220 Load Address: 0x00000000
5221 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223NOTE: for embedded systems where boot time is critical you can trade
5224speed for memory and install an UNCOMPRESSED image instead: this
5225needs more space in Flash, but boots much faster since it does not
5226need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005227
Stefan Roese88fbf932010-04-15 16:07:28 +02005228 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005229 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5230 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005231 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005232 > examples/uImage.TQM850L-uncompressed
5233 Image Name: 2.4.4 kernel for TQM850L
5234 Created: Wed Jul 19 02:34:59 2000
5235 Image Type: PowerPC Linux Kernel Image (uncompressed)
5236 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5237 Load Address: 0x00000000
5238 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005239
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk6c59edc2004-05-03 20:45:30 +00005241Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5242when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk6c59edc2004-05-03 20:45:30 +00005244 -> tools/mkimage -n 'Simple Ramdisk Image' \
5245 > -A ppc -O linux -T ramdisk -C gzip \
5246 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5247 Image Name: Simple Ramdisk Image
5248 Created: Wed Jan 12 14:01:50 2000
5249 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5250 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5251 Load Address: 0x00000000
5252 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005253
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005254The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5255option performs the converse operation of the mkimage's second form (the "-d"
5256option). Given an image built by mkimage, the dumpimage extracts a "data file"
5257from the image:
5258
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005259 tools/dumpimage -i image -T type -p position data_file
5260 -i ==> extract from the 'image' a specific 'data_file'
5261 -T ==> set image type to 'type'
5262 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005263
wdenkc6097192002-11-03 00:24:07 +00005264
wdenk6c59edc2004-05-03 20:45:30 +00005265Installing a Linux Image:
5266-------------------------
wdenkc6097192002-11-03 00:24:07 +00005267
wdenk6c59edc2004-05-03 20:45:30 +00005268To downloading a U-Boot image over the serial (console) interface,
5269you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005270
wdenk6c59edc2004-05-03 20:45:30 +00005271 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005272
wdenk6c59edc2004-05-03 20:45:30 +00005273The 'objcopy' does not understand the information in the U-Boot
5274image header, so the resulting S-Record file will be relative to
5275address 0x00000000. To load it to a given address, you need to
5276specify the target address as 'offset' parameter with the 'loads'
5277command.
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279Example: install the image to address 0x40100000 (which on the
5280TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005281
wdenk6c59edc2004-05-03 20:45:30 +00005282 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005283
wdenk6c59edc2004-05-03 20:45:30 +00005284 .......... done
5285 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287 => loads 40100000
5288 ## Ready for S-Record download ...
5289 ~>examples/image.srec
5290 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5291 ...
5292 15989 15990 15991 15992
5293 [file transfer complete]
5294 [connected]
5295 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005296
wdenkc6097192002-11-03 00:24:07 +00005297
wdenk6c59edc2004-05-03 20:45:30 +00005298You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005299this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005300corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005301
wdenk6c59edc2004-05-03 20:45:30 +00005302 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005303
wdenk6c59edc2004-05-03 20:45:30 +00005304 ## Checking Image at 40100000 ...
5305 Image Name: 2.2.13 for initrd on TQM850L
5306 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5307 Data Size: 335725 Bytes = 327 kB = 0 MB
5308 Load Address: 00000000
5309 Entry Point: 0000000c
5310 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005311
5312
wdenk6c59edc2004-05-03 20:45:30 +00005313Boot Linux:
5314-----------
wdenkc6097192002-11-03 00:24:07 +00005315
wdenk6c59edc2004-05-03 20:45:30 +00005316The "bootm" command is used to boot an application that is stored in
5317memory (RAM or Flash). In case of a Linux kernel image, the contents
5318of the "bootargs" environment variable is passed to the kernel as
5319parameters. You can check and modify this variable using the
5320"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005321
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323 => printenv bootargs
5324 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005325
wdenk6c59edc2004-05-03 20:45:30 +00005326 => 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 +00005327
wdenk6c59edc2004-05-03 20:45:30 +00005328 => printenv bootargs
5329 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 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331 => bootm 40020000
5332 ## Booting Linux kernel at 40020000 ...
5333 Image Name: 2.2.13 for NFS on TQM850L
5334 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5335 Data Size: 381681 Bytes = 372 kB = 0 MB
5336 Load Address: 00000000
5337 Entry Point: 0000000c
5338 Verifying Checksum ... OK
5339 Uncompressing Kernel Image ... OK
5340 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
5341 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5342 time_init: decrementer frequency = 187500000/60
5343 Calibrating delay loop... 49.77 BogoMIPS
5344 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5345 ...
wdenkc6097192002-11-03 00:24:07 +00005346
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005347If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005348the memory addresses of both the kernel and the initrd image (PPBCOOT
5349format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005352
wdenk6c59edc2004-05-03 20:45:30 +00005353 ## Checking Image at 40100000 ...
5354 Image Name: 2.2.13 for initrd on TQM850L
5355 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5356 Data Size: 335725 Bytes = 327 kB = 0 MB
5357 Load Address: 00000000
5358 Entry Point: 0000000c
5359 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005360
wdenk6c59edc2004-05-03 20:45:30 +00005361 ## Checking Image at 40200000 ...
5362 Image Name: Simple Ramdisk Image
5363 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5364 Data Size: 566530 Bytes = 553 kB = 0 MB
5365 Load Address: 00000000
5366 Entry Point: 00000000
5367 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005368
wdenk6c59edc2004-05-03 20:45:30 +00005369 => bootm 40100000 40200000
5370 ## Booting Linux kernel at 40100000 ...
5371 Image Name: 2.2.13 for initrd on TQM850L
5372 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5373 Data Size: 335725 Bytes = 327 kB = 0 MB
5374 Load Address: 00000000
5375 Entry Point: 0000000c
5376 Verifying Checksum ... OK
5377 Uncompressing Kernel Image ... OK
5378 ## Loading RAMDisk Image at 40200000 ...
5379 Image Name: Simple Ramdisk Image
5380 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5381 Data Size: 566530 Bytes = 553 kB = 0 MB
5382 Load Address: 00000000
5383 Entry Point: 00000000
5384 Verifying Checksum ... OK
5385 Loading Ramdisk ... OK
5386 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
5387 Boot arguments: root=/dev/ram
5388 time_init: decrementer frequency = 187500000/60
5389 Calibrating delay loop... 49.77 BogoMIPS
5390 ...
5391 RAMDISK: Compressed image found at block 0
5392 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394 bash#
wdenkc6097192002-11-03 00:24:07 +00005395
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005396Boot Linux and pass a flat device tree:
5397-----------
5398
5399First, U-Boot must be compiled with the appropriate defines. See the section
5400titled "Linux Kernel Interface" above for a more in depth explanation. The
5401following is an example of how to start a kernel and pass an updated
5402flat device tree:
5403
5404=> print oftaddr
5405oftaddr=0x300000
5406=> print oft
5407oft=oftrees/mpc8540ads.dtb
5408=> tftp $oftaddr $oft
5409Speed: 1000, full duplex
5410Using TSEC0 device
5411TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5412Filename 'oftrees/mpc8540ads.dtb'.
5413Load address: 0x300000
5414Loading: #
5415done
5416Bytes transferred = 4106 (100a hex)
5417=> tftp $loadaddr $bootfile
5418Speed: 1000, full duplex
5419Using TSEC0 device
5420TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5421Filename 'uImage'.
5422Load address: 0x200000
5423Loading:############
5424done
5425Bytes transferred = 1029407 (fb51f hex)
5426=> print loadaddr
5427loadaddr=200000
5428=> print oftaddr
5429oftaddr=0x300000
5430=> bootm $loadaddr - $oftaddr
5431## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005432 Image Name: Linux-2.6.17-dirty
5433 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5434 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005435 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005436 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005437 Verifying Checksum ... OK
5438 Uncompressing Kernel Image ... OK
5439Booting using flat device tree at 0x300000
5440Using MPC85xx ADS machine description
5441Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5442[snip]
5443
5444
wdenk6c59edc2004-05-03 20:45:30 +00005445More About U-Boot Image Types:
5446------------------------------
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk6c59edc2004-05-03 20:45:30 +00005448U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005449
wdenk6c59edc2004-05-03 20:45:30 +00005450 "Standalone Programs" are directly runnable in the environment
5451 provided by U-Boot; it is expected that (if they behave
5452 well) you can continue to work in U-Boot after return from
5453 the Standalone Program.
5454 "OS Kernel Images" are usually images of some Embedded OS which
5455 will take over control completely. Usually these programs
5456 will install their own set of exception handlers, device
5457 drivers, set up the MMU, etc. - this means, that you cannot
5458 expect to re-enter U-Boot except by resetting the CPU.
5459 "RAMDisk Images" are more or less just data blocks, and their
5460 parameters (address, size) are passed to an OS kernel that is
5461 being started.
5462 "Multi-File Images" contain several images, typically an OS
5463 (Linux) kernel image and one or more data images like
5464 RAMDisks. This construct is useful for instance when you want
5465 to boot over the network using BOOTP etc., where the boot
5466 server provides just a single image file, but you want to get
5467 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005468
wdenk6c59edc2004-05-03 20:45:30 +00005469 "Multi-File Images" start with a list of image sizes, each
5470 image size (in bytes) specified by an "uint32_t" in network
5471 byte order. This list is terminated by an "(uint32_t)0".
5472 Immediately after the terminating 0 follow the images, one by
5473 one, all aligned on "uint32_t" boundaries (size rounded up to
5474 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005475
wdenk6c59edc2004-05-03 20:45:30 +00005476 "Firmware Images" are binary images containing firmware (like
5477 U-Boot or FPGA images) which usually will be programmed to
5478 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005479
wdenk6c59edc2004-05-03 20:45:30 +00005480 "Script files" are command sequences that will be executed by
5481 U-Boot's command interpreter; this feature is especially
5482 useful when you configure U-Boot to use a real shell (hush)
5483 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005484
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005485Booting the Linux zImage:
5486-------------------------
5487
5488On some platforms, it's possible to boot Linux zImage. This is done
5489using the "bootz" command. The syntax of "bootz" command is the same
5490as the syntax of "bootm" command.
5491
Tom Rini45f46d12013-05-16 11:40:11 -04005492Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005493kernel with raw initrd images. The syntax is slightly different, the
5494address of the initrd must be augmented by it's size, in the following
5495format: "<initrd addres>:<initrd size>".
5496
stroeseb9c17c52003-04-04 15:53:41 +00005497
wdenk6c59edc2004-05-03 20:45:30 +00005498Standalone HOWTO:
5499=================
stroeseb9c17c52003-04-04 15:53:41 +00005500
wdenk6c59edc2004-05-03 20:45:30 +00005501One of the features of U-Boot is that you can dynamically load and
5502run "standalone" applications, which can use some resources of
5503U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005504
wdenk6c59edc2004-05-03 20:45:30 +00005505Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005506
wdenk6c59edc2004-05-03 20:45:30 +00005507"Hello World" Demo:
5508-------------------
wdenkc6097192002-11-03 00:24:07 +00005509
wdenk6c59edc2004-05-03 20:45:30 +00005510'examples/hello_world.c' contains a small "Hello World" Demo
5511application; it is automatically compiled when you build U-Boot.
5512It's configured to run at address 0x00040004, so you can play with it
5513like that:
wdenkc6097192002-11-03 00:24:07 +00005514
wdenk6c59edc2004-05-03 20:45:30 +00005515 => loads
5516 ## Ready for S-Record download ...
5517 ~>examples/hello_world.srec
5518 1 2 3 4 5 6 7 8 9 10 11 ...
5519 [file transfer complete]
5520 [connected]
5521 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523 => go 40004 Hello World! This is a test.
5524 ## Starting application at 0x00040004 ...
5525 Hello World
5526 argc = 7
5527 argv[0] = "40004"
5528 argv[1] = "Hello"
5529 argv[2] = "World!"
5530 argv[3] = "This"
5531 argv[4] = "is"
5532 argv[5] = "a"
5533 argv[6] = "test."
5534 argv[7] = "<NULL>"
5535 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005538
wdenk6c59edc2004-05-03 20:45:30 +00005539Another example, which demonstrates how to register a CPM interrupt
5540handler with the U-Boot code, can be found in 'examples/timer.c'.
5541Here, a CPM timer is set up to generate an interrupt every second.
5542The interrupt service routine is trivial, just printing a '.'
5543character, but this is just a demo program. The application can be
5544controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005545
wdenk6c59edc2004-05-03 20:45:30 +00005546 ? - print current values og the CPM Timer registers
5547 b - enable interrupts and start timer
5548 e - stop timer and disable interrupts
5549 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551 => loads
5552 ## Ready for S-Record download ...
5553 ~>examples/timer.srec
5554 1 2 3 4 5 6 7 8 9 10 11 ...
5555 [file transfer complete]
5556 [connected]
5557 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559 => go 40004
5560 ## Starting application at 0x00040004 ...
5561 TIMERS=0xfff00980
5562 Using timer 1
5563 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005564
wdenk6c59edc2004-05-03 20:45:30 +00005565Hit 'b':
5566 [q, b, e, ?] Set interval 1000000 us
5567 Enabling timer
5568Hit '?':
5569 [q, b, e, ?] ........
5570 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5571Hit '?':
5572 [q, b, e, ?] .
5573 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5574Hit '?':
5575 [q, b, e, ?] .
5576 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5577Hit '?':
5578 [q, b, e, ?] .
5579 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5580Hit 'e':
5581 [q, b, e, ?] ...Stopping timer
5582Hit 'q':
5583 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005584
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586Minicom warning:
5587================
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk6c59edc2004-05-03 20:45:30 +00005589Over time, many people have reported problems when trying to use the
5590"minicom" terminal emulation program for serial download. I (wd)
5591consider minicom to be broken, and recommend not to use it. Under
5592Unix, I recommend to use C-Kermit for general purpose use (and
5593especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005594use "cu" for S-Record download ("loads" command). See
5595http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5596for help with kermit.
5597
wdenkc6097192002-11-03 00:24:07 +00005598
wdenk6c59edc2004-05-03 20:45:30 +00005599Nevertheless, if you absolutely want to use it try adding this
5600configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005601
wdenk6c59edc2004-05-03 20:45:30 +00005602 Name Program Name U/D FullScr IO-Red. Multi
5603 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5604 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005605
wdenk8dba0502003-03-31 16:34:49 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607NetBSD Notes:
5608=============
wdenkc6097192002-11-03 00:24:07 +00005609
wdenk6c59edc2004-05-03 20:45:30 +00005610Starting at version 0.9.2, U-Boot supports NetBSD both as host
5611(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005612
wdenk6c59edc2004-05-03 20:45:30 +00005613Building requires a cross environment; it is known to work on
5614NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5615need gmake since the Makefiles are not compatible with BSD make).
5616Note that the cross-powerpc package does not install include files;
5617attempting to build U-Boot will fail because <machine/ansi.h> is
5618missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005619
wdenk6c59edc2004-05-03 20:45:30 +00005620 # cd /usr/pkg/cross/powerpc-netbsd/include
5621 # mkdir powerpc
5622 # ln -s powerpc machine
5623 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5624 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005625
wdenk6c59edc2004-05-03 20:45:30 +00005626Native builds *don't* work due to incompatibilities between native
5627and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005628
wdenk6c59edc2004-05-03 20:45:30 +00005629Booting assumes that (the first part of) the image booted is a
5630stage-2 loader which in turn loads and then invokes the kernel
5631proper. Loader sources will eventually appear in the NetBSD source
5632tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005633meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005634
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636Implementation Internals:
5637=========================
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk6c59edc2004-05-03 20:45:30 +00005639The following is not intended to be a complete description of every
5640implementation detail. However, it should help to understand the
5641inner workings of U-Boot and make it easier to port it to custom
5642hardware.
wdenkc6097192002-11-03 00:24:07 +00005643
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk6c59edc2004-05-03 20:45:30 +00005645Initial Stack, Global Data:
5646---------------------------
wdenkc6097192002-11-03 00:24:07 +00005647
wdenk6c59edc2004-05-03 20:45:30 +00005648The implementation of U-Boot is complicated by the fact that U-Boot
5649starts running out of ROM (flash memory), usually without access to
5650system RAM (because the memory controller is not initialized yet).
5651This means that we don't have writable Data or BSS segments, and BSS
5652is not initialized as zero. To be able to get a C environment working
5653at all, we have to allocate at least a minimal stack. Implementation
5654options for this are defined and restricted by the CPU used: Some CPU
5655models provide on-chip memory (like the IMMR area on MPC8xx and
5656MPC826x processors), on others (parts of) the data cache can be
5657locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005658
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005659 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005660 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk6c59edc2004-05-03 20:45:30 +00005662 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5663 From: "Chris Hallinan" <clh@net1plus.com>
5664 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5665 ...
wdenkc6097192002-11-03 00:24:07 +00005666
wdenk6c59edc2004-05-03 20:45:30 +00005667 Correct me if I'm wrong, folks, but the way I understand it
5668 is this: Using DCACHE as initial RAM for Stack, etc, does not
5669 require any physical RAM backing up the cache. The cleverness
5670 is that the cache is being used as a temporary supply of
5671 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005672 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005673 can see how this works by studying the cache architecture and
5674 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005675
wdenk6c59edc2004-05-03 20:45:30 +00005676 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5677 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005678 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005679 option should work for you. Using CS 4 should be fine if your
5680 board designers haven't used it for something that would
5681 cause you grief during the initial boot! It is frequently not
5682 used.
wdenkc6097192002-11-03 00:24:07 +00005683
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005684 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005685 with your processor/board/system design. The default value
5686 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005687 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005688 than your SDRAM module. If you have a 64MB SDRAM module, set
5689 it above 400_0000. Just make sure your board has no resources
5690 that are supposed to respond to that address! That code in
5691 start.S has been around a while and should work as is when
5692 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694 -Chris Hallinan
5695 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005696
wdenk6c59edc2004-05-03 20:45:30 +00005697It is essential to remember this, since it has some impact on the C
5698code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005699
wdenk6c59edc2004-05-03 20:45:30 +00005700* Initialized global data (data segment) is read-only. Do not attempt
5701 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005702
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005703* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005704 as zero data - BSS segment) at all - this is undefined, initiali-
5705 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005706
wdenk6c59edc2004-05-03 20:45:30 +00005707* Stack space is very limited. Avoid big data buffers or things like
5708 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005709
wdenk6c59edc2004-05-03 20:45:30 +00005710Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005711normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005712turned out that the implementation of U-Boot can be greatly
5713simplified by making a global data structure (gd_t) available to all
5714functions. We could pass a pointer to this data as argument to _all_
5715functions, but this would bloat the code. Instead we use a feature of
5716the GCC compiler (Global Register Variables) to share the data: we
5717place a pointer (gd) to the global data into a register which we
5718reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005719
wdenk6c59edc2004-05-03 20:45:30 +00005720When choosing a register for such a purpose we are restricted by the
5721relevant (E)ABI specifications for the current architecture, and by
5722GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk6c59edc2004-05-03 20:45:30 +00005724For PowerPC, the following registers have specific use:
5725 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005726 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005727 R3-R4: parameter passing and return values
5728 R5-R10: parameter passing
5729 R13: small data area pointer
5730 R30: GOT pointer
5731 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005732
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005733 (U-Boot also uses R12 as internal GOT pointer. r12
5734 is a volatile register so r12 needs to be reset when
5735 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005736
Wolfgang Denk69c09642008-02-14 22:43:22 +01005737 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005738
wdenk6c59edc2004-05-03 20:45:30 +00005739 Note: on PPC, we could use a static initializer (since the
5740 address of the global data structure is known at compile time),
5741 but it turned out that reserving a register results in somewhat
5742 smaller code - although the code savings are not that big (on
5743 average for all boards 752 bytes for the whole U-Boot image,
5744 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk6c59edc2004-05-03 20:45:30 +00005746On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005747
wdenk6c59edc2004-05-03 20:45:30 +00005748 R0: function argument word/integer result
5749 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005750 R9: platform specific
5751 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005752 R11: argument (frame) pointer
5753 R12: temporary workspace
5754 R13: stack pointer
5755 R14: link register
5756 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005757
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005758 ==> U-Boot will use R9 to hold a pointer to the global data
5759
5760 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005761
Thomas Chou8fa38582010-05-21 11:08:03 +08005762On Nios II, the ABI is documented here:
5763 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5764
5765 ==> U-Boot will use gp to hold a pointer to the global data
5766
5767 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5768 to access small data sections, so gp is free.
5769
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005770On NDS32, the following registers are used:
5771
5772 R0-R1: argument/return
5773 R2-R5: argument
5774 R15: temporary register for assembler
5775 R16: trampoline register
5776 R28: frame pointer (FP)
5777 R29: global pointer (GP)
5778 R30: link register (LP)
5779 R31: stack pointer (SP)
5780 PC: program counter (PC)
5781
5782 ==> U-Boot will use R10 to hold a pointer to the global data
5783
Wolfgang Denk6405a152006-03-31 18:32:53 +02005784NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5785or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787Memory Management:
5788------------------
wdenkc6097192002-11-03 00:24:07 +00005789
wdenk6c59edc2004-05-03 20:45:30 +00005790U-Boot runs in system state and uses physical addresses, i.e. the
5791MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005792
wdenk6c59edc2004-05-03 20:45:30 +00005793The available memory is mapped to fixed addresses using the memory
5794controller. In this process, a contiguous block is formed for each
5795memory type (Flash, SDRAM, SRAM), even when it consists of several
5796physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005797
wdenk6c59edc2004-05-03 20:45:30 +00005798U-Boot is installed in the first 128 kB of the first Flash bank (on
5799TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5800booting and sizing and initializing DRAM, the code relocates itself
5801to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005802memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005803configuration setting]. Below that, a structure with global Board
5804Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk6c59edc2004-05-03 20:45:30 +00005806Additionally, some exception handler code is copied to the low 8 kB
5807of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk6c59edc2004-05-03 20:45:30 +00005809So a typical memory configuration with 16 MB of DRAM could look like
5810this:
wdenkc6097192002-11-03 00:24:07 +00005811
wdenk6c59edc2004-05-03 20:45:30 +00005812 0x0000 0000 Exception Vector code
5813 :
5814 0x0000 1FFF
5815 0x0000 2000 Free for Application Use
5816 :
5817 :
wdenkc6097192002-11-03 00:24:07 +00005818
wdenk6c59edc2004-05-03 20:45:30 +00005819 :
5820 :
5821 0x00FB FF20 Monitor Stack (Growing downward)
5822 0x00FB FFAC Board Info Data and permanent copy of global data
5823 0x00FC 0000 Malloc Arena
5824 :
5825 0x00FD FFFF
5826 0x00FE 0000 RAM Copy of Monitor Code
5827 ... eventually: LCD or video framebuffer
5828 ... eventually: pRAM (Protected RAM - unchanged by reset)
5829 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005830
wdenkc6097192002-11-03 00:24:07 +00005831
wdenk6c59edc2004-05-03 20:45:30 +00005832System Initialization:
5833----------------------
wdenkc6097192002-11-03 00:24:07 +00005834
wdenk6c59edc2004-05-03 20:45:30 +00005835In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005836(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005837configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005838To be able to re-map memory U-Boot then jumps to its link address.
5839To be able to implement the initialization code in C, a (small!)
5840initial stack is set up in the internal Dual Ported RAM (in case CPUs
5841which provide such a feature like MPC8xx or MPC8260), or in a locked
5842part of the data cache. After that, U-Boot initializes the CPU core,
5843the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005844
wdenk6c59edc2004-05-03 20:45:30 +00005845Next, all (potentially) available memory banks are mapped using a
5846preliminary mapping. For example, we put them on 512 MB boundaries
5847(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5848on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5849programmed for SDRAM access. Using the temporary configuration, a
5850simple memory test is run that determines the size of the SDRAM
5851banks.
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk6c59edc2004-05-03 20:45:30 +00005853When there is more than one SDRAM bank, and the banks are of
5854different size, the largest is mapped first. For equal size, the first
5855bank (CS2#) is mapped first. The first mapping is always for address
58560x00000000, with any additional banks following immediately to create
5857contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005858
wdenk6c59edc2004-05-03 20:45:30 +00005859Then, the monitor installs itself at the upper end of the SDRAM area
5860and allocates memory for use by malloc() and for the global Board
5861Info data; also, the exception vector code is copied to the low RAM
5862pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005863
wdenk6c59edc2004-05-03 20:45:30 +00005864Only after this relocation will you have a "normal" C environment;
5865until that you are restricted in several ways, mostly because you are
5866running from ROM, and because the code will have to be relocated to a
5867new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005868
wdenkc6097192002-11-03 00:24:07 +00005869
wdenk6c59edc2004-05-03 20:45:30 +00005870U-Boot Porting Guide:
5871----------------------
wdenkc6097192002-11-03 00:24:07 +00005872
wdenk6c59edc2004-05-03 20:45:30 +00005873[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5874list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005875
wdenkc6097192002-11-03 00:24:07 +00005876
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005877int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005878{
5879 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005880
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005881 signal(SIGALRM, no_more_time);
5882 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005883
wdenk6c59edc2004-05-03 20:45:30 +00005884 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005885 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005886 return 0;
5887 }
wdenkc6097192002-11-03 00:24:07 +00005888
wdenk6c59edc2004-05-03 20:45:30 +00005889 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005890
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005891 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005892
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005893 if (clueless)
5894 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005895
wdenk6c59edc2004-05-03 20:45:30 +00005896 while (learning) {
5897 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005898 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5899 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005900 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005901 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005902 }
wdenkc6097192002-11-03 00:24:07 +00005903
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005904 if (available_money > toLocalCurrency ($2500))
5905 Buy a BDI3000;
5906 else
wdenk6c59edc2004-05-03 20:45:30 +00005907 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005908
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005909 if (a similar board exists) { /* hopefully... */
5910 cp -a board/<similar> board/<myboard>
5911 cp include/configs/<similar>.h include/configs/<myboard>.h
5912 } else {
5913 Create your own board support subdirectory;
5914 Create your own board include/configs/<myboard>.h file;
5915 }
5916 Edit new board/<myboard> files
5917 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005918
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005919 while (!accepted) {
5920 while (!running) {
5921 do {
5922 Add / modify source code;
5923 } until (compiles);
5924 Debug;
5925 if (clueless)
5926 email("Hi, I am having problems...");
5927 }
5928 Send patch file to the U-Boot email list;
5929 if (reasonable critiques)
5930 Incorporate improvements from email list code review;
5931 else
5932 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005933 }
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk6c59edc2004-05-03 20:45:30 +00005935 return 0;
5936}
wdenkc6097192002-11-03 00:24:07 +00005937
wdenk6c59edc2004-05-03 20:45:30 +00005938void no_more_time (int sig)
5939{
5940 hire_a_guru();
5941}
wdenkc6097192002-11-03 00:24:07 +00005942
wdenkc6097192002-11-03 00:24:07 +00005943
wdenk6c59edc2004-05-03 20:45:30 +00005944Coding Standards:
5945-----------------
wdenkc6097192002-11-03 00:24:07 +00005946
wdenk6c59edc2004-05-03 20:45:30 +00005947All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005948coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005949"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005950
5951Source files originating from a different project (for example the
5952MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005953reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005954sources.
wdenkc6097192002-11-03 00:24:07 +00005955
Detlev Zundelaa63d482006-09-01 15:39:02 +02005956Please note that U-Boot is implemented in C (and to some small parts in
5957Assembler); no C++ is used, so please do not use C++ style comments (//)
5958in your code.
wdenkad276f22004-01-04 16:28:35 +00005959
wdenk6c59edc2004-05-03 20:45:30 +00005960Please also stick to the following formatting rules:
5961- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005962- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005963- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005964- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005965- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005966
wdenk6c59edc2004-05-03 20:45:30 +00005967Submissions which do not conform to the standards may be returned
5968with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005969
wdenkc6097192002-11-03 00:24:07 +00005970
wdenk6c59edc2004-05-03 20:45:30 +00005971Submitting Patches:
5972-------------------
wdenkc6097192002-11-03 00:24:07 +00005973
wdenk6c59edc2004-05-03 20:45:30 +00005974Since the number of patches for U-Boot is growing, we need to
5975establish some rules. Submissions which do not conform to these rules
5976may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005977
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005978Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005979
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005980Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5981see http://lists.denx.de/mailman/listinfo/u-boot
5982
wdenk6c59edc2004-05-03 20:45:30 +00005983When you send a patch, please include the following information with
5984it:
wdenkc6097192002-11-03 00:24:07 +00005985
wdenk6c59edc2004-05-03 20:45:30 +00005986* For bug fixes: a description of the bug and how your patch fixes
5987 this bug. Please try to include a way of demonstrating that the
5988 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005989
wdenk6c59edc2004-05-03 20:45:30 +00005990* For new features: a description of the feature and your
5991 implementation.
wdenkc6097192002-11-03 00:24:07 +00005992
wdenk6c59edc2004-05-03 20:45:30 +00005993* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005994
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005995* For major contributions, add a MAINTAINERS file with your
5996 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005997
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005998* When you add support for a new board, don't forget to add a
5999 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006000
wdenk6c59edc2004-05-03 20:45:30 +00006001* If your patch adds new configuration options, don't forget to
6002 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006003
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006004* The patch itself. If you are using git (which is *strongly*
6005 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006006 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006007 the U-Boot mailing list, you will avoid most of the common problems
6008 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006009
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006010 If you cannot use git, use "diff -purN OLD NEW". If your version of
6011 diff does not support these options, then get the latest version of
6012 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006013
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006014 The current directory when running this command shall be the parent
6015 directory of the U-Boot source tree (i. e. please make sure that
6016 your patch includes sufficient directory information for the
6017 affected files).
6018
6019 We prefer patches as plain text. MIME attachments are discouraged,
6020 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006021
wdenk6c59edc2004-05-03 20:45:30 +00006022* If one logical set of modifications affects or creates several
6023 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006024
wdenk6c59edc2004-05-03 20:45:30 +00006025* Changesets that contain different, unrelated modifications shall be
6026 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006027
wdenkc6097192002-11-03 00:24:07 +00006028
wdenk6c59edc2004-05-03 20:45:30 +00006029Notes:
wdenkc6097192002-11-03 00:24:07 +00006030
Simon Glassdc27def2016-07-27 20:33:08 -06006031* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006032 source tree and make sure that no errors or warnings are reported
6033 for any of the boards.
6034
6035* Keep your modifications to the necessary minimum: A patch
6036 containing several unrelated changes or arbitrary reformats will be
6037 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006038
wdenk6c59edc2004-05-03 20:45:30 +00006039* If you modify existing code, make sure that your new code does not
6040 add to the memory footprint of the code ;-) Small is beautiful!
6041 When adding new features, these should compile conditionally only
6042 (using #ifdef), and the resulting code with the new feature
6043 disabled must not need more memory than the old code without your
6044 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006045
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006046* Remember that there is a size limit of 100 kB per message on the
6047 u-boot mailing list. Bigger patches will be moderated. If they are
6048 reasonable and not too big, they will be acknowledged. But patches
6049 bigger than the size limit should be avoided.