blob: 98a51dcb809580e4fb8120e73d910d73112e6d73 [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_ITEST Integer/string test of 2 values
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200856 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000857 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
858 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500859 CONFIG_CMD_LOADB loadb
860 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200861 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400862 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000863 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500864 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000865 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200866 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500867 CONFIG_CMD_MISC Misc functions like sleep etc
868 CONFIG_CMD_MMC * MMC memory mapped support
869 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100870 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500871 CONFIG_CMD_NAND * NAND support
872 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200873 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600874 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000875 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500876 CONFIG_CMD_PCI * pciinfo
877 CONFIG_CMD_PCMCIA * PCMCIA support
878 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
879 host
880 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000881 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500882 CONFIG_CMD_REGINFO * Register dump
883 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000884 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500885 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600886 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500887 CONFIG_CMD_SDRAM * print SDRAM configuration information
888 (requires CONFIG_CMD_I2C)
889 CONFIG_CMD_SETGETDCR Support for DCR Register access
890 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700891 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200892 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400893 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800894 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200895 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500896 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000897 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000898 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000899 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
900 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500901 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500902 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000903 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200904 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200905 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000906
907 EXAMPLE: If you want all functions except of network
908 support you can write:
909
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500910 #include "config_cmd_all.h"
911 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000912
Gerald Van Barend6abef42007-03-31 12:23:51 -0400913 Other Commands:
914 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000915
916 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500917 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000918 what you (and your U-Boot users) are doing. Data
919 cache cannot be enabled on systems like the 8xx or
920 8260 (where accesses to the IMMR region must be
921 uncached), and it cannot be disabled on all other
922 systems where we (mis-) use the data cache to hold an
923 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000924
925
926 XXX - this list needs to get updated!
927
Simon Glassaa34ef22016-03-13 19:07:28 -0600928- Removal of commands
929 If no commands are needed to boot, you can disable
930 CONFIG_CMDLINE to remove them. In this case, the command line
931 will not be available, and when U-Boot wants to execute the
932 boot command (on start-up) it will call board_run_command()
933 instead. This can reduce image size significantly for very
934 simple boot procedures.
935
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000936- Regular expression support:
937 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200938 If this variable is defined, U-Boot is linked against
939 the SLRE (Super Light Regular Expression) library,
940 which adds regex support to some commands, as for
941 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000942
Simon Glass3d686442011-10-15 05:48:20 +0000943- Device tree:
944 CONFIG_OF_CONTROL
945 If this variable is defined, U-Boot will use a device tree
946 to configure its devices, instead of relying on statically
947 compiled #defines in the board file. This option is
948 experimental and only available on a few boards. The device
949 tree is available in the global data as gd->fdt_blob.
950
Simon Glass5cb34db2011-10-24 19:15:31 +0000951 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700952 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000953
954 CONFIG_OF_EMBED
955 If this variable is defined, U-Boot will embed a device tree
956 binary in its image. This device tree file should be in the
957 board directory and called <soc>-<board>.dts. The binary file
958 is then picked up in board_init_f() and made available through
959 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000960
Simon Glass5cb34db2011-10-24 19:15:31 +0000961 CONFIG_OF_SEPARATE
962 If this variable is defined, U-Boot will build a device tree
963 binary. It will be called u-boot.dtb. Architecture-specific
964 code will locate it at run-time. Generally this works by:
965
966 cat u-boot.bin u-boot.dtb >image.bin
967
968 and in fact, U-Boot does this for you, creating a file called
969 u-boot-dtb.bin which is useful in the common case. You can
970 still use the individual files if you need something more
971 exotic.
972
Alex Deymo5b661ec2017-04-02 01:25:20 -0700973 CONFIG_OF_BOARD
974 If this variable is defined, U-Boot will use the device tree
975 provided by the board at runtime instead of embedding one with
976 the image. Only boards defining board_fdt_blob_setup() support
977 this option (see include/fdtdec.h file).
978
wdenkc6097192002-11-03 00:24:07 +0000979- Watchdog:
980 CONFIG_WATCHDOG
981 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000982 support for the SoC. There must be support in the SoC
983 specific code for a watchdog. For the 8xx and 8260
984 CPUs, the SIU Watchdog feature is enabled in the SYPCR
985 register. When supported for a specific SoC is
986 available, then no further board specific code should
987 be needed to use it.
988
989 CONFIG_HW_WATCHDOG
990 When using a watchdog circuitry external to the used
991 SoC, then define this variable and provide board
992 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000993
Heiko Schocher735326c2015-01-21 08:38:22 +0100994 CONFIG_AT91_HW_WDT_TIMEOUT
995 specify the timeout in seconds. default 2 seconds.
996
stroeseb9c17c52003-04-04 15:53:41 +0000997- U-Boot Version:
998 CONFIG_VERSION_VARIABLE
999 If this variable is defined, an environment variable
1000 named "ver" is created by U-Boot showing the U-Boot
1001 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001002 Any change to this variable will be reverted at the
1003 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001004
wdenkc6097192002-11-03 00:24:07 +00001005- Real-Time Clock:
1006
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001007 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001008 has to be selected, too. Define exactly one of the
1009 following options:
1010
1011 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1012 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001013 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001014 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001015 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001016 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001017 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001018 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001019 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001020 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001021 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001022 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001023 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1024 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001025
wdenkb9bbd242003-06-30 16:24:52 +00001026 Note that if the RTC uses I2C, then the I2C interface
1027 must also be configured. See I2C Support, below.
1028
Peter Tyser9902e422008-12-17 16:36:21 -06001029- GPIO Support:
1030 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001031
Chris Packham9b383202010-12-19 10:12:13 +00001032 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1033 chip-ngpio pairs that tell the PCA953X driver the number of
1034 pins supported by a particular chip.
1035
Peter Tyser9902e422008-12-17 16:36:21 -06001036 Note that if the GPIO device uses I2C, then the I2C interface
1037 must also be configured. See I2C Support, below.
1038
Simon Glass4dc47ca2014-06-11 23:29:41 -06001039- I/O tracing:
1040 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1041 accesses and can checksum them or write a list of them out
1042 to memory. See the 'iotrace' command for details. This is
1043 useful for testing device drivers since it can confirm that
1044 the driver behaves the same way before and after a code
1045 change. Currently this is supported on sandbox and arm. To
1046 add support for your architecture, add '#include <iotrace.h>'
1047 to the bottom of arch/<arch>/include/asm/io.h and test.
1048
1049 Example output from the 'iotrace stats' command is below.
1050 Note that if the trace buffer is exhausted, the checksum will
1051 still continue to operate.
1052
1053 iotrace is enabled
1054 Start: 10000000 (buffer start address)
1055 Size: 00010000 (buffer size)
1056 Offset: 00000120 (current buffer offset)
1057 Output: 10000120 (start + offset)
1058 Count: 00000018 (number of trace records)
1059 CRC32: 9526fb66 (CRC32 of all trace records)
1060
wdenkc6097192002-11-03 00:24:07 +00001061- Timestamp Support:
1062
wdenk4a5c8a72003-03-06 00:02:04 +00001063 When CONFIG_TIMESTAMP is selected, the timestamp
1064 (date and time) of an image is printed by image
1065 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001066 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001067
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001068- Partition Labels (disklabels) Supported:
1069 Zero or more of the following:
1070 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1071 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1072 Intel architecture, USB sticks, etc.
1073 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1074 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1075 bootloader. Note 2TB partition limit; see
1076 disk/part_efi.c
1077 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001078
Simon Glassb569a012017-05-17 03:25:30 -06001079 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001080 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001081 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001082
1083- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001084 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1085 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001086
wdenk369d43d2004-03-14 14:09:05 +00001087 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1088 be performed by calling the function
1089 ide_set_reset(int reset)
1090 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001091
1092- ATAPI Support:
1093 CONFIG_ATAPI
1094
1095 Set this to enable ATAPI support.
1096
wdenkf602aa02004-03-13 23:29:43 +00001097- LBA48 Support
1098 CONFIG_LBA48
1099
1100 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001101 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001102 Whithout these , LBA48 support uses 32bit variables and will 'only'
1103 support disks up to 2.1TB.
1104
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001105 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001106 When enabled, makes the IDE subsystem use 64bit sector addresses.
1107 Default is 32bit.
1108
wdenkc6097192002-11-03 00:24:07 +00001109- SCSI Support:
1110 At the moment only there is only support for the
1111 SYM53C8XX SCSI controller; define
1112 CONFIG_SCSI_SYM53C8XX to enable it.
1113
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001114 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1115 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1116 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001117 maximum numbers of LUNs, SCSI ID's and target
1118 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001119 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001120
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001121 The environment variable 'scsidevs' is set to the number of
1122 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001123
wdenkc6097192002-11-03 00:24:07 +00001124- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001125 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001126 Support for Intel 8254x/8257x gigabit chips.
1127
1128 CONFIG_E1000_SPI
1129 Utility code for direct access to the SPI bus on Intel 8257x.
1130 This does not do anything useful unless you set at least one
1131 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1132
1133 CONFIG_E1000_SPI_GENERIC
1134 Allow generic access to the SPI bus on the Intel 8257x, for
1135 example with the "sspi" command.
1136
1137 CONFIG_CMD_E1000
1138 Management command for E1000 devices. When used on devices
1139 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001140
wdenkc6097192002-11-03 00:24:07 +00001141 CONFIG_EEPRO100
1142 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001143 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001144 write routine for first time initialisation.
1145
1146 CONFIG_TULIP
1147 Support for Digital 2114x chips.
1148 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1149 modem chip initialisation (KS8761/QS6611).
1150
1151 CONFIG_NATSEMI
1152 Support for National dp83815 chips.
1153
1154 CONFIG_NS8382X
1155 Support for National dp8382[01] gigabit chips.
1156
wdenkaa603362003-05-12 21:50:16 +00001157- NETWORK Support (other):
1158
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001159 CONFIG_DRIVER_AT91EMAC
1160 Support for AT91RM9200 EMAC.
1161
1162 CONFIG_RMII
1163 Define this to use reduced MII inteface
1164
1165 CONFIG_DRIVER_AT91EMAC_QUIET
1166 If this defined, the driver is quiet.
1167 The driver doen't show link status messages.
1168
Rob Herringc9830dc2011-12-15 11:15:49 +00001169 CONFIG_CALXEDA_XGMAC
1170 Support for the Calxeda XGMAC device
1171
Ashok93fb8722012-10-15 06:20:47 +00001172 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001173 Support for SMSC's LAN91C96 chips.
1174
wdenkaa603362003-05-12 21:50:16 +00001175 CONFIG_LAN91C96_USE_32_BIT
1176 Define this to enable 32 bit addressing
1177
Ashok93fb8722012-10-15 06:20:47 +00001178 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001179 Support for SMSC's LAN91C111 chip
1180
1181 CONFIG_SMC91111_BASE
1182 Define this to hold the physical address
1183 of the device (I/O space)
1184
1185 CONFIG_SMC_USE_32_BIT
1186 Define this if data bus is 32 bits
1187
1188 CONFIG_SMC_USE_IOFUNCS
1189 Define this to use i/o functions instead of macros
1190 (some hardware wont work with macros)
1191
Heiko Schocher7d037f72011-11-15 10:00:04 -05001192 CONFIG_DRIVER_TI_EMAC
1193 Support for davinci emac
1194
1195 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1196 Define this if you have more then 3 PHYs.
1197
Macpaul Lin199c6252010-12-21 16:59:46 +08001198 CONFIG_FTGMAC100
1199 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1200
1201 CONFIG_FTGMAC100_EGIGA
1202 Define this to use GE link update with gigabit PHY.
1203 Define this if FTGMAC100 is connected to gigabit PHY.
1204 If your system has 10/100 PHY only, it might not occur
1205 wrong behavior. Because PHY usually return timeout or
1206 useless data when polling gigabit status and gigabit
1207 control registers. This behavior won't affect the
1208 correctnessof 10/100 link speed update.
1209
Mike Rapoportf4761af2009-11-11 10:03:03 +02001210 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001211 Support for SMSC's LAN911x and LAN921x chips
1212
Mike Rapoportf4761af2009-11-11 10:03:03 +02001213 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001214 Define this to hold the physical address
1215 of the device (I/O space)
1216
Mike Rapoportf4761af2009-11-11 10:03:03 +02001217 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001218 Define this if data bus is 32 bits
1219
Mike Rapoportf4761af2009-11-11 10:03:03 +02001220 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001221 Define this if data bus is 16 bits. If your processor
1222 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001223 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001224
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001225 CONFIG_SH_ETHER
1226 Support for Renesas on-chip Ethernet controller
1227
1228 CONFIG_SH_ETHER_USE_PORT
1229 Define the number of ports to be used
1230
1231 CONFIG_SH_ETHER_PHY_ADDR
1232 Define the ETH PHY's address
1233
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001234 CONFIG_SH_ETHER_CACHE_WRITEBACK
1235 If this option is set, the driver enables cache flush.
1236
Heiko Schocher2b387762014-07-18 06:07:19 +02001237- PWM Support:
1238 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001239 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001240
Vadim Bendeburydac69642011-10-17 08:36:14 +00001241- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001242 CONFIG_TPM
1243 Support TPM devices.
1244
Christophe Ricard8759ff82015-10-06 22:54:41 +02001245 CONFIG_TPM_TIS_INFINEON
1246 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001247 per system is supported at this time.
1248
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001249 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1250 Define the burst count bytes upper limit
1251
Christophe Ricard88249232016-01-21 23:27:13 +01001252 CONFIG_TPM_ST33ZP24
1253 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1254
1255 CONFIG_TPM_ST33ZP24_I2C
1256 Support for STMicroelectronics ST33ZP24 I2C devices.
1257 Requires TPM_ST33ZP24 and I2C.
1258
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001259 CONFIG_TPM_ST33ZP24_SPI
1260 Support for STMicroelectronics ST33ZP24 SPI devices.
1261 Requires TPM_ST33ZP24 and SPI.
1262
Dirk Eibach20489092013-06-26 15:55:15 +02001263 CONFIG_TPM_ATMEL_TWI
1264 Support for Atmel TWI TPM device. Requires I2C support.
1265
Che-liang Chiouacea5702013-04-12 11:04:34 +00001266 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001267 Support for generic parallel port TPM devices. Only one device
1268 per system is supported at this time.
1269
1270 CONFIG_TPM_TIS_BASE_ADDRESS
1271 Base address where the generic TPM device is mapped
1272 to. Contemporary x86 systems usually map it at
1273 0xfed40000.
1274
Reinhard Pfau4fece432013-06-26 15:55:13 +02001275 CONFIG_CMD_TPM
1276 Add tpm monitor functions.
1277 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1278 provides monitor access to authorized functions.
1279
1280 CONFIG_TPM
1281 Define this to enable the TPM support library which provides
1282 functional interfaces to some TPM commands.
1283 Requires support for a TPM device.
1284
1285 CONFIG_TPM_AUTH_SESSIONS
1286 Define this to enable authorized functions in the TPM library.
1287 Requires CONFIG_TPM and CONFIG_SHA1.
1288
wdenkc6097192002-11-03 00:24:07 +00001289- USB Support:
1290 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001291 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001292 CONFIG_USB_UHCI to enable it.
1293 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001294 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001295 storage devices.
1296 Note:
1297 Supported are USB Keyboards and USB Floppy drives
1298 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001299 MPC5200 USB requires additional defines:
1300 CONFIG_USB_CLOCK
1301 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001302 CONFIG_PSC3_USB
1303 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001304 CONFIG_USB_CONFIG
1305 for differential drivers: 0x00001000
1306 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001307 for differential drivers on PSC3: 0x00000100
1308 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001309 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001310 May be defined to allow interrupt polling
1311 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001312
Simon Glass5978cdb2012-02-27 10:52:47 +00001313 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1314 txfilltuning field in the EHCI controller on reset.
1315
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001316 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1317 HW module registers.
1318
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001319- USB Device:
1320 Define the below if you wish to use the USB console.
1321 Once firmware is rebuilt from a serial console issue the
1322 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001323 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001324 it has found a new device. The environment variable usbtty
1325 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001326 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001327 Common Device Class Abstract Control Model serial device.
1328 If you select usbtty = gserial you should be able to enumerate
1329 a Linux host by
1330 # modprobe usbserial vendor=0xVendorID product=0xProductID
1331 else if using cdc_acm, simply setting the environment
1332 variable usbtty to be cdc_acm should suffice. The following
1333 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001334
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001335 CONFIG_USB_DEVICE
1336 Define this to build a UDC device
1337
1338 CONFIG_USB_TTY
1339 Define this to have a tty type of device available to
1340 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001341
Vipin KUMARbdb17702012-03-26 15:38:06 +05301342 CONFIG_USBD_HS
1343 Define this to enable the high speed support for usb
1344 device and usbtty. If this feature is enabled, a routine
1345 int is_usbd_high_speed(void)
1346 also needs to be defined by the driver to dynamically poll
1347 whether the enumeration has succeded at high speed or full
1348 speed.
1349
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001350 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001351 Define this if you want stdin, stdout &/or stderr to
1352 be set to usbtty.
1353
1354 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001355 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001356 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001357 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001358
Wolfgang Denke2601822006-06-14 18:14:56 +02001359 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001360 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001361 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001362 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1363 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1364 should pretend to be a Linux device to it's target host.
1365
1366 CONFIG_USBD_MANUFACTURER
1367 Define this string as the name of your company for
1368 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001369
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001370 CONFIG_USBD_PRODUCT_NAME
1371 Define this string as the name of your product
1372 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001373
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001374 CONFIG_USBD_VENDORID
1375 Define this as your assigned Vendor ID from the USB
1376 Implementors Forum. This *must* be a genuine Vendor ID
1377 to avoid polluting the USB namespace.
1378 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001379
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001380 CONFIG_USBD_PRODUCTID
1381 Define this as the unique Product ID
1382 for your device
1383 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001384
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001385- ULPI Layer Support:
1386 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1387 the generic ULPI layer. The generic layer accesses the ULPI PHY
1388 via the platform viewport, so you need both the genric layer and
1389 the viewport enabled. Currently only Chipidea/ARC based
1390 viewport is supported.
1391 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1392 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001393 If your ULPI phy needs a different reference clock than the
1394 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1395 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001396
wdenk7a428cc2003-06-15 22:40:42 +00001397- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001398 The MMC controller on the Intel PXA is supported. To
1399 enable this define CONFIG_MMC. The MMC can be
1400 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001401 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001402 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1403 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001404
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001405 CONFIG_SH_MMCIF
1406 Support for Renesas on-chip MMCIF controller
1407
1408 CONFIG_SH_MMCIF_ADDR
1409 Define the base address of MMCIF registers
1410
1411 CONFIG_SH_MMCIF_CLK
1412 Define the clock frequency for MMCIF
1413
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001414 CONFIG_SUPPORT_EMMC_BOOT
1415 Enable some additional features of the eMMC boot partitions.
1416
1417 CONFIG_SUPPORT_EMMC_RPMB
1418 Enable the commands for reading, writing and programming the
1419 key for the Replay Protection Memory Block partition in eMMC.
1420
Tom Rini58a8d322013-03-14 05:32:47 +00001421- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001422 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001423 This enables the USB portion of the DFU USB class
1424
1425 CONFIG_CMD_DFU
1426 This enables the command "dfu" which is used to have
1427 U-Boot create a DFU class device via USB. This command
1428 requires that the "dfu_alt_info" environment variable be
1429 set and define the alt settings to expose to the host.
1430
1431 CONFIG_DFU_MMC
1432 This enables support for exposing (e)MMC devices via DFU.
1433
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001434 CONFIG_DFU_NAND
1435 This enables support for exposing NAND devices via DFU.
1436
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301437 CONFIG_DFU_RAM
1438 This enables support for exposing RAM via DFU.
1439 Note: DFU spec refer to non-volatile memory usage, but
1440 allow usages beyond the scope of spec - here RAM usage,
1441 one that would help mostly the developer.
1442
Heiko Schochera2f831e2013-06-12 06:05:51 +02001443 CONFIG_SYS_DFU_DATA_BUF_SIZE
1444 Dfu transfer uses a buffer before writing data to the
1445 raw storage device. Make the size (in bytes) of this buffer
1446 configurable. The size of this buffer is also configurable
1447 through the "dfu_bufsiz" environment variable.
1448
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001449 CONFIG_SYS_DFU_MAX_FILE_SIZE
1450 When updating files rather than the raw storage device,
1451 we use a static buffer to copy the file into and then write
1452 the buffer once we've been given the whole file. Define
1453 this to the maximum filesize (in bytes) for the buffer.
1454 Default is 4 MiB if undefined.
1455
Heiko Schochere1ba1512014-03-18 08:09:56 +01001456 DFU_DEFAULT_POLL_TIMEOUT
1457 Poll timeout [ms], is the timeout a device can send to the
1458 host. The host must wait for this timeout before sending
1459 a subsequent DFU_GET_STATUS request to the device.
1460
1461 DFU_MANIFEST_POLL_TIMEOUT
1462 Poll timeout [ms], which the device sends to the host when
1463 entering dfuMANIFEST state. Host waits this timeout, before
1464 sending again an USB request to the device.
1465
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001466- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001467 CONFIG_USB_FUNCTION_FASTBOOT
1468 This enables the USB part of the fastboot gadget
1469
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001470 CONFIG_CMD_FASTBOOT
1471 This enables the command "fastboot" which enables the Android
1472 fastboot mode for the platform's USB device. Fastboot is a USB
1473 protocol for downloading images, flashing and device control
1474 used on Android devices.
1475 See doc/README.android-fastboot for more information.
1476
1477 CONFIG_ANDROID_BOOT_IMAGE
1478 This enables support for booting images which use the Android
1479 image format header.
1480
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001481 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001482 The fastboot protocol requires a large memory buffer for
1483 downloads. Define this to the starting RAM address to use for
1484 downloaded images.
1485
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001486 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001487 The fastboot protocol requires a large memory buffer for
1488 downloads. This buffer should be as large as possible for a
1489 platform. Define this to the size available RAM for fastboot.
1490
Steve Raebfb9ba42014-08-26 11:47:28 -07001491 CONFIG_FASTBOOT_FLASH
1492 The fastboot protocol includes a "flash" command for writing
1493 the downloaded image to a non-volatile storage device. Define
1494 this to enable the "fastboot flash" command.
1495
1496 CONFIG_FASTBOOT_FLASH_MMC_DEV
1497 The fastboot "flash" command requires additional information
1498 regarding the non-volatile storage device. Define this to
1499 the eMMC device that fastboot should use to store the image.
1500
Steve Rae7d059342014-12-12 15:51:54 -08001501 CONFIG_FASTBOOT_GPT_NAME
1502 The fastboot "flash" command supports writing the downloaded
1503 image to the Protective MBR and the Primary GUID Partition
1504 Table. (Additionally, this downloaded image is post-processed
1505 to generate and write the Backup GUID Partition Table.)
1506 This occurs when the specified "partition name" on the
1507 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001508 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001509
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001510 CONFIG_FASTBOOT_MBR_NAME
1511 The fastboot "flash" command supports writing the downloaded
1512 image to DOS MBR.
1513 This occurs when the "partition name" specified on the
1514 "fastboot flash" command line matches this value.
1515 If not defined the default value "mbr" is used.
1516
wdenkda04a8b2004-08-02 23:22:59 +00001517- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001518 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001519 Define these for a default partition on a NAND device
1520
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001521 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1522 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001523 Define these for a default partition on a NOR device
1524
Donggeun Kim8f814002011-10-24 21:15:28 +00001525- FAT(File Allocation Table) filesystem write function support:
1526 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001527
1528 Define this to enable support for saving memory data as a
1529 file in FAT formatted partition.
1530
1531 This will also enable the command "fatwrite" enabling the
1532 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001533
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301534- FAT(File Allocation Table) filesystem cluster size:
1535 CONFIG_FS_FAT_MAX_CLUSTSIZE
1536
1537 Define the max cluster size for fat operations else
1538 a default value of 65536 will be defined.
1539
wdenkc6097192002-11-03 00:24:07 +00001540- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001541 See Kconfig help for available keyboard drivers.
1542
1543 CONFIG_KEYBOARD
1544
1545 Define this to enable a custom keyboard support.
1546 This simply calls drv_keyboard_init() which must be
1547 defined in your board-specific files. This option is deprecated
1548 and is only used by novena. For new boards, use driver model
1549 instead.
wdenkc6097192002-11-03 00:24:07 +00001550
1551- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001552 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001553 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001554 SOCs that have a DIU should define this macro to enable DIU
1555 support, and should also define these other macros:
1556
1557 CONFIG_SYS_DIU_ADDR
1558 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001559 CONFIG_CFB_CONSOLE
1560 CONFIG_VIDEO_SW_CURSOR
1561 CONFIG_VGA_AS_SINGLE_DEVICE
1562 CONFIG_VIDEO_LOGO
1563 CONFIG_VIDEO_BMP_LOGO
1564
Timur Tabi32f709e2011-04-11 14:18:22 -05001565 The DIU driver will look for the 'video-mode' environment
1566 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001567 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001568 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001569
wdenkc6097192002-11-03 00:24:07 +00001570- LCD Support: CONFIG_LCD
1571
1572 Define this to enable LCD support (for output to LCD
1573 display); also select one of the supported displays
1574 by defining one of these:
1575
Stelian Popf6f86652008-05-09 21:57:18 +02001576 CONFIG_ATMEL_LCD:
1577
1578 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1579
wdenkc0d54ae2003-11-25 16:55:19 +00001580 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001581
wdenkc0d54ae2003-11-25 16:55:19 +00001582 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001583
wdenkc0d54ae2003-11-25 16:55:19 +00001584 CONFIG_NEC_NL6448BC20
1585
1586 NEC NL6448BC20-08. 6.5", 640x480.
1587 Active, color, single scan.
1588
1589 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001590
wdenkc0d54ae2003-11-25 16:55:19 +00001591 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001592 Active, color, single scan.
1593
1594 CONFIG_SHARP_16x9
1595
1596 Sharp 320x240. Active, color, single scan.
1597 It isn't 16x9, and I am not sure what it is.
1598
1599 CONFIG_SHARP_LQ64D341
1600
1601 Sharp LQ64D341 display, 640x480.
1602 Active, color, single scan.
1603
1604 CONFIG_HLD1045
1605
1606 HLD1045 display, 640x480.
1607 Active, color, single scan.
1608
1609 CONFIG_OPTREX_BW
1610
1611 Optrex CBL50840-2 NF-FW 99 22 M5
1612 or
1613 Hitachi LMG6912RPFC-00T
1614 or
1615 Hitachi SP14Q002
1616
1617 320x240. Black & white.
1618
Simon Glass599a4df2012-10-17 13:24:54 +00001619 CONFIG_LCD_ALIGNMENT
1620
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001621 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001622 defined then the LCD will be aligned to this value instead.
1623 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1624 here, since it is cheaper to change data cache settings on
1625 a per-section basis.
1626
1627
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001628 CONFIG_LCD_ROTATION
1629
1630 Sometimes, for example if the display is mounted in portrait
1631 mode or even if it's mounted landscape but rotated by 180degree,
1632 we need to rotate our content of the display relative to the
1633 framebuffer, so that user can read the messages which are
1634 printed out.
1635 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1636 initialized with a given rotation from "vl_rot" out of
1637 "vidinfo_t" which is provided by the board specific code.
1638 The value for vl_rot is coded as following (matching to
1639 fbcon=rotate:<n> linux-kernel commandline):
1640 0 = no rotation respectively 0 degree
1641 1 = 90 degree rotation
1642 2 = 180 degree rotation
1643 3 = 270 degree rotation
1644
1645 If CONFIG_LCD_ROTATION is not defined, the console will be
1646 initialized with 0degree rotation.
1647
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001648 CONFIG_LCD_BMP_RLE8
1649
1650 Support drawing of RLE8-compressed bitmaps on the LCD.
1651
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001652 CONFIG_I2C_EDID
1653
1654 Enables an 'i2c edid' command which can read EDID
1655 information over I2C from an attached LCD display.
1656
wdenkeb20ad32003-09-05 23:19:14 +00001657- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001658
wdenk57b2d802003-06-27 21:31:46 +00001659 If this option is set, the environment is checked for
1660 a variable "splashimage". If found, the usual display
1661 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001662 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001663 specified in "splashimage" is loaded instead. The
1664 console is redirected to the "nulldev", too. This
1665 allows for a "silent" boot where a splash screen is
1666 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001667
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001668 CONFIG_SPLASHIMAGE_GUARD
1669
1670 If this option is set, then U-Boot will prevent the environment
1671 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001672 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001673 This option is useful for targets where, due to alignment
1674 restrictions, an improperly aligned BMP image will cause a data
1675 abort. If you think you will not have problems with unaligned
1676 accesses (for example because your toolchain prevents them)
1677 there is no need to set this option.
1678
Matthias Weisser53884182009-07-09 16:07:30 +02001679 CONFIG_SPLASH_SCREEN_ALIGN
1680
1681 If this option is set the splash image can be freely positioned
1682 on the screen. Environment variable "splashpos" specifies the
1683 position as "x,y". If a positive number is given it is used as
1684 number of pixel from left/top. If a negative number is given it
1685 is used as number of pixel from right/bottom. You can also
1686 specify 'm' for centering the image.
1687
1688 Example:
1689 setenv splashpos m,m
1690 => image at center of screen
1691
1692 setenv splashpos 30,20
1693 => image at x = 30 and y = 20
1694
1695 setenv splashpos -10,m
1696 => vertically centered image
1697 at x = dspWidth - bmpWidth - 9
1698
Stefan Roesed9d97742005-09-22 09:04:17 +02001699- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1700
1701 If this option is set, additionally to standard BMP
1702 images, gzipped BMP images can be displayed via the
1703 splashscreen support or the bmp command.
1704
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001705- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1706
1707 If this option is set, 8-bit RLE compressed BMP images
1708 can be displayed via the splashscreen support or the
1709 bmp command.
1710
wdenk710e3502003-08-29 20:57:53 +00001711- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001712 CONFIG_GZIP
1713
1714 Enabled by default to support gzip compressed images.
1715
wdenk710e3502003-08-29 20:57:53 +00001716 CONFIG_BZIP2
1717
1718 If this option is set, support for bzip2 compressed
1719 images is included. If not, only uncompressed and gzip
1720 compressed images are supported.
1721
wdenk9c53f402003-10-15 23:53:47 +00001722 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001723 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001724 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001725
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001726 CONFIG_LZMA
1727
1728 If this option is set, support for lzma compressed
1729 images is included.
1730
1731 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1732 requires an amount of dynamic memory that is given by the
1733 formula:
1734
1735 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1736
1737 Where lc and lp stand for, respectively, Literal context bits
1738 and Literal pos bits.
1739
1740 This value is upper-bounded by 14MB in the worst case. Anyway,
1741 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1742 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1743 a very small buffer.
1744
1745 Use the lzmainfo tool to determinate the lc and lp values and
1746 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001747 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001748
Kees Cook5b06e642013-08-16 07:59:12 -07001749 CONFIG_LZO
1750
1751 If this option is set, support for LZO compressed images
1752 is included.
1753
wdenk0e2bd9c2004-06-06 21:51:03 +00001754- MII/PHY support:
1755 CONFIG_PHY_ADDR
1756
1757 The address of PHY on MII bus.
1758
1759 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1760
1761 The clock frequency of the MII bus
1762
1763 CONFIG_PHY_GIGE
1764
1765 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001766 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001767
1768 CONFIG_PHY_RESET_DELAY
1769
1770 Some PHY like Intel LXT971A need extra delay after
1771 reset before any MII register access is possible.
1772 For such PHY, set this option to the usec delay
1773 required. (minimum 300usec for LXT971A)
1774
1775 CONFIG_PHY_CMD_DELAY (ppc4xx)
1776
1777 Some PHY like Intel LXT971A need extra delay after
1778 command issued before MII status register can be read
1779
wdenkc6097192002-11-03 00:24:07 +00001780- IP address:
1781 CONFIG_IPADDR
1782
1783 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001784 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001785 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001786 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001787
1788- Server IP address:
1789 CONFIG_SERVERIP
1790
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001791 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001792 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001793 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001794
Robin Getz470a6d42009-07-21 12:15:28 -04001795 CONFIG_KEEP_SERVERADDR
1796
1797 Keeps the server's MAC address, in the env 'serveraddr'
1798 for passing to bootargs (like Linux's netconsole option)
1799
Wolfgang Denk26da2992011-10-26 10:21:22 +00001800- Gateway IP address:
1801 CONFIG_GATEWAYIP
1802
1803 Defines a default value for the IP address of the
1804 default router where packets to other networks are
1805 sent to.
1806 (Environment variable "gatewayip")
1807
1808- Subnet mask:
1809 CONFIG_NETMASK
1810
1811 Defines a default value for the subnet mask (or
1812 routing prefix) which is used to determine if an IP
1813 address belongs to the local subnet or needs to be
1814 forwarded through a router.
1815 (Environment variable "netmask")
1816
David Updegraff7280da72007-06-11 10:41:07 -05001817- Multicast TFTP Mode:
1818 CONFIG_MCAST_TFTP
1819
1820 Defines whether you want to support multicast TFTP as per
1821 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001822 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001823 driver in use must provide a function: mcast() to join/leave a
1824 multicast group.
1825
wdenkc6097192002-11-03 00:24:07 +00001826- BOOTP Recovery Mode:
1827 CONFIG_BOOTP_RANDOM_DELAY
1828
1829 If you have many targets in a network that try to
1830 boot using BOOTP, you may want to avoid that all
1831 systems send out BOOTP requests at precisely the same
1832 moment (which would happen for instance at recovery
1833 from a power failure, when all systems will try to
1834 boot, thus flooding the BOOTP server. Defining
1835 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1836 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001837 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001838
1839 1st BOOTP request: delay 0 ... 1 sec
1840 2nd BOOTP request: delay 0 ... 2 sec
1841 3rd BOOTP request: delay 0 ... 4 sec
1842 4th and following
1843 BOOTP requests: delay 0 ... 8 sec
1844
Thierry Reding8977cda2014-08-19 10:21:24 +02001845 CONFIG_BOOTP_ID_CACHE_SIZE
1846
1847 BOOTP packets are uniquely identified using a 32-bit ID. The
1848 server will copy the ID from client requests to responses and
1849 U-Boot will use this to determine if it is the destination of
1850 an incoming response. Some servers will check that addresses
1851 aren't in use before handing them out (usually using an ARP
1852 ping) and therefore take up to a few hundred milliseconds to
1853 respond. Network congestion may also influence the time it
1854 takes for a response to make it back to the client. If that
1855 time is too long, U-Boot will retransmit requests. In order
1856 to allow earlier responses to still be accepted after these
1857 retransmissions, U-Boot's BOOTP client keeps a small cache of
1858 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1859 cache. The default is to keep IDs for up to four outstanding
1860 requests. Increasing this will allow U-Boot to accept offers
1861 from a BOOTP client in networks with unusually high latency.
1862
stroesee0aadfb2003-08-28 14:17:32 +00001863- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001864 You can fine tune the DHCP functionality by defining
1865 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001866
Jon Loeliger5336a762007-07-09 22:08:34 -05001867 CONFIG_BOOTP_SUBNETMASK
1868 CONFIG_BOOTP_GATEWAY
1869 CONFIG_BOOTP_HOSTNAME
1870 CONFIG_BOOTP_NISDOMAIN
1871 CONFIG_BOOTP_BOOTPATH
1872 CONFIG_BOOTP_BOOTFILESIZE
1873 CONFIG_BOOTP_DNS
1874 CONFIG_BOOTP_DNS2
1875 CONFIG_BOOTP_SEND_HOSTNAME
1876 CONFIG_BOOTP_NTPSERVER
1877 CONFIG_BOOTP_TIMEOFFSET
1878 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001879 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001880
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001881 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1882 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001883
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001884 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1885 after the configured retry count, the call will fail
1886 instead of starting over. This can be used to fail over
1887 to Link-local IP address configuration if the DHCP server
1888 is not available.
1889
stroesee0aadfb2003-08-28 14:17:32 +00001890 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1891 serverip from a DHCP server, it is possible that more
1892 than one DNS serverip is offered to the client.
1893 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1894 serverip will be stored in the additional environment
1895 variable "dnsip2". The first DNS serverip is always
1896 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001897 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001898
1899 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1900 to do a dynamic update of a DNS server. To do this, they
1901 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001902 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001903 of the "hostname" environment variable is passed as
1904 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001905
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001906 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1907
1908 A 32bit value in microseconds for a delay between
1909 receiving a "DHCP Offer" and sending the "DHCP Request".
1910 This fixes a problem with certain DHCP servers that don't
1911 respond 100% of the time to a "DHCP request". E.g. On an
1912 AT91RM9200 processor running at 180MHz, this delay needed
1913 to be *at least* 15,000 usec before a Windows Server 2003
1914 DHCP server would reply 100% of the time. I recommend at
1915 least 50,000 usec to be safe. The alternative is to hope
1916 that one of the retries will be successful but note that
1917 the DHCP timeout and retry process takes a longer than
1918 this delay.
1919
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001920 - Link-local IP address negotiation:
1921 Negotiate with other link-local clients on the local network
1922 for an address that doesn't require explicit configuration.
1923 This is especially useful if a DHCP server cannot be guaranteed
1924 to exist in all environments that the device must operate.
1925
1926 See doc/README.link-local for more information.
1927
wdenk145d2c12004-04-15 21:48:45 +00001928 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001929 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001930
1931 The device id used in CDP trigger frames.
1932
1933 CONFIG_CDP_DEVICE_ID_PREFIX
1934
1935 A two character string which is prefixed to the MAC address
1936 of the device.
1937
1938 CONFIG_CDP_PORT_ID
1939
1940 A printf format string which contains the ascii name of
1941 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001942 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001943
1944 CONFIG_CDP_CAPABILITIES
1945
1946 A 32bit integer which indicates the device capabilities;
1947 0x00000010 for a normal host which does not forwards.
1948
1949 CONFIG_CDP_VERSION
1950
1951 An ascii string containing the version of the software.
1952
1953 CONFIG_CDP_PLATFORM
1954
1955 An ascii string containing the name of the platform.
1956
1957 CONFIG_CDP_TRIGGER
1958
1959 A 32bit integer sent on the trigger.
1960
1961 CONFIG_CDP_POWER_CONSUMPTION
1962
1963 A 16bit integer containing the power consumption of the
1964 device in .1 of milliwatts.
1965
1966 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1967
1968 A byte containing the id of the VLAN.
1969
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001970- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001971
1972 Several configurations allow to display the current
1973 status using a LED. For instance, the LED will blink
1974 fast while running U-Boot code, stop blinking as
1975 soon as a reply to a BOOTP request was received, and
1976 start blinking slow once the Linux kernel is running
1977 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001978 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001979 feature in U-Boot.
1980
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001981 Additional options:
1982
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001983 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001984 The status LED can be connected to a GPIO pin.
1985 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001986 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001987 to include the gpio_led driver in the U-Boot binary.
1988
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001989 CONFIG_GPIO_LED_INVERTED_TABLE
1990 Some GPIO connected LEDs may have inverted polarity in which
1991 case the GPIO high value corresponds to LED off state and
1992 GPIO low value corresponds to LED on state.
1993 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1994 with a list of GPIO LEDs that have inverted polarity.
1995
wdenkc6097192002-11-03 00:24:07 +00001996- CAN Support: CONFIG_CAN_DRIVER
1997
1998 Defining CONFIG_CAN_DRIVER enables CAN driver support
1999 on those systems that support this (optional)
2000 feature, like the TQM8xxL modules.
2001
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002002- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002003
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002004 This enable the NEW i2c subsystem, and will allow you to use
2005 i2c commands at the u-boot command line (as long as you set
2006 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2007 based realtime clock chips or other i2c devices. See
2008 common/cmd_i2c.c for a description of the command line
2009 interface.
2010
2011 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002012 - drivers/i2c/soft_i2c.c:
2013 - activate first bus with CONFIG_SYS_I2C_SOFT define
2014 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2015 for defining speed and slave address
2016 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2017 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2018 for defining speed and slave address
2019 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2020 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2021 for defining speed and slave address
2022 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2023 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2024 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002025
Heiko Schocherf2850742012-10-24 13:48:22 +02002026 - drivers/i2c/fsl_i2c.c:
2027 - activate i2c driver with CONFIG_SYS_I2C_FSL
2028 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2029 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2030 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2031 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002032 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002033 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2034 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2035 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2036 second bus.
2037
Simon Glass026fefb2012-10-30 07:28:53 +00002038 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002039 - activate this driver with CONFIG_SYS_I2C_TEGRA
2040 - This driver adds 4 i2c buses with a fix speed from
2041 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002042
Dirk Eibach42b204f2013-04-25 02:40:01 +00002043 - drivers/i2c/ppc4xx_i2c.c
2044 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2045 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2046 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2047
trema49f40a2013-09-21 18:13:35 +02002048 - drivers/i2c/i2c_mxc.c
2049 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002050 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2051 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2052 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2053 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002054 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2055 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2056 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2057 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2058 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2059 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002060 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2061 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002062 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002063 for speed, and 0 for slave.
2064
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002065 - drivers/i2c/rcar_i2c.c:
2066 - activate this driver with CONFIG_SYS_I2C_RCAR
2067 - This driver adds 4 i2c buses
2068
2069 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2070 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2071 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2072 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2073 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2074 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2075 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2076 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2077 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2078
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002079 - drivers/i2c/sh_i2c.c:
2080 - activate this driver with CONFIG_SYS_I2C_SH
2081 - This driver adds from 2 to 5 i2c buses
2082
2083 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2084 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2085 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2086 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2087 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2088 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2089 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2090 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2091 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2092 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002093 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002094
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002095 - drivers/i2c/omap24xx_i2c.c
2096 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2097 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2098 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2099 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2100 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2101 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2102 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2103 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2104 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2105 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2106 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2107
Heiko Schocher465819a2013-11-08 07:30:53 +01002108 - drivers/i2c/zynq_i2c.c
2109 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2110 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2111 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2112
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302113 - drivers/i2c/s3c24x0_i2c.c:
2114 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2115 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2116 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2117 with a fix speed from 100000 and the slave addr 0!
2118
Dirk Eibachb9577432014-07-03 09:28:18 +02002119 - drivers/i2c/ihs_i2c.c
2120 - activate this driver with CONFIG_SYS_I2C_IHS
2121 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2122 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2123 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2124 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2125 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2126 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2127 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2128 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2129 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2130 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2131 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2132 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002133 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2134 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2135 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2136 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2137 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2138 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2139 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2140 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2141 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002142
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002143 additional defines:
2144
2145 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002146 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002147
2148 CONFIG_SYS_I2C_DIRECT_BUS
2149 define this, if you don't use i2c muxes on your hardware.
2150 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2151 omit this define.
2152
2153 CONFIG_SYS_I2C_MAX_HOPS
2154 define how many muxes are maximal consecutively connected
2155 on one i2c bus. If you not use i2c muxes, omit this
2156 define.
2157
2158 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002159 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002160 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2161 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2162 CONFIG_SYS_NUM_I2C_BUSES = 9:
2163
2164 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2165 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2166 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2167 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2168 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2169 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2170 {1, {I2C_NULL_HOP}}, \
2171 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2172 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2173 }
2174
2175 which defines
2176 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002177 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2178 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2179 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2180 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2181 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002182 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002183 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2184 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002185
2186 If you do not have i2c muxes on your board, omit this define.
2187
Simon Glass3efce392017-05-12 21:10:00 -06002188- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002189 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002190 then the following macros need to be defined (examples are
2191 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002192
2193 I2C_INIT
2194
wdenkb9bbd242003-06-30 16:24:52 +00002195 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002196 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002197
wdenk544e9732004-02-06 23:19:44 +00002198 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002199
wdenkc6097192002-11-03 00:24:07 +00002200 I2C_PORT
2201
wdenk4a5c8a72003-03-06 00:02:04 +00002202 (Only for MPC8260 CPU). The I/O port to use (the code
2203 assumes both bits are on the same port). Valid values
2204 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002205
2206 I2C_ACTIVE
2207
2208 The code necessary to make the I2C data line active
2209 (driven). If the data line is open collector, this
2210 define can be null.
2211
wdenkb9bbd242003-06-30 16:24:52 +00002212 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2213
wdenkc6097192002-11-03 00:24:07 +00002214 I2C_TRISTATE
2215
2216 The code necessary to make the I2C data line tri-stated
2217 (inactive). If the data line is open collector, this
2218 define can be null.
2219
wdenkb9bbd242003-06-30 16:24:52 +00002220 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2221
wdenkc6097192002-11-03 00:24:07 +00002222 I2C_READ
2223
York Sun4a598092013-04-01 11:29:11 -07002224 Code that returns true if the I2C data line is high,
2225 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002226
wdenkb9bbd242003-06-30 16:24:52 +00002227 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2228
wdenkc6097192002-11-03 00:24:07 +00002229 I2C_SDA(bit)
2230
York Sun4a598092013-04-01 11:29:11 -07002231 If <bit> is true, sets the I2C data line high. If it
2232 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002233
wdenkb9bbd242003-06-30 16:24:52 +00002234 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002235 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002236 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002237
wdenkc6097192002-11-03 00:24:07 +00002238 I2C_SCL(bit)
2239
York Sun4a598092013-04-01 11:29:11 -07002240 If <bit> is true, sets the I2C clock line high. If it
2241 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002242
wdenkb9bbd242003-06-30 16:24:52 +00002243 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002244 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002245 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002246
wdenkc6097192002-11-03 00:24:07 +00002247 I2C_DELAY
2248
2249 This delay is invoked four times per clock cycle so this
2250 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002251 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002252 like:
2253
wdenkb9bbd242003-06-30 16:24:52 +00002254 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002255
Mike Frysingeree12d542010-07-21 13:38:02 -04002256 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2257
2258 If your arch supports the generic GPIO framework (asm/gpio.h),
2259 then you may alternatively define the two GPIOs that are to be
2260 used as SCL / SDA. Any of the previous I2C_xxx macros will
2261 have GPIO-based defaults assigned to them as appropriate.
2262
2263 You should define these to the GPIO value as given directly to
2264 the generic GPIO functions.
2265
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002266 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002267
wdenk57b2d802003-06-27 21:31:46 +00002268 When a board is reset during an i2c bus transfer
2269 chips might think that the current transfer is still
2270 in progress. On some boards it is possible to access
2271 the i2c SCLK line directly, either by using the
2272 processor pin as a GPIO or by having a second pin
2273 connected to the bus. If this option is defined a
2274 custom i2c_init_board() routine in boards/xxx/board.c
2275 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002276
Ben Warren45657152006-09-07 16:50:54 -04002277 CONFIG_I2C_MULTI_BUS
2278
2279 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002280 must have a controller. At any point in time, only one bus is
2281 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002282 Note that bus numbering is zero-based.
2283
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002284 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002285
2286 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002287 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002288 is set, specify a list of bus-device pairs. Otherwise, specify
2289 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002290
2291 e.g.
2292 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002293 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002294
2295 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2296
Wolfgang Denk092ae952011-10-26 10:21:21 +00002297 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002298 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002299
2300 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2301
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002302 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002303
2304 If defined, then this indicates the I2C bus number for DDR SPD.
2305 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2306
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002307 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002308
2309 If defined, then this indicates the I2C bus number for the RTC.
2310 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2311
Andrew Dyer58c41f92008-12-29 17:36:01 -06002312 CONFIG_SOFT_I2C_READ_REPEATED_START
2313
2314 defining this will force the i2c_read() function in
2315 the soft_i2c driver to perform an I2C repeated start
2316 between writing the address pointer and reading the
2317 data. If this define is omitted the default behaviour
2318 of doing a stop-start sequence will be used. Most I2C
2319 devices can use either method, but some require one or
2320 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002321
wdenkc6097192002-11-03 00:24:07 +00002322- SPI Support: CONFIG_SPI
2323
2324 Enables SPI driver (so far only tested with
2325 SPI EEPROM, also an instance works with Crystal A/D and
2326 D/As on the SACSng board)
2327
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002328 CONFIG_SH_SPI
2329
2330 Enables the driver for SPI controller on SuperH. Currently
2331 only SH7757 is supported.
2332
wdenkc6097192002-11-03 00:24:07 +00002333 CONFIG_SOFT_SPI
2334
wdenk4a5c8a72003-03-06 00:02:04 +00002335 Enables a software (bit-bang) SPI driver rather than
2336 using hardware support. This is a general purpose
2337 driver that only requires three general I/O port pins
2338 (two outputs, one input) to function. If this is
2339 defined, the board configuration must define several
2340 SPI configuration items (port pins to use, etc). For
2341 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002342
Ben Warren7efe9272008-01-16 22:37:35 -05002343 CONFIG_HARD_SPI
2344
2345 Enables a hardware SPI driver for general-purpose reads
2346 and writes. As with CONFIG_SOFT_SPI, the board configuration
2347 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002348 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002349 example, see include/configs/mpc8349emds.h.
2350
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002351 CONFIG_MXC_SPI
2352
2353 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002354 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002355
Heiko Schocherb77c8882014-07-14 10:22:11 +02002356 CONFIG_SYS_SPI_MXC_WAIT
2357 Timeout for waiting until spi transfer completed.
2358 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2359
Matthias Fuchsa4400872007-12-27 17:12:34 +01002360- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002361
Matthias Fuchsa4400872007-12-27 17:12:34 +01002362 Enables FPGA subsystem.
2363
2364 CONFIG_FPGA_<vendor>
2365
2366 Enables support for specific chip vendors.
2367 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002368
Matthias Fuchsa4400872007-12-27 17:12:34 +01002369 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002370
Matthias Fuchsa4400872007-12-27 17:12:34 +01002371 Enables support for FPGA family.
2372 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2373
2374 CONFIG_FPGA_COUNT
2375
2376 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002377
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002378 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002379
wdenk57b2d802003-06-27 21:31:46 +00002380 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002381
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002382 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002383
wdenk4a5c8a72003-03-06 00:02:04 +00002384 Enable checks on FPGA configuration interface busy
2385 status by the configuration function. This option
2386 will require a board or device specific function to
2387 be written.
wdenkc6097192002-11-03 00:24:07 +00002388
2389 CONFIG_FPGA_DELAY
2390
2391 If defined, a function that provides delays in the FPGA
2392 configuration driver.
2393
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002394 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002395 Allow Control-C to interrupt FPGA configuration
2396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002397 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002398
wdenk4a5c8a72003-03-06 00:02:04 +00002399 Check for configuration errors during FPGA bitfile
2400 loading. For example, abort during Virtex II
2401 configuration if the INIT_B line goes low (which
2402 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002403
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002404 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002405
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002406 Maximum time to wait for the INIT_B line to de-assert
2407 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002408 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002409 ms.
wdenkc6097192002-11-03 00:24:07 +00002410
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002411 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002412
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002413 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002414 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002415
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002416 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002417
wdenk4a5c8a72003-03-06 00:02:04 +00002418 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002419 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002420
2421- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002422 CONFIG_BUILD_TARGET
2423
2424 Some SoCs need special image types (e.g. U-Boot binary
2425 with a special header) as build targets. By defining
2426 CONFIG_BUILD_TARGET in the SoC / board header, this
2427 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002428 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002429
wdenkc6097192002-11-03 00:24:07 +00002430 CONFIG_IDENT_STRING
2431
wdenk4a5c8a72003-03-06 00:02:04 +00002432 If defined, this string will be added to the U-Boot
2433 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002434
2435- Vendor Parameter Protection:
2436
wdenk4a5c8a72003-03-06 00:02:04 +00002437 U-Boot considers the values of the environment
2438 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002439 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002440 are set once by the board vendor / manufacturer, and
2441 protects these variables from casual modification by
2442 the user. Once set, these variables are read-only,
2443 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002444 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002445
2446 If CONFIG_ENV_OVERWRITE is #defined in your config
2447 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002448 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002449 these parameters.
2450
Joe Hershberger76f353e2015-05-04 14:55:14 -05002451 Alternatively, if you define _both_ an ethaddr in the
2452 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002453 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002454 which can be changed exactly ONCE by the user. [The
2455 serial# is unaffected by this, i. e. it remains
2456 read-only.]
2457
Joe Hershberger71497d02012-12-11 22:16:31 -06002458 The same can be accomplished in a more flexible way
2459 for any variable by configuring the type of access
2460 to allow for those variables in the ".flags" variable
2461 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2462
wdenkc6097192002-11-03 00:24:07 +00002463- Protected RAM:
2464 CONFIG_PRAM
2465
2466 Define this variable to enable the reservation of
2467 "protected RAM", i. e. RAM which is not overwritten
2468 by U-Boot. Define CONFIG_PRAM to hold the number of
2469 kB you want to reserve for pRAM. You can overwrite
2470 this default value by defining an environment
2471 variable "pram" to the number of kB you want to
2472 reserve. Note that the board info structure will
2473 still show the full amount of RAM. If pRAM is
2474 reserved, a new environment variable "mem" will
2475 automatically be defined to hold the amount of
2476 remaining RAM in a form that can be passed as boot
2477 argument to Linux, for instance like that:
2478
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002479 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002480 saveenv
2481
2482 This way you can tell Linux not to use this memory,
2483 either, which results in a memory region that will
2484 not be affected by reboots.
2485
2486 *WARNING* If your board configuration uses automatic
2487 detection of the RAM size, you must make sure that
2488 this memory test is non-destructive. So far, the
2489 following board configurations are known to be
2490 "pRAM-clean":
2491
Wolfgang Denk90326762012-10-24 02:36:15 +00002492 IVMS8, IVML24, SPD8xx, TQM8xxL,
2493 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002494 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002495
Gabe Blacka2f3a932012-12-02 04:55:18 +00002496- Access to physical memory region (> 4GB)
2497 Some basic support is provided for operations on memory not
2498 normally accessible to U-Boot - e.g. some architectures
2499 support access to more than 4GB of memory on 32-bit
2500 machines using physical address extension or similar.
2501 Define CONFIG_PHYSMEM to access this basic support, which
2502 currently only supports clearing the memory.
2503
wdenkc6097192002-11-03 00:24:07 +00002504- Error Recovery:
2505 CONFIG_PANIC_HANG
2506
2507 Define this variable to stop the system in case of a
2508 fatal error, so that you have to reset it manually.
2509 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002510 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002511 automatically as fast as possible, but it may be
2512 useful during development since you can try to debug
2513 the conditions that lead to the situation.
2514
2515 CONFIG_NET_RETRY_COUNT
2516
wdenk4a5c8a72003-03-06 00:02:04 +00002517 This variable defines the number of retries for
2518 network operations like ARP, RARP, TFTP, or BOOTP
2519 before giving up the operation. If not defined, a
2520 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002521
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002522 CONFIG_ARP_TIMEOUT
2523
2524 Timeout waiting for an ARP reply in milliseconds.
2525
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002526 CONFIG_NFS_TIMEOUT
2527
2528 Timeout in milliseconds used in NFS protocol.
2529 If you encounter "ERROR: Cannot umount" in nfs command,
2530 try longer timeout such as
2531 #define CONFIG_NFS_TIMEOUT 10000UL
2532
wdenkc6097192002-11-03 00:24:07 +00002533- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002534 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002535
2536 Enable auto completion of commands using TAB.
2537
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002538 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002539
2540 This defines the secondary prompt string, which is
2541 printed when the command interpreter needs more input
2542 to complete a command. Usually "> ".
2543
2544 Note:
2545
wdenk57b2d802003-06-27 21:31:46 +00002546 In the current implementation, the local variables
2547 space and global environment variables space are
2548 separated. Local variables are those you define by
2549 simply typing `name=value'. To access a local
2550 variable later on, you have write `$name' or
2551 `${name}'; to execute the contents of a variable
2552 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002553
wdenk4a5c8a72003-03-06 00:02:04 +00002554 Global environment variables are those you use
2555 setenv/printenv to work with. To run a command stored
2556 in such a variable, you need to use the run command,
2557 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002558
2559 To store commands and special characters in a
2560 variable, please use double quotation marks
2561 surrounding the whole text of the variable, instead
2562 of the backslashes before semicolons and special
2563 symbols.
2564
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002565- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002566 CONFIG_CMDLINE_EDITING
2567
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002568 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002569 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002570
Marek Vasut734fb042016-01-27 04:47:55 +01002571- Command Line PS1/PS2 support:
2572 CONFIG_CMDLINE_PS_SUPPORT
2573
2574 Enable support for changing the command prompt string
2575 at run-time. Only static string is supported so far.
2576 The string is obtained from environment variables PS1
2577 and PS2.
2578
wdenkc0aa5c52003-12-06 19:49:23 +00002579- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002580 CONFIG_EXTRA_ENV_SETTINGS
2581
wdenk4a5c8a72003-03-06 00:02:04 +00002582 Define this to contain any number of null terminated
2583 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002584 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002585
wdenk4a5c8a72003-03-06 00:02:04 +00002586 For example, place something like this in your
2587 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002588
2589 #define CONFIG_EXTRA_ENV_SETTINGS \
2590 "myvar1=value1\0" \
2591 "myvar2=value2\0"
2592
wdenk4a5c8a72003-03-06 00:02:04 +00002593 Warning: This method is based on knowledge about the
2594 internal format how the environment is stored by the
2595 U-Boot code. This is NOT an official, exported
2596 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002597 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002598 You better know what you are doing here.
2599
wdenk4a5c8a72003-03-06 00:02:04 +00002600 Note: overly (ab)use of the default environment is
2601 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002602 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002603 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002604
Stephen Warren1465d5f2012-05-22 09:21:54 +00002605 CONFIG_ENV_VARS_UBOOT_CONFIG
2606
2607 Define this in order to add variables describing the
2608 U-Boot build configuration to the default environment.
2609 These will be named arch, cpu, board, vendor, and soc.
2610
2611 Enabling this option will cause the following to be defined:
2612
2613 - CONFIG_SYS_ARCH
2614 - CONFIG_SYS_CPU
2615 - CONFIG_SYS_BOARD
2616 - CONFIG_SYS_VENDOR
2617 - CONFIG_SYS_SOC
2618
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002619 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2620
2621 Define this in order to add variables describing certain
2622 run-time determined information about the hardware to the
2623 environment. These will be named board_name, board_rev.
2624
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002625 CONFIG_DELAY_ENVIRONMENT
2626
2627 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002628 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002629 that so that the environment is not available until
2630 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2631 this is instead controlled by the value of
2632 /config/load-environment.
2633
wdenkc0aa5c52003-12-06 19:49:23 +00002634- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002635 CONFIG_HAS_DATAFLASH
2636
wdenk57b2d802003-06-27 21:31:46 +00002637 Defining this option enables DataFlash features and
2638 allows to read/write in Dataflash via the standard
2639 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002640
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002641- Serial Flash support
2642 CONFIG_CMD_SF
2643
2644 Defining this option enables SPI flash commands
2645 'sf probe/read/write/erase/update'.
2646
2647 Usage requires an initial 'probe' to define the serial
2648 flash parameters, followed by read/write/erase/update
2649 commands.
2650
2651 The following defaults may be provided by the platform
2652 to handle the common case when only a single serial
2653 flash is present on the system.
2654
2655 CONFIG_SF_DEFAULT_BUS Bus identifier
2656 CONFIG_SF_DEFAULT_CS Chip-select
2657 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2658 CONFIG_SF_DEFAULT_SPEED in Hz
2659
Simon Glass4b5545e2012-10-08 13:16:02 +00002660 CONFIG_CMD_SF_TEST
2661
2662 Define this option to include a destructive SPI flash
2663 test ('sf test').
2664
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302665 CONFIG_SF_DUAL_FLASH Dual flash memories
2666
2667 Define this option to use dual flash support where two flash
2668 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002669 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302670
wdenkef893942004-02-23 16:11:30 +00002671- SystemACE Support:
2672 CONFIG_SYSTEMACE
2673
2674 Adding this option adds support for Xilinx SystemACE
2675 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002676 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002677 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002678
2679 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002680 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002681
2682 When SystemACE support is added, the "ace" device type
2683 becomes available to the fat commands, i.e. fatls.
2684
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002685- TFTP Fixed UDP Port:
2686 CONFIG_TFTP_PORT
2687
Wolfgang Denk227b5192005-09-24 23:25:46 +02002688 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002689 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002690 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002691 number generator is used.
2692
Wolfgang Denk227b5192005-09-24 23:25:46 +02002693 Also, the environment variable tftpdstp is used to supply
2694 the TFTP UDP destination port value. If tftpdstp isn't
2695 defined, the normal port 69 is used.
2696
2697 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002698 blindly start the TFTP transfer using the pre-configured
2699 target IP address and UDP port. This has the effect of
2700 "punching through" the (Windows XP) firewall, allowing
2701 the remainder of the TFTP transfer to proceed normally.
2702 A better solution is to properly configure the firewall,
2703 but sometimes that is not allowed.
2704
Simon Glass058bb8d2012-12-05 14:46:38 +00002705- Hashing support:
Simon Glass058bb8d2012-12-05 14:46:38 +00002706 CONFIG_HASH_VERIFY
2707
2708 Enable the hash verify command (hash -v). This adds to code
2709 size a little.
2710
Simon Glass058bb8d2012-12-05 14:46:38 +00002711 Note: There is also a sha1sum command, which should perhaps
2712 be deprecated in favour of 'hash sha1'.
2713
Heiko Schocher443ca402014-01-25 07:27:13 +01002714- bootcount support:
2715 CONFIG_BOOTCOUNT_LIMIT
2716
2717 This enables the bootcounter support, see:
2718 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2719
2720 CONFIG_AT91SAM9XE
2721 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002722 CONFIG_SOC_DA8XX
2723 enable special bootcounter support on da850 based boards.
2724 CONFIG_BOOTCOUNT_RAM
2725 enable support for the bootcounter in RAM
2726 CONFIG_BOOTCOUNT_I2C
2727 enable support for the bootcounter on an i2c (like RTC) device.
2728 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2729 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2730 the bootcounter.
2731 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002732
wdenkc0aa5c52003-12-06 19:49:23 +00002733- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002734 CONFIG_SHOW_BOOT_PROGRESS
2735
wdenk4a5c8a72003-03-06 00:02:04 +00002736 Defining this option allows to add some board-
2737 specific code (calling a user-provided function
2738 "show_boot_progress(int)") that enables you to show
2739 the system's boot progress on some display (for
2740 example, some LED's) on your board. At the moment,
2741 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002742
Simon Glass0fa36a42012-09-28 08:56:37 +00002743
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002744Legacy uImage format:
2745
wdenkc6097192002-11-03 00:24:07 +00002746 Arg Where When
2747 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002748 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002749 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002750 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002751 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002752 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002753 4 common/cmd_bootm.c Image data has correct checksum
2754 -4 common/cmd_bootm.c Image is for unsupported architecture
2755 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002756 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002757 6 common/cmd_bootm.c Image Type check OK
2758 -6 common/cmd_bootm.c gunzip uncompression error
2759 -7 common/cmd_bootm.c Unimplemented compression type
2760 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002761 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002762 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002763
2764 9 common/image.c Start initial ramdisk verification
2765 -10 common/image.c Ramdisk header has bad magic number
2766 -11 common/image.c Ramdisk header has bad checksum
2767 10 common/image.c Ramdisk header is OK
2768 -12 common/image.c Ramdisk data has bad checksum
2769 11 common/image.c Ramdisk data has correct checksum
2770 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002771 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002772 13 common/image.c Start multifile image verification
2773 14 common/image.c No initial ramdisk, no multifile, continue.
2774
Wolfgang Denk092ae952011-10-26 10:21:21 +00002775 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002776
Stefan Roese88fbf932010-04-15 16:07:28 +02002777 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002778 -31 post/post.c POST test failed, detected by post_output_backlog()
2779 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002780
Heiko Schocher633e03a2007-06-22 19:11:54 +02002781 34 common/cmd_doc.c before loading a Image from a DOC device
2782 -35 common/cmd_doc.c Bad usage of "doc" command
2783 35 common/cmd_doc.c correct usage of "doc" command
2784 -36 common/cmd_doc.c No boot device
2785 36 common/cmd_doc.c correct boot device
2786 -37 common/cmd_doc.c Unknown Chip ID on boot device
2787 37 common/cmd_doc.c correct chip ID found, device available
2788 -38 common/cmd_doc.c Read Error on boot device
2789 38 common/cmd_doc.c reading Image header from DOC device OK
2790 -39 common/cmd_doc.c Image header has bad magic number
2791 39 common/cmd_doc.c Image header has correct magic number
2792 -40 common/cmd_doc.c Error reading Image from DOC device
2793 40 common/cmd_doc.c Image header has correct magic number
2794 41 common/cmd_ide.c before loading a Image from a IDE device
2795 -42 common/cmd_ide.c Bad usage of "ide" command
2796 42 common/cmd_ide.c correct usage of "ide" command
2797 -43 common/cmd_ide.c No boot device
2798 43 common/cmd_ide.c boot device found
2799 -44 common/cmd_ide.c Device not available
2800 44 common/cmd_ide.c Device available
2801 -45 common/cmd_ide.c wrong partition selected
2802 45 common/cmd_ide.c partition selected
2803 -46 common/cmd_ide.c Unknown partition table
2804 46 common/cmd_ide.c valid partition table found
2805 -47 common/cmd_ide.c Invalid partition type
2806 47 common/cmd_ide.c correct partition type
2807 -48 common/cmd_ide.c Error reading Image Header on boot device
2808 48 common/cmd_ide.c reading Image Header from IDE device OK
2809 -49 common/cmd_ide.c Image header has bad magic number
2810 49 common/cmd_ide.c Image header has correct magic number
2811 -50 common/cmd_ide.c Image header has bad checksum
2812 50 common/cmd_ide.c Image header has correct checksum
2813 -51 common/cmd_ide.c Error reading Image from IDE device
2814 51 common/cmd_ide.c reading Image from IDE device OK
2815 52 common/cmd_nand.c before loading a Image from a NAND device
2816 -53 common/cmd_nand.c Bad usage of "nand" command
2817 53 common/cmd_nand.c correct usage of "nand" command
2818 -54 common/cmd_nand.c No boot device
2819 54 common/cmd_nand.c boot device found
2820 -55 common/cmd_nand.c Unknown Chip ID on boot device
2821 55 common/cmd_nand.c correct chip ID found, device available
2822 -56 common/cmd_nand.c Error reading Image Header on boot device
2823 56 common/cmd_nand.c reading Image Header from NAND device OK
2824 -57 common/cmd_nand.c Image header has bad magic number
2825 57 common/cmd_nand.c Image header has correct magic number
2826 -58 common/cmd_nand.c Error reading Image from NAND device
2827 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002828
Heiko Schocher633e03a2007-06-22 19:11:54 +02002829 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002830
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002831 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002832 -64 net/eth.c no Ethernet found.
2833 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002834
Heiko Schocher633e03a2007-06-22 19:11:54 +02002835 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002836 80 common/cmd_net.c before calling net_loop()
2837 -81 common/cmd_net.c some error in net_loop() occurred
2838 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002839 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2840 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002841 83 common/cmd_net.c running "source" command
2842 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002843 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002844
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002845FIT uImage format:
2846
2847 Arg Where When
2848 100 common/cmd_bootm.c Kernel FIT Image has correct format
2849 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2850 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2851 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2852 102 common/cmd_bootm.c Kernel unit name specified
2853 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002854 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002855 104 common/cmd_bootm.c Got kernel subimage node offset
2856 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2857 105 common/cmd_bootm.c Kernel subimage hash verification OK
2858 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2859 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002860 -106 common/cmd_bootm.c Kernel subimage has wrong type
2861 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002862 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2863 108 common/cmd_bootm.c Got kernel subimage data/size
2864 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2865 -109 common/cmd_bootm.c Can't get kernel subimage type
2866 -110 common/cmd_bootm.c Can't get kernel subimage comp
2867 -111 common/cmd_bootm.c Can't get kernel subimage os
2868 -112 common/cmd_bootm.c Can't get kernel subimage load address
2869 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2870
2871 120 common/image.c Start initial ramdisk verification
2872 -120 common/image.c Ramdisk FIT image has incorrect format
2873 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002874 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002875 -122 common/image.c Can't get configuration for ramdisk subimage
2876 123 common/image.c Ramdisk unit name specified
2877 -124 common/image.c Can't get ramdisk subimage node offset
2878 125 common/image.c Got ramdisk subimage node offset
2879 -125 common/image.c Ramdisk subimage hash verification failed
2880 126 common/image.c Ramdisk subimage hash verification OK
2881 -126 common/image.c Ramdisk subimage for unsupported architecture
2882 127 common/image.c Architecture check OK
2883 -127 common/image.c Can't get ramdisk subimage data/size
2884 128 common/image.c Got ramdisk subimage data/size
2885 129 common/image.c Can't get ramdisk load address
2886 -129 common/image.c Got ramdisk load address
2887
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002888 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002889 131 common/cmd_doc.c FIT image format OK
2890
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002891 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002892 141 common/cmd_ide.c FIT image format OK
2893
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002894 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002895 151 common/cmd_nand.c FIT image format OK
2896
Heiko Schocher515eb122014-05-28 11:33:33 +02002897- legacy image format:
2898 CONFIG_IMAGE_FORMAT_LEGACY
2899 enables the legacy image format support in U-Boot.
2900
2901 Default:
2902 enabled if CONFIG_FIT_SIGNATURE is not defined.
2903
2904 CONFIG_DISABLE_IMAGE_LEGACY
2905 disable the legacy image format
2906
2907 This define is introduced, as the legacy image format is
2908 enabled per default for backward compatibility.
2909
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002910- Standalone program support:
2911 CONFIG_STANDALONE_LOAD_ADDR
2912
Wolfgang Denk23f78482011-10-09 21:06:34 +02002913 This option defines a board specific value for the
2914 address where standalone program gets loaded, thus
2915 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002916 settings.
2917
2918- Frame Buffer Address:
2919 CONFIG_FB_ADDR
2920
2921 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002922 address for frame buffer. This is typically the case
2923 when using a graphics controller has separate video
2924 memory. U-Boot will then place the frame buffer at
2925 the given address instead of dynamically reserving it
2926 in system RAM by calling lcd_setmem(), which grabs
2927 the memory for the frame buffer depending on the
2928 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002929
2930 Please see board_init_f function.
2931
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002932- Automatic software updates via TFTP server
2933 CONFIG_UPDATE_TFTP
2934 CONFIG_UPDATE_TFTP_CNT_MAX
2935 CONFIG_UPDATE_TFTP_MSEC_MAX
2936
2937 These options enable and control the auto-update feature;
2938 for a more detailed description refer to doc/README.update.
2939
2940- MTD Support (mtdparts command, UBI support)
2941 CONFIG_MTD_DEVICE
2942
2943 Adds the MTD device infrastructure from the Linux kernel.
2944 Needed for mtdparts command support.
2945
2946 CONFIG_MTD_PARTITIONS
2947
2948 Adds the MTD partitioning infrastructure from the Linux
2949 kernel. Needed for UBI support.
2950
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002951- UBI support
2952 CONFIG_CMD_UBI
2953
2954 Adds commands for interacting with MTD partitions formatted
2955 with the UBI flash translation layer
2956
2957 Requires also defining CONFIG_RBTREE
2958
Joe Hershberger47550fc2013-04-08 10:32:49 +00002959 CONFIG_UBI_SILENCE_MSG
2960
2961 Make the verbose messages from UBI stop printing. This leaves
2962 warnings and errors enabled.
2963
Heiko Schocherf5895d12014-06-24 10:10:04 +02002964
2965 CONFIG_MTD_UBI_WL_THRESHOLD
2966 This parameter defines the maximum difference between the highest
2967 erase counter value and the lowest erase counter value of eraseblocks
2968 of UBI devices. When this threshold is exceeded, UBI starts performing
2969 wear leveling by means of moving data from eraseblock with low erase
2970 counter to eraseblocks with high erase counter.
2971
2972 The default value should be OK for SLC NAND flashes, NOR flashes and
2973 other flashes which have eraseblock life-cycle 100000 or more.
2974 However, in case of MLC NAND flashes which typically have eraseblock
2975 life-cycle less than 10000, the threshold should be lessened (e.g.,
2976 to 128 or 256, although it does not have to be power of 2).
2977
2978 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002979
Heiko Schocherf5895d12014-06-24 10:10:04 +02002980 CONFIG_MTD_UBI_BEB_LIMIT
2981 This option specifies the maximum bad physical eraseblocks UBI
2982 expects on the MTD device (per 1024 eraseblocks). If the
2983 underlying flash does not admit of bad eraseblocks (e.g. NOR
2984 flash), this value is ignored.
2985
2986 NAND datasheets often specify the minimum and maximum NVM
2987 (Number of Valid Blocks) for the flashes' endurance lifetime.
2988 The maximum expected bad eraseblocks per 1024 eraseblocks
2989 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2990 which gives 20 for most NANDs (MaxNVB is basically the total
2991 count of eraseblocks on the chip).
2992
2993 To put it differently, if this value is 20, UBI will try to
2994 reserve about 1.9% of physical eraseblocks for bad blocks
2995 handling. And that will be 1.9% of eraseblocks on the entire
2996 NAND chip, not just the MTD partition UBI attaches. This means
2997 that if you have, say, a NAND flash chip admits maximum 40 bad
2998 eraseblocks, and it is split on two MTD partitions of the same
2999 size, UBI will reserve 40 eraseblocks when attaching a
3000 partition.
3001
3002 default: 20
3003
3004 CONFIG_MTD_UBI_FASTMAP
3005 Fastmap is a mechanism which allows attaching an UBI device
3006 in nearly constant time. Instead of scanning the whole MTD device it
3007 only has to locate a checkpoint (called fastmap) on the device.
3008 The on-flash fastmap contains all information needed to attach
3009 the device. Using fastmap makes only sense on large devices where
3010 attaching by scanning takes long. UBI will not automatically install
3011 a fastmap on old images, but you can set the UBI parameter
3012 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3013 that fastmap-enabled images are still usable with UBI implementations
3014 without fastmap support. On typical flash devices the whole fastmap
3015 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3016
3017 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3018 Set this parameter to enable fastmap automatically on images
3019 without a fastmap.
3020 default: 0
3021
Heiko Schocher94b66de2015-10-22 06:19:21 +02003022 CONFIG_MTD_UBI_FM_DEBUG
3023 Enable UBI fastmap debug
3024 default: 0
3025
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003026- UBIFS support
3027 CONFIG_CMD_UBIFS
3028
3029 Adds commands for interacting with UBI volumes formatted as
3030 UBIFS. UBIFS is read-only in u-boot.
3031
3032 Requires UBI support as well as CONFIG_LZO
3033
Joe Hershberger47550fc2013-04-08 10:32:49 +00003034 CONFIG_UBIFS_SILENCE_MSG
3035
3036 Make the verbose messages from UBIFS stop printing. This leaves
3037 warnings and errors enabled.
3038
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003039- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003040 CONFIG_SPL
3041 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003042
Tom Rini36853852012-02-14 07:29:40 +00003043 CONFIG_SPL_LDSCRIPT
3044 LDSCRIPT for linking the SPL binary.
3045
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003046 CONFIG_SPL_MAX_FOOTPRINT
3047 Maximum size in memory allocated to the SPL, BSS included.
3048 When defined, the linker checks that the actual memory
3049 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003050 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003051 must not be both defined at the same time.
3052
Tom Rini36853852012-02-14 07:29:40 +00003053 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003054 Maximum size of the SPL image (text, data, rodata, and
3055 linker lists sections), BSS excluded.
3056 When defined, the linker checks that the actual size does
3057 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003058
Wolfgang Denk825223d2011-09-11 21:24:09 +02003059 CONFIG_SPL_TEXT_BASE
3060 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003061
Scott Woodc4f0d002012-09-20 19:05:12 -05003062 CONFIG_SPL_RELOC_TEXT_BASE
3063 Address to relocate to. If unspecified, this is equal to
3064 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3065
Tom Rini36853852012-02-14 07:29:40 +00003066 CONFIG_SPL_BSS_START_ADDR
3067 Link address for the BSS within the SPL binary.
3068
3069 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003070 Maximum size in memory allocated to the SPL BSS.
3071 When defined, the linker checks that the actual memory used
3072 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003073 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003074 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003075
3076 CONFIG_SPL_STACK
3077 Adress of the start of the stack SPL will use
3078
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003079 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3080 When defined, SPL will panic() if the image it has
3081 loaded does not have a signature.
3082 Defining this is useful when code which loads images
3083 in SPL cannot guarantee that absolutely all read errors
3084 will be caught.
3085 An example is the LPC32XX MLC NAND driver, which will
3086 consider that a completely unreadable NAND block is bad,
3087 and thus should be skipped silently.
3088
Scott Woodc4f0d002012-09-20 19:05:12 -05003089 CONFIG_SPL_RELOC_STACK
3090 Adress of the start of the stack SPL will use after
3091 relocation. If unspecified, this is equal to
3092 CONFIG_SPL_STACK.
3093
Tom Rini36853852012-02-14 07:29:40 +00003094 CONFIG_SYS_SPL_MALLOC_START
3095 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003096 When this option is set the full malloc is used in SPL and
3097 it is set up by spl_init() and before that, the simple malloc()
3098 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003099
3100 CONFIG_SYS_SPL_MALLOC_SIZE
3101 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003102
Tom Rini28591df2012-08-13 12:03:19 -07003103 CONFIG_SPL_FRAMEWORK
3104 Enable the SPL framework under common/. This framework
3105 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3106 NAND loading of the Linux Kernel.
3107
Tom Rinic2b76002014-03-28 12:03:39 -04003108 CONFIG_SPL_OS_BOOT
3109 Enable booting directly to an OS from SPL.
3110 See also: doc/README.falcon
3111
Tom Rinife3b0c72012-08-13 11:37:56 -07003112 CONFIG_SPL_DISPLAY_PRINT
3113 For ARM, enable an optional function to print more information
3114 about the running system.
3115
Scott Wood7c810902012-09-20 16:35:21 -05003116 CONFIG_SPL_INIT_MINIMAL
3117 Arch init code should be built for a very small image
3118
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003119 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3120 Partition on the MMC to load U-Boot from when the MMC is being
3121 used in raw mode
3122
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003123 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3124 Sector to load kernel uImage from when MMC is being
3125 used in raw mode (for Falcon mode)
3126
3127 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3128 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3129 Sector and number of sectors to load kernel argument
3130 parameters from when MMC is being used in raw mode
3131 (for falcon mode)
3132
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003133 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3134 Partition on the MMC to load U-Boot from when the MMC is being
3135 used in fs mode
3136
Guillaume GARDET5065b712014-10-15 17:53:13 +02003137 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3138 Filename to read to load U-Boot when reading from filesystem
3139
3140 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003141 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003142 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003143
Guillaume GARDET5065b712014-10-15 17:53:13 +02003144 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003145 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003146 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003147
Scott Wood2b36fbb2012-12-06 13:33:17 +00003148 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3149 Set this for NAND SPL on PPC mpc83xx targets, so that
3150 start.S waits for the rest of the SPL to load before
3151 continuing (the hardware starts execution after just
3152 loading the first page rather than the full 4K).
3153
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303154 CONFIG_SPL_SKIP_RELOCATE
3155 Avoid SPL relocation
3156
Scott Woodc352a0c2012-09-20 19:09:07 -05003157 CONFIG_SPL_NAND_BASE
3158 Include nand_base.c in the SPL. Requires
3159 CONFIG_SPL_NAND_DRIVERS.
3160
3161 CONFIG_SPL_NAND_DRIVERS
3162 SPL uses normal NAND drivers, not minimal drivers.
3163
3164 CONFIG_SPL_NAND_ECC
3165 Include standard software ECC in the SPL
3166
Tom Rini36853852012-02-14 07:29:40 +00003167 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003168 Support for NAND boot using simple NAND drivers that
3169 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003170
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003171 CONFIG_SPL_UBI
3172 Support for a lightweight UBI (fastmap) scanner and
3173 loader
3174
Heiko Schochercf000272014-10-31 08:31:00 +01003175 CONFIG_SPL_NAND_RAW_ONLY
3176 Support to boot only raw u-boot.bin images. Use this only
3177 if you need to save space.
3178
Ying Zhangdfb2b152013-08-16 15:16:12 +08003179 CONFIG_SPL_COMMON_INIT_DDR
3180 Set for common ddr init with serial presence detect in
3181 SPL binary.
3182
Tom Rini36853852012-02-14 07:29:40 +00003183 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3184 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3185 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3186 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3187 CONFIG_SYS_NAND_ECCBYTES
3188 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003189 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003190
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303191 CONFIG_SPL_NAND_BOOT
3192 Add support NAND boot
3193
Tom Rini36853852012-02-14 07:29:40 +00003194 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003195 Location in NAND to read U-Boot from
3196
3197 CONFIG_SYS_NAND_U_BOOT_DST
3198 Location in memory to load U-Boot to
3199
3200 CONFIG_SYS_NAND_U_BOOT_SIZE
3201 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003202
3203 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003204 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003205
3206 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3207 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003208 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003209
3210 CONFIG_SPL_OMAP3_ID_NAND
3211 Support for an OMAP3-specific set of functions to return the
3212 ID and MFR of the first attached NAND chip, if present.
3213
Pavel Machekde997252012-08-30 22:42:11 +02003214 CONFIG_SPL_RAM_DEVICE
3215 Support for running image already present in ram, in SPL binary
3216
Scott Woodeb7bd972012-12-06 13:33:16 +00003217 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003218 Image offset to which the SPL should be padded before appending
3219 the SPL payload. By default, this is defined as
3220 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3221 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3222 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003223
Scott Woodf147eb72012-09-21 16:27:32 -05003224 CONFIG_SPL_TARGET
3225 Final target image containing SPL and payload. Some SPLs
3226 use an arch-specific makefile fragment instead, for
3227 example if more than one image needs to be produced.
3228
Simon Glass82d94532013-05-08 08:05:59 +00003229 CONFIG_FIT_SPL_PRINT
3230 Printing information about a FIT image adds quite a bit of
3231 code to SPL. So this is normally disabled in SPL. Use this
3232 option to re-enable it. This will affect the output of the
3233 bootm command when booting a FIT image.
3234
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003235- TPL framework
3236 CONFIG_TPL
3237 Enable building of TPL globally.
3238
3239 CONFIG_TPL_PAD_TO
3240 Image offset to which the TPL should be padded before appending
3241 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003242 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3243 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3244 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003245
wdenkc0aa5c52003-12-06 19:49:23 +00003246- Interrupt support (PPC):
3247
wdenk1ebf41e2004-01-02 14:00:00 +00003248 There are common interrupt_init() and timer_interrupt()
3249 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003250 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003251 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003252 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003253 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003254 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003255 specific handling. If board has watchdog / status_led
3256 / other_activity_monitor it works automatically from
3257 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003258
wdenkc6097192002-11-03 00:24:07 +00003259
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003260Board initialization settings:
3261------------------------------
3262
3263During Initialization u-boot calls a number of board specific functions
3264to allow the preparation of board specific prerequisites, e.g. pin setup
3265before drivers are initialized. To enable these callbacks the
3266following configuration macros have to be defined. Currently this is
3267architecture specific, so please check arch/your_architecture/lib/board.c
3268typically in board_init_f() and board_init_r().
3269
3270- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3271- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3272- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3273- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003274
wdenkc6097192002-11-03 00:24:07 +00003275Configuration Settings:
3276-----------------------
3277
York Sun6c480012014-02-26 17:03:19 -08003278- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3279 Optionally it can be defined to support 64-bit memory commands.
3280
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003281- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003282 undefine this when you're short of memory.
3283
Peter Tyserdfb72b82009-01-27 18:03:12 -06003284- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3285 width of the commands listed in the 'help' command output.
3286
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003287- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003288 prompt for user input.
3289
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003290- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003291
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003292- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003293
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003294- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003295
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003296- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003297 the application (usually a Linux kernel) when it is
3298 booted
3299
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003300- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003301 List of legal baudrate settings for this board.
3302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003303- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003304 Begin and End addresses of the area used by the
3305 simple memory test.
3306
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003307- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003308 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003309
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003310- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003311 Scratch address used by the alternate memory test
3312 You only need to set this if address zero isn't writeable
3313
York Sun5d286cd2015-12-04 11:57:07 -08003314- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003315 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003316 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3317 is substracted from total RAM and won't be reported to OS.
3318 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003319 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003320 the RAM base is not zero, or RAM is divided into banks,
3321 this variable needs to be recalcuated to get the address.
3322
York Sun50739372015-12-07 11:05:29 -08003323- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003324 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003325 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003326 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003327 fixing up gd->ram_size the Linux kernel should gets passed
3328 the now "corrected" memory size and won't touch it either.
3329 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003330 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003331 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003332 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003333
3334 This option can be used as a workaround for the 440EPx/GRx
3335 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3336 be touched.
3337
3338 WARNING: Please make sure that this value is a multiple of
3339 the Linux page size (normally 4k). If this is not the case,
3340 then the end address of the Linux memory will be located at a
3341 non page size aligned address and this could cause major
3342 problems.
3343
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003344- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003345 Enable temporary baudrate change while serial download
3346
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003347- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003348 Physical start address of SDRAM. _Must_ be 0 here.
3349
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003350- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003351 Physical start address of Flash memory.
3352
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003353- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003354 Physical start address of boot monitor code (set by
3355 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003356 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003357 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003358
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003359- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003360 Size of memory reserved for monitor code, used to
3361 determine _at_compile_time_ (!) if the environment is
3362 embedded within the U-Boot image, or in a separate
3363 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003364
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003365- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003366 Size of DRAM reserved for malloc() use.
3367
Simon Glass863e4042014-07-10 22:23:28 -06003368- CONFIG_SYS_MALLOC_F_LEN
3369 Size of the malloc() pool for use before relocation. If
3370 this is defined, then a very simple malloc() implementation
3371 will become available before relocation. The address is just
3372 below the global data, and the stack is moved down to make
3373 space.
3374
3375 This feature allocates regions with increasing addresses
3376 within the region. calloc() is supported, but realloc()
3377 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003378 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003379 U-Boot relocates itself.
3380
Simon Glass9fa901b2014-11-10 17:16:54 -07003381- CONFIG_SYS_MALLOC_SIMPLE
3382 Provides a simple and small malloc() and calloc() for those
3383 boards which do not use the full malloc in SPL (which is
3384 enabled with CONFIG_SYS_SPL_MALLOC_START).
3385
Thierry Redingc97d9742014-12-09 22:25:22 -07003386- CONFIG_SYS_NONCACHED_MEMORY:
3387 Size of non-cached memory area. This area of memory will be
3388 typically located right below the malloc() area and mapped
3389 uncached in the MMU. This is useful for drivers that would
3390 otherwise require a lot of explicit cache maintenance. For
3391 some drivers it's also impossible to properly maintain the
3392 cache. For example if the regions that need to be flushed
3393 are not a multiple of the cache-line size, *and* padding
3394 cannot be allocated between the regions to align them (i.e.
3395 if the HW requires a contiguous array of regions, and the
3396 size of each region is not cache-aligned), then a flush of
3397 one region may result in overwriting data that hardware has
3398 written to another region in the same cache-line. This can
3399 happen for example in network drivers where descriptors for
3400 buffers are typically smaller than the CPU cache-line (e.g.
3401 16 bytes vs. 32 or 64 bytes).
3402
3403 Non-cached memory is only supported on 32-bit ARM at present.
3404
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003405- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003406 Normally compressed uImages are limited to an
3407 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003408 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003409 to adjust this setting to your needs.
3410
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003411- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003412 Maximum size of memory mapped by the startup code of
3413 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003414 the Linux kernel (bd_info, boot arguments, FDT blob if
3415 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003416 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003417 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003418 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003419 variable "bootm_mapsize" will override the value of
3420 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3421 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003422
John Rigbyeea8e692010-10-13 13:57:35 -06003423- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3424 Enable initrd_high functionality. If defined then the
3425 initrd_high feature is enabled and the bootm ramdisk subcommand
3426 is enabled.
3427
3428- CONFIG_SYS_BOOT_GET_CMDLINE:
3429 Enables allocating and saving kernel cmdline in space between
3430 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3431
3432- CONFIG_SYS_BOOT_GET_KBD:
3433 Enables allocating and saving a kernel copy of the bd_info in
3434 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3435
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003436- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003437 Max number of Flash memory banks
3438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003439- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003440 Max number of sectors on a Flash chip
3441
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003442- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003443 Timeout for Flash erase operations (in ms)
3444
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003445- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003446 Timeout for Flash write operations (in ms)
3447
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003448- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003449 Timeout for Flash set sector lock bit operation (in ms)
3450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003451- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003452 Timeout for Flash clear lock bits operation (in ms)
3453
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003454- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003455 If defined, hardware flash sectors protection is used
3456 instead of U-Boot software protection.
3457
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003458- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003459
3460 Enable TFTP transfers directly to flash memory;
3461 without this option such a download has to be
3462 performed in two steps: (1) download to RAM, and (2)
3463 copy from RAM to flash.
3464
3465 The two-step approach is usually more reliable, since
3466 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003467 the flash, but in some situations (when system RAM is
3468 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003469 downloaded image) this option may be very useful.
3470
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003471- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003472 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003473 common flash structure for storing flash geometry.
3474
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003475- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003476 This option also enables the building of the cfi_flash driver
3477 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003478
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003479- CONFIG_FLASH_CFI_MTD
3480 This option enables the building of the cfi_mtd driver
3481 in the drivers directory. The driver exports CFI flash
3482 to the MTD layer.
3483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003484- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003485 Use buffered writes to flash.
3486
3487- CONFIG_FLASH_SPANSION_S29WS_N
3488 s29ws-n MirrorBit flash has non-standard addresses for buffered
3489 write commands.
3490
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003491- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003492 If this option is defined, the common CFI flash doesn't
3493 print it's warning upon not recognized FLASH banks. This
3494 is useful, if some of the configured banks are only
3495 optionally available.
3496
Jerry Van Barenaae73572008-03-08 13:48:01 -05003497- CONFIG_FLASH_SHOW_PROGRESS
3498 If defined (must be an integer), print out countdown
3499 digits and dots. Recommended value: 45 (9..1) for 80
3500 column displays, 15 (3..1) for 40 column displays.
3501
Stefan Roesed20cba52013-04-04 15:53:14 +02003502- CONFIG_FLASH_VERIFY
3503 If defined, the content of the flash (destination) is compared
3504 against the source after the write operation. An error message
3505 will be printed when the contents are not identical.
3506 Please note that this option is useless in nearly all cases,
3507 since such flash programming errors usually are detected earlier
3508 while unprotecting/erasing/programming. Please only enable
3509 this option if you really know what you are doing.
3510
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003511- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003512 Defines the number of Ethernet receive buffers. On some
3513 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003514 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3515 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003516 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003517 Defaults to 4 if not defined.
3518
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003519- CONFIG_ENV_MAX_ENTRIES
3520
Wolfgang Denk1136f692010-10-27 22:48:30 +02003521 Maximum number of entries in the hash table that is used
3522 internally to store the environment settings. The default
3523 setting is supposed to be generous and should work in most
3524 cases. This setting can be used to tune behaviour; see
3525 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003526
Joe Hershberger71497d02012-12-11 22:16:31 -06003527- CONFIG_ENV_FLAGS_LIST_DEFAULT
3528- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003529 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003530 calling env set. Variables can be restricted to only decimal,
3531 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3532 the variables can also be restricted to IP address or MAC address.
3533
3534 The format of the list is:
3535 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003536 access_attribute = [a|r|o|c]
3537 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003538 entry = variable_name[:attributes]
3539 list = entry[,list]
3540
3541 The type attributes are:
3542 s - String (default)
3543 d - Decimal
3544 x - Hexadecimal
3545 b - Boolean ([1yYtT|0nNfF])
3546 i - IP address
3547 m - MAC address
3548
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003549 The access attributes are:
3550 a - Any (default)
3551 r - Read-only
3552 o - Write-once
3553 c - Change-default
3554
Joe Hershberger71497d02012-12-11 22:16:31 -06003555 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3556 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003557 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003558
3559 - CONFIG_ENV_FLAGS_LIST_STATIC
3560 Define this to a list (string) to define validation that
3561 should be done if an entry is not found in the ".flags"
3562 environment variable. To override a setting in the static
3563 list, simply add an entry for the same variable name to the
3564 ".flags" variable.
3565
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003566 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3567 regular expression. This allows multiple variables to define the same
3568 flags without explicitly listing them for each variable.
3569
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003570- CONFIG_ENV_ACCESS_IGNORE_FORCE
3571 If defined, don't allow the -f switch to env set override variable
3572 access flags.
3573
Gabe Black3687fe42014-10-15 04:38:30 -06003574- CONFIG_USE_STDINT
3575 If stdint.h is available with your toolchain you can define this
3576 option to enable it. You can provide option 'USE_STDINT=1' when
3577 building U-Boot to enable this.
3578
wdenkc6097192002-11-03 00:24:07 +00003579The following definitions that deal with the placement and management
3580of environment data (variable area); in general, we support the
3581following configurations:
3582
Mike Frysinger63b8f122011-07-08 10:44:25 +00003583- CONFIG_BUILD_ENVCRC:
3584
3585 Builds up envcrc with the target environment so that external utils
3586 may easily extract it and embed it in final U-Boot images.
3587
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003588- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003589
3590 Define this if the environment is in flash memory.
3591
3592 a) The environment occupies one whole flash sector, which is
3593 "embedded" in the text segment with the U-Boot code. This
3594 happens usually with "bottom boot sector" or "top boot
3595 sector" type flash chips, which have several smaller
3596 sectors at the start or the end. For instance, such a
3597 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3598 such a case you would place the environment in one of the
3599 4 kB sectors - with U-Boot code before and after it. With
3600 "top boot sector" type flash chips, you would put the
3601 environment in one of the last sectors, leaving a gap
3602 between U-Boot and the environment.
3603
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003604 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003605
3606 Offset of environment data (variable area) to the
3607 beginning of flash memory; for instance, with bottom boot
3608 type flash chips the second sector can be used: the offset
3609 for this sector is given here.
3610
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003611 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003612
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003613 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003614
3615 This is just another way to specify the start address of
3616 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003617 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003618
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003619 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003620
3621 Size of the sector containing the environment.
3622
3623
3624 b) Sometimes flash chips have few, equal sized, BIG sectors.
3625 In such a case you don't want to spend a whole sector for
3626 the environment.
3627
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003628 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003629
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003630 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003631 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003632 of this flash sector for the environment. This saves
3633 memory for the RAM copy of the environment.
3634
3635 It may also save flash memory if you decide to use this
3636 when your environment is "embedded" within U-Boot code,
3637 since then the remainder of the flash sector could be used
3638 for U-Boot code. It should be pointed out that this is
3639 STRONGLY DISCOURAGED from a robustness point of view:
3640 updating the environment in flash makes it always
3641 necessary to erase the WHOLE sector. If something goes
3642 wrong before the contents has been restored from a copy in
3643 RAM, your target system will be dead.
3644
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003645 - CONFIG_ENV_ADDR_REDUND
3646 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003647
wdenk4a5c8a72003-03-06 00:02:04 +00003648 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003649 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003650 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003651 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003652
3653BE CAREFUL! Any changes to the flash layout, and some changes to the
3654source code will make it necessary to adapt <board>/u-boot.lds*
3655accordingly!
3656
3657
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003658- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003659
3660 Define this if you have some non-volatile memory device
3661 (NVRAM, battery buffered SRAM) which you want to use for the
3662 environment.
3663
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003664 - CONFIG_ENV_ADDR:
3665 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003666
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003667 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003668 want to use for environment. It is assumed that this memory
3669 can just be read and written to, without any special
3670 provision.
3671
3672BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003673in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003674console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003675U-Boot will hang.
3676
3677Please note that even with NVRAM we still use a copy of the
3678environment in RAM: we could work on NVRAM directly, but we want to
3679keep settings there always unmodified except somebody uses "saveenv"
3680to save the current settings.
3681
3682
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003683- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003684
3685 Use this if you have an EEPROM or similar serial access
3686 device and a driver for it.
3687
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003688 - CONFIG_ENV_OFFSET:
3689 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003690
3691 These two #defines specify the offset and size of the
3692 environment area within the total memory of your EEPROM.
3693
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003694 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003695 If defined, specified the chip address of the EEPROM device.
3696 The default address is zero.
3697
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003698 - CONFIG_SYS_I2C_EEPROM_BUS:
3699 If defined, specified the i2c bus of the EEPROM device.
3700
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003701 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003702 If defined, the number of bits used to address bytes in a
3703 single page in the EEPROM device. A 64 byte page, for example
3704 would require six bits.
3705
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003706 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003707 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003708 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003710 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003711 The length in bytes of the EEPROM memory array address. Note
3712 that this is NOT the chip address length!
3713
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003714 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003715 EEPROM chips that implement "address overflow" are ones
3716 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3717 address and the extra bits end up in the "chip address" bit
3718 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3719 byte chips.
3720
3721 Note that we consider the length of the address field to
3722 still be one byte because the extra address bits are hidden
3723 in the chip address.
3724
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003725 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003726 The size in bytes of the EEPROM device.
3727
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003728 - CONFIG_ENV_EEPROM_IS_ON_I2C
3729 define this, if you have I2C and SPI activated, and your
3730 EEPROM, which holds the environment, is on the I2C bus.
3731
3732 - CONFIG_I2C_ENV_EEPROM_BUS
3733 if you have an Environment on an EEPROM reached over
3734 I2C muxes, you can define here, how to reach this
3735 EEPROM. For example:
3736
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003737 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003738
3739 EEPROM which holds the environment, is reached over
3740 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003741
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003742- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003743
wdenk1ebf41e2004-01-02 14:00:00 +00003744 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003745 want to use for the environment.
3746
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003747 - CONFIG_ENV_OFFSET:
3748 - CONFIG_ENV_ADDR:
3749 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003750
3751 These three #defines specify the offset and size of the
3752 environment area within the total memory of your DataFlash placed
3753 at the specified address.
3754
Wu, Josh76db7bf2014-07-01 19:30:13 +08003755- CONFIG_ENV_IS_IN_SPI_FLASH:
3756
3757 Define this if you have a SPI Flash memory device which you
3758 want to use for the environment.
3759
3760 - CONFIG_ENV_OFFSET:
3761 - CONFIG_ENV_SIZE:
3762
3763 These two #defines specify the offset and size of the
3764 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3765 aligned to an erase sector boundary.
3766
3767 - CONFIG_ENV_SECT_SIZE:
3768
3769 Define the SPI flash's sector size.
3770
3771 - CONFIG_ENV_OFFSET_REDUND (optional):
3772
3773 This setting describes a second storage area of CONFIG_ENV_SIZE
3774 size used to hold a redundant copy of the environment data, so
3775 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003776 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003777 aligned to an erase sector boundary.
3778
3779 - CONFIG_ENV_SPI_BUS (optional):
3780 - CONFIG_ENV_SPI_CS (optional):
3781
3782 Define the SPI bus and chip select. If not defined they will be 0.
3783
3784 - CONFIG_ENV_SPI_MAX_HZ (optional):
3785
3786 Define the SPI max work clock. If not defined then use 1MHz.
3787
3788 - CONFIG_ENV_SPI_MODE (optional):
3789
3790 Define the SPI work mode. If not defined then use SPI_MODE_3.
3791
Liu Gang85bcd732012-03-08 00:33:20 +00003792- CONFIG_ENV_IS_IN_REMOTE:
3793
3794 Define this if you have a remote memory space which you
3795 want to use for the local device's environment.
3796
3797 - CONFIG_ENV_ADDR:
3798 - CONFIG_ENV_SIZE:
3799
3800 These two #defines specify the address and size of the
3801 environment area within the remote memory space. The
3802 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003803 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003804
3805BE CAREFUL! For some special cases, the local device can not use
3806"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003807environment stored in a remote NOR flash by SRIO or PCIE link,
3808but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003809
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003810- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003811
3812 Define this if you have a NAND device which you want to use
3813 for the environment.
3814
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003815 - CONFIG_ENV_OFFSET:
3816 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003817
3818 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003819 area within the first NAND device. CONFIG_ENV_OFFSET must be
3820 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003821
Scott Wood08239322010-09-17 14:38:37 -05003822 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003823
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003824 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003825 size used to hold a redundant copy of the environment data, so
3826 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003827 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003828 aligned to an erase block boundary.
3829
3830 - CONFIG_ENV_RANGE (optional):
3831
3832 Specifies the length of the region in which the environment
3833 can be written. This should be a multiple of the NAND device's
3834 block size. Specifying a range with more erase blocks than
3835 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3836 the range to be avoided.
3837
3838 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003839
Scott Wood08239322010-09-17 14:38:37 -05003840 Enables support for dynamically retrieving the offset of the
3841 environment from block zero's out-of-band data. The
3842 "nand env.oob" command can be used to record this offset.
3843 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3844 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003845
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003846- CONFIG_NAND_ENV_DST
3847
3848 Defines address in RAM to which the nand_spl code should copy the
3849 environment. If redundant environment is used, it will be copied to
3850 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3851
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003852- CONFIG_ENV_IS_IN_UBI:
3853
3854 Define this if you have an UBI volume that you want to use for the
3855 environment. This has the benefit of wear-leveling the environment
3856 accesses, which is important on NAND.
3857
3858 - CONFIG_ENV_UBI_PART:
3859
3860 Define this to a string that is the mtd partition containing the UBI.
3861
3862 - CONFIG_ENV_UBI_VOLUME:
3863
3864 Define this to the name of the volume that you want to store the
3865 environment in.
3866
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003867 - CONFIG_ENV_UBI_VOLUME_REDUND:
3868
3869 Define this to the name of another volume to store a second copy of
3870 the environment in. This will enable redundant environments in UBI.
3871 It is assumed that both volumes are in the same MTD partition.
3872
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003873 - CONFIG_UBI_SILENCE_MSG
3874 - CONFIG_UBIFS_SILENCE_MSG
3875
3876 You will probably want to define these to avoid a really noisy system
3877 when storing the env in UBI.
3878
Wu, Josha7d0c872014-06-24 17:31:03 +08003879- CONFIG_ENV_IS_IN_FAT:
3880 Define this if you want to use the FAT file system for the environment.
3881
3882 - FAT_ENV_INTERFACE:
3883
3884 Define this to a string that is the name of the block device.
3885
Nicolae Rosia86811f22016-11-21 17:33:58 +02003886 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003887
3888 Define this to a string to specify the partition of the device. It can
3889 be as following:
3890
3891 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3892 - "D:P": device D partition P. Error occurs if device D has no
3893 partition table.
3894 - "D:0": device D.
3895 - "D" or "D:": device D partition 1 if device D has partition
3896 table, or the whole device D if has no partition
3897 table.
3898 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003899 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08003900 partition table then means device D.
3901
3902 - FAT_ENV_FILE:
3903
3904 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003905 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08003906
3907 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003908 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08003909
Stephen Warreneedcacd2013-06-11 15:14:00 -06003910- CONFIG_ENV_IS_IN_MMC:
3911
3912 Define this if you have an MMC device which you want to use for the
3913 environment.
3914
3915 - CONFIG_SYS_MMC_ENV_DEV:
3916
3917 Specifies which MMC device the environment is stored in.
3918
3919 - CONFIG_SYS_MMC_ENV_PART (optional):
3920
3921 Specifies which MMC partition the environment is stored in. If not
3922 set, defaults to partition 0, the user area. Common values might be
3923 1 (first MMC boot partition), 2 (second MMC boot partition).
3924
3925 - CONFIG_ENV_OFFSET:
3926 - CONFIG_ENV_SIZE:
3927
3928 These two #defines specify the offset and size of the environment
3929 area within the specified MMC device.
3930
Stephen Warren24dc2032013-06-11 15:14:02 -06003931 If offset is positive (the usual case), it is treated as relative to
3932 the start of the MMC partition. If offset is negative, it is treated
3933 as relative to the end of the MMC partition. This can be useful if
3934 your board may be fitted with different MMC devices, which have
3935 different sizes for the MMC partitions, and you always want the
3936 environment placed at the very end of the partition, to leave the
3937 maximum possible space before it, to store other data.
3938
Stephen Warreneedcacd2013-06-11 15:14:00 -06003939 These two values are in units of bytes, but must be aligned to an
3940 MMC sector boundary.
3941
3942 - CONFIG_ENV_OFFSET_REDUND (optional):
3943
3944 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3945 hold a redundant copy of the environment data. This provides a
3946 valid backup copy in case the other copy is corrupted, e.g. due
3947 to a power failure during a "saveenv" operation.
3948
Stephen Warren24dc2032013-06-11 15:14:02 -06003949 This value may also be positive or negative; this is handled in the
3950 same way as CONFIG_ENV_OFFSET.
3951
Stephen Warreneedcacd2013-06-11 15:14:00 -06003952 This value is also in units of bytes, but must also be aligned to
3953 an MMC sector boundary.
3954
3955 - CONFIG_ENV_SIZE_REDUND (optional):
3956
3957 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3958 set. If this value is set, it must be set to the same value as
3959 CONFIG_ENV_SIZE.
3960
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003961- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003962
3963 Defines offset to the initial SPI buffer area in DPRAM. The
3964 area is used at an early stage (ROM part) if the environment
3965 is configured to reside in the SPI EEPROM: We need a 520 byte
3966 scratch DPRAM area. It is used between the two initialization
3967 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3968 to be a good choice since it makes it far enough from the
3969 start of the data area as well as from the stack pointer.
3970
Bruce Adleredecc942007-11-02 13:15:42 -07003971Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003972has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003973created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003974until then to read environment variables.
3975
wdenk8dba0502003-03-31 16:34:49 +00003976The environment is protected by a CRC32 checksum. Before the monitor
3977is relocated into RAM, as a result of a bad CRC you will be working
3978with the compiled-in default environment - *silently*!!! [This is
3979necessary, because the first environment variable we need is the
3980"baudrate" setting for the console - if we have a bad CRC, we don't
3981have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003982
3983Note: once the monitor has been relocated, then it will complain if
3984the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003985use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003986
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003987- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003988 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003989
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003990 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003991 also needs to be defined.
3992
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003993- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003994 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003995
Ron Madriddfa028a2009-02-18 14:30:44 -08003996- CONFIG_NS16550_MIN_FUNCTIONS:
3997 Define this if you desire to only have use of the NS16550_init
3998 and NS16550_putc functions for the serial driver located at
3999 drivers/serial/ns16550.c. This option is useful for saving
4000 space for already greatly restricted images, including but not
4001 limited to NAND_SPL configurations.
4002
Simon Glass28a9e332012-11-30 13:01:18 +00004003- CONFIG_DISPLAY_BOARDINFO
4004 Display information about the board that U-Boot is running on
4005 when U-Boot starts up. The board function checkboard() is called
4006 to do this.
4007
Simon Glasse8822012012-11-30 13:01:19 +00004008- CONFIG_DISPLAY_BOARDINFO_LATE
4009 Similar to the previous option, but display this information
4010 later, once stdio is running and output goes to the LCD, if
4011 present.
4012
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004013- CONFIG_BOARD_SIZE_LIMIT:
4014 Maximum size of the U-Boot image. When defined, the
4015 build system checks that the actual size does not
4016 exceed it.
4017
wdenkc6097192002-11-03 00:24:07 +00004018Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004019---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004020
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004021- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004022 Cache Line Size of the CPU.
4023
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004024- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004025 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004026
wdenk9c53f402003-10-15 23:53:47 +00004027 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4028 and RPXsuper) to be able to adjust the position of
4029 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004030
Timur Tabid8f341c2011-08-04 18:03:41 -05004031- CONFIG_SYS_CCSRBAR_DEFAULT:
4032 Default (power-on reset) physical address of CCSR on Freescale
4033 PowerPC SOCs.
4034
4035- CONFIG_SYS_CCSRBAR:
4036 Virtual address of CCSR. On a 32-bit build, this is typically
4037 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4038
4039 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4040 for cross-platform code that uses that macro instead.
4041
4042- CONFIG_SYS_CCSRBAR_PHYS:
4043 Physical address of CCSR. CCSR can be relocated to a new
4044 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004045 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004046 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4047 is typically relocated on 36-bit builds. It is recommended
4048 that this macro be defined via the _HIGH and _LOW macros:
4049
4050 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4051 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4052
4053- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004054 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4055 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004056 used in assembly code, so it must not contain typecasts or
4057 integer size suffixes (e.g. "ULL").
4058
4059- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4060 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4061 used in assembly code, so it must not contain typecasts or
4062 integer size suffixes (e.g. "ULL").
4063
4064- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4065 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4066 forced to a value that ensures that CCSR is not relocated.
4067
wdenk1272e232002-11-10 22:06:23 +00004068- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004069 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004070
4071 the default drive number (default value 0)
4072
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004073 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004074
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004075 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004076 (default value 1)
4077
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004078 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004079
wdenk4a5c8a72003-03-06 00:02:04 +00004080 defines the offset of register from address. It
4081 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004082 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004084 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4085 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004086 default value.
wdenk1272e232002-11-10 22:06:23 +00004087
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004088 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004089 fdc_hw_init() is called at the beginning of the FDC
4090 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004091 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004092 initializations.
wdenk1272e232002-11-10 22:06:23 +00004093
Macpaul Lind1e49942011-04-11 20:45:32 +00004094- CONFIG_IDE_AHB:
4095 Most IDE controllers were designed to be connected with PCI
4096 interface. Only few of them were designed for AHB interface.
4097 When software is doing ATA command and data transfer to
4098 IDE devices through IDE-AHB controller, some additional
4099 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004100 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004101
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004102- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004103 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004104 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004105
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004106- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004107
wdenkeb20ad32003-09-05 23:19:14 +00004108 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004109 initial data and stack; please note that this must be
4110 writable memory that is working WITHOUT special
4111 initialization, i. e. you CANNOT use normal RAM which
4112 will become available only after programming the
4113 memory controller and running certain initialization
4114 sequences.
4115
4116 U-Boot uses the following memory types:
4117 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4118 - MPC824X: data cache
4119 - PPC4xx: data cache
4120
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004121- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004122
4123 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004124 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4125 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004126 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004127 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004128 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004129 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4130 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004131
4132 Note:
4133 On the MPC824X (or other systems that use the data
4134 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004135 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004136 point to an otherwise UNUSED address space between
4137 the top of RAM and the start of the PCI space.
4138
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004139- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004140
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004141- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004142
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004143- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004144
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004145- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004146
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004147- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004148
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004149- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004150
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004151- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004152 SDRAM timing
4153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004154- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004155 periodic timer for refresh
4156
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004157- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004158
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004159- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4160 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4161 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4162 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004163 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4164
4165- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004166 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4167 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004168 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4169
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004170- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4171 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004172 Machine Mode Register and Memory Periodic Timer
4173 Prescaler definitions (SDRAM timing)
4174
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004175- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004176 enable I2C microcode relocation patch (MPC8xx);
4177 define relocation offset in DPRAM [DSP2]
4178
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004179- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004180 enable SMC microcode relocation patch (MPC8xx);
4181 define relocation offset in DPRAM [SMC1]
4182
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004183- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004184 enable SPI microcode relocation patch (MPC8xx);
4185 define relocation offset in DPRAM [SCC4]
4186
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004187- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004188 Offset of the bootmode word in DPRAM used by post
4189 (Power On Self Tests). This definition overrides
4190 #define'd default value in commproc.h resp.
4191 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004192
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004193- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4194 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4195 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4196 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4197 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4198 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4199 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4200 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004201 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004202
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004203- CONFIG_PCI_DISABLE_PCIE:
4204 Disable PCI-Express on systems where it is supported but not
4205 required.
4206
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004207- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004208 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004209 Don't do any setup work, presumably because someone or
4210 something has already done it, and we don't need to do it
4211 a second time. Useful for platforms that are pre-booted
4212 by coreboot or similar.
4213
Gabor Juhosb4458732013-05-30 07:06:12 +00004214- CONFIG_PCI_INDIRECT_BRIDGE:
4215 Enable support for indirect PCI bridges.
4216
Kumar Gala8975d7a2010-12-30 12:09:53 -06004217- CONFIG_SYS_SRIO:
4218 Chip has SRIO or not
4219
4220- CONFIG_SRIO1:
4221 Board has SRIO 1 port available
4222
4223- CONFIG_SRIO2:
4224 Board has SRIO 2 port available
4225
Liu Gang27afb9c2013-05-07 16:30:46 +08004226- CONFIG_SRIO_PCIE_BOOT_MASTER
4227 Board can support master function for Boot from SRIO and PCIE
4228
Kumar Gala8975d7a2010-12-30 12:09:53 -06004229- CONFIG_SYS_SRIOn_MEM_VIRT:
4230 Virtual Address of SRIO port 'n' memory region
4231
4232- CONFIG_SYS_SRIOn_MEM_PHYS:
4233 Physical Address of SRIO port 'n' memory region
4234
4235- CONFIG_SYS_SRIOn_MEM_SIZE:
4236 Size of SRIO port 'n' memory region
4237
Fabio Estevamf17e8782013-04-11 09:35:34 +00004238- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4239 Defined to tell the NAND controller that the NAND chip is using
4240 a 16 bit bus.
4241 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004242 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004243 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004244 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004245
4246- CONFIG_SYS_NDFC_EBC0_CFG
4247 Sets the EBC0_CFG register for the NDFC. If not defined
4248 a default value will be used.
4249
Ben Warren45657152006-09-07 16:50:54 -04004250- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004251 Get DDR timing information from an I2C EEPROM. Common
4252 with pluggable memory modules such as SODIMMs
4253
Ben Warren45657152006-09-07 16:50:54 -04004254 SPD_EEPROM_ADDRESS
4255 I2C address of the SPD EEPROM
4256
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004257- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004258 If SPD EEPROM is on an I2C bus other than the first
4259 one, specify here. Note that the value must resolve
4260 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004261
York Sune73cc042011-06-07 09:42:16 +08004262- CONFIG_SYS_DDR_RAW_TIMING
4263 Get DDR timing information from other than SPD. Common with
4264 soldered DDR chips onboard without SPD. DDR raw timing
4265 parameters are extracted from datasheet and hard-coded into
4266 header files or board specific files.
4267
York Sunbd495cf2011-09-16 13:21:35 -07004268- CONFIG_FSL_DDR_INTERACTIVE
4269 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4270
York Sun8ced0502015-01-06 13:18:55 -08004271- CONFIG_FSL_DDR_SYNC_REFRESH
4272 Enable sync of refresh for multiple controllers.
4273
York Sunb6a35f82015-03-19 09:30:28 -07004274- CONFIG_FSL_DDR_BIST
4275 Enable built-in memory test for Freescale DDR controllers.
4276
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004277- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004278 Only for 83xx systems. If specified, then DDR should
4279 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004280
wdenk6203e402004-04-18 10:13:26 +00004281- CONFIG_ETHER_ON_FEC[12]
4282 Define to enable FEC[12] on a 8xx series processor.
4283
4284- CONFIG_FEC[12]_PHY
4285 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004286 to the given FEC; i. e.
4287 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004288 means that the PHY with address 4 is connected to FEC1
4289
4290 When set to -1, means to probe for first available.
4291
4292- CONFIG_FEC[12]_PHY_NORXERR
4293 The PHY does not have a RXERR line (RMII only).
4294 (so program the FEC to ignore it).
4295
4296- CONFIG_RMII
4297 Enable RMII mode for all FECs.
4298 Note that this is a global option, we can't
4299 have one FEC in standard MII mode and another in RMII mode.
4300
wdenk20c98a62004-04-23 20:32:05 +00004301- CONFIG_CRC32_VERIFY
4302 Add a verify option to the crc32 command.
4303 The syntax is:
4304
4305 => crc32 -v <address> <count> <crc32>
4306
4307 Where address/count indicate a memory area
4308 and crc32 is the correct crc32 which the
4309 area should have.
4310
wdenk64519362004-07-11 17:40:54 +00004311- CONFIG_LOOPW
4312 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004313 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004314
stroesecc3af832004-12-16 18:46:55 +00004315- CONFIG_MX_CYCLIC
4316 Add the "mdc" and "mwc" memory commands. These are cyclic
4317 "md/mw" commands.
4318 Examples:
4319
wdenk07d7e6b2004-12-16 21:44:03 +00004320 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004321 This command will print 4 bytes (10,11,12,13) each 500 ms.
4322
wdenk07d7e6b2004-12-16 21:44:03 +00004323 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004324 This command will write 12345678 to address 100 all 10 ms.
4325
wdenk07d7e6b2004-12-16 21:44:03 +00004326 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004327 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004328
wdenk3d3d99f2005-04-04 12:44:11 +00004329- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004330 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004331 low level initializations (like setting up the memory
4332 controller) are omitted and/or U-Boot does not
4333 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004334
Wolfgang Denk302141d2010-11-27 23:30:56 +01004335 Normally this variable MUST NOT be defined. The only
4336 exception is when U-Boot is loaded (to RAM) by some
4337 other boot loader or by a debugger which performs
4338 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004339
Simon Glass90844072016-05-05 07:28:06 -06004340- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4341 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004342 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004343 instruction cache) is still performed.
4344
Aneesh V552a3192011-07-13 05:11:07 +00004345- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004346 Modifies the behaviour of start.S when compiling a loader
4347 that is executed before the actual U-Boot. E.g. when
4348 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004349
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004350- CONFIG_TPL_BUILD
4351 Modifies the behaviour of start.S when compiling a loader
4352 that is executed after the SPL and before the actual U-Boot.
4353 It is loaded by the SPL.
4354
Ying Zhang0d4f5442013-05-20 14:07:23 +08004355- CONFIG_SYS_MPC85XX_NO_RESETVEC
4356 Only for 85xx systems. If this variable is specified, the section
4357 .resetvec is not kept and the section .bootpg is placed in the
4358 previous 4k of the .text section.
4359
Simon Glass17dabf02013-02-24 17:33:14 +00004360- CONFIG_ARCH_MAP_SYSMEM
4361 Generally U-Boot (and in particular the md command) uses
4362 effective address. It is therefore not necessary to regard
4363 U-Boot address as virtual addresses that need to be translated
4364 to physical addresses. However, sandbox requires this, since
4365 it maintains its own little RAM buffer which contains all
4366 addressable memory. This option causes some memory accesses
4367 to be mapped through map_sysmem() / unmap_sysmem().
4368
Simon Glassbfb59802013-02-14 04:18:54 +00004369- CONFIG_X86_RESET_VECTOR
4370 If defined, the x86 reset vector code is included. This is not
4371 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004372
Heiko Schocher2233e462013-11-04 14:05:00 +01004373- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4374 Enables the RTC32K OSC on AM33xx based plattforms
4375
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004376- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4377 Option to disable subpage write in NAND driver
4378 driver that uses this:
4379 drivers/mtd/nand/davinci_nand.c
4380
Timur Tabi275f4bb2011-11-22 09:21:25 -06004381Freescale QE/FMAN Firmware Support:
4382-----------------------------------
4383
4384The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4385loading of "firmware", which is encoded in the QE firmware binary format.
4386This firmware often needs to be loaded during U-Boot booting, so macros
4387are used to identify the storage device (NOR flash, SPI, etc) and the address
4388within that device.
4389
Zhao Qiang83a90842014-03-21 16:21:44 +08004390- CONFIG_SYS_FMAN_FW_ADDR
4391 The address in the storage device where the FMAN microcode is located. The
4392 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4393 is also specified.
4394
4395- CONFIG_SYS_QE_FW_ADDR
4396 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004397 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4398 is also specified.
4399
4400- CONFIG_SYS_QE_FMAN_FW_LENGTH
4401 The maximum possible size of the firmware. The firmware binary format
4402 has a field that specifies the actual size of the firmware, but it
4403 might not be possible to read any part of the firmware unless some
4404 local storage is allocated to hold the entire firmware first.
4405
4406- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4407 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4408 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4409 virtual address in NOR flash.
4410
4411- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4412 Specifies that QE/FMAN firmware is located in NAND flash.
4413 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4414
4415- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4416 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4417 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4418
Liu Gang1e084582012-03-08 00:33:18 +00004419- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4420 Specifies that QE/FMAN firmware is located in the remote (master)
4421 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004422 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4423 window->master inbound window->master LAW->the ucode address in
4424 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004425
J. German Rivera8ff14b72014-06-23 15:15:55 -07004426Freescale Layerscape Management Complex Firmware Support:
4427---------------------------------------------------------
4428The Freescale Layerscape Management Complex (MC) supports the loading of
4429"firmware".
4430This firmware often needs to be loaded during U-Boot booting, so macros
4431are used to identify the storage device (NOR flash, SPI, etc) and the address
4432within that device.
4433
4434- CONFIG_FSL_MC_ENET
4435 Enable the MC driver for Layerscape SoCs.
4436
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304437Freescale Layerscape Debug Server Support:
4438-------------------------------------------
4439The Freescale Layerscape Debug Server Support supports the loading of
4440"Debug Server firmware" and triggering SP boot-rom.
4441This firmware often needs to be loaded during U-Boot booting.
4442
York Sun928b6812015-12-07 11:08:58 -08004443- CONFIG_SYS_MC_RSV_MEM_ALIGN
4444 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304445
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004446Reproducible builds
4447-------------------
4448
4449In order to achieve reproducible builds, timestamps used in the U-Boot build
4450process have to be set to a fixed value.
4451
4452This is done using the SOURCE_DATE_EPOCH environment variable.
4453SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4454option for U-Boot or an environment variable in U-Boot.
4455
4456SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4457
wdenkc6097192002-11-03 00:24:07 +00004458Building the Software:
4459======================
4460
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004461Building U-Boot has been tested in several native build environments
4462and in many different cross environments. Of course we cannot support
4463all possibly existing versions of cross development tools in all
4464(potentially obsolete) versions. In case of tool chain problems we
4465recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4466which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004467
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004468If you are not using a native environment, it is assumed that you
4469have GNU cross compiling tools available in your path. In this case,
4470you must set the environment variable CROSS_COMPILE in your shell.
4471Note that no changes to the Makefile or any other source files are
4472necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004473
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004474 $ CROSS_COMPILE=ppc_4xx-
4475 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004476
Peter Tyserb06976d2009-03-13 18:54:51 -05004477Note: If you wish to generate Windows versions of the utilities in
4478 the tools directory you can use the MinGW toolchain
4479 (http://www.mingw.org). Set your HOST tools to the MinGW
4480 toolchain and execute 'make tools'. For example:
4481
4482 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4483
4484 Binaries such as tools/mkimage.exe will be created which can
4485 be executed on computers running Windows.
4486
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004487U-Boot is intended to be simple to build. After installing the
4488sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004489is done by typing:
4490
Holger Freyther7ba4e572014-08-04 09:26:05 +02004491 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004492
Holger Freyther7ba4e572014-08-04 09:26:05 +02004493where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004494rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004495
wdenk6c59edc2004-05-03 20:45:30 +00004496Note: for some board special configuration names may exist; check if
4497 additional information is available from the board vendor; for
4498 instance, the TQM823L systems are available without (standard)
4499 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004500 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004501
Holger Freyther7ba4e572014-08-04 09:26:05 +02004502 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004503 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004504
Holger Freyther7ba4e572014-08-04 09:26:05 +02004505 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004506 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004507
wdenk6c59edc2004-05-03 20:45:30 +00004508 etc.
wdenkc6097192002-11-03 00:24:07 +00004509
wdenkc6097192002-11-03 00:24:07 +00004510
wdenk6c59edc2004-05-03 20:45:30 +00004511Finally, type "make all", and you should get some working U-Boot
4512images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004513
wdenk6c59edc2004-05-03 20:45:30 +00004514- "u-boot.bin" is a raw binary image
4515- "u-boot" is an image in ELF binary format
4516- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004517
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004518By default the build is performed locally and the objects are saved
4519in the source directory. One of the two methods can be used to change
4520this behavior and build U-Boot to some external directory:
4521
45221. Add O= to the make command line invocations:
4523
4524 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004525 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004526 make O=/tmp/build all
4527
Timo Ketolac8c67602014-11-06 14:39:05 +020045282. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004529
Timo Ketolac8c67602014-11-06 14:39:05 +02004530 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004531 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004532 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004533 make all
4534
Timo Ketolac8c67602014-11-06 14:39:05 +02004535Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004536variable.
4537
wdenkc6097192002-11-03 00:24:07 +00004538
wdenk6c59edc2004-05-03 20:45:30 +00004539Please be aware that the Makefiles assume you are using GNU make, so
4540for instance on NetBSD you might need to use "gmake" instead of
4541native "make".
wdenkc6097192002-11-03 00:24:07 +00004542
wdenkc6097192002-11-03 00:24:07 +00004543
wdenk6c59edc2004-05-03 20:45:30 +00004544If the system board that you have is not listed, then you will need
4545to port U-Boot to your hardware platform. To do this, follow these
4546steps:
wdenkc6097192002-11-03 00:24:07 +00004547
Phil Sutterc77b4882015-12-25 14:41:18 +010045481. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004549 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004550 the "Makefile" and a "<board>.c".
45512. Create a new configuration file "include/configs/<board>.h" for
4552 your board.
wdenk6c59edc2004-05-03 20:45:30 +000045533. If you're porting U-Boot to a new CPU, then also create a new
4554 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020045554. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000045565. Type "make", and you should get a working "u-boot.srec" file
4557 to be installed on your target system.
45586. Debug and solve any problems that might arise.
4559 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004560
wdenkc6097192002-11-03 00:24:07 +00004561
wdenk6c59edc2004-05-03 20:45:30 +00004562Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4563==============================================================
wdenkc6097192002-11-03 00:24:07 +00004564
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004565If you have modified U-Boot sources (for instance added a new board
4566or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004567provide feedback to the other developers. The feedback normally takes
4568the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004569official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004570
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004571But before you submit such a patch, please verify that your modifi-
4572cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004573the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004574just run the buildman script (tools/buildman/buildman), which will
4575configure and build U-Boot for ALL supported system. Be warned, this
4576will take a while. Please see the buildman README, or run 'buildman -H'
4577for documentation.
wdenkc6097192002-11-03 00:24:07 +00004578
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004579
wdenk6c59edc2004-05-03 20:45:30 +00004580See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004581
wdenkc6097192002-11-03 00:24:07 +00004582
wdenk6c59edc2004-05-03 20:45:30 +00004583Monitor Commands - Overview:
4584============================
wdenkc6097192002-11-03 00:24:07 +00004585
wdenk6c59edc2004-05-03 20:45:30 +00004586go - start application at address 'addr'
4587run - run commands in an environment variable
4588bootm - boot application image from memory
4589bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004590bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004591tftpboot- boot image via network using TFTP protocol
4592 and env variables "ipaddr" and "serverip"
4593 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004594tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004595rarpboot- boot image via network using RARP/TFTP protocol
4596diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4597loads - load S-Record file over serial line
4598loadb - load binary file over serial line (kermit mode)
4599md - memory display
4600mm - memory modify (auto-incrementing)
4601nm - memory modify (constant address)
4602mw - memory write (fill)
4603cp - memory copy
4604cmp - memory compare
4605crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004606i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004607sspi - SPI utility commands
4608base - print or set address offset
4609printenv- print environment variables
4610setenv - set environment variables
4611saveenv - save environment variables to persistent storage
4612protect - enable or disable FLASH write protection
4613erase - erase FLASH memory
4614flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004615nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004616bdinfo - print Board Info structure
4617iminfo - print header information for application image
4618coninfo - print console devices and informations
4619ide - IDE sub-system
4620loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004621loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004622mtest - simple RAM test
4623icache - enable or disable instruction cache
4624dcache - enable or disable data cache
4625reset - Perform RESET of the CPU
4626echo - echo args to console
4627version - print monitor version
4628help - print online help
4629? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004630
wdenkc6097192002-11-03 00:24:07 +00004631
wdenk6c59edc2004-05-03 20:45:30 +00004632Monitor Commands - Detailed Description:
4633========================================
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk6c59edc2004-05-03 20:45:30 +00004635TODO.
wdenkc6097192002-11-03 00:24:07 +00004636
wdenk6c59edc2004-05-03 20:45:30 +00004637For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004638
4639
wdenk6c59edc2004-05-03 20:45:30 +00004640Environment Variables:
4641======================
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk6c59edc2004-05-03 20:45:30 +00004643U-Boot supports user configuration using Environment Variables which
4644can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk6c59edc2004-05-03 20:45:30 +00004646Environment Variables are set using "setenv", printed using
4647"printenv", and saved to Flash using "saveenv". Using "setenv"
4648without a value can be used to delete a variable from the
4649environment. As long as you don't save the environment you are
4650working with an in-memory copy. In case the Flash area containing the
4651environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004652
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004653Some configuration options can be set using Environment Variables.
4654
4655List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004656
wdenk6c59edc2004-05-03 20:45:30 +00004657 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004658
wdenk6c59edc2004-05-03 20:45:30 +00004659 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004660
wdenk6c59edc2004-05-03 20:45:30 +00004661 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004662
wdenk6c59edc2004-05-03 20:45:30 +00004663 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004664
wdenk6c59edc2004-05-03 20:45:30 +00004665 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004666
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004667 bootm_low - Memory range available for image processing in the bootm
4668 command can be restricted. This variable is given as
4669 a hexadecimal number and defines lowest address allowed
4670 for use by the bootm command. See also "bootm_size"
4671 environment variable. Address defined by "bootm_low" is
4672 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004673 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4674 bootm_mapsize.
4675
Wolfgang Denk092ae952011-10-26 10:21:21 +00004676 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004677 This variable is given as a hexadecimal number and it
4678 defines the size of the memory region starting at base
4679 address bootm_low that is accessible by the Linux kernel
4680 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4681 as the default value if it is defined, and bootm_size is
4682 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004683
4684 bootm_size - Memory range available for image processing in the bootm
4685 command can be restricted. This variable is given as
4686 a hexadecimal number and defines the size of the region
4687 allowed for use by the bootm command. See also "bootm_low"
4688 environment variable.
4689
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004690 updatefile - Location of the software update file on a TFTP server, used
4691 by the automatic software update feature. Please refer to
4692 documentation in doc/README.update for more details.
4693
wdenk6c59edc2004-05-03 20:45:30 +00004694 autoload - if set to "no" (any string beginning with 'n'),
4695 "bootp" will just load perform a lookup of the
4696 configuration from the BOOTP server, but not try to
4697 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004698
wdenk6c59edc2004-05-03 20:45:30 +00004699 autostart - if set to "yes", an image loaded using the "bootp",
4700 "rarpboot", "tftpboot" or "diskboot" commands will
4701 be automatically started (by internally calling
4702 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004703
wdenk6c59edc2004-05-03 20:45:30 +00004704 If set to "no", a standalone image passed to the
4705 "bootm" command will be copied to the load address
4706 (and eventually uncompressed), but NOT be started.
4707 This can be used to load and uncompress arbitrary
4708 data.
wdenkc6097192002-11-03 00:24:07 +00004709
David A. Longd558a4e2011-07-09 16:40:19 -04004710 fdt_high - if set this restricts the maximum address that the
4711 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004712 For example, if you have a system with 1 GB memory
4713 at physical address 0x10000000, while Linux kernel
4714 only recognizes the first 704 MB as low memory, you
4715 may need to set fdt_high as 0x3C000000 to have the
4716 device tree blob be copied to the maximum address
4717 of the 704 MB low memory, so that Linux kernel can
4718 access it during the boot procedure.
4719
David A. Longd558a4e2011-07-09 16:40:19 -04004720 If this is set to the special value 0xFFFFFFFF then
4721 the fdt will not be copied at all on boot. For this
4722 to work it must reside in writable memory, have
4723 sufficient padding on the end of it for u-boot to
4724 add the information it needs into it, and the memory
4725 must be accessible by the kernel.
4726
Simon Glassdc6fa642011-10-24 19:15:34 +00004727 fdtcontroladdr- if set this is the address of the control flattened
4728 device tree used by U-Boot when CONFIG_OF_CONTROL is
4729 defined.
4730
wdenk0e2bd9c2004-06-06 21:51:03 +00004731 i2cfast - (PPC405GP|PPC405EP only)
4732 if set to 'y' configures Linux I2C driver for fast
4733 mode (400kHZ). This environment variable is used in
4734 initialization code. So, for changes to be effective
4735 it must be saved and board must be reset.
4736
wdenk6c59edc2004-05-03 20:45:30 +00004737 initrd_high - restrict positioning of initrd images:
4738 If this variable is not set, initrd images will be
4739 copied to the highest possible address in RAM; this
4740 is usually what you want since it allows for
4741 maximum initrd size. If for some reason you want to
4742 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004743 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004744 variable to a value of "no" or "off" or "0".
4745 Alternatively, you can set it to a maximum upper
4746 address to use (U-Boot will still check that it
4747 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004748
wdenk6c59edc2004-05-03 20:45:30 +00004749 For instance, when you have a system with 16 MB
4750 RAM, and want to reserve 4 MB from use by Linux,
4751 you can do this by adding "mem=12M" to the value of
4752 the "bootargs" variable. However, now you must make
4753 sure that the initrd image is placed in the first
4754 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004755
wdenk6c59edc2004-05-03 20:45:30 +00004756 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004757
wdenk6c59edc2004-05-03 20:45:30 +00004758 If you set initrd_high to 0xFFFFFFFF, this is an
4759 indication to U-Boot that all addresses are legal
4760 for the Linux kernel, including addresses in flash
4761 memory. In this case U-Boot will NOT COPY the
4762 ramdisk at all. This may be useful to reduce the
4763 boot time on your system, but requires that this
4764 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004765
wdenk6c59edc2004-05-03 20:45:30 +00004766 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004767
wdenk6c59edc2004-05-03 20:45:30 +00004768 loadaddr - Default load address for commands like "bootp",
4769 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004770
wdenk6c59edc2004-05-03 20:45:30 +00004771 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004772
wdenk6c59edc2004-05-03 20:45:30 +00004773 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004774
wdenk6c59edc2004-05-03 20:45:30 +00004775 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004776
wdenk6c59edc2004-05-03 20:45:30 +00004777 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk6c59edc2004-05-03 20:45:30 +00004779 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004780
Mike Frysingera23230c2011-10-02 10:01:27 +00004781 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004782
Mike Frysingera23230c2011-10-02 10:01:27 +00004783 ethact - controls which interface is currently active.
4784 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004785
Heiko Schocherc5e84052010-07-20 17:45:02 +02004786 => setenv ethact FEC
4787 => ping 192.168.0.1 # traffic sent on FEC
4788 => setenv ethact SCC
4789 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004790
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004791 ethrotate - When set to "no" U-Boot does not go through all
4792 available network interfaces.
4793 It just stays at the currently selected interface.
4794
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004795 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004796 either succeed or fail without retrying.
4797 When set to "once" the network operation will
4798 fail when all the available network interfaces
4799 are tried once without success.
4800 Useful on scripts which control the retry operation
4801 themselves.
wdenkc6097192002-11-03 00:24:07 +00004802
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004803 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004804
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004805 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004806 changing the console to be empty. If "yes" it will be
4807 made silent. If "no" it will not be made silent. If
4808 unset, then it will be made silent if the U-Boot console
4809 is silent.
4810
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004811 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004812 UDP source port.
4813
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004814 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004815 destination port instead of the Well Know Port 69.
4816
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004817 tftpblocksize - Block size to use for TFTP transfers; if not set,
4818 we use the TFTP server's default block size
4819
4820 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4821 seconds, minimum value is 1000 = 1 second). Defines
4822 when a packet is considered to be lost so it has to
4823 be retransmitted. The default is 5000 = 5 seconds.
4824 Lowering this value may make downloads succeed
4825 faster in networks with high packet loss rates or
4826 with unreliable TFTP servers.
4827
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004828 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4829 unit, minimum value = 0). Defines how many timeouts
4830 can happen during a single file transfer before that
4831 transfer is aborted. The default is 10, and 0 means
4832 'no timeouts allowed'. Increasing this value may help
4833 downloads succeed with high packet loss rates, or with
4834 unreliable TFTP servers or client hardware.
4835
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004836 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004837 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004838 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004839
Alexandre Messier15971322016-02-01 17:08:57 -05004840 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4841 Unsigned value, in milliseconds. If not set, the period will
4842 be either the default (28000), or a value based on
4843 CONFIG_NET_RETRY_COUNT, if defined. This value has
4844 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4845
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004846The following image location variables contain the location of images
4847used in booting. The "Image" column gives the role of the image and is
4848not an environment variable name. The other columns are environment
4849variable names. "File Name" gives the name of the file on a TFTP
4850server, "RAM Address" gives the location in RAM the image will be
4851loaded to, and "Flash Location" gives the image's address in NOR
4852flash or offset in NAND flash.
4853
4854*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004855boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004856boards use these variables for other purposes.
4857
Wolfgang Denk092ae952011-10-26 10:21:21 +00004858Image File Name RAM Address Flash Location
4859----- --------- ----------- --------------
4860u-boot u-boot u-boot_addr_r u-boot_addr
4861Linux kernel bootfile kernel_addr_r kernel_addr
4862device tree blob fdtfile fdt_addr_r fdt_addr
4863ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004864
wdenk6c59edc2004-05-03 20:45:30 +00004865The following environment variables may be used and automatically
4866updated by the network boot commands ("bootp" and "rarpboot"),
4867depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004868
wdenk6c59edc2004-05-03 20:45:30 +00004869 bootfile - see above
4870 dnsip - IP address of your Domain Name Server
4871 dnsip2 - IP address of your secondary Domain Name Server
4872 gatewayip - IP address of the Gateway (Router) to use
4873 hostname - Target hostname
4874 ipaddr - see above
4875 netmask - Subnet Mask
4876 rootpath - Pathname of the root filesystem on the NFS server
4877 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004878
wdenk145d2c12004-04-15 21:48:45 +00004879
wdenk6c59edc2004-05-03 20:45:30 +00004880There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004881
wdenk6c59edc2004-05-03 20:45:30 +00004882 serial# - contains hardware identification information such
4883 as type string and/or serial number
4884 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004885
wdenk6c59edc2004-05-03 20:45:30 +00004886These variables can be set only once (usually during manufacturing of
4887the board). U-Boot refuses to delete or overwrite these variables
4888once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004889
4890
wdenk6c59edc2004-05-03 20:45:30 +00004891Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893 ver - Contains the U-Boot version string as printed
4894 with the "version" command. This variable is
4895 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004896
wdenkc6097192002-11-03 00:24:07 +00004897
wdenk6c59edc2004-05-03 20:45:30 +00004898Please note that changes to some configuration parameters may take
4899only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004900
stroeseb9c17c52003-04-04 15:53:41 +00004901
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004902Callback functions for environment variables:
4903---------------------------------------------
4904
4905For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004906when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004907be associated with arbitrary variables. On creation, overwrite, or
4908deletion, the callback will provide the opportunity for some side
4909effect to happen or for the change to be rejected.
4910
4911The callbacks are named and associated with a function using the
4912U_BOOT_ENV_CALLBACK macro in your board or driver code.
4913
4914These callbacks are associated with variables in one of two ways. The
4915static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4916in the board configuration to a string that defines a list of
4917associations. The list must be in the following format:
4918
4919 entry = variable_name[:callback_name]
4920 list = entry[,list]
4921
4922If the callback name is not specified, then the callback is deleted.
4923Spaces are also allowed anywhere in the list.
4924
4925Callbacks can also be associated by defining the ".callbacks" variable
4926with the same list format above. Any association in ".callbacks" will
4927override any association in the static list. You can define
4928CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004929".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004930
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004931If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4932regular expression. This allows multiple variables to be connected to
4933the same callback without explicitly listing them all out.
4934
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004935
wdenk6c59edc2004-05-03 20:45:30 +00004936Command Line Parsing:
4937=====================
stroeseb9c17c52003-04-04 15:53:41 +00004938
wdenk6c59edc2004-05-03 20:45:30 +00004939There are two different command line parsers available with U-Boot:
4940the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004941
wdenk6c59edc2004-05-03 20:45:30 +00004942Old, simple command line parser:
4943--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk6c59edc2004-05-03 20:45:30 +00004945- supports environment variables (through setenv / saveenv commands)
4946- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004947- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004948- special characters ('$', ';') can be escaped by prefixing with '\',
4949 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004950 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004951- You can also escape text by enclosing in single apostrophes, for example:
4952 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004953
wdenk6c59edc2004-05-03 20:45:30 +00004954Hush shell:
4955-----------
wdenkf4688a22003-05-28 08:06:31 +00004956
wdenk6c59edc2004-05-03 20:45:30 +00004957- similar to Bourne shell, with control structures like
4958 if...then...else...fi, for...do...done; while...do...done,
4959 until...do...done, ...
4960- supports environment ("global") variables (through setenv / saveenv
4961 commands) and local shell variables (through standard shell syntax
4962 "name=value"); only environment variables can be used with "run"
4963 command
wdenkf4688a22003-05-28 08:06:31 +00004964
wdenk6c59edc2004-05-03 20:45:30 +00004965General rules:
4966--------------
wdenkf4688a22003-05-28 08:06:31 +00004967
wdenk6c59edc2004-05-03 20:45:30 +00004968(1) If a command line (or an environment variable executed by a "run"
4969 command) contains several commands separated by semicolon, and
4970 one of these commands fails, then the remaining commands will be
4971 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004972
wdenk6c59edc2004-05-03 20:45:30 +00004973(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004974 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004975 command will cause "run" to terminate, i. e. the remaining
4976 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004977
wdenk6c59edc2004-05-03 20:45:30 +00004978Note for Redundant Ethernet Interfaces:
4979=======================================
wdenkf4688a22003-05-28 08:06:31 +00004980
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004981Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004982such configurations and is capable of automatic selection of a
4983"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004984
wdenk6c59edc2004-05-03 20:45:30 +00004985Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4986MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4987"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004988
wdenk6c59edc2004-05-03 20:45:30 +00004989If the network interface stores some valid MAC address (for instance
4990in SROM), this is used as default address if there is NO correspon-
4991ding setting in the environment; if the corresponding environment
4992variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004993
wdenk6c59edc2004-05-03 20:45:30 +00004994o If the SROM has a valid MAC address, and there is no address in the
4995 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk6c59edc2004-05-03 20:45:30 +00004997o If there is no valid address in the SROM, and a definition in the
4998 environment exists, then the value from the environment variable is
4999 used.
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001o If both the SROM and the environment contain a MAC address, and
5002 both addresses are the same, this MAC address is 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 the
5005 addresses differ, the value from the environment is used and a
5006 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +00005008o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005009 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5010 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005011
Ben Warren6db991a2010-04-26 11:11:46 -07005012If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005013will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005014may be skipped by setting the appropriate 'ethmacskip' environment variable.
5015The naming convention is as follows:
5016"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk6c59edc2004-05-03 20:45:30 +00005018Image Formats:
5019==============
wdenkc6097192002-11-03 00:24:07 +00005020
Marian Balakowicz18710b82008-03-12 12:13:13 +01005021U-Boot is capable of booting (and performing other auxiliary operations on)
5022images in two formats:
5023
5024New uImage format (FIT)
5025-----------------------
5026
5027Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5028to Flattened Device Tree). It allows the use of images with multiple
5029components (several kernels, ramdisks, etc.), with contents protected by
5030SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5031
5032
5033Old uImage format
5034-----------------
5035
5036Old image format is based on binary files which can be basically anything,
5037preceded by a special header; see the definitions in include/image.h for
5038details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk6c59edc2004-05-03 20:45:30 +00005040* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5041 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005042 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5043 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5044 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005045* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005046 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5047 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005048* Compression Type (uncompressed, gzip, bzip2)
5049* Load Address
5050* Entry Point
5051* Image Name
5052* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005053
wdenk6c59edc2004-05-03 20:45:30 +00005054The header is marked by a special Magic Number, and both the header
5055and the data portions of the image are secured against corruption by
5056CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005057
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk6c59edc2004-05-03 20:45:30 +00005059Linux Support:
5060==============
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062Although U-Boot should support any OS or standalone application
5063easily, the main focus has always been on Linux during the design of
5064U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005065
wdenk6c59edc2004-05-03 20:45:30 +00005066U-Boot includes many features that so far have been part of some
5067special "boot loader" code within the Linux kernel. Also, any
5068"initrd" images to be used are no longer part of one big Linux image;
5069instead, kernel and "initrd" are separate images. This implementation
5070serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005071
wdenk6c59edc2004-05-03 20:45:30 +00005072- the same features can be used for other OS or standalone
5073 applications (for instance: using compressed images to reduce the
5074 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005075
wdenk6c59edc2004-05-03 20:45:30 +00005076- it becomes much easier to port new Linux kernel versions because
5077 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005078
wdenk6c59edc2004-05-03 20:45:30 +00005079- the same Linux kernel image can now be used with different "initrd"
5080 images; of course this also means that different kernel images can
5081 be run with the same "initrd". This makes testing easier (you don't
5082 have to build a new "zImage.initrd" Linux image when you just
5083 change a file in your "initrd"). Also, a field-upgrade of the
5084 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005085
wdenkc6097192002-11-03 00:24:07 +00005086
wdenk6c59edc2004-05-03 20:45:30 +00005087Linux HOWTO:
5088============
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090Porting Linux to U-Boot based systems:
5091---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk6c59edc2004-05-03 20:45:30 +00005093U-Boot cannot save you from doing all the necessary modifications to
5094configure the Linux device drivers for use with your target hardware
5095(no, we don't intend to provide a full virtual machine interface to
5096Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005097
Stefan Roese88fbf932010-04-15 16:07:28 +02005098But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005099
wdenk6c59edc2004-05-03 20:45:30 +00005100Just make sure your machine specific header file (for instance
5101include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005102Information structure as we define in include/asm-<arch>/u-boot.h,
5103and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005104as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005105
Simon Glassd097e592014-06-11 23:29:46 -06005106Note that U-Boot now has a driver model, a unified model for drivers.
5107If you are adding a new driver, plumb it into driver model. If there
5108is no uclass available, you are encouraged to create one. See
5109doc/driver-model.
5110
wdenkc6097192002-11-03 00:24:07 +00005111
wdenk6c59edc2004-05-03 20:45:30 +00005112Configuring the Linux kernel:
5113-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005114
wdenk6c59edc2004-05-03 20:45:30 +00005115No specific requirements for U-Boot. Make sure you have some root
5116device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005117
wdenkc6097192002-11-03 00:24:07 +00005118
wdenk6c59edc2004-05-03 20:45:30 +00005119Building a Linux Image:
5120-----------------------
wdenkc6097192002-11-03 00:24:07 +00005121
wdenk6c59edc2004-05-03 20:45:30 +00005122With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5123not used. If you use recent kernel source, a new build target
5124"uImage" will exist which automatically builds an image usable by
5125U-Boot. Most older kernels also have support for a "pImage" target,
5126which was introduced for our predecessor project PPCBoot and uses a
5127100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005128
wdenk6c59edc2004-05-03 20:45:30 +00005129Example:
wdenkc6097192002-11-03 00:24:07 +00005130
Holger Freyther7ba4e572014-08-04 09:26:05 +02005131 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005132 make oldconfig
5133 make dep
5134 make uImage
wdenkc6097192002-11-03 00:24:07 +00005135
wdenk6c59edc2004-05-03 20:45:30 +00005136The "uImage" build target uses a special tool (in 'tools/mkimage') to
5137encapsulate a compressed Linux kernel image with header information,
5138CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk6c59edc2004-05-03 20:45:30 +00005140* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk6c59edc2004-05-03 20:45:30 +00005142* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005143
wdenk6c59edc2004-05-03 20:45:30 +00005144 ${CROSS_COMPILE}-objcopy -O binary \
5145 -R .note -R .comment \
5146 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005147
wdenk6c59edc2004-05-03 20:45:30 +00005148* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005149
wdenk6c59edc2004-05-03 20:45:30 +00005150 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005151
wdenk6c59edc2004-05-03 20:45:30 +00005152* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005153
wdenk6c59edc2004-05-03 20:45:30 +00005154 mkimage -A ppc -O linux -T kernel -C gzip \
5155 -a 0 -e 0 -n "Linux Kernel Image" \
5156 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005157
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk6c59edc2004-05-03 20:45:30 +00005159The "mkimage" tool can also be used to create ramdisk images for use
5160with U-Boot, either separated from the Linux kernel image, or
5161combined into one file. "mkimage" encapsulates the images with a 64
5162byte header containing information about target architecture,
5163operating system, image type, compression method, entry points, time
5164stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005165
wdenk6c59edc2004-05-03 20:45:30 +00005166"mkimage" can be called in two ways: to verify existing images and
5167print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005168
wdenk6c59edc2004-05-03 20:45:30 +00005169In the first form (with "-l" option) mkimage lists the information
5170contained in the header of an existing U-Boot image; this includes
5171checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005172
wdenk6c59edc2004-05-03 20:45:30 +00005173 tools/mkimage -l image
5174 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005175
wdenk6c59edc2004-05-03 20:45:30 +00005176The second form (with "-d" option) is used to build a U-Boot image
5177from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005178
wdenk6c59edc2004-05-03 20:45:30 +00005179 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5180 -n name -d data_file image
5181 -A ==> set architecture to 'arch'
5182 -O ==> set operating system to 'os'
5183 -T ==> set image type to 'type'
5184 -C ==> set compression type 'comp'
5185 -a ==> set load address to 'addr' (hex)
5186 -e ==> set entry point to 'ep' (hex)
5187 -n ==> set image name to 'name'
5188 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005189
wdenkcd914452004-05-29 16:53:29 +00005190Right now, all Linux kernels for PowerPC systems use the same load
5191address (0x00000000), but the entry point address depends on the
5192kernel version:
wdenkc6097192002-11-03 00:24:07 +00005193
wdenk6c59edc2004-05-03 20:45:30 +00005194- 2.2.x kernels have the entry point at 0x0000000C,
5195- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk6c59edc2004-05-03 20:45:30 +00005197So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005198
wdenk6c59edc2004-05-03 20:45:30 +00005199 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5200 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005201 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005202 > examples/uImage.TQM850L
5203 Image Name: 2.4.4 kernel for TQM850L
5204 Created: Wed Jul 19 02:34:59 2000
5205 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5206 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5207 Load Address: 0x00000000
5208 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk6c59edc2004-05-03 20:45:30 +00005210To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk6c59edc2004-05-03 20:45:30 +00005212 -> tools/mkimage -l examples/uImage.TQM850L
5213 Image Name: 2.4.4 kernel for TQM850L
5214 Created: Wed Jul 19 02:34:59 2000
5215 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5216 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5217 Load Address: 0x00000000
5218 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005219
wdenk6c59edc2004-05-03 20:45:30 +00005220NOTE: for embedded systems where boot time is critical you can trade
5221speed for memory and install an UNCOMPRESSED image instead: this
5222needs more space in Flash, but boots much faster since it does not
5223need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005224
Stefan Roese88fbf932010-04-15 16:07:28 +02005225 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005226 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5227 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005228 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005229 > examples/uImage.TQM850L-uncompressed
5230 Image Name: 2.4.4 kernel for TQM850L
5231 Created: Wed Jul 19 02:34:59 2000
5232 Image Type: PowerPC Linux Kernel Image (uncompressed)
5233 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5234 Load Address: 0x00000000
5235 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005236
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk6c59edc2004-05-03 20:45:30 +00005238Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5239when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005240
wdenk6c59edc2004-05-03 20:45:30 +00005241 -> tools/mkimage -n 'Simple Ramdisk Image' \
5242 > -A ppc -O linux -T ramdisk -C gzip \
5243 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5244 Image Name: Simple Ramdisk Image
5245 Created: Wed Jan 12 14:01:50 2000
5246 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5247 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5248 Load Address: 0x00000000
5249 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005250
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005251The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5252option performs the converse operation of the mkimage's second form (the "-d"
5253option). Given an image built by mkimage, the dumpimage extracts a "data file"
5254from the image:
5255
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005256 tools/dumpimage -i image -T type -p position data_file
5257 -i ==> extract from the 'image' a specific 'data_file'
5258 -T ==> set image type to 'type'
5259 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005260
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk6c59edc2004-05-03 20:45:30 +00005262Installing a Linux Image:
5263-------------------------
wdenkc6097192002-11-03 00:24:07 +00005264
wdenk6c59edc2004-05-03 20:45:30 +00005265To downloading a U-Boot image over the serial (console) interface,
5266you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005267
wdenk6c59edc2004-05-03 20:45:30 +00005268 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270The 'objcopy' does not understand the information in the U-Boot
5271image header, so the resulting S-Record file will be relative to
5272address 0x00000000. To load it to a given address, you need to
5273specify the target address as 'offset' parameter with the 'loads'
5274command.
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276Example: install the image to address 0x40100000 (which on the
5277TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk6c59edc2004-05-03 20:45:30 +00005281 .......... done
5282 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005283
wdenk6c59edc2004-05-03 20:45:30 +00005284 => loads 40100000
5285 ## Ready for S-Record download ...
5286 ~>examples/image.srec
5287 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5288 ...
5289 15989 15990 15991 15992
5290 [file transfer complete]
5291 [connected]
5292 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005293
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005296this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005297corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005298
wdenk6c59edc2004-05-03 20:45:30 +00005299 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005300
wdenk6c59edc2004-05-03 20:45:30 +00005301 ## Checking Image at 40100000 ...
5302 Image Name: 2.2.13 for initrd on TQM850L
5303 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5304 Data Size: 335725 Bytes = 327 kB = 0 MB
5305 Load Address: 00000000
5306 Entry Point: 0000000c
5307 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005308
5309
wdenk6c59edc2004-05-03 20:45:30 +00005310Boot Linux:
5311-----------
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk6c59edc2004-05-03 20:45:30 +00005313The "bootm" command is used to boot an application that is stored in
5314memory (RAM or Flash). In case of a Linux kernel image, the contents
5315of the "bootargs" environment variable is passed to the kernel as
5316parameters. You can check and modify this variable using the
5317"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005318
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk6c59edc2004-05-03 20:45:30 +00005320 => printenv bootargs
5321 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323 => 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 +00005324
wdenk6c59edc2004-05-03 20:45:30 +00005325 => printenv bootargs
5326 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 => bootm 40020000
5329 ## Booting Linux kernel at 40020000 ...
5330 Image Name: 2.2.13 for NFS on TQM850L
5331 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5332 Data Size: 381681 Bytes = 372 kB = 0 MB
5333 Load Address: 00000000
5334 Entry Point: 0000000c
5335 Verifying Checksum ... OK
5336 Uncompressing Kernel Image ... OK
5337 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
5338 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5339 time_init: decrementer frequency = 187500000/60
5340 Calibrating delay loop... 49.77 BogoMIPS
5341 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5342 ...
wdenkc6097192002-11-03 00:24:07 +00005343
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005344If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005345the memory addresses of both the kernel and the initrd image (PPBCOOT
5346format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005347
wdenk6c59edc2004-05-03 20:45:30 +00005348 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005349
wdenk6c59edc2004-05-03 20:45:30 +00005350 ## Checking Image at 40100000 ...
5351 Image Name: 2.2.13 for initrd on TQM850L
5352 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5353 Data Size: 335725 Bytes = 327 kB = 0 MB
5354 Load Address: 00000000
5355 Entry Point: 0000000c
5356 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358 ## Checking Image at 40200000 ...
5359 Image Name: Simple Ramdisk Image
5360 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5361 Data Size: 566530 Bytes = 553 kB = 0 MB
5362 Load Address: 00000000
5363 Entry Point: 00000000
5364 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005365
wdenk6c59edc2004-05-03 20:45:30 +00005366 => bootm 40100000 40200000
5367 ## Booting Linux kernel at 40100000 ...
5368 Image Name: 2.2.13 for initrd on TQM850L
5369 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5370 Data Size: 335725 Bytes = 327 kB = 0 MB
5371 Load Address: 00000000
5372 Entry Point: 0000000c
5373 Verifying Checksum ... OK
5374 Uncompressing Kernel Image ... OK
5375 ## Loading RAMDisk Image at 40200000 ...
5376 Image Name: Simple Ramdisk Image
5377 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5378 Data Size: 566530 Bytes = 553 kB = 0 MB
5379 Load Address: 00000000
5380 Entry Point: 00000000
5381 Verifying Checksum ... OK
5382 Loading Ramdisk ... OK
5383 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
5384 Boot arguments: root=/dev/ram
5385 time_init: decrementer frequency = 187500000/60
5386 Calibrating delay loop... 49.77 BogoMIPS
5387 ...
5388 RAMDISK: Compressed image found at block 0
5389 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391 bash#
wdenkc6097192002-11-03 00:24:07 +00005392
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005393Boot Linux and pass a flat device tree:
5394-----------
5395
5396First, U-Boot must be compiled with the appropriate defines. See the section
5397titled "Linux Kernel Interface" above for a more in depth explanation. The
5398following is an example of how to start a kernel and pass an updated
5399flat device tree:
5400
5401=> print oftaddr
5402oftaddr=0x300000
5403=> print oft
5404oft=oftrees/mpc8540ads.dtb
5405=> tftp $oftaddr $oft
5406Speed: 1000, full duplex
5407Using TSEC0 device
5408TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5409Filename 'oftrees/mpc8540ads.dtb'.
5410Load address: 0x300000
5411Loading: #
5412done
5413Bytes transferred = 4106 (100a hex)
5414=> tftp $loadaddr $bootfile
5415Speed: 1000, full duplex
5416Using TSEC0 device
5417TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5418Filename 'uImage'.
5419Load address: 0x200000
5420Loading:############
5421done
5422Bytes transferred = 1029407 (fb51f hex)
5423=> print loadaddr
5424loadaddr=200000
5425=> print oftaddr
5426oftaddr=0x300000
5427=> bootm $loadaddr - $oftaddr
5428## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005429 Image Name: Linux-2.6.17-dirty
5430 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5431 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005432 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005433 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005434 Verifying Checksum ... OK
5435 Uncompressing Kernel Image ... OK
5436Booting using flat device tree at 0x300000
5437Using MPC85xx ADS machine description
5438Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5439[snip]
5440
5441
wdenk6c59edc2004-05-03 20:45:30 +00005442More About U-Boot Image Types:
5443------------------------------
wdenkc6097192002-11-03 00:24:07 +00005444
wdenk6c59edc2004-05-03 20:45:30 +00005445U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005446
wdenk6c59edc2004-05-03 20:45:30 +00005447 "Standalone Programs" are directly runnable in the environment
5448 provided by U-Boot; it is expected that (if they behave
5449 well) you can continue to work in U-Boot after return from
5450 the Standalone Program.
5451 "OS Kernel Images" are usually images of some Embedded OS which
5452 will take over control completely. Usually these programs
5453 will install their own set of exception handlers, device
5454 drivers, set up the MMU, etc. - this means, that you cannot
5455 expect to re-enter U-Boot except by resetting the CPU.
5456 "RAMDisk Images" are more or less just data blocks, and their
5457 parameters (address, size) are passed to an OS kernel that is
5458 being started.
5459 "Multi-File Images" contain several images, typically an OS
5460 (Linux) kernel image and one or more data images like
5461 RAMDisks. This construct is useful for instance when you want
5462 to boot over the network using BOOTP etc., where the boot
5463 server provides just a single image file, but you want to get
5464 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005465
wdenk6c59edc2004-05-03 20:45:30 +00005466 "Multi-File Images" start with a list of image sizes, each
5467 image size (in bytes) specified by an "uint32_t" in network
5468 byte order. This list is terminated by an "(uint32_t)0".
5469 Immediately after the terminating 0 follow the images, one by
5470 one, all aligned on "uint32_t" boundaries (size rounded up to
5471 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005472
wdenk6c59edc2004-05-03 20:45:30 +00005473 "Firmware Images" are binary images containing firmware (like
5474 U-Boot or FPGA images) which usually will be programmed to
5475 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005476
wdenk6c59edc2004-05-03 20:45:30 +00005477 "Script files" are command sequences that will be executed by
5478 U-Boot's command interpreter; this feature is especially
5479 useful when you configure U-Boot to use a real shell (hush)
5480 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005481
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005482Booting the Linux zImage:
5483-------------------------
5484
5485On some platforms, it's possible to boot Linux zImage. This is done
5486using the "bootz" command. The syntax of "bootz" command is the same
5487as the syntax of "bootm" command.
5488
Tom Rini45f46d12013-05-16 11:40:11 -04005489Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005490kernel with raw initrd images. The syntax is slightly different, the
5491address of the initrd must be augmented by it's size, in the following
5492format: "<initrd addres>:<initrd size>".
5493
stroeseb9c17c52003-04-04 15:53:41 +00005494
wdenk6c59edc2004-05-03 20:45:30 +00005495Standalone HOWTO:
5496=================
stroeseb9c17c52003-04-04 15:53:41 +00005497
wdenk6c59edc2004-05-03 20:45:30 +00005498One of the features of U-Boot is that you can dynamically load and
5499run "standalone" applications, which can use some resources of
5500U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005501
wdenk6c59edc2004-05-03 20:45:30 +00005502Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005503
wdenk6c59edc2004-05-03 20:45:30 +00005504"Hello World" Demo:
5505-------------------
wdenkc6097192002-11-03 00:24:07 +00005506
wdenk6c59edc2004-05-03 20:45:30 +00005507'examples/hello_world.c' contains a small "Hello World" Demo
5508application; it is automatically compiled when you build U-Boot.
5509It's configured to run at address 0x00040004, so you can play with it
5510like that:
wdenkc6097192002-11-03 00:24:07 +00005511
wdenk6c59edc2004-05-03 20:45:30 +00005512 => loads
5513 ## Ready for S-Record download ...
5514 ~>examples/hello_world.srec
5515 1 2 3 4 5 6 7 8 9 10 11 ...
5516 [file transfer complete]
5517 [connected]
5518 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520 => go 40004 Hello World! This is a test.
5521 ## Starting application at 0x00040004 ...
5522 Hello World
5523 argc = 7
5524 argv[0] = "40004"
5525 argv[1] = "Hello"
5526 argv[2] = "World!"
5527 argv[3] = "This"
5528 argv[4] = "is"
5529 argv[5] = "a"
5530 argv[6] = "test."
5531 argv[7] = "<NULL>"
5532 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005533
wdenk6c59edc2004-05-03 20:45:30 +00005534 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005535
wdenk6c59edc2004-05-03 20:45:30 +00005536Another example, which demonstrates how to register a CPM interrupt
5537handler with the U-Boot code, can be found in 'examples/timer.c'.
5538Here, a CPM timer is set up to generate an interrupt every second.
5539The interrupt service routine is trivial, just printing a '.'
5540character, but this is just a demo program. The application can be
5541controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543 ? - print current values og the CPM Timer registers
5544 b - enable interrupts and start timer
5545 e - stop timer and disable interrupts
5546 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005547
wdenk6c59edc2004-05-03 20:45:30 +00005548 => loads
5549 ## Ready for S-Record download ...
5550 ~>examples/timer.srec
5551 1 2 3 4 5 6 7 8 9 10 11 ...
5552 [file transfer complete]
5553 [connected]
5554 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556 => go 40004
5557 ## Starting application at 0x00040004 ...
5558 TIMERS=0xfff00980
5559 Using timer 1
5560 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005561
wdenk6c59edc2004-05-03 20:45:30 +00005562Hit 'b':
5563 [q, b, e, ?] Set interval 1000000 us
5564 Enabling timer
5565Hit '?':
5566 [q, b, e, ?] ........
5567 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5568Hit '?':
5569 [q, b, e, ?] .
5570 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5571Hit '?':
5572 [q, b, e, ?] .
5573 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5574Hit '?':
5575 [q, b, e, ?] .
5576 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5577Hit 'e':
5578 [q, b, e, ?] ...Stopping timer
5579Hit 'q':
5580 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005581
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk6c59edc2004-05-03 20:45:30 +00005583Minicom warning:
5584================
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586Over time, many people have reported problems when trying to use the
5587"minicom" terminal emulation program for serial download. I (wd)
5588consider minicom to be broken, and recommend not to use it. Under
5589Unix, I recommend to use C-Kermit for general purpose use (and
5590especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005591use "cu" for S-Record download ("loads" command). See
5592http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5593for help with kermit.
5594
wdenkc6097192002-11-03 00:24:07 +00005595
wdenk6c59edc2004-05-03 20:45:30 +00005596Nevertheless, if you absolutely want to use it try adding this
5597configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005598
wdenk6c59edc2004-05-03 20:45:30 +00005599 Name Program Name U/D FullScr IO-Red. Multi
5600 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5601 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005602
wdenk8dba0502003-03-31 16:34:49 +00005603
wdenk6c59edc2004-05-03 20:45:30 +00005604NetBSD Notes:
5605=============
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607Starting at version 0.9.2, U-Boot supports NetBSD both as host
5608(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005609
wdenk6c59edc2004-05-03 20:45:30 +00005610Building requires a cross environment; it is known to work on
5611NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5612need gmake since the Makefiles are not compatible with BSD make).
5613Note that the cross-powerpc package does not install include files;
5614attempting to build U-Boot will fail because <machine/ansi.h> is
5615missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617 # cd /usr/pkg/cross/powerpc-netbsd/include
5618 # mkdir powerpc
5619 # ln -s powerpc machine
5620 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5621 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005622
wdenk6c59edc2004-05-03 20:45:30 +00005623Native builds *don't* work due to incompatibilities between native
5624and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005625
wdenk6c59edc2004-05-03 20:45:30 +00005626Booting assumes that (the first part of) the image booted is a
5627stage-2 loader which in turn loads and then invokes the kernel
5628proper. Loader sources will eventually appear in the NetBSD source
5629tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005630meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005631
wdenkc6097192002-11-03 00:24:07 +00005632
wdenk6c59edc2004-05-03 20:45:30 +00005633Implementation Internals:
5634=========================
wdenkc6097192002-11-03 00:24:07 +00005635
wdenk6c59edc2004-05-03 20:45:30 +00005636The following is not intended to be a complete description of every
5637implementation detail. However, it should help to understand the
5638inner workings of U-Boot and make it easier to port it to custom
5639hardware.
wdenkc6097192002-11-03 00:24:07 +00005640
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk6c59edc2004-05-03 20:45:30 +00005642Initial Stack, Global Data:
5643---------------------------
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk6c59edc2004-05-03 20:45:30 +00005645The implementation of U-Boot is complicated by the fact that U-Boot
5646starts running out of ROM (flash memory), usually without access to
5647system RAM (because the memory controller is not initialized yet).
5648This means that we don't have writable Data or BSS segments, and BSS
5649is not initialized as zero. To be able to get a C environment working
5650at all, we have to allocate at least a minimal stack. Implementation
5651options for this are defined and restricted by the CPU used: Some CPU
5652models provide on-chip memory (like the IMMR area on MPC8xx and
5653MPC826x processors), on others (parts of) the data cache can be
5654locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005655
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005656 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005657 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk6c59edc2004-05-03 20:45:30 +00005659 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5660 From: "Chris Hallinan" <clh@net1plus.com>
5661 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5662 ...
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk6c59edc2004-05-03 20:45:30 +00005664 Correct me if I'm wrong, folks, but the way I understand it
5665 is this: Using DCACHE as initial RAM for Stack, etc, does not
5666 require any physical RAM backing up the cache. The cleverness
5667 is that the cache is being used as a temporary supply of
5668 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005669 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005670 can see how this works by studying the cache architecture and
5671 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005672
wdenk6c59edc2004-05-03 20:45:30 +00005673 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5674 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005675 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005676 option should work for you. Using CS 4 should be fine if your
5677 board designers haven't used it for something that would
5678 cause you grief during the initial boot! It is frequently not
5679 used.
wdenkc6097192002-11-03 00:24:07 +00005680
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005681 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005682 with your processor/board/system design. The default value
5683 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005684 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005685 than your SDRAM module. If you have a 64MB SDRAM module, set
5686 it above 400_0000. Just make sure your board has no resources
5687 that are supposed to respond to that address! That code in
5688 start.S has been around a while and should work as is when
5689 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005690
wdenk6c59edc2004-05-03 20:45:30 +00005691 -Chris Hallinan
5692 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694It is essential to remember this, since it has some impact on the C
5695code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005696
wdenk6c59edc2004-05-03 20:45:30 +00005697* Initialized global data (data segment) is read-only. Do not attempt
5698 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005699
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005700* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005701 as zero data - BSS segment) at all - this is undefined, initiali-
5702 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005703
wdenk6c59edc2004-05-03 20:45:30 +00005704* Stack space is very limited. Avoid big data buffers or things like
5705 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005706
wdenk6c59edc2004-05-03 20:45:30 +00005707Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005708normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005709turned out that the implementation of U-Boot can be greatly
5710simplified by making a global data structure (gd_t) available to all
5711functions. We could pass a pointer to this data as argument to _all_
5712functions, but this would bloat the code. Instead we use a feature of
5713the GCC compiler (Global Register Variables) to share the data: we
5714place a pointer (gd) to the global data into a register which we
5715reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk6c59edc2004-05-03 20:45:30 +00005717When choosing a register for such a purpose we are restricted by the
5718relevant (E)ABI specifications for the current architecture, and by
5719GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005720
wdenk6c59edc2004-05-03 20:45:30 +00005721For PowerPC, the following registers have specific use:
5722 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005723 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005724 R3-R4: parameter passing and return values
5725 R5-R10: parameter passing
5726 R13: small data area pointer
5727 R30: GOT pointer
5728 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005729
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005730 (U-Boot also uses R12 as internal GOT pointer. r12
5731 is a volatile register so r12 needs to be reset when
5732 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005733
Wolfgang Denk69c09642008-02-14 22:43:22 +01005734 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk6c59edc2004-05-03 20:45:30 +00005736 Note: on PPC, we could use a static initializer (since the
5737 address of the global data structure is known at compile time),
5738 but it turned out that reserving a register results in somewhat
5739 smaller code - although the code savings are not that big (on
5740 average for all boards 752 bytes for the whole U-Boot image,
5741 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk6c59edc2004-05-03 20:45:30 +00005743On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk6c59edc2004-05-03 20:45:30 +00005745 R0: function argument word/integer result
5746 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005747 R9: platform specific
5748 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005749 R11: argument (frame) pointer
5750 R12: temporary workspace
5751 R13: stack pointer
5752 R14: link register
5753 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005754
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005755 ==> U-Boot will use R9 to hold a pointer to the global data
5756
5757 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005758
Thomas Chou8fa38582010-05-21 11:08:03 +08005759On Nios II, the ABI is documented here:
5760 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5761
5762 ==> U-Boot will use gp to hold a pointer to the global data
5763
5764 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5765 to access small data sections, so gp is free.
5766
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005767On NDS32, the following registers are used:
5768
5769 R0-R1: argument/return
5770 R2-R5: argument
5771 R15: temporary register for assembler
5772 R16: trampoline register
5773 R28: frame pointer (FP)
5774 R29: global pointer (GP)
5775 R30: link register (LP)
5776 R31: stack pointer (SP)
5777 PC: program counter (PC)
5778
5779 ==> U-Boot will use R10 to hold a pointer to the global data
5780
Wolfgang Denk6405a152006-03-31 18:32:53 +02005781NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5782or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005783
wdenk6c59edc2004-05-03 20:45:30 +00005784Memory Management:
5785------------------
wdenkc6097192002-11-03 00:24:07 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787U-Boot runs in system state and uses physical addresses, i.e. the
5788MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005789
wdenk6c59edc2004-05-03 20:45:30 +00005790The available memory is mapped to fixed addresses using the memory
5791controller. In this process, a contiguous block is formed for each
5792memory type (Flash, SDRAM, SRAM), even when it consists of several
5793physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005794
wdenk6c59edc2004-05-03 20:45:30 +00005795U-Boot is installed in the first 128 kB of the first Flash bank (on
5796TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5797booting and sizing and initializing DRAM, the code relocates itself
5798to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005799memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005800configuration setting]. Below that, a structure with global Board
5801Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005802
wdenk6c59edc2004-05-03 20:45:30 +00005803Additionally, some exception handler code is copied to the low 8 kB
5804of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk6c59edc2004-05-03 20:45:30 +00005806So a typical memory configuration with 16 MB of DRAM could look like
5807this:
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk6c59edc2004-05-03 20:45:30 +00005809 0x0000 0000 Exception Vector code
5810 :
5811 0x0000 1FFF
5812 0x0000 2000 Free for Application Use
5813 :
5814 :
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816 :
5817 :
5818 0x00FB FF20 Monitor Stack (Growing downward)
5819 0x00FB FFAC Board Info Data and permanent copy of global data
5820 0x00FC 0000 Malloc Arena
5821 :
5822 0x00FD FFFF
5823 0x00FE 0000 RAM Copy of Monitor Code
5824 ... eventually: LCD or video framebuffer
5825 ... eventually: pRAM (Protected RAM - unchanged by reset)
5826 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005827
wdenkc6097192002-11-03 00:24:07 +00005828
wdenk6c59edc2004-05-03 20:45:30 +00005829System Initialization:
5830----------------------
wdenkc6097192002-11-03 00:24:07 +00005831
wdenk6c59edc2004-05-03 20:45:30 +00005832In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005833(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005834configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005835To be able to re-map memory U-Boot then jumps to its link address.
5836To be able to implement the initialization code in C, a (small!)
5837initial stack is set up in the internal Dual Ported RAM (in case CPUs
5838which provide such a feature like MPC8xx or MPC8260), or in a locked
5839part of the data cache. After that, U-Boot initializes the CPU core,
5840the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005841
wdenk6c59edc2004-05-03 20:45:30 +00005842Next, all (potentially) available memory banks are mapped using a
5843preliminary mapping. For example, we put them on 512 MB boundaries
5844(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5845on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5846programmed for SDRAM access. Using the temporary configuration, a
5847simple memory test is run that determines the size of the SDRAM
5848banks.
wdenkc6097192002-11-03 00:24:07 +00005849
wdenk6c59edc2004-05-03 20:45:30 +00005850When there is more than one SDRAM bank, and the banks are of
5851different size, the largest is mapped first. For equal size, the first
5852bank (CS2#) is mapped first. The first mapping is always for address
58530x00000000, with any additional banks following immediately to create
5854contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005855
wdenk6c59edc2004-05-03 20:45:30 +00005856Then, the monitor installs itself at the upper end of the SDRAM area
5857and allocates memory for use by malloc() and for the global Board
5858Info data; also, the exception vector code is copied to the low RAM
5859pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005860
wdenk6c59edc2004-05-03 20:45:30 +00005861Only after this relocation will you have a "normal" C environment;
5862until that you are restricted in several ways, mostly because you are
5863running from ROM, and because the code will have to be relocated to a
5864new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005865
wdenkc6097192002-11-03 00:24:07 +00005866
wdenk6c59edc2004-05-03 20:45:30 +00005867U-Boot Porting Guide:
5868----------------------
wdenkc6097192002-11-03 00:24:07 +00005869
wdenk6c59edc2004-05-03 20:45:30 +00005870[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5871list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005872
wdenkc6097192002-11-03 00:24:07 +00005873
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005874int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005875{
5876 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005877
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005878 signal(SIGALRM, no_more_time);
5879 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk6c59edc2004-05-03 20:45:30 +00005881 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005882 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005883 return 0;
5884 }
wdenkc6097192002-11-03 00:24:07 +00005885
wdenk6c59edc2004-05-03 20:45:30 +00005886 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005887
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005888 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005889
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005890 if (clueless)
5891 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005892
wdenk6c59edc2004-05-03 20:45:30 +00005893 while (learning) {
5894 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005895 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5896 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005897 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005898 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005899 }
wdenkc6097192002-11-03 00:24:07 +00005900
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005901 if (available_money > toLocalCurrency ($2500))
5902 Buy a BDI3000;
5903 else
wdenk6c59edc2004-05-03 20:45:30 +00005904 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005905
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005906 if (a similar board exists) { /* hopefully... */
5907 cp -a board/<similar> board/<myboard>
5908 cp include/configs/<similar>.h include/configs/<myboard>.h
5909 } else {
5910 Create your own board support subdirectory;
5911 Create your own board include/configs/<myboard>.h file;
5912 }
5913 Edit new board/<myboard> files
5914 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005915
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005916 while (!accepted) {
5917 while (!running) {
5918 do {
5919 Add / modify source code;
5920 } until (compiles);
5921 Debug;
5922 if (clueless)
5923 email("Hi, I am having problems...");
5924 }
5925 Send patch file to the U-Boot email list;
5926 if (reasonable critiques)
5927 Incorporate improvements from email list code review;
5928 else
5929 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005930 }
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk6c59edc2004-05-03 20:45:30 +00005932 return 0;
5933}
wdenkc6097192002-11-03 00:24:07 +00005934
wdenk6c59edc2004-05-03 20:45:30 +00005935void no_more_time (int sig)
5936{
5937 hire_a_guru();
5938}
wdenkc6097192002-11-03 00:24:07 +00005939
wdenkc6097192002-11-03 00:24:07 +00005940
wdenk6c59edc2004-05-03 20:45:30 +00005941Coding Standards:
5942-----------------
wdenkc6097192002-11-03 00:24:07 +00005943
wdenk6c59edc2004-05-03 20:45:30 +00005944All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005945coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005946"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005947
5948Source files originating from a different project (for example the
5949MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005950reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005951sources.
wdenkc6097192002-11-03 00:24:07 +00005952
Detlev Zundelaa63d482006-09-01 15:39:02 +02005953Please note that U-Boot is implemented in C (and to some small parts in
5954Assembler); no C++ is used, so please do not use C++ style comments (//)
5955in your code.
wdenkad276f22004-01-04 16:28:35 +00005956
wdenk6c59edc2004-05-03 20:45:30 +00005957Please also stick to the following formatting rules:
5958- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005959- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005960- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005961- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005962- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005963
wdenk6c59edc2004-05-03 20:45:30 +00005964Submissions which do not conform to the standards may be returned
5965with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005966
wdenkc6097192002-11-03 00:24:07 +00005967
wdenk6c59edc2004-05-03 20:45:30 +00005968Submitting Patches:
5969-------------------
wdenkc6097192002-11-03 00:24:07 +00005970
wdenk6c59edc2004-05-03 20:45:30 +00005971Since the number of patches for U-Boot is growing, we need to
5972establish some rules. Submissions which do not conform to these rules
5973may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005974
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005975Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005976
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005977Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5978see http://lists.denx.de/mailman/listinfo/u-boot
5979
wdenk6c59edc2004-05-03 20:45:30 +00005980When you send a patch, please include the following information with
5981it:
wdenkc6097192002-11-03 00:24:07 +00005982
wdenk6c59edc2004-05-03 20:45:30 +00005983* For bug fixes: a description of the bug and how your patch fixes
5984 this bug. Please try to include a way of demonstrating that the
5985 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005986
wdenk6c59edc2004-05-03 20:45:30 +00005987* For new features: a description of the feature and your
5988 implementation.
wdenkc6097192002-11-03 00:24:07 +00005989
wdenk6c59edc2004-05-03 20:45:30 +00005990* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005991
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005992* For major contributions, add a MAINTAINERS file with your
5993 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005994
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005995* When you add support for a new board, don't forget to add a
5996 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005997
wdenk6c59edc2004-05-03 20:45:30 +00005998* If your patch adds new configuration options, don't forget to
5999 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006000
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006001* The patch itself. If you are using git (which is *strongly*
6002 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006003 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006004 the U-Boot mailing list, you will avoid most of the common problems
6005 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006006
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006007 If you cannot use git, use "diff -purN OLD NEW". If your version of
6008 diff does not support these options, then get the latest version of
6009 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006010
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006011 The current directory when running this command shall be the parent
6012 directory of the U-Boot source tree (i. e. please make sure that
6013 your patch includes sufficient directory information for the
6014 affected files).
6015
6016 We prefer patches as plain text. MIME attachments are discouraged,
6017 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006018
wdenk6c59edc2004-05-03 20:45:30 +00006019* If one logical set of modifications affects or creates several
6020 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006021
wdenk6c59edc2004-05-03 20:45:30 +00006022* Changesets that contain different, unrelated modifications shall be
6023 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006024
wdenkc6097192002-11-03 00:24:07 +00006025
wdenk6c59edc2004-05-03 20:45:30 +00006026Notes:
wdenkc6097192002-11-03 00:24:07 +00006027
Simon Glassdc27def2016-07-27 20:33:08 -06006028* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006029 source tree and make sure that no errors or warnings are reported
6030 for any of the boards.
6031
6032* Keep your modifications to the necessary minimum: A patch
6033 containing several unrelated changes or arbitrary reformats will be
6034 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006035
wdenk6c59edc2004-05-03 20:45:30 +00006036* If you modify existing code, make sure that your new code does not
6037 add to the memory footprint of the code ;-) Small is beautiful!
6038 When adding new features, these should compile conditionally only
6039 (using #ifdef), and the resulting code with the new feature
6040 disabled must not need more memory than the old code without your
6041 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006042
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006043* Remember that there is a size limit of 100 kB per message on the
6044 u-boot mailing list. Bigger patches will be moderated. If they are
6045 reasonable and not too big, they will be acknowledged. But patches
6046 bigger than the size limit should be avoided.