blob: d31cca108271e0a0f8c2ef9b532a03804ce2e00a [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
Peter Tyser15258042008-12-17 16:36:22 -0600833 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
Peter Tyser15258042008-12-17 16:36:22 -0600834 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
835 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500836 CONFIG_CMD_DTT * Digital Therm and Thermostat
837 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500838 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500839 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanov37dda1c2016-04-16 17:55:03 +0300840 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500841 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600842 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600843 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500844 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500845 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000846 CONFIG_CMD_EXT2 * ext2 command support
847 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700848 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
849 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100850 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500851 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500852 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000853 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500854 CONFIG_CMD_FLASH flinfo, erase, protect
855 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200856 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000857 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500858 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000859 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000860 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500861 CONFIG_CMD_I2C * I2C serial bus support
862 CONFIG_CMD_IDE * IDE harddisk support
863 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000864 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200865 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500866 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -0600867 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500868 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000869 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500870 CONFIG_CMD_IRQ * irqinfo
871 CONFIG_CMD_ITEST Integer/string test of 2 values
872 CONFIG_CMD_JFFS2 * JFFS2 Support
873 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200874 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000875 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
876 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500877 CONFIG_CMD_LOADB loadb
878 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200879 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400880 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000881 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500882 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000883 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200884 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500885 CONFIG_CMD_MISC Misc functions like sleep etc
886 CONFIG_CMD_MMC * MMC memory mapped support
887 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100888 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500889 CONFIG_CMD_NAND * NAND support
890 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200891 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600892 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000893 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500894 CONFIG_CMD_PCI * pciinfo
895 CONFIG_CMD_PCMCIA * PCMCIA support
896 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
897 host
898 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000899 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500900 CONFIG_CMD_REGINFO * Register dump
901 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000902 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500903 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600904 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500905 CONFIG_CMD_SDRAM * print SDRAM configuration information
906 (requires CONFIG_CMD_I2C)
907 CONFIG_CMD_SETGETDCR Support for DCR Register access
908 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700909 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200910 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400911 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800912 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200913 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500914 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000915 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000916 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000917 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
918 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500919 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500920 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000921 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200922 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200923 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000924
925 EXAMPLE: If you want all functions except of network
926 support you can write:
927
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500928 #include "config_cmd_all.h"
929 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000930
Gerald Van Barend6abef42007-03-31 12:23:51 -0400931 Other Commands:
932 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000933
934 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500935 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000936 what you (and your U-Boot users) are doing. Data
937 cache cannot be enabled on systems like the 8xx or
938 8260 (where accesses to the IMMR region must be
939 uncached), and it cannot be disabled on all other
940 systems where we (mis-) use the data cache to hold an
941 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000942
943
944 XXX - this list needs to get updated!
945
Simon Glassaa34ef22016-03-13 19:07:28 -0600946- Removal of commands
947 If no commands are needed to boot, you can disable
948 CONFIG_CMDLINE to remove them. In this case, the command line
949 will not be available, and when U-Boot wants to execute the
950 boot command (on start-up) it will call board_run_command()
951 instead. This can reduce image size significantly for very
952 simple boot procedures.
953
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000954- Regular expression support:
955 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200956 If this variable is defined, U-Boot is linked against
957 the SLRE (Super Light Regular Expression) library,
958 which adds regex support to some commands, as for
959 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000960
Simon Glass3d686442011-10-15 05:48:20 +0000961- Device tree:
962 CONFIG_OF_CONTROL
963 If this variable is defined, U-Boot will use a device tree
964 to configure its devices, instead of relying on statically
965 compiled #defines in the board file. This option is
966 experimental and only available on a few boards. The device
967 tree is available in the global data as gd->fdt_blob.
968
Simon Glass5cb34db2011-10-24 19:15:31 +0000969 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700970 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000971
972 CONFIG_OF_EMBED
973 If this variable is defined, U-Boot will embed a device tree
974 binary in its image. This device tree file should be in the
975 board directory and called <soc>-<board>.dts. The binary file
976 is then picked up in board_init_f() and made available through
977 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000978
Simon Glass5cb34db2011-10-24 19:15:31 +0000979 CONFIG_OF_SEPARATE
980 If this variable is defined, U-Boot will build a device tree
981 binary. It will be called u-boot.dtb. Architecture-specific
982 code will locate it at run-time. Generally this works by:
983
984 cat u-boot.bin u-boot.dtb >image.bin
985
986 and in fact, U-Boot does this for you, creating a file called
987 u-boot-dtb.bin which is useful in the common case. You can
988 still use the individual files if you need something more
989 exotic.
990
Alex Deymo5b661ec2017-04-02 01:25:20 -0700991 CONFIG_OF_BOARD
992 If this variable is defined, U-Boot will use the device tree
993 provided by the board at runtime instead of embedding one with
994 the image. Only boards defining board_fdt_blob_setup() support
995 this option (see include/fdtdec.h file).
996
wdenkc6097192002-11-03 00:24:07 +0000997- Watchdog:
998 CONFIG_WATCHDOG
999 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001000 support for the SoC. There must be support in the SoC
1001 specific code for a watchdog. For the 8xx and 8260
1002 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1003 register. When supported for a specific SoC is
1004 available, then no further board specific code should
1005 be needed to use it.
1006
1007 CONFIG_HW_WATCHDOG
1008 When using a watchdog circuitry external to the used
1009 SoC, then define this variable and provide board
1010 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001011
Heiko Schocher735326c2015-01-21 08:38:22 +01001012 CONFIG_AT91_HW_WDT_TIMEOUT
1013 specify the timeout in seconds. default 2 seconds.
1014
stroeseb9c17c52003-04-04 15:53:41 +00001015- U-Boot Version:
1016 CONFIG_VERSION_VARIABLE
1017 If this variable is defined, an environment variable
1018 named "ver" is created by U-Boot showing the U-Boot
1019 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001020 Any change to this variable will be reverted at the
1021 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001022
wdenkc6097192002-11-03 00:24:07 +00001023- Real-Time Clock:
1024
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001025 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001026 has to be selected, too. Define exactly one of the
1027 following options:
1028
1029 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1030 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001031 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001032 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001033 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001034 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001035 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001036 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001037 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001038 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001039 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001040 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001041 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1042 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001043
wdenkb9bbd242003-06-30 16:24:52 +00001044 Note that if the RTC uses I2C, then the I2C interface
1045 must also be configured. See I2C Support, below.
1046
Peter Tyser9902e422008-12-17 16:36:21 -06001047- GPIO Support:
1048 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001049
Chris Packham9b383202010-12-19 10:12:13 +00001050 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1051 chip-ngpio pairs that tell the PCA953X driver the number of
1052 pins supported by a particular chip.
1053
Peter Tyser9902e422008-12-17 16:36:21 -06001054 Note that if the GPIO device uses I2C, then the I2C interface
1055 must also be configured. See I2C Support, below.
1056
Simon Glass4dc47ca2014-06-11 23:29:41 -06001057- I/O tracing:
1058 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1059 accesses and can checksum them or write a list of them out
1060 to memory. See the 'iotrace' command for details. This is
1061 useful for testing device drivers since it can confirm that
1062 the driver behaves the same way before and after a code
1063 change. Currently this is supported on sandbox and arm. To
1064 add support for your architecture, add '#include <iotrace.h>'
1065 to the bottom of arch/<arch>/include/asm/io.h and test.
1066
1067 Example output from the 'iotrace stats' command is below.
1068 Note that if the trace buffer is exhausted, the checksum will
1069 still continue to operate.
1070
1071 iotrace is enabled
1072 Start: 10000000 (buffer start address)
1073 Size: 00010000 (buffer size)
1074 Offset: 00000120 (current buffer offset)
1075 Output: 10000120 (start + offset)
1076 Count: 00000018 (number of trace records)
1077 CRC32: 9526fb66 (CRC32 of all trace records)
1078
wdenkc6097192002-11-03 00:24:07 +00001079- Timestamp Support:
1080
wdenk4a5c8a72003-03-06 00:02:04 +00001081 When CONFIG_TIMESTAMP is selected, the timestamp
1082 (date and time) of an image is printed by image
1083 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001084 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001085
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001086- Partition Labels (disklabels) Supported:
1087 Zero or more of the following:
1088 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1089 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1090 Intel architecture, USB sticks, etc.
1091 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1092 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1093 bootloader. Note 2TB partition limit; see
1094 disk/part_efi.c
1095 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001096
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001097 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001098 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001099 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001100
1101- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001102 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1103 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001104
wdenk369d43d2004-03-14 14:09:05 +00001105 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1106 be performed by calling the function
1107 ide_set_reset(int reset)
1108 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001109
1110- ATAPI Support:
1111 CONFIG_ATAPI
1112
1113 Set this to enable ATAPI support.
1114
wdenkf602aa02004-03-13 23:29:43 +00001115- LBA48 Support
1116 CONFIG_LBA48
1117
1118 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001119 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001120 Whithout these , LBA48 support uses 32bit variables and will 'only'
1121 support disks up to 2.1TB.
1122
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001123 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001124 When enabled, makes the IDE subsystem use 64bit sector addresses.
1125 Default is 32bit.
1126
wdenkc6097192002-11-03 00:24:07 +00001127- SCSI Support:
1128 At the moment only there is only support for the
1129 SYM53C8XX SCSI controller; define
1130 CONFIG_SCSI_SYM53C8XX to enable it.
1131
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001132 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1133 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1134 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001135 maximum numbers of LUNs, SCSI ID's and target
1136 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001137 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001138
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001139 The environment variable 'scsidevs' is set to the number of
1140 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001141
wdenkc6097192002-11-03 00:24:07 +00001142- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001143 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001144 Support for Intel 8254x/8257x gigabit chips.
1145
1146 CONFIG_E1000_SPI
1147 Utility code for direct access to the SPI bus on Intel 8257x.
1148 This does not do anything useful unless you set at least one
1149 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1150
1151 CONFIG_E1000_SPI_GENERIC
1152 Allow generic access to the SPI bus on the Intel 8257x, for
1153 example with the "sspi" command.
1154
1155 CONFIG_CMD_E1000
1156 Management command for E1000 devices. When used on devices
1157 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001158
wdenkc6097192002-11-03 00:24:07 +00001159 CONFIG_EEPRO100
1160 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001161 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001162 write routine for first time initialisation.
1163
1164 CONFIG_TULIP
1165 Support for Digital 2114x chips.
1166 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1167 modem chip initialisation (KS8761/QS6611).
1168
1169 CONFIG_NATSEMI
1170 Support for National dp83815 chips.
1171
1172 CONFIG_NS8382X
1173 Support for National dp8382[01] gigabit chips.
1174
wdenkaa603362003-05-12 21:50:16 +00001175- NETWORK Support (other):
1176
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001177 CONFIG_DRIVER_AT91EMAC
1178 Support for AT91RM9200 EMAC.
1179
1180 CONFIG_RMII
1181 Define this to use reduced MII inteface
1182
1183 CONFIG_DRIVER_AT91EMAC_QUIET
1184 If this defined, the driver is quiet.
1185 The driver doen't show link status messages.
1186
Rob Herringc9830dc2011-12-15 11:15:49 +00001187 CONFIG_CALXEDA_XGMAC
1188 Support for the Calxeda XGMAC device
1189
Ashok93fb8722012-10-15 06:20:47 +00001190 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001191 Support for SMSC's LAN91C96 chips.
1192
wdenkaa603362003-05-12 21:50:16 +00001193 CONFIG_LAN91C96_USE_32_BIT
1194 Define this to enable 32 bit addressing
1195
Ashok93fb8722012-10-15 06:20:47 +00001196 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001197 Support for SMSC's LAN91C111 chip
1198
1199 CONFIG_SMC91111_BASE
1200 Define this to hold the physical address
1201 of the device (I/O space)
1202
1203 CONFIG_SMC_USE_32_BIT
1204 Define this if data bus is 32 bits
1205
1206 CONFIG_SMC_USE_IOFUNCS
1207 Define this to use i/o functions instead of macros
1208 (some hardware wont work with macros)
1209
Heiko Schocher7d037f72011-11-15 10:00:04 -05001210 CONFIG_DRIVER_TI_EMAC
1211 Support for davinci emac
1212
1213 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1214 Define this if you have more then 3 PHYs.
1215
Macpaul Lin199c6252010-12-21 16:59:46 +08001216 CONFIG_FTGMAC100
1217 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1218
1219 CONFIG_FTGMAC100_EGIGA
1220 Define this to use GE link update with gigabit PHY.
1221 Define this if FTGMAC100 is connected to gigabit PHY.
1222 If your system has 10/100 PHY only, it might not occur
1223 wrong behavior. Because PHY usually return timeout or
1224 useless data when polling gigabit status and gigabit
1225 control registers. This behavior won't affect the
1226 correctnessof 10/100 link speed update.
1227
Mike Rapoportf4761af2009-11-11 10:03:03 +02001228 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001229 Support for SMSC's LAN911x and LAN921x chips
1230
Mike Rapoportf4761af2009-11-11 10:03:03 +02001231 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001232 Define this to hold the physical address
1233 of the device (I/O space)
1234
Mike Rapoportf4761af2009-11-11 10:03:03 +02001235 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001236 Define this if data bus is 32 bits
1237
Mike Rapoportf4761af2009-11-11 10:03:03 +02001238 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001239 Define this if data bus is 16 bits. If your processor
1240 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001241 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001242
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001243 CONFIG_SH_ETHER
1244 Support for Renesas on-chip Ethernet controller
1245
1246 CONFIG_SH_ETHER_USE_PORT
1247 Define the number of ports to be used
1248
1249 CONFIG_SH_ETHER_PHY_ADDR
1250 Define the ETH PHY's address
1251
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001252 CONFIG_SH_ETHER_CACHE_WRITEBACK
1253 If this option is set, the driver enables cache flush.
1254
Heiko Schocher2b387762014-07-18 06:07:19 +02001255- PWM Support:
1256 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001257 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001258
Vadim Bendeburydac69642011-10-17 08:36:14 +00001259- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001260 CONFIG_TPM
1261 Support TPM devices.
1262
Christophe Ricard8759ff82015-10-06 22:54:41 +02001263 CONFIG_TPM_TIS_INFINEON
1264 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001265 per system is supported at this time.
1266
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001267 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1268 Define the burst count bytes upper limit
1269
Christophe Ricard88249232016-01-21 23:27:13 +01001270 CONFIG_TPM_ST33ZP24
1271 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1272
1273 CONFIG_TPM_ST33ZP24_I2C
1274 Support for STMicroelectronics ST33ZP24 I2C devices.
1275 Requires TPM_ST33ZP24 and I2C.
1276
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001277 CONFIG_TPM_ST33ZP24_SPI
1278 Support for STMicroelectronics ST33ZP24 SPI devices.
1279 Requires TPM_ST33ZP24 and SPI.
1280
Dirk Eibach20489092013-06-26 15:55:15 +02001281 CONFIG_TPM_ATMEL_TWI
1282 Support for Atmel TWI TPM device. Requires I2C support.
1283
Che-liang Chiouacea5702013-04-12 11:04:34 +00001284 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001285 Support for generic parallel port TPM devices. Only one device
1286 per system is supported at this time.
1287
1288 CONFIG_TPM_TIS_BASE_ADDRESS
1289 Base address where the generic TPM device is mapped
1290 to. Contemporary x86 systems usually map it at
1291 0xfed40000.
1292
Reinhard Pfau4fece432013-06-26 15:55:13 +02001293 CONFIG_CMD_TPM
1294 Add tpm monitor functions.
1295 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1296 provides monitor access to authorized functions.
1297
1298 CONFIG_TPM
1299 Define this to enable the TPM support library which provides
1300 functional interfaces to some TPM commands.
1301 Requires support for a TPM device.
1302
1303 CONFIG_TPM_AUTH_SESSIONS
1304 Define this to enable authorized functions in the TPM library.
1305 Requires CONFIG_TPM and CONFIG_SHA1.
1306
wdenkc6097192002-11-03 00:24:07 +00001307- USB Support:
1308 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001309 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001310 CONFIG_USB_UHCI to enable it.
1311 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001312 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001313 storage devices.
1314 Note:
1315 Supported are USB Keyboards and USB Floppy drives
1316 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001317 MPC5200 USB requires additional defines:
1318 CONFIG_USB_CLOCK
1319 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001320 CONFIG_PSC3_USB
1321 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001322 CONFIG_USB_CONFIG
1323 for differential drivers: 0x00001000
1324 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001325 for differential drivers on PSC3: 0x00000100
1326 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001327 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001328 May be defined to allow interrupt polling
1329 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001330
Simon Glass5978cdb2012-02-27 10:52:47 +00001331 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1332 txfilltuning field in the EHCI controller on reset.
1333
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001334 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1335 HW module registers.
1336
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001337- USB Device:
1338 Define the below if you wish to use the USB console.
1339 Once firmware is rebuilt from a serial console issue the
1340 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001341 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001342 it has found a new device. The environment variable usbtty
1343 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001344 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001345 Common Device Class Abstract Control Model serial device.
1346 If you select usbtty = gserial you should be able to enumerate
1347 a Linux host by
1348 # modprobe usbserial vendor=0xVendorID product=0xProductID
1349 else if using cdc_acm, simply setting the environment
1350 variable usbtty to be cdc_acm should suffice. The following
1351 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001352
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001353 CONFIG_USB_DEVICE
1354 Define this to build a UDC device
1355
1356 CONFIG_USB_TTY
1357 Define this to have a tty type of device available to
1358 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001359
Vipin KUMARbdb17702012-03-26 15:38:06 +05301360 CONFIG_USBD_HS
1361 Define this to enable the high speed support for usb
1362 device and usbtty. If this feature is enabled, a routine
1363 int is_usbd_high_speed(void)
1364 also needs to be defined by the driver to dynamically poll
1365 whether the enumeration has succeded at high speed or full
1366 speed.
1367
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001368 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001369 Define this if you want stdin, stdout &/or stderr to
1370 be set to usbtty.
1371
1372 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001373 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001374 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001375 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001376
Wolfgang Denke2601822006-06-14 18:14:56 +02001377 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001378 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001379 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001380 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1381 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1382 should pretend to be a Linux device to it's target host.
1383
1384 CONFIG_USBD_MANUFACTURER
1385 Define this string as the name of your company for
1386 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001387
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001388 CONFIG_USBD_PRODUCT_NAME
1389 Define this string as the name of your product
1390 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001391
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001392 CONFIG_USBD_VENDORID
1393 Define this as your assigned Vendor ID from the USB
1394 Implementors Forum. This *must* be a genuine Vendor ID
1395 to avoid polluting the USB namespace.
1396 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001397
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001398 CONFIG_USBD_PRODUCTID
1399 Define this as the unique Product ID
1400 for your device
1401 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001402
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001403- ULPI Layer Support:
1404 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1405 the generic ULPI layer. The generic layer accesses the ULPI PHY
1406 via the platform viewport, so you need both the genric layer and
1407 the viewport enabled. Currently only Chipidea/ARC based
1408 viewport is supported.
1409 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1410 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001411 If your ULPI phy needs a different reference clock than the
1412 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1413 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001414
wdenk7a428cc2003-06-15 22:40:42 +00001415- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001416 The MMC controller on the Intel PXA is supported. To
1417 enable this define CONFIG_MMC. The MMC can be
1418 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001419 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001420 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1421 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001422
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001423 CONFIG_SH_MMCIF
1424 Support for Renesas on-chip MMCIF controller
1425
1426 CONFIG_SH_MMCIF_ADDR
1427 Define the base address of MMCIF registers
1428
1429 CONFIG_SH_MMCIF_CLK
1430 Define the clock frequency for MMCIF
1431
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001432 CONFIG_SUPPORT_EMMC_BOOT
1433 Enable some additional features of the eMMC boot partitions.
1434
1435 CONFIG_SUPPORT_EMMC_RPMB
1436 Enable the commands for reading, writing and programming the
1437 key for the Replay Protection Memory Block partition in eMMC.
1438
Tom Rini58a8d322013-03-14 05:32:47 +00001439- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001440 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001441 This enables the USB portion of the DFU USB class
1442
1443 CONFIG_CMD_DFU
1444 This enables the command "dfu" which is used to have
1445 U-Boot create a DFU class device via USB. This command
1446 requires that the "dfu_alt_info" environment variable be
1447 set and define the alt settings to expose to the host.
1448
1449 CONFIG_DFU_MMC
1450 This enables support for exposing (e)MMC devices via DFU.
1451
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001452 CONFIG_DFU_NAND
1453 This enables support for exposing NAND devices via DFU.
1454
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301455 CONFIG_DFU_RAM
1456 This enables support for exposing RAM via DFU.
1457 Note: DFU spec refer to non-volatile memory usage, but
1458 allow usages beyond the scope of spec - here RAM usage,
1459 one that would help mostly the developer.
1460
Heiko Schochera2f831e2013-06-12 06:05:51 +02001461 CONFIG_SYS_DFU_DATA_BUF_SIZE
1462 Dfu transfer uses a buffer before writing data to the
1463 raw storage device. Make the size (in bytes) of this buffer
1464 configurable. The size of this buffer is also configurable
1465 through the "dfu_bufsiz" environment variable.
1466
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001467 CONFIG_SYS_DFU_MAX_FILE_SIZE
1468 When updating files rather than the raw storage device,
1469 we use a static buffer to copy the file into and then write
1470 the buffer once we've been given the whole file. Define
1471 this to the maximum filesize (in bytes) for the buffer.
1472 Default is 4 MiB if undefined.
1473
Heiko Schochere1ba1512014-03-18 08:09:56 +01001474 DFU_DEFAULT_POLL_TIMEOUT
1475 Poll timeout [ms], is the timeout a device can send to the
1476 host. The host must wait for this timeout before sending
1477 a subsequent DFU_GET_STATUS request to the device.
1478
1479 DFU_MANIFEST_POLL_TIMEOUT
1480 Poll timeout [ms], which the device sends to the host when
1481 entering dfuMANIFEST state. Host waits this timeout, before
1482 sending again an USB request to the device.
1483
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001484- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001485 CONFIG_USB_FUNCTION_FASTBOOT
1486 This enables the USB part of the fastboot gadget
1487
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001488 CONFIG_CMD_FASTBOOT
1489 This enables the command "fastboot" which enables the Android
1490 fastboot mode for the platform's USB device. Fastboot is a USB
1491 protocol for downloading images, flashing and device control
1492 used on Android devices.
1493 See doc/README.android-fastboot for more information.
1494
1495 CONFIG_ANDROID_BOOT_IMAGE
1496 This enables support for booting images which use the Android
1497 image format header.
1498
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001499 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001500 The fastboot protocol requires a large memory buffer for
1501 downloads. Define this to the starting RAM address to use for
1502 downloaded images.
1503
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001504 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001505 The fastboot protocol requires a large memory buffer for
1506 downloads. This buffer should be as large as possible for a
1507 platform. Define this to the size available RAM for fastboot.
1508
Steve Raebfb9ba42014-08-26 11:47:28 -07001509 CONFIG_FASTBOOT_FLASH
1510 The fastboot protocol includes a "flash" command for writing
1511 the downloaded image to a non-volatile storage device. Define
1512 this to enable the "fastboot flash" command.
1513
1514 CONFIG_FASTBOOT_FLASH_MMC_DEV
1515 The fastboot "flash" command requires additional information
1516 regarding the non-volatile storage device. Define this to
1517 the eMMC device that fastboot should use to store the image.
1518
Steve Rae7d059342014-12-12 15:51:54 -08001519 CONFIG_FASTBOOT_GPT_NAME
1520 The fastboot "flash" command supports writing the downloaded
1521 image to the Protective MBR and the Primary GUID Partition
1522 Table. (Additionally, this downloaded image is post-processed
1523 to generate and write the Backup GUID Partition Table.)
1524 This occurs when the specified "partition name" on the
1525 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001526 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001527
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001528 CONFIG_FASTBOOT_MBR_NAME
1529 The fastboot "flash" command supports writing the downloaded
1530 image to DOS MBR.
1531 This occurs when the "partition name" specified on the
1532 "fastboot flash" command line matches this value.
1533 If not defined the default value "mbr" is used.
1534
wdenkda04a8b2004-08-02 23:22:59 +00001535- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001536 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001537 Define these for a default partition on a NAND device
1538
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001539 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1540 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001541 Define these for a default partition on a NOR device
1542
Donggeun Kim8f814002011-10-24 21:15:28 +00001543- FAT(File Allocation Table) filesystem write function support:
1544 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001545
1546 Define this to enable support for saving memory data as a
1547 file in FAT formatted partition.
1548
1549 This will also enable the command "fatwrite" enabling the
1550 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001551
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301552- FAT(File Allocation Table) filesystem cluster size:
1553 CONFIG_FS_FAT_MAX_CLUSTSIZE
1554
1555 Define the max cluster size for fat operations else
1556 a default value of 65536 will be defined.
1557
wdenkc6097192002-11-03 00:24:07 +00001558- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001559 See Kconfig help for available keyboard drivers.
1560
1561 CONFIG_KEYBOARD
1562
1563 Define this to enable a custom keyboard support.
1564 This simply calls drv_keyboard_init() which must be
1565 defined in your board-specific files. This option is deprecated
1566 and is only used by novena. For new boards, use driver model
1567 instead.
wdenkc6097192002-11-03 00:24:07 +00001568
1569- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001570 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001571 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001572 SOCs that have a DIU should define this macro to enable DIU
1573 support, and should also define these other macros:
1574
1575 CONFIG_SYS_DIU_ADDR
1576 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001577 CONFIG_CFB_CONSOLE
1578 CONFIG_VIDEO_SW_CURSOR
1579 CONFIG_VGA_AS_SINGLE_DEVICE
1580 CONFIG_VIDEO_LOGO
1581 CONFIG_VIDEO_BMP_LOGO
1582
Timur Tabi32f709e2011-04-11 14:18:22 -05001583 The DIU driver will look for the 'video-mode' environment
1584 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001585 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001586 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001587
wdenkc6097192002-11-03 00:24:07 +00001588- LCD Support: CONFIG_LCD
1589
1590 Define this to enable LCD support (for output to LCD
1591 display); also select one of the supported displays
1592 by defining one of these:
1593
Stelian Popf6f86652008-05-09 21:57:18 +02001594 CONFIG_ATMEL_LCD:
1595
1596 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1597
wdenkc0d54ae2003-11-25 16:55:19 +00001598 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001599
wdenkc0d54ae2003-11-25 16:55:19 +00001600 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001601
wdenkc0d54ae2003-11-25 16:55:19 +00001602 CONFIG_NEC_NL6448BC20
1603
1604 NEC NL6448BC20-08. 6.5", 640x480.
1605 Active, color, single scan.
1606
1607 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001608
wdenkc0d54ae2003-11-25 16:55:19 +00001609 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001610 Active, color, single scan.
1611
1612 CONFIG_SHARP_16x9
1613
1614 Sharp 320x240. Active, color, single scan.
1615 It isn't 16x9, and I am not sure what it is.
1616
1617 CONFIG_SHARP_LQ64D341
1618
1619 Sharp LQ64D341 display, 640x480.
1620 Active, color, single scan.
1621
1622 CONFIG_HLD1045
1623
1624 HLD1045 display, 640x480.
1625 Active, color, single scan.
1626
1627 CONFIG_OPTREX_BW
1628
1629 Optrex CBL50840-2 NF-FW 99 22 M5
1630 or
1631 Hitachi LMG6912RPFC-00T
1632 or
1633 Hitachi SP14Q002
1634
1635 320x240. Black & white.
1636
Simon Glass599a4df2012-10-17 13:24:54 +00001637 CONFIG_LCD_ALIGNMENT
1638
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001639 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001640 defined then the LCD will be aligned to this value instead.
1641 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1642 here, since it is cheaper to change data cache settings on
1643 a per-section basis.
1644
1645
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001646 CONFIG_LCD_ROTATION
1647
1648 Sometimes, for example if the display is mounted in portrait
1649 mode or even if it's mounted landscape but rotated by 180degree,
1650 we need to rotate our content of the display relative to the
1651 framebuffer, so that user can read the messages which are
1652 printed out.
1653 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1654 initialized with a given rotation from "vl_rot" out of
1655 "vidinfo_t" which is provided by the board specific code.
1656 The value for vl_rot is coded as following (matching to
1657 fbcon=rotate:<n> linux-kernel commandline):
1658 0 = no rotation respectively 0 degree
1659 1 = 90 degree rotation
1660 2 = 180 degree rotation
1661 3 = 270 degree rotation
1662
1663 If CONFIG_LCD_ROTATION is not defined, the console will be
1664 initialized with 0degree rotation.
1665
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001666 CONFIG_LCD_BMP_RLE8
1667
1668 Support drawing of RLE8-compressed bitmaps on the LCD.
1669
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001670 CONFIG_I2C_EDID
1671
1672 Enables an 'i2c edid' command which can read EDID
1673 information over I2C from an attached LCD display.
1674
wdenkeb20ad32003-09-05 23:19:14 +00001675- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001676
wdenk57b2d802003-06-27 21:31:46 +00001677 If this option is set, the environment is checked for
1678 a variable "splashimage". If found, the usual display
1679 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001680 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001681 specified in "splashimage" is loaded instead. The
1682 console is redirected to the "nulldev", too. This
1683 allows for a "silent" boot where a splash screen is
1684 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001685
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001686 CONFIG_SPLASHIMAGE_GUARD
1687
1688 If this option is set, then U-Boot will prevent the environment
1689 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001690 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001691 This option is useful for targets where, due to alignment
1692 restrictions, an improperly aligned BMP image will cause a data
1693 abort. If you think you will not have problems with unaligned
1694 accesses (for example because your toolchain prevents them)
1695 there is no need to set this option.
1696
Matthias Weisser53884182009-07-09 16:07:30 +02001697 CONFIG_SPLASH_SCREEN_ALIGN
1698
1699 If this option is set the splash image can be freely positioned
1700 on the screen. Environment variable "splashpos" specifies the
1701 position as "x,y". If a positive number is given it is used as
1702 number of pixel from left/top. If a negative number is given it
1703 is used as number of pixel from right/bottom. You can also
1704 specify 'm' for centering the image.
1705
1706 Example:
1707 setenv splashpos m,m
1708 => image at center of screen
1709
1710 setenv splashpos 30,20
1711 => image at x = 30 and y = 20
1712
1713 setenv splashpos -10,m
1714 => vertically centered image
1715 at x = dspWidth - bmpWidth - 9
1716
Stefan Roesed9d97742005-09-22 09:04:17 +02001717- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1718
1719 If this option is set, additionally to standard BMP
1720 images, gzipped BMP images can be displayed via the
1721 splashscreen support or the bmp command.
1722
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001723- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1724
1725 If this option is set, 8-bit RLE compressed BMP images
1726 can be displayed via the splashscreen support or the
1727 bmp command.
1728
wdenk710e3502003-08-29 20:57:53 +00001729- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001730 CONFIG_GZIP
1731
1732 Enabled by default to support gzip compressed images.
1733
wdenk710e3502003-08-29 20:57:53 +00001734 CONFIG_BZIP2
1735
1736 If this option is set, support for bzip2 compressed
1737 images is included. If not, only uncompressed and gzip
1738 compressed images are supported.
1739
wdenk9c53f402003-10-15 23:53:47 +00001740 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001741 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001742 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001743
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001744 CONFIG_LZMA
1745
1746 If this option is set, support for lzma compressed
1747 images is included.
1748
1749 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1750 requires an amount of dynamic memory that is given by the
1751 formula:
1752
1753 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1754
1755 Where lc and lp stand for, respectively, Literal context bits
1756 and Literal pos bits.
1757
1758 This value is upper-bounded by 14MB in the worst case. Anyway,
1759 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1760 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1761 a very small buffer.
1762
1763 Use the lzmainfo tool to determinate the lc and lp values and
1764 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001765 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001766
Kees Cook5b06e642013-08-16 07:59:12 -07001767 CONFIG_LZO
1768
1769 If this option is set, support for LZO compressed images
1770 is included.
1771
wdenk0e2bd9c2004-06-06 21:51:03 +00001772- MII/PHY support:
1773 CONFIG_PHY_ADDR
1774
1775 The address of PHY on MII bus.
1776
1777 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1778
1779 The clock frequency of the MII bus
1780
1781 CONFIG_PHY_GIGE
1782
1783 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001784 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001785
1786 CONFIG_PHY_RESET_DELAY
1787
1788 Some PHY like Intel LXT971A need extra delay after
1789 reset before any MII register access is possible.
1790 For such PHY, set this option to the usec delay
1791 required. (minimum 300usec for LXT971A)
1792
1793 CONFIG_PHY_CMD_DELAY (ppc4xx)
1794
1795 Some PHY like Intel LXT971A need extra delay after
1796 command issued before MII status register can be read
1797
wdenkc6097192002-11-03 00:24:07 +00001798- IP address:
1799 CONFIG_IPADDR
1800
1801 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001802 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001803 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001804 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001805
1806- Server IP address:
1807 CONFIG_SERVERIP
1808
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001809 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001810 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001811 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001812
Robin Getz470a6d42009-07-21 12:15:28 -04001813 CONFIG_KEEP_SERVERADDR
1814
1815 Keeps the server's MAC address, in the env 'serveraddr'
1816 for passing to bootargs (like Linux's netconsole option)
1817
Wolfgang Denk26da2992011-10-26 10:21:22 +00001818- Gateway IP address:
1819 CONFIG_GATEWAYIP
1820
1821 Defines a default value for the IP address of the
1822 default router where packets to other networks are
1823 sent to.
1824 (Environment variable "gatewayip")
1825
1826- Subnet mask:
1827 CONFIG_NETMASK
1828
1829 Defines a default value for the subnet mask (or
1830 routing prefix) which is used to determine if an IP
1831 address belongs to the local subnet or needs to be
1832 forwarded through a router.
1833 (Environment variable "netmask")
1834
David Updegraff7280da72007-06-11 10:41:07 -05001835- Multicast TFTP Mode:
1836 CONFIG_MCAST_TFTP
1837
1838 Defines whether you want to support multicast TFTP as per
1839 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001840 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001841 driver in use must provide a function: mcast() to join/leave a
1842 multicast group.
1843
wdenkc6097192002-11-03 00:24:07 +00001844- BOOTP Recovery Mode:
1845 CONFIG_BOOTP_RANDOM_DELAY
1846
1847 If you have many targets in a network that try to
1848 boot using BOOTP, you may want to avoid that all
1849 systems send out BOOTP requests at precisely the same
1850 moment (which would happen for instance at recovery
1851 from a power failure, when all systems will try to
1852 boot, thus flooding the BOOTP server. Defining
1853 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1854 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001855 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001856
1857 1st BOOTP request: delay 0 ... 1 sec
1858 2nd BOOTP request: delay 0 ... 2 sec
1859 3rd BOOTP request: delay 0 ... 4 sec
1860 4th and following
1861 BOOTP requests: delay 0 ... 8 sec
1862
Thierry Reding8977cda2014-08-19 10:21:24 +02001863 CONFIG_BOOTP_ID_CACHE_SIZE
1864
1865 BOOTP packets are uniquely identified using a 32-bit ID. The
1866 server will copy the ID from client requests to responses and
1867 U-Boot will use this to determine if it is the destination of
1868 an incoming response. Some servers will check that addresses
1869 aren't in use before handing them out (usually using an ARP
1870 ping) and therefore take up to a few hundred milliseconds to
1871 respond. Network congestion may also influence the time it
1872 takes for a response to make it back to the client. If that
1873 time is too long, U-Boot will retransmit requests. In order
1874 to allow earlier responses to still be accepted after these
1875 retransmissions, U-Boot's BOOTP client keeps a small cache of
1876 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1877 cache. The default is to keep IDs for up to four outstanding
1878 requests. Increasing this will allow U-Boot to accept offers
1879 from a BOOTP client in networks with unusually high latency.
1880
stroesee0aadfb2003-08-28 14:17:32 +00001881- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001882 You can fine tune the DHCP functionality by defining
1883 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001884
Jon Loeliger5336a762007-07-09 22:08:34 -05001885 CONFIG_BOOTP_SUBNETMASK
1886 CONFIG_BOOTP_GATEWAY
1887 CONFIG_BOOTP_HOSTNAME
1888 CONFIG_BOOTP_NISDOMAIN
1889 CONFIG_BOOTP_BOOTPATH
1890 CONFIG_BOOTP_BOOTFILESIZE
1891 CONFIG_BOOTP_DNS
1892 CONFIG_BOOTP_DNS2
1893 CONFIG_BOOTP_SEND_HOSTNAME
1894 CONFIG_BOOTP_NTPSERVER
1895 CONFIG_BOOTP_TIMEOFFSET
1896 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001897 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001898
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001899 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1900 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001901
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001902 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1903 after the configured retry count, the call will fail
1904 instead of starting over. This can be used to fail over
1905 to Link-local IP address configuration if the DHCP server
1906 is not available.
1907
stroesee0aadfb2003-08-28 14:17:32 +00001908 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1909 serverip from a DHCP server, it is possible that more
1910 than one DNS serverip is offered to the client.
1911 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1912 serverip will be stored in the additional environment
1913 variable "dnsip2". The first DNS serverip is always
1914 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001915 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001916
1917 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1918 to do a dynamic update of a DNS server. To do this, they
1919 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001920 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001921 of the "hostname" environment variable is passed as
1922 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001923
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001924 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1925
1926 A 32bit value in microseconds for a delay between
1927 receiving a "DHCP Offer" and sending the "DHCP Request".
1928 This fixes a problem with certain DHCP servers that don't
1929 respond 100% of the time to a "DHCP request". E.g. On an
1930 AT91RM9200 processor running at 180MHz, this delay needed
1931 to be *at least* 15,000 usec before a Windows Server 2003
1932 DHCP server would reply 100% of the time. I recommend at
1933 least 50,000 usec to be safe. The alternative is to hope
1934 that one of the retries will be successful but note that
1935 the DHCP timeout and retry process takes a longer than
1936 this delay.
1937
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001938 - Link-local IP address negotiation:
1939 Negotiate with other link-local clients on the local network
1940 for an address that doesn't require explicit configuration.
1941 This is especially useful if a DHCP server cannot be guaranteed
1942 to exist in all environments that the device must operate.
1943
1944 See doc/README.link-local for more information.
1945
wdenk145d2c12004-04-15 21:48:45 +00001946 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001947 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001948
1949 The device id used in CDP trigger frames.
1950
1951 CONFIG_CDP_DEVICE_ID_PREFIX
1952
1953 A two character string which is prefixed to the MAC address
1954 of the device.
1955
1956 CONFIG_CDP_PORT_ID
1957
1958 A printf format string which contains the ascii name of
1959 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001960 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001961
1962 CONFIG_CDP_CAPABILITIES
1963
1964 A 32bit integer which indicates the device capabilities;
1965 0x00000010 for a normal host which does not forwards.
1966
1967 CONFIG_CDP_VERSION
1968
1969 An ascii string containing the version of the software.
1970
1971 CONFIG_CDP_PLATFORM
1972
1973 An ascii string containing the name of the platform.
1974
1975 CONFIG_CDP_TRIGGER
1976
1977 A 32bit integer sent on the trigger.
1978
1979 CONFIG_CDP_POWER_CONSUMPTION
1980
1981 A 16bit integer containing the power consumption of the
1982 device in .1 of milliwatts.
1983
1984 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1985
1986 A byte containing the id of the VLAN.
1987
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001988- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001989
1990 Several configurations allow to display the current
1991 status using a LED. For instance, the LED will blink
1992 fast while running U-Boot code, stop blinking as
1993 soon as a reply to a BOOTP request was received, and
1994 start blinking slow once the Linux kernel is running
1995 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001996 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001997 feature in U-Boot.
1998
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001999 Additional options:
2000
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002001 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002002 The status LED can be connected to a GPIO pin.
2003 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002004 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002005 to include the gpio_led driver in the U-Boot binary.
2006
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002007 CONFIG_GPIO_LED_INVERTED_TABLE
2008 Some GPIO connected LEDs may have inverted polarity in which
2009 case the GPIO high value corresponds to LED off state and
2010 GPIO low value corresponds to LED on state.
2011 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2012 with a list of GPIO LEDs that have inverted polarity.
2013
wdenkc6097192002-11-03 00:24:07 +00002014- CAN Support: CONFIG_CAN_DRIVER
2015
2016 Defining CONFIG_CAN_DRIVER enables CAN driver support
2017 on those systems that support this (optional)
2018 feature, like the TQM8xxL modules.
2019
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002020- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002021
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002022 This enable the NEW i2c subsystem, and will allow you to use
2023 i2c commands at the u-boot command line (as long as you set
2024 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2025 based realtime clock chips or other i2c devices. See
2026 common/cmd_i2c.c for a description of the command line
2027 interface.
2028
2029 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002030 - drivers/i2c/soft_i2c.c:
2031 - activate first bus with CONFIG_SYS_I2C_SOFT define
2032 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2033 for defining speed and slave address
2034 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2035 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2036 for defining speed and slave address
2037 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2038 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2039 for defining speed and slave address
2040 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2041 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2042 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002043
Heiko Schocherf2850742012-10-24 13:48:22 +02002044 - drivers/i2c/fsl_i2c.c:
2045 - activate i2c driver with CONFIG_SYS_I2C_FSL
2046 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2047 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2048 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2049 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002050 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002051 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2052 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2053 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2054 second bus.
2055
Simon Glass026fefb2012-10-30 07:28:53 +00002056 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002057 - activate this driver with CONFIG_SYS_I2C_TEGRA
2058 - This driver adds 4 i2c buses with a fix speed from
2059 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002060
Dirk Eibach42b204f2013-04-25 02:40:01 +00002061 - drivers/i2c/ppc4xx_i2c.c
2062 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2063 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2064 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2065
trema49f40a2013-09-21 18:13:35 +02002066 - drivers/i2c/i2c_mxc.c
2067 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002068 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2069 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2070 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2071 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002072 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2073 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2074 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2075 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2076 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2077 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002078 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2079 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002080 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002081 for speed, and 0 for slave.
2082
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002083 - drivers/i2c/rcar_i2c.c:
2084 - activate this driver with CONFIG_SYS_I2C_RCAR
2085 - This driver adds 4 i2c buses
2086
2087 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2088 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2089 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2090 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2091 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2092 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2093 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2094 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2095 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2096
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002097 - drivers/i2c/sh_i2c.c:
2098 - activate this driver with CONFIG_SYS_I2C_SH
2099 - This driver adds from 2 to 5 i2c buses
2100
2101 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2102 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2103 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2104 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2105 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2106 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2107 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2108 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2109 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2110 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002111 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002112
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002113 - drivers/i2c/omap24xx_i2c.c
2114 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2115 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2116 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2117 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2118 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2119 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2120 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2121 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2122 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2123 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2124 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2125
Heiko Schocher465819a2013-11-08 07:30:53 +01002126 - drivers/i2c/zynq_i2c.c
2127 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2128 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2129 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2130
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302131 - drivers/i2c/s3c24x0_i2c.c:
2132 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2133 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2134 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2135 with a fix speed from 100000 and the slave addr 0!
2136
Dirk Eibachb9577432014-07-03 09:28:18 +02002137 - drivers/i2c/ihs_i2c.c
2138 - activate this driver with CONFIG_SYS_I2C_IHS
2139 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2140 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2141 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2142 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2143 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2144 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2145 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2146 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2147 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2148 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2149 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2150 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002151 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2152 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2153 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2154 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2155 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2156 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2157 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2158 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2159 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002160
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002161 additional defines:
2162
2163 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002164 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002165
2166 CONFIG_SYS_I2C_DIRECT_BUS
2167 define this, if you don't use i2c muxes on your hardware.
2168 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2169 omit this define.
2170
2171 CONFIG_SYS_I2C_MAX_HOPS
2172 define how many muxes are maximal consecutively connected
2173 on one i2c bus. If you not use i2c muxes, omit this
2174 define.
2175
2176 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002177 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002178 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2179 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2180 CONFIG_SYS_NUM_I2C_BUSES = 9:
2181
2182 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2183 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2184 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2185 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2186 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2187 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2188 {1, {I2C_NULL_HOP}}, \
2189 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2190 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2191 }
2192
2193 which defines
2194 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002195 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2196 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2197 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2198 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2199 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002200 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002201 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2202 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002203
2204 If you do not have i2c muxes on your board, omit this define.
2205
Simon Glass3efce392017-05-12 21:10:00 -06002206- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002207 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002208 then the following macros need to be defined (examples are
2209 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002210
2211 I2C_INIT
2212
wdenkb9bbd242003-06-30 16:24:52 +00002213 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002214 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002215
wdenk544e9732004-02-06 23:19:44 +00002216 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002217
wdenkc6097192002-11-03 00:24:07 +00002218 I2C_PORT
2219
wdenk4a5c8a72003-03-06 00:02:04 +00002220 (Only for MPC8260 CPU). The I/O port to use (the code
2221 assumes both bits are on the same port). Valid values
2222 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002223
2224 I2C_ACTIVE
2225
2226 The code necessary to make the I2C data line active
2227 (driven). If the data line is open collector, this
2228 define can be null.
2229
wdenkb9bbd242003-06-30 16:24:52 +00002230 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2231
wdenkc6097192002-11-03 00:24:07 +00002232 I2C_TRISTATE
2233
2234 The code necessary to make the I2C data line tri-stated
2235 (inactive). If the data line is open collector, this
2236 define can be null.
2237
wdenkb9bbd242003-06-30 16:24:52 +00002238 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2239
wdenkc6097192002-11-03 00:24:07 +00002240 I2C_READ
2241
York Sun4a598092013-04-01 11:29:11 -07002242 Code that returns true if the I2C data line is high,
2243 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002244
wdenkb9bbd242003-06-30 16:24:52 +00002245 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2246
wdenkc6097192002-11-03 00:24:07 +00002247 I2C_SDA(bit)
2248
York Sun4a598092013-04-01 11:29:11 -07002249 If <bit> is true, sets the I2C data line high. If it
2250 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002251
wdenkb9bbd242003-06-30 16:24:52 +00002252 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002253 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002254 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002255
wdenkc6097192002-11-03 00:24:07 +00002256 I2C_SCL(bit)
2257
York Sun4a598092013-04-01 11:29:11 -07002258 If <bit> is true, sets the I2C clock line high. If it
2259 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002260
wdenkb9bbd242003-06-30 16:24:52 +00002261 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002262 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002263 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002264
wdenkc6097192002-11-03 00:24:07 +00002265 I2C_DELAY
2266
2267 This delay is invoked four times per clock cycle so this
2268 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002269 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002270 like:
2271
wdenkb9bbd242003-06-30 16:24:52 +00002272 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002273
Mike Frysingeree12d542010-07-21 13:38:02 -04002274 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2275
2276 If your arch supports the generic GPIO framework (asm/gpio.h),
2277 then you may alternatively define the two GPIOs that are to be
2278 used as SCL / SDA. Any of the previous I2C_xxx macros will
2279 have GPIO-based defaults assigned to them as appropriate.
2280
2281 You should define these to the GPIO value as given directly to
2282 the generic GPIO functions.
2283
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002284 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002285
wdenk57b2d802003-06-27 21:31:46 +00002286 When a board is reset during an i2c bus transfer
2287 chips might think that the current transfer is still
2288 in progress. On some boards it is possible to access
2289 the i2c SCLK line directly, either by using the
2290 processor pin as a GPIO or by having a second pin
2291 connected to the bus. If this option is defined a
2292 custom i2c_init_board() routine in boards/xxx/board.c
2293 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002294
Ben Warren45657152006-09-07 16:50:54 -04002295 CONFIG_I2C_MULTI_BUS
2296
2297 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002298 must have a controller. At any point in time, only one bus is
2299 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002300 Note that bus numbering is zero-based.
2301
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002302 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002303
2304 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002305 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002306 is set, specify a list of bus-device pairs. Otherwise, specify
2307 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002308
2309 e.g.
2310 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002311 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002312
2313 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2314
Wolfgang Denk092ae952011-10-26 10:21:21 +00002315 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002316 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002317
2318 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2319
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002320 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002321
2322 If defined, then this indicates the I2C bus number for DDR SPD.
2323 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2324
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002325 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002326
2327 If defined, then this indicates the I2C bus number for the RTC.
2328 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2329
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002330 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002331
2332 If defined, then this indicates the I2C bus number for the DTT.
2333 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2334
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002335 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002336
2337 If defined, specifies the I2C address of the DTT device.
2338 If not defined, then U-Boot uses predefined value for
2339 specified DTT device.
2340
Andrew Dyer58c41f92008-12-29 17:36:01 -06002341 CONFIG_SOFT_I2C_READ_REPEATED_START
2342
2343 defining this will force the i2c_read() function in
2344 the soft_i2c driver to perform an I2C repeated start
2345 between writing the address pointer and reading the
2346 data. If this define is omitted the default behaviour
2347 of doing a stop-start sequence will be used. Most I2C
2348 devices can use either method, but some require one or
2349 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002350
wdenkc6097192002-11-03 00:24:07 +00002351- SPI Support: CONFIG_SPI
2352
2353 Enables SPI driver (so far only tested with
2354 SPI EEPROM, also an instance works with Crystal A/D and
2355 D/As on the SACSng board)
2356
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002357 CONFIG_SH_SPI
2358
2359 Enables the driver for SPI controller on SuperH. Currently
2360 only SH7757 is supported.
2361
wdenkc6097192002-11-03 00:24:07 +00002362 CONFIG_SOFT_SPI
2363
wdenk4a5c8a72003-03-06 00:02:04 +00002364 Enables a software (bit-bang) SPI driver rather than
2365 using hardware support. This is a general purpose
2366 driver that only requires three general I/O port pins
2367 (two outputs, one input) to function. If this is
2368 defined, the board configuration must define several
2369 SPI configuration items (port pins to use, etc). For
2370 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002371
Ben Warren7efe9272008-01-16 22:37:35 -05002372 CONFIG_HARD_SPI
2373
2374 Enables a hardware SPI driver for general-purpose reads
2375 and writes. As with CONFIG_SOFT_SPI, the board configuration
2376 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002377 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002378 example, see include/configs/mpc8349emds.h.
2379
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002380 CONFIG_MXC_SPI
2381
2382 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002383 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002384
Heiko Schocherb77c8882014-07-14 10:22:11 +02002385 CONFIG_SYS_SPI_MXC_WAIT
2386 Timeout for waiting until spi transfer completed.
2387 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2388
Matthias Fuchsa4400872007-12-27 17:12:34 +01002389- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002390
Matthias Fuchsa4400872007-12-27 17:12:34 +01002391 Enables FPGA subsystem.
2392
2393 CONFIG_FPGA_<vendor>
2394
2395 Enables support for specific chip vendors.
2396 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002397
Matthias Fuchsa4400872007-12-27 17:12:34 +01002398 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002399
Matthias Fuchsa4400872007-12-27 17:12:34 +01002400 Enables support for FPGA family.
2401 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2402
2403 CONFIG_FPGA_COUNT
2404
2405 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002406
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302407 CONFIG_CMD_FPGA_LOADMK
2408
2409 Enable support for fpga loadmk command
2410
Michal Simek64c70982014-05-02 13:43:39 +02002411 CONFIG_CMD_FPGA_LOADP
2412
2413 Enable support for fpga loadp command - load partial bitstream
2414
2415 CONFIG_CMD_FPGA_LOADBP
2416
2417 Enable support for fpga loadbp command - load partial bitstream
2418 (Xilinx only)
2419
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002420 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002421
wdenk57b2d802003-06-27 21:31:46 +00002422 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002423
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002424 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002425
wdenk4a5c8a72003-03-06 00:02:04 +00002426 Enable checks on FPGA configuration interface busy
2427 status by the configuration function. This option
2428 will require a board or device specific function to
2429 be written.
wdenkc6097192002-11-03 00:24:07 +00002430
2431 CONFIG_FPGA_DELAY
2432
2433 If defined, a function that provides delays in the FPGA
2434 configuration driver.
2435
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002436 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002437 Allow Control-C to interrupt FPGA configuration
2438
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002439 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002440
wdenk4a5c8a72003-03-06 00:02:04 +00002441 Check for configuration errors during FPGA bitfile
2442 loading. For example, abort during Virtex II
2443 configuration if the INIT_B line goes low (which
2444 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002445
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002446 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002447
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002448 Maximum time to wait for the INIT_B line to de-assert
2449 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002450 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002451 ms.
wdenkc6097192002-11-03 00:24:07 +00002452
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002453 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002454
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002455 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002456 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002457
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002458 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002459
wdenk4a5c8a72003-03-06 00:02:04 +00002460 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002461 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002462
2463- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002464 CONFIG_BUILD_TARGET
2465
2466 Some SoCs need special image types (e.g. U-Boot binary
2467 with a special header) as build targets. By defining
2468 CONFIG_BUILD_TARGET in the SoC / board header, this
2469 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002470 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002471
wdenkc6097192002-11-03 00:24:07 +00002472 CONFIG_IDENT_STRING
2473
wdenk4a5c8a72003-03-06 00:02:04 +00002474 If defined, this string will be added to the U-Boot
2475 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002476
2477- Vendor Parameter Protection:
2478
wdenk4a5c8a72003-03-06 00:02:04 +00002479 U-Boot considers the values of the environment
2480 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002481 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002482 are set once by the board vendor / manufacturer, and
2483 protects these variables from casual modification by
2484 the user. Once set, these variables are read-only,
2485 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002486 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002487
2488 If CONFIG_ENV_OVERWRITE is #defined in your config
2489 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002490 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002491 these parameters.
2492
Joe Hershberger76f353e2015-05-04 14:55:14 -05002493 Alternatively, if you define _both_ an ethaddr in the
2494 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002495 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002496 which can be changed exactly ONCE by the user. [The
2497 serial# is unaffected by this, i. e. it remains
2498 read-only.]
2499
Joe Hershberger71497d02012-12-11 22:16:31 -06002500 The same can be accomplished in a more flexible way
2501 for any variable by configuring the type of access
2502 to allow for those variables in the ".flags" variable
2503 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2504
wdenkc6097192002-11-03 00:24:07 +00002505- Protected RAM:
2506 CONFIG_PRAM
2507
2508 Define this variable to enable the reservation of
2509 "protected RAM", i. e. RAM which is not overwritten
2510 by U-Boot. Define CONFIG_PRAM to hold the number of
2511 kB you want to reserve for pRAM. You can overwrite
2512 this default value by defining an environment
2513 variable "pram" to the number of kB you want to
2514 reserve. Note that the board info structure will
2515 still show the full amount of RAM. If pRAM is
2516 reserved, a new environment variable "mem" will
2517 automatically be defined to hold the amount of
2518 remaining RAM in a form that can be passed as boot
2519 argument to Linux, for instance like that:
2520
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002521 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002522 saveenv
2523
2524 This way you can tell Linux not to use this memory,
2525 either, which results in a memory region that will
2526 not be affected by reboots.
2527
2528 *WARNING* If your board configuration uses automatic
2529 detection of the RAM size, you must make sure that
2530 this memory test is non-destructive. So far, the
2531 following board configurations are known to be
2532 "pRAM-clean":
2533
Wolfgang Denk90326762012-10-24 02:36:15 +00002534 IVMS8, IVML24, SPD8xx, TQM8xxL,
2535 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002536 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002537
Gabe Blacka2f3a932012-12-02 04:55:18 +00002538- Access to physical memory region (> 4GB)
2539 Some basic support is provided for operations on memory not
2540 normally accessible to U-Boot - e.g. some architectures
2541 support access to more than 4GB of memory on 32-bit
2542 machines using physical address extension or similar.
2543 Define CONFIG_PHYSMEM to access this basic support, which
2544 currently only supports clearing the memory.
2545
wdenkc6097192002-11-03 00:24:07 +00002546- Error Recovery:
2547 CONFIG_PANIC_HANG
2548
2549 Define this variable to stop the system in case of a
2550 fatal error, so that you have to reset it manually.
2551 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002552 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002553 automatically as fast as possible, but it may be
2554 useful during development since you can try to debug
2555 the conditions that lead to the situation.
2556
2557 CONFIG_NET_RETRY_COUNT
2558
wdenk4a5c8a72003-03-06 00:02:04 +00002559 This variable defines the number of retries for
2560 network operations like ARP, RARP, TFTP, or BOOTP
2561 before giving up the operation. If not defined, a
2562 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002563
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002564 CONFIG_ARP_TIMEOUT
2565
2566 Timeout waiting for an ARP reply in milliseconds.
2567
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002568 CONFIG_NFS_TIMEOUT
2569
2570 Timeout in milliseconds used in NFS protocol.
2571 If you encounter "ERROR: Cannot umount" in nfs command,
2572 try longer timeout such as
2573 #define CONFIG_NFS_TIMEOUT 10000UL
2574
wdenkc6097192002-11-03 00:24:07 +00002575- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002576 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002577
2578 Enable auto completion of commands using TAB.
2579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002580 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002581
2582 This defines the secondary prompt string, which is
2583 printed when the command interpreter needs more input
2584 to complete a command. Usually "> ".
2585
2586 Note:
2587
wdenk57b2d802003-06-27 21:31:46 +00002588 In the current implementation, the local variables
2589 space and global environment variables space are
2590 separated. Local variables are those you define by
2591 simply typing `name=value'. To access a local
2592 variable later on, you have write `$name' or
2593 `${name}'; to execute the contents of a variable
2594 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002595
wdenk4a5c8a72003-03-06 00:02:04 +00002596 Global environment variables are those you use
2597 setenv/printenv to work with. To run a command stored
2598 in such a variable, you need to use the run command,
2599 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002600
2601 To store commands and special characters in a
2602 variable, please use double quotation marks
2603 surrounding the whole text of the variable, instead
2604 of the backslashes before semicolons and special
2605 symbols.
2606
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002607- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002608 CONFIG_CMDLINE_EDITING
2609
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002610 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002611 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002612
Marek Vasut734fb042016-01-27 04:47:55 +01002613- Command Line PS1/PS2 support:
2614 CONFIG_CMDLINE_PS_SUPPORT
2615
2616 Enable support for changing the command prompt string
2617 at run-time. Only static string is supported so far.
2618 The string is obtained from environment variables PS1
2619 and PS2.
2620
wdenkc0aa5c52003-12-06 19:49:23 +00002621- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002622 CONFIG_EXTRA_ENV_SETTINGS
2623
wdenk4a5c8a72003-03-06 00:02:04 +00002624 Define this to contain any number of null terminated
2625 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002626 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002627
wdenk4a5c8a72003-03-06 00:02:04 +00002628 For example, place something like this in your
2629 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002630
2631 #define CONFIG_EXTRA_ENV_SETTINGS \
2632 "myvar1=value1\0" \
2633 "myvar2=value2\0"
2634
wdenk4a5c8a72003-03-06 00:02:04 +00002635 Warning: This method is based on knowledge about the
2636 internal format how the environment is stored by the
2637 U-Boot code. This is NOT an official, exported
2638 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002639 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002640 You better know what you are doing here.
2641
wdenk4a5c8a72003-03-06 00:02:04 +00002642 Note: overly (ab)use of the default environment is
2643 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002644 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002645 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002646
Stephen Warren1465d5f2012-05-22 09:21:54 +00002647 CONFIG_ENV_VARS_UBOOT_CONFIG
2648
2649 Define this in order to add variables describing the
2650 U-Boot build configuration to the default environment.
2651 These will be named arch, cpu, board, vendor, and soc.
2652
2653 Enabling this option will cause the following to be defined:
2654
2655 - CONFIG_SYS_ARCH
2656 - CONFIG_SYS_CPU
2657 - CONFIG_SYS_BOARD
2658 - CONFIG_SYS_VENDOR
2659 - CONFIG_SYS_SOC
2660
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002661 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2662
2663 Define this in order to add variables describing certain
2664 run-time determined information about the hardware to the
2665 environment. These will be named board_name, board_rev.
2666
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002667 CONFIG_DELAY_ENVIRONMENT
2668
2669 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002670 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002671 that so that the environment is not available until
2672 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2673 this is instead controlled by the value of
2674 /config/load-environment.
2675
wdenkc0aa5c52003-12-06 19:49:23 +00002676- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002677 CONFIG_HAS_DATAFLASH
2678
wdenk57b2d802003-06-27 21:31:46 +00002679 Defining this option enables DataFlash features and
2680 allows to read/write in Dataflash via the standard
2681 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002682
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002683- Serial Flash support
2684 CONFIG_CMD_SF
2685
2686 Defining this option enables SPI flash commands
2687 'sf probe/read/write/erase/update'.
2688
2689 Usage requires an initial 'probe' to define the serial
2690 flash parameters, followed by read/write/erase/update
2691 commands.
2692
2693 The following defaults may be provided by the platform
2694 to handle the common case when only a single serial
2695 flash is present on the system.
2696
2697 CONFIG_SF_DEFAULT_BUS Bus identifier
2698 CONFIG_SF_DEFAULT_CS Chip-select
2699 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2700 CONFIG_SF_DEFAULT_SPEED in Hz
2701
Simon Glass4b5545e2012-10-08 13:16:02 +00002702 CONFIG_CMD_SF_TEST
2703
2704 Define this option to include a destructive SPI flash
2705 test ('sf test').
2706
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302707 CONFIG_SF_DUAL_FLASH Dual flash memories
2708
2709 Define this option to use dual flash support where two flash
2710 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002711 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302712
wdenkef893942004-02-23 16:11:30 +00002713- SystemACE Support:
2714 CONFIG_SYSTEMACE
2715
2716 Adding this option adds support for Xilinx SystemACE
2717 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002718 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002719 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002720
2721 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002722 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002723
2724 When SystemACE support is added, the "ace" device type
2725 becomes available to the fat commands, i.e. fatls.
2726
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002727- TFTP Fixed UDP Port:
2728 CONFIG_TFTP_PORT
2729
Wolfgang Denk227b5192005-09-24 23:25:46 +02002730 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002731 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002732 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002733 number generator is used.
2734
Wolfgang Denk227b5192005-09-24 23:25:46 +02002735 Also, the environment variable tftpdstp is used to supply
2736 the TFTP UDP destination port value. If tftpdstp isn't
2737 defined, the normal port 69 is used.
2738
2739 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002740 blindly start the TFTP transfer using the pre-configured
2741 target IP address and UDP port. This has the effect of
2742 "punching through" the (Windows XP) firewall, allowing
2743 the remainder of the TFTP transfer to proceed normally.
2744 A better solution is to properly configure the firewall,
2745 but sometimes that is not allowed.
2746
Simon Glass058bb8d2012-12-05 14:46:38 +00002747- Hashing support:
2748 CONFIG_CMD_HASH
2749
2750 This enables a generic 'hash' command which can produce
2751 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2752
2753 CONFIG_HASH_VERIFY
2754
2755 Enable the hash verify command (hash -v). This adds to code
2756 size a little.
2757
Simon Glass058bb8d2012-12-05 14:46:38 +00002758 Note: There is also a sha1sum command, which should perhaps
2759 be deprecated in favour of 'hash sha1'.
2760
Robert Winkler765ccf42013-07-24 17:57:06 -07002761- Freescale i.MX specific commands:
2762 CONFIG_CMD_HDMIDETECT
2763 This enables 'hdmidet' command which returns true if an
2764 HDMI monitor is detected. This command is i.MX 6 specific.
2765
Heiko Schocher443ca402014-01-25 07:27:13 +01002766- bootcount support:
2767 CONFIG_BOOTCOUNT_LIMIT
2768
2769 This enables the bootcounter support, see:
2770 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2771
2772 CONFIG_AT91SAM9XE
2773 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002774 CONFIG_SOC_DA8XX
2775 enable special bootcounter support on da850 based boards.
2776 CONFIG_BOOTCOUNT_RAM
2777 enable support for the bootcounter in RAM
2778 CONFIG_BOOTCOUNT_I2C
2779 enable support for the bootcounter on an i2c (like RTC) device.
2780 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2781 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2782 the bootcounter.
2783 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002784
wdenkc0aa5c52003-12-06 19:49:23 +00002785- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002786 CONFIG_SHOW_BOOT_PROGRESS
2787
wdenk4a5c8a72003-03-06 00:02:04 +00002788 Defining this option allows to add some board-
2789 specific code (calling a user-provided function
2790 "show_boot_progress(int)") that enables you to show
2791 the system's boot progress on some display (for
2792 example, some LED's) on your board. At the moment,
2793 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002794
Simon Glass0fa36a42012-09-28 08:56:37 +00002795
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002796Legacy uImage format:
2797
wdenkc6097192002-11-03 00:24:07 +00002798 Arg Where When
2799 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002800 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002801 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002802 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002803 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002804 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002805 4 common/cmd_bootm.c Image data has correct checksum
2806 -4 common/cmd_bootm.c Image is for unsupported architecture
2807 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002808 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002809 6 common/cmd_bootm.c Image Type check OK
2810 -6 common/cmd_bootm.c gunzip uncompression error
2811 -7 common/cmd_bootm.c Unimplemented compression type
2812 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002813 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002814 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002815
2816 9 common/image.c Start initial ramdisk verification
2817 -10 common/image.c Ramdisk header has bad magic number
2818 -11 common/image.c Ramdisk header has bad checksum
2819 10 common/image.c Ramdisk header is OK
2820 -12 common/image.c Ramdisk data has bad checksum
2821 11 common/image.c Ramdisk data has correct checksum
2822 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002823 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002824 13 common/image.c Start multifile image verification
2825 14 common/image.c No initial ramdisk, no multifile, continue.
2826
Wolfgang Denk092ae952011-10-26 10:21:21 +00002827 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002828
Stefan Roese88fbf932010-04-15 16:07:28 +02002829 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002830 -31 post/post.c POST test failed, detected by post_output_backlog()
2831 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002832
Heiko Schocher633e03a2007-06-22 19:11:54 +02002833 34 common/cmd_doc.c before loading a Image from a DOC device
2834 -35 common/cmd_doc.c Bad usage of "doc" command
2835 35 common/cmd_doc.c correct usage of "doc" command
2836 -36 common/cmd_doc.c No boot device
2837 36 common/cmd_doc.c correct boot device
2838 -37 common/cmd_doc.c Unknown Chip ID on boot device
2839 37 common/cmd_doc.c correct chip ID found, device available
2840 -38 common/cmd_doc.c Read Error on boot device
2841 38 common/cmd_doc.c reading Image header from DOC device OK
2842 -39 common/cmd_doc.c Image header has bad magic number
2843 39 common/cmd_doc.c Image header has correct magic number
2844 -40 common/cmd_doc.c Error reading Image from DOC device
2845 40 common/cmd_doc.c Image header has correct magic number
2846 41 common/cmd_ide.c before loading a Image from a IDE device
2847 -42 common/cmd_ide.c Bad usage of "ide" command
2848 42 common/cmd_ide.c correct usage of "ide" command
2849 -43 common/cmd_ide.c No boot device
2850 43 common/cmd_ide.c boot device found
2851 -44 common/cmd_ide.c Device not available
2852 44 common/cmd_ide.c Device available
2853 -45 common/cmd_ide.c wrong partition selected
2854 45 common/cmd_ide.c partition selected
2855 -46 common/cmd_ide.c Unknown partition table
2856 46 common/cmd_ide.c valid partition table found
2857 -47 common/cmd_ide.c Invalid partition type
2858 47 common/cmd_ide.c correct partition type
2859 -48 common/cmd_ide.c Error reading Image Header on boot device
2860 48 common/cmd_ide.c reading Image Header from IDE device OK
2861 -49 common/cmd_ide.c Image header has bad magic number
2862 49 common/cmd_ide.c Image header has correct magic number
2863 -50 common/cmd_ide.c Image header has bad checksum
2864 50 common/cmd_ide.c Image header has correct checksum
2865 -51 common/cmd_ide.c Error reading Image from IDE device
2866 51 common/cmd_ide.c reading Image from IDE device OK
2867 52 common/cmd_nand.c before loading a Image from a NAND device
2868 -53 common/cmd_nand.c Bad usage of "nand" command
2869 53 common/cmd_nand.c correct usage of "nand" command
2870 -54 common/cmd_nand.c No boot device
2871 54 common/cmd_nand.c boot device found
2872 -55 common/cmd_nand.c Unknown Chip ID on boot device
2873 55 common/cmd_nand.c correct chip ID found, device available
2874 -56 common/cmd_nand.c Error reading Image Header on boot device
2875 56 common/cmd_nand.c reading Image Header from NAND device OK
2876 -57 common/cmd_nand.c Image header has bad magic number
2877 57 common/cmd_nand.c Image header has correct magic number
2878 -58 common/cmd_nand.c Error reading Image from NAND device
2879 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002880
Heiko Schocher633e03a2007-06-22 19:11:54 +02002881 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002882
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002883 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002884 -64 net/eth.c no Ethernet found.
2885 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002886
Heiko Schocher633e03a2007-06-22 19:11:54 +02002887 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002888 80 common/cmd_net.c before calling net_loop()
2889 -81 common/cmd_net.c some error in net_loop() occurred
2890 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002891 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2892 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002893 83 common/cmd_net.c running "source" command
2894 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002895 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002896
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002897FIT uImage format:
2898
2899 Arg Where When
2900 100 common/cmd_bootm.c Kernel FIT Image has correct format
2901 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2902 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2903 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2904 102 common/cmd_bootm.c Kernel unit name specified
2905 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002906 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002907 104 common/cmd_bootm.c Got kernel subimage node offset
2908 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2909 105 common/cmd_bootm.c Kernel subimage hash verification OK
2910 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2911 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002912 -106 common/cmd_bootm.c Kernel subimage has wrong type
2913 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002914 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2915 108 common/cmd_bootm.c Got kernel subimage data/size
2916 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2917 -109 common/cmd_bootm.c Can't get kernel subimage type
2918 -110 common/cmd_bootm.c Can't get kernel subimage comp
2919 -111 common/cmd_bootm.c Can't get kernel subimage os
2920 -112 common/cmd_bootm.c Can't get kernel subimage load address
2921 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2922
2923 120 common/image.c Start initial ramdisk verification
2924 -120 common/image.c Ramdisk FIT image has incorrect format
2925 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002926 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002927 -122 common/image.c Can't get configuration for ramdisk subimage
2928 123 common/image.c Ramdisk unit name specified
2929 -124 common/image.c Can't get ramdisk subimage node offset
2930 125 common/image.c Got ramdisk subimage node offset
2931 -125 common/image.c Ramdisk subimage hash verification failed
2932 126 common/image.c Ramdisk subimage hash verification OK
2933 -126 common/image.c Ramdisk subimage for unsupported architecture
2934 127 common/image.c Architecture check OK
2935 -127 common/image.c Can't get ramdisk subimage data/size
2936 128 common/image.c Got ramdisk subimage data/size
2937 129 common/image.c Can't get ramdisk load address
2938 -129 common/image.c Got ramdisk load address
2939
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002940 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002941 131 common/cmd_doc.c FIT image format OK
2942
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002943 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002944 141 common/cmd_ide.c FIT image format OK
2945
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002946 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002947 151 common/cmd_nand.c FIT image format OK
2948
Heiko Schocher515eb122014-05-28 11:33:33 +02002949- legacy image format:
2950 CONFIG_IMAGE_FORMAT_LEGACY
2951 enables the legacy image format support in U-Boot.
2952
2953 Default:
2954 enabled if CONFIG_FIT_SIGNATURE is not defined.
2955
2956 CONFIG_DISABLE_IMAGE_LEGACY
2957 disable the legacy image format
2958
2959 This define is introduced, as the legacy image format is
2960 enabled per default for backward compatibility.
2961
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002962- Standalone program support:
2963 CONFIG_STANDALONE_LOAD_ADDR
2964
Wolfgang Denk23f78482011-10-09 21:06:34 +02002965 This option defines a board specific value for the
2966 address where standalone program gets loaded, thus
2967 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002968 settings.
2969
2970- Frame Buffer Address:
2971 CONFIG_FB_ADDR
2972
2973 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002974 address for frame buffer. This is typically the case
2975 when using a graphics controller has separate video
2976 memory. U-Boot will then place the frame buffer at
2977 the given address instead of dynamically reserving it
2978 in system RAM by calling lcd_setmem(), which grabs
2979 the memory for the frame buffer depending on the
2980 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002981
2982 Please see board_init_f function.
2983
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002984- Automatic software updates via TFTP server
2985 CONFIG_UPDATE_TFTP
2986 CONFIG_UPDATE_TFTP_CNT_MAX
2987 CONFIG_UPDATE_TFTP_MSEC_MAX
2988
2989 These options enable and control the auto-update feature;
2990 for a more detailed description refer to doc/README.update.
2991
2992- MTD Support (mtdparts command, UBI support)
2993 CONFIG_MTD_DEVICE
2994
2995 Adds the MTD device infrastructure from the Linux kernel.
2996 Needed for mtdparts command support.
2997
2998 CONFIG_MTD_PARTITIONS
2999
3000 Adds the MTD partitioning infrastructure from the Linux
3001 kernel. Needed for UBI support.
3002
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003003- UBI support
3004 CONFIG_CMD_UBI
3005
3006 Adds commands for interacting with MTD partitions formatted
3007 with the UBI flash translation layer
3008
3009 Requires also defining CONFIG_RBTREE
3010
Joe Hershberger47550fc2013-04-08 10:32:49 +00003011 CONFIG_UBI_SILENCE_MSG
3012
3013 Make the verbose messages from UBI stop printing. This leaves
3014 warnings and errors enabled.
3015
Heiko Schocherf5895d12014-06-24 10:10:04 +02003016
3017 CONFIG_MTD_UBI_WL_THRESHOLD
3018 This parameter defines the maximum difference between the highest
3019 erase counter value and the lowest erase counter value of eraseblocks
3020 of UBI devices. When this threshold is exceeded, UBI starts performing
3021 wear leveling by means of moving data from eraseblock with low erase
3022 counter to eraseblocks with high erase counter.
3023
3024 The default value should be OK for SLC NAND flashes, NOR flashes and
3025 other flashes which have eraseblock life-cycle 100000 or more.
3026 However, in case of MLC NAND flashes which typically have eraseblock
3027 life-cycle less than 10000, the threshold should be lessened (e.g.,
3028 to 128 or 256, although it does not have to be power of 2).
3029
3030 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003031
Heiko Schocherf5895d12014-06-24 10:10:04 +02003032 CONFIG_MTD_UBI_BEB_LIMIT
3033 This option specifies the maximum bad physical eraseblocks UBI
3034 expects on the MTD device (per 1024 eraseblocks). If the
3035 underlying flash does not admit of bad eraseblocks (e.g. NOR
3036 flash), this value is ignored.
3037
3038 NAND datasheets often specify the minimum and maximum NVM
3039 (Number of Valid Blocks) for the flashes' endurance lifetime.
3040 The maximum expected bad eraseblocks per 1024 eraseblocks
3041 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3042 which gives 20 for most NANDs (MaxNVB is basically the total
3043 count of eraseblocks on the chip).
3044
3045 To put it differently, if this value is 20, UBI will try to
3046 reserve about 1.9% of physical eraseblocks for bad blocks
3047 handling. And that will be 1.9% of eraseblocks on the entire
3048 NAND chip, not just the MTD partition UBI attaches. This means
3049 that if you have, say, a NAND flash chip admits maximum 40 bad
3050 eraseblocks, and it is split on two MTD partitions of the same
3051 size, UBI will reserve 40 eraseblocks when attaching a
3052 partition.
3053
3054 default: 20
3055
3056 CONFIG_MTD_UBI_FASTMAP
3057 Fastmap is a mechanism which allows attaching an UBI device
3058 in nearly constant time. Instead of scanning the whole MTD device it
3059 only has to locate a checkpoint (called fastmap) on the device.
3060 The on-flash fastmap contains all information needed to attach
3061 the device. Using fastmap makes only sense on large devices where
3062 attaching by scanning takes long. UBI will not automatically install
3063 a fastmap on old images, but you can set the UBI parameter
3064 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3065 that fastmap-enabled images are still usable with UBI implementations
3066 without fastmap support. On typical flash devices the whole fastmap
3067 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3068
3069 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3070 Set this parameter to enable fastmap automatically on images
3071 without a fastmap.
3072 default: 0
3073
Heiko Schocher94b66de2015-10-22 06:19:21 +02003074 CONFIG_MTD_UBI_FM_DEBUG
3075 Enable UBI fastmap debug
3076 default: 0
3077
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003078- UBIFS support
3079 CONFIG_CMD_UBIFS
3080
3081 Adds commands for interacting with UBI volumes formatted as
3082 UBIFS. UBIFS is read-only in u-boot.
3083
3084 Requires UBI support as well as CONFIG_LZO
3085
Joe Hershberger47550fc2013-04-08 10:32:49 +00003086 CONFIG_UBIFS_SILENCE_MSG
3087
3088 Make the verbose messages from UBIFS stop printing. This leaves
3089 warnings and errors enabled.
3090
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003091- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003092 CONFIG_SPL
3093 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003094
Tom Rini36853852012-02-14 07:29:40 +00003095 CONFIG_SPL_LDSCRIPT
3096 LDSCRIPT for linking the SPL binary.
3097
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003098 CONFIG_SPL_MAX_FOOTPRINT
3099 Maximum size in memory allocated to the SPL, BSS included.
3100 When defined, the linker checks that the actual memory
3101 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003102 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003103 must not be both defined at the same time.
3104
Tom Rini36853852012-02-14 07:29:40 +00003105 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003106 Maximum size of the SPL image (text, data, rodata, and
3107 linker lists sections), BSS excluded.
3108 When defined, the linker checks that the actual size does
3109 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003110
Wolfgang Denk825223d2011-09-11 21:24:09 +02003111 CONFIG_SPL_TEXT_BASE
3112 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003113
Scott Woodc4f0d002012-09-20 19:05:12 -05003114 CONFIG_SPL_RELOC_TEXT_BASE
3115 Address to relocate to. If unspecified, this is equal to
3116 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3117
Tom Rini36853852012-02-14 07:29:40 +00003118 CONFIG_SPL_BSS_START_ADDR
3119 Link address for the BSS within the SPL binary.
3120
3121 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003122 Maximum size in memory allocated to the SPL BSS.
3123 When defined, the linker checks that the actual memory used
3124 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003125 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003126 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003127
3128 CONFIG_SPL_STACK
3129 Adress of the start of the stack SPL will use
3130
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003131 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3132 When defined, SPL will panic() if the image it has
3133 loaded does not have a signature.
3134 Defining this is useful when code which loads images
3135 in SPL cannot guarantee that absolutely all read errors
3136 will be caught.
3137 An example is the LPC32XX MLC NAND driver, which will
3138 consider that a completely unreadable NAND block is bad,
3139 and thus should be skipped silently.
3140
Scott Woodc4f0d002012-09-20 19:05:12 -05003141 CONFIG_SPL_RELOC_STACK
3142 Adress of the start of the stack SPL will use after
3143 relocation. If unspecified, this is equal to
3144 CONFIG_SPL_STACK.
3145
Tom Rini36853852012-02-14 07:29:40 +00003146 CONFIG_SYS_SPL_MALLOC_START
3147 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003148 When this option is set the full malloc is used in SPL and
3149 it is set up by spl_init() and before that, the simple malloc()
3150 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003151
3152 CONFIG_SYS_SPL_MALLOC_SIZE
3153 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003154
Tom Rini28591df2012-08-13 12:03:19 -07003155 CONFIG_SPL_FRAMEWORK
3156 Enable the SPL framework under common/. This framework
3157 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3158 NAND loading of the Linux Kernel.
3159
Tom Rinic2b76002014-03-28 12:03:39 -04003160 CONFIG_SPL_OS_BOOT
3161 Enable booting directly to an OS from SPL.
3162 See also: doc/README.falcon
3163
Tom Rinife3b0c72012-08-13 11:37:56 -07003164 CONFIG_SPL_DISPLAY_PRINT
3165 For ARM, enable an optional function to print more information
3166 about the running system.
3167
Scott Wood7c810902012-09-20 16:35:21 -05003168 CONFIG_SPL_INIT_MINIMAL
3169 Arch init code should be built for a very small image
3170
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003171 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3172 Partition on the MMC to load U-Boot from when the MMC is being
3173 used in raw mode
3174
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003175 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3176 Sector to load kernel uImage from when MMC is being
3177 used in raw mode (for Falcon mode)
3178
3179 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3180 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3181 Sector and number of sectors to load kernel argument
3182 parameters from when MMC is being used in raw mode
3183 (for falcon mode)
3184
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003185 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3186 Partition on the MMC to load U-Boot from when the MMC is being
3187 used in fs mode
3188
Guillaume GARDET5065b712014-10-15 17:53:13 +02003189 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3190 Filename to read to load U-Boot when reading from filesystem
3191
3192 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003193 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003194 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003195
Guillaume GARDET5065b712014-10-15 17:53:13 +02003196 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003197 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003198 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003199
Scott Wood2b36fbb2012-12-06 13:33:17 +00003200 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3201 Set this for NAND SPL on PPC mpc83xx targets, so that
3202 start.S waits for the rest of the SPL to load before
3203 continuing (the hardware starts execution after just
3204 loading the first page rather than the full 4K).
3205
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303206 CONFIG_SPL_SKIP_RELOCATE
3207 Avoid SPL relocation
3208
Scott Woodc352a0c2012-09-20 19:09:07 -05003209 CONFIG_SPL_NAND_BASE
3210 Include nand_base.c in the SPL. Requires
3211 CONFIG_SPL_NAND_DRIVERS.
3212
3213 CONFIG_SPL_NAND_DRIVERS
3214 SPL uses normal NAND drivers, not minimal drivers.
3215
3216 CONFIG_SPL_NAND_ECC
3217 Include standard software ECC in the SPL
3218
Tom Rini36853852012-02-14 07:29:40 +00003219 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003220 Support for NAND boot using simple NAND drivers that
3221 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003222
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003223 CONFIG_SPL_UBI
3224 Support for a lightweight UBI (fastmap) scanner and
3225 loader
3226
Heiko Schochercf000272014-10-31 08:31:00 +01003227 CONFIG_SPL_NAND_RAW_ONLY
3228 Support to boot only raw u-boot.bin images. Use this only
3229 if you need to save space.
3230
Ying Zhangdfb2b152013-08-16 15:16:12 +08003231 CONFIG_SPL_COMMON_INIT_DDR
3232 Set for common ddr init with serial presence detect in
3233 SPL binary.
3234
Tom Rini36853852012-02-14 07:29:40 +00003235 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3236 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3237 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3238 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3239 CONFIG_SYS_NAND_ECCBYTES
3240 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003241 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003242
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303243 CONFIG_SPL_NAND_BOOT
3244 Add support NAND boot
3245
Tom Rini36853852012-02-14 07:29:40 +00003246 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003247 Location in NAND to read U-Boot from
3248
3249 CONFIG_SYS_NAND_U_BOOT_DST
3250 Location in memory to load U-Boot to
3251
3252 CONFIG_SYS_NAND_U_BOOT_SIZE
3253 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003254
3255 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003256 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003257
3258 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3259 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003260 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003261
3262 CONFIG_SPL_OMAP3_ID_NAND
3263 Support for an OMAP3-specific set of functions to return the
3264 ID and MFR of the first attached NAND chip, if present.
3265
Pavel Machekde997252012-08-30 22:42:11 +02003266 CONFIG_SPL_RAM_DEVICE
3267 Support for running image already present in ram, in SPL binary
3268
Scott Woodeb7bd972012-12-06 13:33:16 +00003269 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003270 Image offset to which the SPL should be padded before appending
3271 the SPL payload. By default, this is defined as
3272 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3273 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3274 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003275
Scott Woodf147eb72012-09-21 16:27:32 -05003276 CONFIG_SPL_TARGET
3277 Final target image containing SPL and payload. Some SPLs
3278 use an arch-specific makefile fragment instead, for
3279 example if more than one image needs to be produced.
3280
Simon Glass82d94532013-05-08 08:05:59 +00003281 CONFIG_FIT_SPL_PRINT
3282 Printing information about a FIT image adds quite a bit of
3283 code to SPL. So this is normally disabled in SPL. Use this
3284 option to re-enable it. This will affect the output of the
3285 bootm command when booting a FIT image.
3286
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003287- TPL framework
3288 CONFIG_TPL
3289 Enable building of TPL globally.
3290
3291 CONFIG_TPL_PAD_TO
3292 Image offset to which the TPL should be padded before appending
3293 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003294 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3295 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3296 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003297
wdenkc0aa5c52003-12-06 19:49:23 +00003298- Interrupt support (PPC):
3299
wdenk1ebf41e2004-01-02 14:00:00 +00003300 There are common interrupt_init() and timer_interrupt()
3301 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003302 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003303 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003304 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003305 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003306 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003307 specific handling. If board has watchdog / status_led
3308 / other_activity_monitor it works automatically from
3309 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003310
wdenkc6097192002-11-03 00:24:07 +00003311
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003312Board initialization settings:
3313------------------------------
3314
3315During Initialization u-boot calls a number of board specific functions
3316to allow the preparation of board specific prerequisites, e.g. pin setup
3317before drivers are initialized. To enable these callbacks the
3318following configuration macros have to be defined. Currently this is
3319architecture specific, so please check arch/your_architecture/lib/board.c
3320typically in board_init_f() and board_init_r().
3321
3322- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3323- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3324- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3325- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003326
wdenkc6097192002-11-03 00:24:07 +00003327Configuration Settings:
3328-----------------------
3329
York Sun6c480012014-02-26 17:03:19 -08003330- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3331 Optionally it can be defined to support 64-bit memory commands.
3332
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003333- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003334 undefine this when you're short of memory.
3335
Peter Tyserdfb72b82009-01-27 18:03:12 -06003336- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3337 width of the commands listed in the 'help' command output.
3338
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003339- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003340 prompt for user input.
3341
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003342- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003343
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003344- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003345
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003346- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003347
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003348- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003349 the application (usually a Linux kernel) when it is
3350 booted
3351
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003352- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003353 List of legal baudrate settings for this board.
3354
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003355- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003356 Begin and End addresses of the area used by the
3357 simple memory test.
3358
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003359- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003360 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003361
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003362- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003363 Scratch address used by the alternate memory test
3364 You only need to set this if address zero isn't writeable
3365
York Sun5d286cd2015-12-04 11:57:07 -08003366- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003367 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003368 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3369 is substracted from total RAM and won't be reported to OS.
3370 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003371 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003372 the RAM base is not zero, or RAM is divided into banks,
3373 this variable needs to be recalcuated to get the address.
3374
York Sun50739372015-12-07 11:05:29 -08003375- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003376 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003377 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003378 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003379 fixing up gd->ram_size the Linux kernel should gets passed
3380 the now "corrected" memory size and won't touch it either.
3381 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003382 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003383 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003384 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003385
3386 This option can be used as a workaround for the 440EPx/GRx
3387 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3388 be touched.
3389
3390 WARNING: Please make sure that this value is a multiple of
3391 the Linux page size (normally 4k). If this is not the case,
3392 then the end address of the Linux memory will be located at a
3393 non page size aligned address and this could cause major
3394 problems.
3395
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003396- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003397 Enable temporary baudrate change while serial download
3398
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003399- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003400 Physical start address of SDRAM. _Must_ be 0 here.
3401
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003402- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003403 Physical start address of Flash memory.
3404
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003405- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003406 Physical start address of boot monitor code (set by
3407 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003408 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003409 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003410
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003411- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003412 Size of memory reserved for monitor code, used to
3413 determine _at_compile_time_ (!) if the environment is
3414 embedded within the U-Boot image, or in a separate
3415 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003416
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003417- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003418 Size of DRAM reserved for malloc() use.
3419
Simon Glass863e4042014-07-10 22:23:28 -06003420- CONFIG_SYS_MALLOC_F_LEN
3421 Size of the malloc() pool for use before relocation. If
3422 this is defined, then a very simple malloc() implementation
3423 will become available before relocation. The address is just
3424 below the global data, and the stack is moved down to make
3425 space.
3426
3427 This feature allocates regions with increasing addresses
3428 within the region. calloc() is supported, but realloc()
3429 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003430 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003431 U-Boot relocates itself.
3432
Simon Glass9fa901b2014-11-10 17:16:54 -07003433- CONFIG_SYS_MALLOC_SIMPLE
3434 Provides a simple and small malloc() and calloc() for those
3435 boards which do not use the full malloc in SPL (which is
3436 enabled with CONFIG_SYS_SPL_MALLOC_START).
3437
Thierry Redingc97d9742014-12-09 22:25:22 -07003438- CONFIG_SYS_NONCACHED_MEMORY:
3439 Size of non-cached memory area. This area of memory will be
3440 typically located right below the malloc() area and mapped
3441 uncached in the MMU. This is useful for drivers that would
3442 otherwise require a lot of explicit cache maintenance. For
3443 some drivers it's also impossible to properly maintain the
3444 cache. For example if the regions that need to be flushed
3445 are not a multiple of the cache-line size, *and* padding
3446 cannot be allocated between the regions to align them (i.e.
3447 if the HW requires a contiguous array of regions, and the
3448 size of each region is not cache-aligned), then a flush of
3449 one region may result in overwriting data that hardware has
3450 written to another region in the same cache-line. This can
3451 happen for example in network drivers where descriptors for
3452 buffers are typically smaller than the CPU cache-line (e.g.
3453 16 bytes vs. 32 or 64 bytes).
3454
3455 Non-cached memory is only supported on 32-bit ARM at present.
3456
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003457- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003458 Normally compressed uImages are limited to an
3459 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003460 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003461 to adjust this setting to your needs.
3462
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003463- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003464 Maximum size of memory mapped by the startup code of
3465 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003466 the Linux kernel (bd_info, boot arguments, FDT blob if
3467 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003468 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003469 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003470 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003471 variable "bootm_mapsize" will override the value of
3472 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3473 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003474
John Rigbyeea8e692010-10-13 13:57:35 -06003475- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3476 Enable initrd_high functionality. If defined then the
3477 initrd_high feature is enabled and the bootm ramdisk subcommand
3478 is enabled.
3479
3480- CONFIG_SYS_BOOT_GET_CMDLINE:
3481 Enables allocating and saving kernel cmdline in space between
3482 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3483
3484- CONFIG_SYS_BOOT_GET_KBD:
3485 Enables allocating and saving a kernel copy of the bd_info in
3486 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3487
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003488- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003489 Max number of Flash memory banks
3490
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003491- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003492 Max number of sectors on a Flash chip
3493
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003494- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003495 Timeout for Flash erase operations (in ms)
3496
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003497- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003498 Timeout for Flash write operations (in ms)
3499
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003500- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003501 Timeout for Flash set sector lock bit operation (in ms)
3502
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003503- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003504 Timeout for Flash clear lock bits operation (in ms)
3505
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003506- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003507 If defined, hardware flash sectors protection is used
3508 instead of U-Boot software protection.
3509
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003510- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003511
3512 Enable TFTP transfers directly to flash memory;
3513 without this option such a download has to be
3514 performed in two steps: (1) download to RAM, and (2)
3515 copy from RAM to flash.
3516
3517 The two-step approach is usually more reliable, since
3518 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003519 the flash, but in some situations (when system RAM is
3520 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003521 downloaded image) this option may be very useful.
3522
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003523- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003524 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003525 common flash structure for storing flash geometry.
3526
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003527- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003528 This option also enables the building of the cfi_flash driver
3529 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003530
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003531- CONFIG_FLASH_CFI_MTD
3532 This option enables the building of the cfi_mtd driver
3533 in the drivers directory. The driver exports CFI flash
3534 to the MTD layer.
3535
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003536- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003537 Use buffered writes to flash.
3538
3539- CONFIG_FLASH_SPANSION_S29WS_N
3540 s29ws-n MirrorBit flash has non-standard addresses for buffered
3541 write commands.
3542
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003543- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003544 If this option is defined, the common CFI flash doesn't
3545 print it's warning upon not recognized FLASH banks. This
3546 is useful, if some of the configured banks are only
3547 optionally available.
3548
Jerry Van Barenaae73572008-03-08 13:48:01 -05003549- CONFIG_FLASH_SHOW_PROGRESS
3550 If defined (must be an integer), print out countdown
3551 digits and dots. Recommended value: 45 (9..1) for 80
3552 column displays, 15 (3..1) for 40 column displays.
3553
Stefan Roesed20cba52013-04-04 15:53:14 +02003554- CONFIG_FLASH_VERIFY
3555 If defined, the content of the flash (destination) is compared
3556 against the source after the write operation. An error message
3557 will be printed when the contents are not identical.
3558 Please note that this option is useless in nearly all cases,
3559 since such flash programming errors usually are detected earlier
3560 while unprotecting/erasing/programming. Please only enable
3561 this option if you really know what you are doing.
3562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003563- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003564 Defines the number of Ethernet receive buffers. On some
3565 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003566 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3567 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003568 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003569 Defaults to 4 if not defined.
3570
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003571- CONFIG_ENV_MAX_ENTRIES
3572
Wolfgang Denk1136f692010-10-27 22:48:30 +02003573 Maximum number of entries in the hash table that is used
3574 internally to store the environment settings. The default
3575 setting is supposed to be generous and should work in most
3576 cases. This setting can be used to tune behaviour; see
3577 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003578
Joe Hershberger71497d02012-12-11 22:16:31 -06003579- CONFIG_ENV_FLAGS_LIST_DEFAULT
3580- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003581 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003582 calling env set. Variables can be restricted to only decimal,
3583 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3584 the variables can also be restricted to IP address or MAC address.
3585
3586 The format of the list is:
3587 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003588 access_attribute = [a|r|o|c]
3589 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003590 entry = variable_name[:attributes]
3591 list = entry[,list]
3592
3593 The type attributes are:
3594 s - String (default)
3595 d - Decimal
3596 x - Hexadecimal
3597 b - Boolean ([1yYtT|0nNfF])
3598 i - IP address
3599 m - MAC address
3600
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003601 The access attributes are:
3602 a - Any (default)
3603 r - Read-only
3604 o - Write-once
3605 c - Change-default
3606
Joe Hershberger71497d02012-12-11 22:16:31 -06003607 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3608 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003609 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003610
3611 - CONFIG_ENV_FLAGS_LIST_STATIC
3612 Define this to a list (string) to define validation that
3613 should be done if an entry is not found in the ".flags"
3614 environment variable. To override a setting in the static
3615 list, simply add an entry for the same variable name to the
3616 ".flags" variable.
3617
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003618 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3619 regular expression. This allows multiple variables to define the same
3620 flags without explicitly listing them for each variable.
3621
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003622- CONFIG_ENV_ACCESS_IGNORE_FORCE
3623 If defined, don't allow the -f switch to env set override variable
3624 access flags.
3625
Gabe Black3687fe42014-10-15 04:38:30 -06003626- CONFIG_USE_STDINT
3627 If stdint.h is available with your toolchain you can define this
3628 option to enable it. You can provide option 'USE_STDINT=1' when
3629 building U-Boot to enable this.
3630
wdenkc6097192002-11-03 00:24:07 +00003631The following definitions that deal with the placement and management
3632of environment data (variable area); in general, we support the
3633following configurations:
3634
Mike Frysinger63b8f122011-07-08 10:44:25 +00003635- CONFIG_BUILD_ENVCRC:
3636
3637 Builds up envcrc with the target environment so that external utils
3638 may easily extract it and embed it in final U-Boot images.
3639
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003640- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003641
3642 Define this if the environment is in flash memory.
3643
3644 a) The environment occupies one whole flash sector, which is
3645 "embedded" in the text segment with the U-Boot code. This
3646 happens usually with "bottom boot sector" or "top boot
3647 sector" type flash chips, which have several smaller
3648 sectors at the start or the end. For instance, such a
3649 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3650 such a case you would place the environment in one of the
3651 4 kB sectors - with U-Boot code before and after it. With
3652 "top boot sector" type flash chips, you would put the
3653 environment in one of the last sectors, leaving a gap
3654 between U-Boot and the environment.
3655
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003656 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003657
3658 Offset of environment data (variable area) to the
3659 beginning of flash memory; for instance, with bottom boot
3660 type flash chips the second sector can be used: the offset
3661 for this sector is given here.
3662
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003663 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003664
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003665 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003666
3667 This is just another way to specify the start address of
3668 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003669 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003670
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003671 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003672
3673 Size of the sector containing the environment.
3674
3675
3676 b) Sometimes flash chips have few, equal sized, BIG sectors.
3677 In such a case you don't want to spend a whole sector for
3678 the environment.
3679
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003680 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003681
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003682 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003683 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003684 of this flash sector for the environment. This saves
3685 memory for the RAM copy of the environment.
3686
3687 It may also save flash memory if you decide to use this
3688 when your environment is "embedded" within U-Boot code,
3689 since then the remainder of the flash sector could be used
3690 for U-Boot code. It should be pointed out that this is
3691 STRONGLY DISCOURAGED from a robustness point of view:
3692 updating the environment in flash makes it always
3693 necessary to erase the WHOLE sector. If something goes
3694 wrong before the contents has been restored from a copy in
3695 RAM, your target system will be dead.
3696
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003697 - CONFIG_ENV_ADDR_REDUND
3698 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003699
wdenk4a5c8a72003-03-06 00:02:04 +00003700 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003701 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003702 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003703 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003704
3705BE CAREFUL! Any changes to the flash layout, and some changes to the
3706source code will make it necessary to adapt <board>/u-boot.lds*
3707accordingly!
3708
3709
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003710- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003711
3712 Define this if you have some non-volatile memory device
3713 (NVRAM, battery buffered SRAM) which you want to use for the
3714 environment.
3715
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003716 - CONFIG_ENV_ADDR:
3717 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003718
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003719 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003720 want to use for environment. It is assumed that this memory
3721 can just be read and written to, without any special
3722 provision.
3723
3724BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003725in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003726console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003727U-Boot will hang.
3728
3729Please note that even with NVRAM we still use a copy of the
3730environment in RAM: we could work on NVRAM directly, but we want to
3731keep settings there always unmodified except somebody uses "saveenv"
3732to save the current settings.
3733
3734
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003735- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003736
3737 Use this if you have an EEPROM or similar serial access
3738 device and a driver for it.
3739
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003740 - CONFIG_ENV_OFFSET:
3741 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003742
3743 These two #defines specify the offset and size of the
3744 environment area within the total memory of your EEPROM.
3745
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003746 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003747 If defined, specified the chip address of the EEPROM device.
3748 The default address is zero.
3749
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003750 - CONFIG_SYS_I2C_EEPROM_BUS:
3751 If defined, specified the i2c bus of the EEPROM device.
3752
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003753 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003754 If defined, the number of bits used to address bytes in a
3755 single page in the EEPROM device. A 64 byte page, for example
3756 would require six bits.
3757
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003758 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003759 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003760 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003761
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003762 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003763 The length in bytes of the EEPROM memory array address. Note
3764 that this is NOT the chip address length!
3765
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003766 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003767 EEPROM chips that implement "address overflow" are ones
3768 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3769 address and the extra bits end up in the "chip address" bit
3770 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3771 byte chips.
3772
3773 Note that we consider the length of the address field to
3774 still be one byte because the extra address bits are hidden
3775 in the chip address.
3776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003777 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003778 The size in bytes of the EEPROM device.
3779
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003780 - CONFIG_ENV_EEPROM_IS_ON_I2C
3781 define this, if you have I2C and SPI activated, and your
3782 EEPROM, which holds the environment, is on the I2C bus.
3783
3784 - CONFIG_I2C_ENV_EEPROM_BUS
3785 if you have an Environment on an EEPROM reached over
3786 I2C muxes, you can define here, how to reach this
3787 EEPROM. For example:
3788
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003789 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003790
3791 EEPROM which holds the environment, is reached over
3792 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003793
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003794- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003795
wdenk1ebf41e2004-01-02 14:00:00 +00003796 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003797 want to use for the environment.
3798
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003799 - CONFIG_ENV_OFFSET:
3800 - CONFIG_ENV_ADDR:
3801 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003802
3803 These three #defines specify the offset and size of the
3804 environment area within the total memory of your DataFlash placed
3805 at the specified address.
3806
Wu, Josh76db7bf2014-07-01 19:30:13 +08003807- CONFIG_ENV_IS_IN_SPI_FLASH:
3808
3809 Define this if you have a SPI Flash memory device which you
3810 want to use for the environment.
3811
3812 - CONFIG_ENV_OFFSET:
3813 - CONFIG_ENV_SIZE:
3814
3815 These two #defines specify the offset and size of the
3816 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3817 aligned to an erase sector boundary.
3818
3819 - CONFIG_ENV_SECT_SIZE:
3820
3821 Define the SPI flash's sector size.
3822
3823 - CONFIG_ENV_OFFSET_REDUND (optional):
3824
3825 This setting describes a second storage area of CONFIG_ENV_SIZE
3826 size used to hold a redundant copy of the environment data, so
3827 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003828 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003829 aligned to an erase sector boundary.
3830
3831 - CONFIG_ENV_SPI_BUS (optional):
3832 - CONFIG_ENV_SPI_CS (optional):
3833
3834 Define the SPI bus and chip select. If not defined they will be 0.
3835
3836 - CONFIG_ENV_SPI_MAX_HZ (optional):
3837
3838 Define the SPI max work clock. If not defined then use 1MHz.
3839
3840 - CONFIG_ENV_SPI_MODE (optional):
3841
3842 Define the SPI work mode. If not defined then use SPI_MODE_3.
3843
Liu Gang85bcd732012-03-08 00:33:20 +00003844- CONFIG_ENV_IS_IN_REMOTE:
3845
3846 Define this if you have a remote memory space which you
3847 want to use for the local device's environment.
3848
3849 - CONFIG_ENV_ADDR:
3850 - CONFIG_ENV_SIZE:
3851
3852 These two #defines specify the address and size of the
3853 environment area within the remote memory space. The
3854 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003855 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003856
3857BE CAREFUL! For some special cases, the local device can not use
3858"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003859environment stored in a remote NOR flash by SRIO or PCIE link,
3860but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003861
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003862- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003863
3864 Define this if you have a NAND device which you want to use
3865 for the environment.
3866
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003867 - CONFIG_ENV_OFFSET:
3868 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003869
3870 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003871 area within the first NAND device. CONFIG_ENV_OFFSET must be
3872 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003873
Scott Wood08239322010-09-17 14:38:37 -05003874 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003875
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003876 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003877 size used to hold a redundant copy of the environment data, so
3878 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003879 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003880 aligned to an erase block boundary.
3881
3882 - CONFIG_ENV_RANGE (optional):
3883
3884 Specifies the length of the region in which the environment
3885 can be written. This should be a multiple of the NAND device's
3886 block size. Specifying a range with more erase blocks than
3887 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3888 the range to be avoided.
3889
3890 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003891
Scott Wood08239322010-09-17 14:38:37 -05003892 Enables support for dynamically retrieving the offset of the
3893 environment from block zero's out-of-band data. The
3894 "nand env.oob" command can be used to record this offset.
3895 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3896 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003897
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003898- CONFIG_NAND_ENV_DST
3899
3900 Defines address in RAM to which the nand_spl code should copy the
3901 environment. If redundant environment is used, it will be copied to
3902 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3903
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003904- CONFIG_ENV_IS_IN_UBI:
3905
3906 Define this if you have an UBI volume that you want to use for the
3907 environment. This has the benefit of wear-leveling the environment
3908 accesses, which is important on NAND.
3909
3910 - CONFIG_ENV_UBI_PART:
3911
3912 Define this to a string that is the mtd partition containing the UBI.
3913
3914 - CONFIG_ENV_UBI_VOLUME:
3915
3916 Define this to the name of the volume that you want to store the
3917 environment in.
3918
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003919 - CONFIG_ENV_UBI_VOLUME_REDUND:
3920
3921 Define this to the name of another volume to store a second copy of
3922 the environment in. This will enable redundant environments in UBI.
3923 It is assumed that both volumes are in the same MTD partition.
3924
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003925 - CONFIG_UBI_SILENCE_MSG
3926 - CONFIG_UBIFS_SILENCE_MSG
3927
3928 You will probably want to define these to avoid a really noisy system
3929 when storing the env in UBI.
3930
Wu, Josha7d0c872014-06-24 17:31:03 +08003931- CONFIG_ENV_IS_IN_FAT:
3932 Define this if you want to use the FAT file system for the environment.
3933
3934 - FAT_ENV_INTERFACE:
3935
3936 Define this to a string that is the name of the block device.
3937
Nicolae Rosia86811f22016-11-21 17:33:58 +02003938 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003939
3940 Define this to a string to specify the partition of the device. It can
3941 be as following:
3942
3943 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3944 - "D:P": device D partition P. Error occurs if device D has no
3945 partition table.
3946 - "D:0": device D.
3947 - "D" or "D:": device D partition 1 if device D has partition
3948 table, or the whole device D if has no partition
3949 table.
3950 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003951 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08003952 partition table then means device D.
3953
3954 - FAT_ENV_FILE:
3955
3956 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003957 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08003958
3959 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003960 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08003961
Stephen Warreneedcacd2013-06-11 15:14:00 -06003962- CONFIG_ENV_IS_IN_MMC:
3963
3964 Define this if you have an MMC device which you want to use for the
3965 environment.
3966
3967 - CONFIG_SYS_MMC_ENV_DEV:
3968
3969 Specifies which MMC device the environment is stored in.
3970
3971 - CONFIG_SYS_MMC_ENV_PART (optional):
3972
3973 Specifies which MMC partition the environment is stored in. If not
3974 set, defaults to partition 0, the user area. Common values might be
3975 1 (first MMC boot partition), 2 (second MMC boot partition).
3976
3977 - CONFIG_ENV_OFFSET:
3978 - CONFIG_ENV_SIZE:
3979
3980 These two #defines specify the offset and size of the environment
3981 area within the specified MMC device.
3982
Stephen Warren24dc2032013-06-11 15:14:02 -06003983 If offset is positive (the usual case), it is treated as relative to
3984 the start of the MMC partition. If offset is negative, it is treated
3985 as relative to the end of the MMC partition. This can be useful if
3986 your board may be fitted with different MMC devices, which have
3987 different sizes for the MMC partitions, and you always want the
3988 environment placed at the very end of the partition, to leave the
3989 maximum possible space before it, to store other data.
3990
Stephen Warreneedcacd2013-06-11 15:14:00 -06003991 These two values are in units of bytes, but must be aligned to an
3992 MMC sector boundary.
3993
3994 - CONFIG_ENV_OFFSET_REDUND (optional):
3995
3996 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3997 hold a redundant copy of the environment data. This provides a
3998 valid backup copy in case the other copy is corrupted, e.g. due
3999 to a power failure during a "saveenv" operation.
4000
Stephen Warren24dc2032013-06-11 15:14:02 -06004001 This value may also be positive or negative; this is handled in the
4002 same way as CONFIG_ENV_OFFSET.
4003
Stephen Warreneedcacd2013-06-11 15:14:00 -06004004 This value is also in units of bytes, but must also be aligned to
4005 an MMC sector boundary.
4006
4007 - CONFIG_ENV_SIZE_REDUND (optional):
4008
4009 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4010 set. If this value is set, it must be set to the same value as
4011 CONFIG_ENV_SIZE.
4012
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004013- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004014
4015 Defines offset to the initial SPI buffer area in DPRAM. The
4016 area is used at an early stage (ROM part) if the environment
4017 is configured to reside in the SPI EEPROM: We need a 520 byte
4018 scratch DPRAM area. It is used between the two initialization
4019 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4020 to be a good choice since it makes it far enough from the
4021 start of the data area as well as from the stack pointer.
4022
Bruce Adleredecc942007-11-02 13:15:42 -07004023Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004024has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004025created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004026until then to read environment variables.
4027
wdenk8dba0502003-03-31 16:34:49 +00004028The environment is protected by a CRC32 checksum. Before the monitor
4029is relocated into RAM, as a result of a bad CRC you will be working
4030with the compiled-in default environment - *silently*!!! [This is
4031necessary, because the first environment variable we need is the
4032"baudrate" setting for the console - if we have a bad CRC, we don't
4033have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004034
4035Note: once the monitor has been relocated, then it will complain if
4036the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004037use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004038
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004039- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004040 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004041
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004042 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004043 also needs to be defined.
4044
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004045- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004046 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004047
Ron Madriddfa028a2009-02-18 14:30:44 -08004048- CONFIG_NS16550_MIN_FUNCTIONS:
4049 Define this if you desire to only have use of the NS16550_init
4050 and NS16550_putc functions for the serial driver located at
4051 drivers/serial/ns16550.c. This option is useful for saving
4052 space for already greatly restricted images, including but not
4053 limited to NAND_SPL configurations.
4054
Simon Glass28a9e332012-11-30 13:01:18 +00004055- CONFIG_DISPLAY_BOARDINFO
4056 Display information about the board that U-Boot is running on
4057 when U-Boot starts up. The board function checkboard() is called
4058 to do this.
4059
Simon Glasse8822012012-11-30 13:01:19 +00004060- CONFIG_DISPLAY_BOARDINFO_LATE
4061 Similar to the previous option, but display this information
4062 later, once stdio is running and output goes to the LCD, if
4063 present.
4064
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004065- CONFIG_BOARD_SIZE_LIMIT:
4066 Maximum size of the U-Boot image. When defined, the
4067 build system checks that the actual size does not
4068 exceed it.
4069
wdenkc6097192002-11-03 00:24:07 +00004070Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004071---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004072
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004073- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004074 Cache Line Size of the CPU.
4075
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004076- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004077 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004078
wdenk9c53f402003-10-15 23:53:47 +00004079 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4080 and RPXsuper) to be able to adjust the position of
4081 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004082
Timur Tabid8f341c2011-08-04 18:03:41 -05004083- CONFIG_SYS_CCSRBAR_DEFAULT:
4084 Default (power-on reset) physical address of CCSR on Freescale
4085 PowerPC SOCs.
4086
4087- CONFIG_SYS_CCSRBAR:
4088 Virtual address of CCSR. On a 32-bit build, this is typically
4089 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4090
4091 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4092 for cross-platform code that uses that macro instead.
4093
4094- CONFIG_SYS_CCSRBAR_PHYS:
4095 Physical address of CCSR. CCSR can be relocated to a new
4096 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004097 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004098 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4099 is typically relocated on 36-bit builds. It is recommended
4100 that this macro be defined via the _HIGH and _LOW macros:
4101
4102 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4103 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4104
4105- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004106 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4107 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004108 used in assembly code, so it must not contain typecasts or
4109 integer size suffixes (e.g. "ULL").
4110
4111- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4112 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4113 used in assembly code, so it must not contain typecasts or
4114 integer size suffixes (e.g. "ULL").
4115
4116- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4117 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4118 forced to a value that ensures that CCSR is not relocated.
4119
wdenk1272e232002-11-10 22:06:23 +00004120- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004121 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004122
4123 the default drive number (default value 0)
4124
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004125 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004126
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004127 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004128 (default value 1)
4129
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004130 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004131
wdenk4a5c8a72003-03-06 00:02:04 +00004132 defines the offset of register from address. It
4133 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004134 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004135
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004136 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4137 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004138 default value.
wdenk1272e232002-11-10 22:06:23 +00004139
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004140 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004141 fdc_hw_init() is called at the beginning of the FDC
4142 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004143 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004144 initializations.
wdenk1272e232002-11-10 22:06:23 +00004145
Macpaul Lind1e49942011-04-11 20:45:32 +00004146- CONFIG_IDE_AHB:
4147 Most IDE controllers were designed to be connected with PCI
4148 interface. Only few of them were designed for AHB interface.
4149 When software is doing ATA command and data transfer to
4150 IDE devices through IDE-AHB controller, some additional
4151 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004152 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004154- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004155 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004156 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004158- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004159
wdenkeb20ad32003-09-05 23:19:14 +00004160 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004161 initial data and stack; please note that this must be
4162 writable memory that is working WITHOUT special
4163 initialization, i. e. you CANNOT use normal RAM which
4164 will become available only after programming the
4165 memory controller and running certain initialization
4166 sequences.
4167
4168 U-Boot uses the following memory types:
4169 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4170 - MPC824X: data cache
4171 - PPC4xx: data cache
4172
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004173- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004174
4175 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004176 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4177 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004178 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004179 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004180 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004181 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4182 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004183
4184 Note:
4185 On the MPC824X (or other systems that use the data
4186 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004187 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004188 point to an otherwise UNUSED address space between
4189 the top of RAM and the start of the PCI space.
4190
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004191- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004192
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004193- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004194
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004195- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004196
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004197- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004198
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004199- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004200
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004201- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004202
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004203- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004204 SDRAM timing
4205
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004206- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004207 periodic timer for refresh
4208
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004209- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004210
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004211- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4212 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4213 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4214 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004215 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4216
4217- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004218 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4219 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004220 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004222- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4223 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004224 Machine Mode Register and Memory Periodic Timer
4225 Prescaler definitions (SDRAM timing)
4226
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004227- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004228 enable I2C microcode relocation patch (MPC8xx);
4229 define relocation offset in DPRAM [DSP2]
4230
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004231- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004232 enable SMC microcode relocation patch (MPC8xx);
4233 define relocation offset in DPRAM [SMC1]
4234
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004235- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004236 enable SPI microcode relocation patch (MPC8xx);
4237 define relocation offset in DPRAM [SCC4]
4238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004239- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004240 Offset of the bootmode word in DPRAM used by post
4241 (Power On Self Tests). This definition overrides
4242 #define'd default value in commproc.h resp.
4243 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004244
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004245- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4246 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4247 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4248 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4249 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4250 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4251 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4252 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004253 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004254
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004255- CONFIG_PCI_DISABLE_PCIE:
4256 Disable PCI-Express on systems where it is supported but not
4257 required.
4258
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004259- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004260 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004261 Don't do any setup work, presumably because someone or
4262 something has already done it, and we don't need to do it
4263 a second time. Useful for platforms that are pre-booted
4264 by coreboot or similar.
4265
Gabor Juhosb4458732013-05-30 07:06:12 +00004266- CONFIG_PCI_INDIRECT_BRIDGE:
4267 Enable support for indirect PCI bridges.
4268
Kumar Gala8975d7a2010-12-30 12:09:53 -06004269- CONFIG_SYS_SRIO:
4270 Chip has SRIO or not
4271
4272- CONFIG_SRIO1:
4273 Board has SRIO 1 port available
4274
4275- CONFIG_SRIO2:
4276 Board has SRIO 2 port available
4277
Liu Gang27afb9c2013-05-07 16:30:46 +08004278- CONFIG_SRIO_PCIE_BOOT_MASTER
4279 Board can support master function for Boot from SRIO and PCIE
4280
Kumar Gala8975d7a2010-12-30 12:09:53 -06004281- CONFIG_SYS_SRIOn_MEM_VIRT:
4282 Virtual Address of SRIO port 'n' memory region
4283
4284- CONFIG_SYS_SRIOn_MEM_PHYS:
4285 Physical Address of SRIO port 'n' memory region
4286
4287- CONFIG_SYS_SRIOn_MEM_SIZE:
4288 Size of SRIO port 'n' memory region
4289
Fabio Estevamf17e8782013-04-11 09:35:34 +00004290- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4291 Defined to tell the NAND controller that the NAND chip is using
4292 a 16 bit bus.
4293 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004294 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004295 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004296 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004297
4298- CONFIG_SYS_NDFC_EBC0_CFG
4299 Sets the EBC0_CFG register for the NDFC. If not defined
4300 a default value will be used.
4301
Ben Warren45657152006-09-07 16:50:54 -04004302- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004303 Get DDR timing information from an I2C EEPROM. Common
4304 with pluggable memory modules such as SODIMMs
4305
Ben Warren45657152006-09-07 16:50:54 -04004306 SPD_EEPROM_ADDRESS
4307 I2C address of the SPD EEPROM
4308
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004309- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004310 If SPD EEPROM is on an I2C bus other than the first
4311 one, specify here. Note that the value must resolve
4312 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004313
York Sune73cc042011-06-07 09:42:16 +08004314- CONFIG_SYS_DDR_RAW_TIMING
4315 Get DDR timing information from other than SPD. Common with
4316 soldered DDR chips onboard without SPD. DDR raw timing
4317 parameters are extracted from datasheet and hard-coded into
4318 header files or board specific files.
4319
York Sunbd495cf2011-09-16 13:21:35 -07004320- CONFIG_FSL_DDR_INTERACTIVE
4321 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4322
York Sun8ced0502015-01-06 13:18:55 -08004323- CONFIG_FSL_DDR_SYNC_REFRESH
4324 Enable sync of refresh for multiple controllers.
4325
York Sunb6a35f82015-03-19 09:30:28 -07004326- CONFIG_FSL_DDR_BIST
4327 Enable built-in memory test for Freescale DDR controllers.
4328
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004329- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004330 Only for 83xx systems. If specified, then DDR should
4331 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004332
wdenk6203e402004-04-18 10:13:26 +00004333- CONFIG_ETHER_ON_FEC[12]
4334 Define to enable FEC[12] on a 8xx series processor.
4335
4336- CONFIG_FEC[12]_PHY
4337 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004338 to the given FEC; i. e.
4339 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004340 means that the PHY with address 4 is connected to FEC1
4341
4342 When set to -1, means to probe for first available.
4343
4344- CONFIG_FEC[12]_PHY_NORXERR
4345 The PHY does not have a RXERR line (RMII only).
4346 (so program the FEC to ignore it).
4347
4348- CONFIG_RMII
4349 Enable RMII mode for all FECs.
4350 Note that this is a global option, we can't
4351 have one FEC in standard MII mode and another in RMII mode.
4352
wdenk20c98a62004-04-23 20:32:05 +00004353- CONFIG_CRC32_VERIFY
4354 Add a verify option to the crc32 command.
4355 The syntax is:
4356
4357 => crc32 -v <address> <count> <crc32>
4358
4359 Where address/count indicate a memory area
4360 and crc32 is the correct crc32 which the
4361 area should have.
4362
wdenk64519362004-07-11 17:40:54 +00004363- CONFIG_LOOPW
4364 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004365 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004366
stroesecc3af832004-12-16 18:46:55 +00004367- CONFIG_MX_CYCLIC
4368 Add the "mdc" and "mwc" memory commands. These are cyclic
4369 "md/mw" commands.
4370 Examples:
4371
wdenk07d7e6b2004-12-16 21:44:03 +00004372 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004373 This command will print 4 bytes (10,11,12,13) each 500 ms.
4374
wdenk07d7e6b2004-12-16 21:44:03 +00004375 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004376 This command will write 12345678 to address 100 all 10 ms.
4377
wdenk07d7e6b2004-12-16 21:44:03 +00004378 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004379 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004380
wdenk3d3d99f2005-04-04 12:44:11 +00004381- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004382 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004383 low level initializations (like setting up the memory
4384 controller) are omitted and/or U-Boot does not
4385 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004386
Wolfgang Denk302141d2010-11-27 23:30:56 +01004387 Normally this variable MUST NOT be defined. The only
4388 exception is when U-Boot is loaded (to RAM) by some
4389 other boot loader or by a debugger which performs
4390 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004391
Simon Glass90844072016-05-05 07:28:06 -06004392- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4393 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004394 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004395 instruction cache) is still performed.
4396
Aneesh V552a3192011-07-13 05:11:07 +00004397- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004398 Modifies the behaviour of start.S when compiling a loader
4399 that is executed before the actual U-Boot. E.g. when
4400 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004401
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004402- CONFIG_TPL_BUILD
4403 Modifies the behaviour of start.S when compiling a loader
4404 that is executed after the SPL and before the actual U-Boot.
4405 It is loaded by the SPL.
4406
Ying Zhang0d4f5442013-05-20 14:07:23 +08004407- CONFIG_SYS_MPC85XX_NO_RESETVEC
4408 Only for 85xx systems. If this variable is specified, the section
4409 .resetvec is not kept and the section .bootpg is placed in the
4410 previous 4k of the .text section.
4411
Simon Glass17dabf02013-02-24 17:33:14 +00004412- CONFIG_ARCH_MAP_SYSMEM
4413 Generally U-Boot (and in particular the md command) uses
4414 effective address. It is therefore not necessary to regard
4415 U-Boot address as virtual addresses that need to be translated
4416 to physical addresses. However, sandbox requires this, since
4417 it maintains its own little RAM buffer which contains all
4418 addressable memory. This option causes some memory accesses
4419 to be mapped through map_sysmem() / unmap_sysmem().
4420
Simon Glassbfb59802013-02-14 04:18:54 +00004421- CONFIG_X86_RESET_VECTOR
4422 If defined, the x86 reset vector code is included. This is not
4423 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004424
Heiko Schocher2233e462013-11-04 14:05:00 +01004425- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4426 Enables the RTC32K OSC on AM33xx based plattforms
4427
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004428- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4429 Option to disable subpage write in NAND driver
4430 driver that uses this:
4431 drivers/mtd/nand/davinci_nand.c
4432
Timur Tabi275f4bb2011-11-22 09:21:25 -06004433Freescale QE/FMAN Firmware Support:
4434-----------------------------------
4435
4436The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4437loading of "firmware", which is encoded in the QE firmware binary format.
4438This firmware often needs to be loaded during U-Boot booting, so macros
4439are used to identify the storage device (NOR flash, SPI, etc) and the address
4440within that device.
4441
Zhao Qiang83a90842014-03-21 16:21:44 +08004442- CONFIG_SYS_FMAN_FW_ADDR
4443 The address in the storage device where the FMAN microcode is located. The
4444 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4445 is also specified.
4446
4447- CONFIG_SYS_QE_FW_ADDR
4448 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004449 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4450 is also specified.
4451
4452- CONFIG_SYS_QE_FMAN_FW_LENGTH
4453 The maximum possible size of the firmware. The firmware binary format
4454 has a field that specifies the actual size of the firmware, but it
4455 might not be possible to read any part of the firmware unless some
4456 local storage is allocated to hold the entire firmware first.
4457
4458- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4459 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4460 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4461 virtual address in NOR flash.
4462
4463- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4464 Specifies that QE/FMAN firmware is located in NAND flash.
4465 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4466
4467- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4468 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4469 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4470
Liu Gang1e084582012-03-08 00:33:18 +00004471- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4472 Specifies that QE/FMAN firmware is located in the remote (master)
4473 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004474 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4475 window->master inbound window->master LAW->the ucode address in
4476 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004477
J. German Rivera8ff14b72014-06-23 15:15:55 -07004478Freescale Layerscape Management Complex Firmware Support:
4479---------------------------------------------------------
4480The Freescale Layerscape Management Complex (MC) supports the loading of
4481"firmware".
4482This firmware often needs to be loaded during U-Boot booting, so macros
4483are used to identify the storage device (NOR flash, SPI, etc) and the address
4484within that device.
4485
4486- CONFIG_FSL_MC_ENET
4487 Enable the MC driver for Layerscape SoCs.
4488
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304489Freescale Layerscape Debug Server Support:
4490-------------------------------------------
4491The Freescale Layerscape Debug Server Support supports the loading of
4492"Debug Server firmware" and triggering SP boot-rom.
4493This firmware often needs to be loaded during U-Boot booting.
4494
York Sun928b6812015-12-07 11:08:58 -08004495- CONFIG_SYS_MC_RSV_MEM_ALIGN
4496 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304497
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004498Reproducible builds
4499-------------------
4500
4501In order to achieve reproducible builds, timestamps used in the U-Boot build
4502process have to be set to a fixed value.
4503
4504This is done using the SOURCE_DATE_EPOCH environment variable.
4505SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4506option for U-Boot or an environment variable in U-Boot.
4507
4508SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4509
wdenkc6097192002-11-03 00:24:07 +00004510Building the Software:
4511======================
4512
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004513Building U-Boot has been tested in several native build environments
4514and in many different cross environments. Of course we cannot support
4515all possibly existing versions of cross development tools in all
4516(potentially obsolete) versions. In case of tool chain problems we
4517recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4518which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004519
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004520If you are not using a native environment, it is assumed that you
4521have GNU cross compiling tools available in your path. In this case,
4522you must set the environment variable CROSS_COMPILE in your shell.
4523Note that no changes to the Makefile or any other source files are
4524necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004525
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004526 $ CROSS_COMPILE=ppc_4xx-
4527 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004528
Peter Tyserb06976d2009-03-13 18:54:51 -05004529Note: If you wish to generate Windows versions of the utilities in
4530 the tools directory you can use the MinGW toolchain
4531 (http://www.mingw.org). Set your HOST tools to the MinGW
4532 toolchain and execute 'make tools'. For example:
4533
4534 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4535
4536 Binaries such as tools/mkimage.exe will be created which can
4537 be executed on computers running Windows.
4538
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004539U-Boot is intended to be simple to build. After installing the
4540sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004541is done by typing:
4542
Holger Freyther7ba4e572014-08-04 09:26:05 +02004543 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004544
Holger Freyther7ba4e572014-08-04 09:26:05 +02004545where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004546rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004547
wdenk6c59edc2004-05-03 20:45:30 +00004548Note: for some board special configuration names may exist; check if
4549 additional information is available from the board vendor; for
4550 instance, the TQM823L systems are available without (standard)
4551 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004552 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004553
Holger Freyther7ba4e572014-08-04 09:26:05 +02004554 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004555 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004556
Holger Freyther7ba4e572014-08-04 09:26:05 +02004557 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004558 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004559
wdenk6c59edc2004-05-03 20:45:30 +00004560 etc.
wdenkc6097192002-11-03 00:24:07 +00004561
wdenkc6097192002-11-03 00:24:07 +00004562
wdenk6c59edc2004-05-03 20:45:30 +00004563Finally, type "make all", and you should get some working U-Boot
4564images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004565
wdenk6c59edc2004-05-03 20:45:30 +00004566- "u-boot.bin" is a raw binary image
4567- "u-boot" is an image in ELF binary format
4568- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004569
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004570By default the build is performed locally and the objects are saved
4571in the source directory. One of the two methods can be used to change
4572this behavior and build U-Boot to some external directory:
4573
45741. Add O= to the make command line invocations:
4575
4576 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004577 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004578 make O=/tmp/build all
4579
Timo Ketolac8c67602014-11-06 14:39:05 +020045802. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004581
Timo Ketolac8c67602014-11-06 14:39:05 +02004582 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004583 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004584 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004585 make all
4586
Timo Ketolac8c67602014-11-06 14:39:05 +02004587Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004588variable.
4589
wdenkc6097192002-11-03 00:24:07 +00004590
wdenk6c59edc2004-05-03 20:45:30 +00004591Please be aware that the Makefiles assume you are using GNU make, so
4592for instance on NetBSD you might need to use "gmake" instead of
4593native "make".
wdenkc6097192002-11-03 00:24:07 +00004594
wdenkc6097192002-11-03 00:24:07 +00004595
wdenk6c59edc2004-05-03 20:45:30 +00004596If the system board that you have is not listed, then you will need
4597to port U-Boot to your hardware platform. To do this, follow these
4598steps:
wdenkc6097192002-11-03 00:24:07 +00004599
Phil Sutterc77b4882015-12-25 14:41:18 +010046001. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004601 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004602 the "Makefile" and a "<board>.c".
46032. Create a new configuration file "include/configs/<board>.h" for
4604 your board.
wdenk6c59edc2004-05-03 20:45:30 +000046053. If you're porting U-Boot to a new CPU, then also create a new
4606 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020046074. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000046085. Type "make", and you should get a working "u-boot.srec" file
4609 to be installed on your target system.
46106. Debug and solve any problems that might arise.
4611 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004612
wdenkc6097192002-11-03 00:24:07 +00004613
wdenk6c59edc2004-05-03 20:45:30 +00004614Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4615==============================================================
wdenkc6097192002-11-03 00:24:07 +00004616
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004617If you have modified U-Boot sources (for instance added a new board
4618or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004619provide feedback to the other developers. The feedback normally takes
4620the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004621official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004622
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004623But before you submit such a patch, please verify that your modifi-
4624cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004625the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004626just run the buildman script (tools/buildman/buildman), which will
4627configure and build U-Boot for ALL supported system. Be warned, this
4628will take a while. Please see the buildman README, or run 'buildman -H'
4629for documentation.
wdenkc6097192002-11-03 00:24:07 +00004630
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004631
wdenk6c59edc2004-05-03 20:45:30 +00004632See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004633
wdenkc6097192002-11-03 00:24:07 +00004634
wdenk6c59edc2004-05-03 20:45:30 +00004635Monitor Commands - Overview:
4636============================
wdenkc6097192002-11-03 00:24:07 +00004637
wdenk6c59edc2004-05-03 20:45:30 +00004638go - start application at address 'addr'
4639run - run commands in an environment variable
4640bootm - boot application image from memory
4641bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004642bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004643tftpboot- boot image via network using TFTP protocol
4644 and env variables "ipaddr" and "serverip"
4645 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004646tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004647rarpboot- boot image via network using RARP/TFTP protocol
4648diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4649loads - load S-Record file over serial line
4650loadb - load binary file over serial line (kermit mode)
4651md - memory display
4652mm - memory modify (auto-incrementing)
4653nm - memory modify (constant address)
4654mw - memory write (fill)
4655cp - memory copy
4656cmp - memory compare
4657crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004658i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004659sspi - SPI utility commands
4660base - print or set address offset
4661printenv- print environment variables
4662setenv - set environment variables
4663saveenv - save environment variables to persistent storage
4664protect - enable or disable FLASH write protection
4665erase - erase FLASH memory
4666flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004667nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004668bdinfo - print Board Info structure
4669iminfo - print header information for application image
4670coninfo - print console devices and informations
4671ide - IDE sub-system
4672loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004673loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004674mtest - simple RAM test
4675icache - enable or disable instruction cache
4676dcache - enable or disable data cache
4677reset - Perform RESET of the CPU
4678echo - echo args to console
4679version - print monitor version
4680help - print online help
4681? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004682
wdenkc6097192002-11-03 00:24:07 +00004683
wdenk6c59edc2004-05-03 20:45:30 +00004684Monitor Commands - Detailed Description:
4685========================================
wdenkc6097192002-11-03 00:24:07 +00004686
wdenk6c59edc2004-05-03 20:45:30 +00004687TODO.
wdenkc6097192002-11-03 00:24:07 +00004688
wdenk6c59edc2004-05-03 20:45:30 +00004689For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004690
4691
wdenk6c59edc2004-05-03 20:45:30 +00004692Environment Variables:
4693======================
wdenkc6097192002-11-03 00:24:07 +00004694
wdenk6c59edc2004-05-03 20:45:30 +00004695U-Boot supports user configuration using Environment Variables which
4696can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004697
wdenk6c59edc2004-05-03 20:45:30 +00004698Environment Variables are set using "setenv", printed using
4699"printenv", and saved to Flash using "saveenv". Using "setenv"
4700without a value can be used to delete a variable from the
4701environment. As long as you don't save the environment you are
4702working with an in-memory copy. In case the Flash area containing the
4703environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004704
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004705Some configuration options can be set using Environment Variables.
4706
4707List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004708
wdenk6c59edc2004-05-03 20:45:30 +00004709 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004710
wdenk6c59edc2004-05-03 20:45:30 +00004711 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004712
wdenk6c59edc2004-05-03 20:45:30 +00004713 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004714
wdenk6c59edc2004-05-03 20:45:30 +00004715 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004716
wdenk6c59edc2004-05-03 20:45:30 +00004717 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004718
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004719 bootm_low - Memory range available for image processing in the bootm
4720 command can be restricted. This variable is given as
4721 a hexadecimal number and defines lowest address allowed
4722 for use by the bootm command. See also "bootm_size"
4723 environment variable. Address defined by "bootm_low" is
4724 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004725 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4726 bootm_mapsize.
4727
Wolfgang Denk092ae952011-10-26 10:21:21 +00004728 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004729 This variable is given as a hexadecimal number and it
4730 defines the size of the memory region starting at base
4731 address bootm_low that is accessible by the Linux kernel
4732 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4733 as the default value if it is defined, and bootm_size is
4734 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004735
4736 bootm_size - Memory range available for image processing in the bootm
4737 command can be restricted. This variable is given as
4738 a hexadecimal number and defines the size of the region
4739 allowed for use by the bootm command. See also "bootm_low"
4740 environment variable.
4741
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004742 updatefile - Location of the software update file on a TFTP server, used
4743 by the automatic software update feature. Please refer to
4744 documentation in doc/README.update for more details.
4745
wdenk6c59edc2004-05-03 20:45:30 +00004746 autoload - if set to "no" (any string beginning with 'n'),
4747 "bootp" will just load perform a lookup of the
4748 configuration from the BOOTP server, but not try to
4749 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004750
wdenk6c59edc2004-05-03 20:45:30 +00004751 autostart - if set to "yes", an image loaded using the "bootp",
4752 "rarpboot", "tftpboot" or "diskboot" commands will
4753 be automatically started (by internally calling
4754 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004755
wdenk6c59edc2004-05-03 20:45:30 +00004756 If set to "no", a standalone image passed to the
4757 "bootm" command will be copied to the load address
4758 (and eventually uncompressed), but NOT be started.
4759 This can be used to load and uncompress arbitrary
4760 data.
wdenkc6097192002-11-03 00:24:07 +00004761
David A. Longd558a4e2011-07-09 16:40:19 -04004762 fdt_high - if set this restricts the maximum address that the
4763 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004764 For example, if you have a system with 1 GB memory
4765 at physical address 0x10000000, while Linux kernel
4766 only recognizes the first 704 MB as low memory, you
4767 may need to set fdt_high as 0x3C000000 to have the
4768 device tree blob be copied to the maximum address
4769 of the 704 MB low memory, so that Linux kernel can
4770 access it during the boot procedure.
4771
David A. Longd558a4e2011-07-09 16:40:19 -04004772 If this is set to the special value 0xFFFFFFFF then
4773 the fdt will not be copied at all on boot. For this
4774 to work it must reside in writable memory, have
4775 sufficient padding on the end of it for u-boot to
4776 add the information it needs into it, and the memory
4777 must be accessible by the kernel.
4778
Simon Glassdc6fa642011-10-24 19:15:34 +00004779 fdtcontroladdr- if set this is the address of the control flattened
4780 device tree used by U-Boot when CONFIG_OF_CONTROL is
4781 defined.
4782
wdenk0e2bd9c2004-06-06 21:51:03 +00004783 i2cfast - (PPC405GP|PPC405EP only)
4784 if set to 'y' configures Linux I2C driver for fast
4785 mode (400kHZ). This environment variable is used in
4786 initialization code. So, for changes to be effective
4787 it must be saved and board must be reset.
4788
wdenk6c59edc2004-05-03 20:45:30 +00004789 initrd_high - restrict positioning of initrd images:
4790 If this variable is not set, initrd images will be
4791 copied to the highest possible address in RAM; this
4792 is usually what you want since it allows for
4793 maximum initrd size. If for some reason you want to
4794 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004795 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004796 variable to a value of "no" or "off" or "0".
4797 Alternatively, you can set it to a maximum upper
4798 address to use (U-Boot will still check that it
4799 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004800
wdenk6c59edc2004-05-03 20:45:30 +00004801 For instance, when you have a system with 16 MB
4802 RAM, and want to reserve 4 MB from use by Linux,
4803 you can do this by adding "mem=12M" to the value of
4804 the "bootargs" variable. However, now you must make
4805 sure that the initrd image is placed in the first
4806 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004807
wdenk6c59edc2004-05-03 20:45:30 +00004808 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004809
wdenk6c59edc2004-05-03 20:45:30 +00004810 If you set initrd_high to 0xFFFFFFFF, this is an
4811 indication to U-Boot that all addresses are legal
4812 for the Linux kernel, including addresses in flash
4813 memory. In this case U-Boot will NOT COPY the
4814 ramdisk at all. This may be useful to reduce the
4815 boot time on your system, but requires that this
4816 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004817
wdenk6c59edc2004-05-03 20:45:30 +00004818 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004819
wdenk6c59edc2004-05-03 20:45:30 +00004820 loadaddr - Default load address for commands like "bootp",
4821 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004822
wdenk6c59edc2004-05-03 20:45:30 +00004823 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004824
wdenk6c59edc2004-05-03 20:45:30 +00004825 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004826
wdenk6c59edc2004-05-03 20:45:30 +00004827 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk6c59edc2004-05-03 20:45:30 +00004829 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004830
wdenk6c59edc2004-05-03 20:45:30 +00004831 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004832
Mike Frysingera23230c2011-10-02 10:01:27 +00004833 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004834
Mike Frysingera23230c2011-10-02 10:01:27 +00004835 ethact - controls which interface is currently active.
4836 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004837
Heiko Schocherc5e84052010-07-20 17:45:02 +02004838 => setenv ethact FEC
4839 => ping 192.168.0.1 # traffic sent on FEC
4840 => setenv ethact SCC
4841 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004842
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004843 ethrotate - When set to "no" U-Boot does not go through all
4844 available network interfaces.
4845 It just stays at the currently selected interface.
4846
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004847 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004848 either succeed or fail without retrying.
4849 When set to "once" the network operation will
4850 fail when all the available network interfaces
4851 are tried once without success.
4852 Useful on scripts which control the retry operation
4853 themselves.
wdenkc6097192002-11-03 00:24:07 +00004854
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004855 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004856
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004857 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004858 changing the console to be empty. If "yes" it will be
4859 made silent. If "no" it will not be made silent. If
4860 unset, then it will be made silent if the U-Boot console
4861 is silent.
4862
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004863 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004864 UDP source port.
4865
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004866 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004867 destination port instead of the Well Know Port 69.
4868
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004869 tftpblocksize - Block size to use for TFTP transfers; if not set,
4870 we use the TFTP server's default block size
4871
4872 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4873 seconds, minimum value is 1000 = 1 second). Defines
4874 when a packet is considered to be lost so it has to
4875 be retransmitted. The default is 5000 = 5 seconds.
4876 Lowering this value may make downloads succeed
4877 faster in networks with high packet loss rates or
4878 with unreliable TFTP servers.
4879
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004880 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4881 unit, minimum value = 0). Defines how many timeouts
4882 can happen during a single file transfer before that
4883 transfer is aborted. The default is 10, and 0 means
4884 'no timeouts allowed'. Increasing this value may help
4885 downloads succeed with high packet loss rates, or with
4886 unreliable TFTP servers or client hardware.
4887
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004888 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004889 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004890 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004891
Alexandre Messier15971322016-02-01 17:08:57 -05004892 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4893 Unsigned value, in milliseconds. If not set, the period will
4894 be either the default (28000), or a value based on
4895 CONFIG_NET_RETRY_COUNT, if defined. This value has
4896 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4897
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004898The following image location variables contain the location of images
4899used in booting. The "Image" column gives the role of the image and is
4900not an environment variable name. The other columns are environment
4901variable names. "File Name" gives the name of the file on a TFTP
4902server, "RAM Address" gives the location in RAM the image will be
4903loaded to, and "Flash Location" gives the image's address in NOR
4904flash or offset in NAND flash.
4905
4906*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004907boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004908boards use these variables for other purposes.
4909
Wolfgang Denk092ae952011-10-26 10:21:21 +00004910Image File Name RAM Address Flash Location
4911----- --------- ----------- --------------
4912u-boot u-boot u-boot_addr_r u-boot_addr
4913Linux kernel bootfile kernel_addr_r kernel_addr
4914device tree blob fdtfile fdt_addr_r fdt_addr
4915ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004916
wdenk6c59edc2004-05-03 20:45:30 +00004917The following environment variables may be used and automatically
4918updated by the network boot commands ("bootp" and "rarpboot"),
4919depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004920
wdenk6c59edc2004-05-03 20:45:30 +00004921 bootfile - see above
4922 dnsip - IP address of your Domain Name Server
4923 dnsip2 - IP address of your secondary Domain Name Server
4924 gatewayip - IP address of the Gateway (Router) to use
4925 hostname - Target hostname
4926 ipaddr - see above
4927 netmask - Subnet Mask
4928 rootpath - Pathname of the root filesystem on the NFS server
4929 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004930
wdenk145d2c12004-04-15 21:48:45 +00004931
wdenk6c59edc2004-05-03 20:45:30 +00004932There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004933
wdenk6c59edc2004-05-03 20:45:30 +00004934 serial# - contains hardware identification information such
4935 as type string and/or serial number
4936 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004937
wdenk6c59edc2004-05-03 20:45:30 +00004938These variables can be set only once (usually during manufacturing of
4939the board). U-Boot refuses to delete or overwrite these variables
4940once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004941
4942
wdenk6c59edc2004-05-03 20:45:30 +00004943Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004944
wdenk6c59edc2004-05-03 20:45:30 +00004945 ver - Contains the U-Boot version string as printed
4946 with the "version" command. This variable is
4947 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004948
wdenkc6097192002-11-03 00:24:07 +00004949
wdenk6c59edc2004-05-03 20:45:30 +00004950Please note that changes to some configuration parameters may take
4951only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004952
stroeseb9c17c52003-04-04 15:53:41 +00004953
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004954Callback functions for environment variables:
4955---------------------------------------------
4956
4957For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004958when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004959be associated with arbitrary variables. On creation, overwrite, or
4960deletion, the callback will provide the opportunity for some side
4961effect to happen or for the change to be rejected.
4962
4963The callbacks are named and associated with a function using the
4964U_BOOT_ENV_CALLBACK macro in your board or driver code.
4965
4966These callbacks are associated with variables in one of two ways. The
4967static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4968in the board configuration to a string that defines a list of
4969associations. The list must be in the following format:
4970
4971 entry = variable_name[:callback_name]
4972 list = entry[,list]
4973
4974If the callback name is not specified, then the callback is deleted.
4975Spaces are also allowed anywhere in the list.
4976
4977Callbacks can also be associated by defining the ".callbacks" variable
4978with the same list format above. Any association in ".callbacks" will
4979override any association in the static list. You can define
4980CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004981".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004982
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004983If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4984regular expression. This allows multiple variables to be connected to
4985the same callback without explicitly listing them all out.
4986
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004987
wdenk6c59edc2004-05-03 20:45:30 +00004988Command Line Parsing:
4989=====================
stroeseb9c17c52003-04-04 15:53:41 +00004990
wdenk6c59edc2004-05-03 20:45:30 +00004991There are two different command line parsers available with U-Boot:
4992the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004993
wdenk6c59edc2004-05-03 20:45:30 +00004994Old, simple command line parser:
4995--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004996
wdenk6c59edc2004-05-03 20:45:30 +00004997- supports environment variables (through setenv / saveenv commands)
4998- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004999- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005000- special characters ('$', ';') can be escaped by prefixing with '\',
5001 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005002 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005003- You can also escape text by enclosing in single apostrophes, for example:
5004 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005005
wdenk6c59edc2004-05-03 20:45:30 +00005006Hush shell:
5007-----------
wdenkf4688a22003-05-28 08:06:31 +00005008
wdenk6c59edc2004-05-03 20:45:30 +00005009- similar to Bourne shell, with control structures like
5010 if...then...else...fi, for...do...done; while...do...done,
5011 until...do...done, ...
5012- supports environment ("global") variables (through setenv / saveenv
5013 commands) and local shell variables (through standard shell syntax
5014 "name=value"); only environment variables can be used with "run"
5015 command
wdenkf4688a22003-05-28 08:06:31 +00005016
wdenk6c59edc2004-05-03 20:45:30 +00005017General rules:
5018--------------
wdenkf4688a22003-05-28 08:06:31 +00005019
wdenk6c59edc2004-05-03 20:45:30 +00005020(1) If a command line (or an environment variable executed by a "run"
5021 command) contains several commands separated by semicolon, and
5022 one of these commands fails, then the remaining commands will be
5023 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005024
wdenk6c59edc2004-05-03 20:45:30 +00005025(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005026 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005027 command will cause "run" to terminate, i. e. the remaining
5028 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005029
wdenk6c59edc2004-05-03 20:45:30 +00005030Note for Redundant Ethernet Interfaces:
5031=======================================
wdenkf4688a22003-05-28 08:06:31 +00005032
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005033Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005034such configurations and is capable of automatic selection of a
5035"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005036
wdenk6c59edc2004-05-03 20:45:30 +00005037Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5038MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5039"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005040
wdenk6c59edc2004-05-03 20:45:30 +00005041If the network interface stores some valid MAC address (for instance
5042in SROM), this is used as default address if there is NO correspon-
5043ding setting in the environment; if the corresponding environment
5044variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005045
wdenk6c59edc2004-05-03 20:45:30 +00005046o If the SROM has a valid MAC address, and there is no address in the
5047 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005048
wdenk6c59edc2004-05-03 20:45:30 +00005049o If there is no valid address in the SROM, and a definition in the
5050 environment exists, then the value from the environment variable is
5051 used.
wdenkc6097192002-11-03 00:24:07 +00005052
wdenk6c59edc2004-05-03 20:45:30 +00005053o If both the SROM and the environment contain a MAC address, and
5054 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk6c59edc2004-05-03 20:45:30 +00005056o If both the SROM and the environment contain a MAC address, and the
5057 addresses differ, the value from the environment is used and a
5058 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005059
wdenk6c59edc2004-05-03 20:45:30 +00005060o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005061 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5062 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005063
Ben Warren6db991a2010-04-26 11:11:46 -07005064If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005065will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005066may be skipped by setting the appropriate 'ethmacskip' environment variable.
5067The naming convention is as follows:
5068"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005069
wdenk6c59edc2004-05-03 20:45:30 +00005070Image Formats:
5071==============
wdenkc6097192002-11-03 00:24:07 +00005072
Marian Balakowicz18710b82008-03-12 12:13:13 +01005073U-Boot is capable of booting (and performing other auxiliary operations on)
5074images in two formats:
5075
5076New uImage format (FIT)
5077-----------------------
5078
5079Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5080to Flattened Device Tree). It allows the use of images with multiple
5081components (several kernels, ramdisks, etc.), with contents protected by
5082SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5083
5084
5085Old uImage format
5086-----------------
5087
5088Old image format is based on binary files which can be basically anything,
5089preceded by a special header; see the definitions in include/image.h for
5090details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk6c59edc2004-05-03 20:45:30 +00005092* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5093 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005094 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5095 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5096 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005097* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005098 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5099 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005100* Compression Type (uncompressed, gzip, bzip2)
5101* Load Address
5102* Entry Point
5103* Image Name
5104* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005105
wdenk6c59edc2004-05-03 20:45:30 +00005106The header is marked by a special Magic Number, and both the header
5107and the data portions of the image are secured against corruption by
5108CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005109
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111Linux Support:
5112==============
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk6c59edc2004-05-03 20:45:30 +00005114Although U-Boot should support any OS or standalone application
5115easily, the main focus has always been on Linux during the design of
5116U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118U-Boot includes many features that so far have been part of some
5119special "boot loader" code within the Linux kernel. Also, any
5120"initrd" images to be used are no longer part of one big Linux image;
5121instead, kernel and "initrd" are separate images. This implementation
5122serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005123
wdenk6c59edc2004-05-03 20:45:30 +00005124- the same features can be used for other OS or standalone
5125 applications (for instance: using compressed images to reduce the
5126 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk6c59edc2004-05-03 20:45:30 +00005128- it becomes much easier to port new Linux kernel versions because
5129 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk6c59edc2004-05-03 20:45:30 +00005131- the same Linux kernel image can now be used with different "initrd"
5132 images; of course this also means that different kernel images can
5133 be run with the same "initrd". This makes testing easier (you don't
5134 have to build a new "zImage.initrd" Linux image when you just
5135 change a file in your "initrd"). Also, a field-upgrade of the
5136 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005137
wdenkc6097192002-11-03 00:24:07 +00005138
wdenk6c59edc2004-05-03 20:45:30 +00005139Linux HOWTO:
5140============
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk6c59edc2004-05-03 20:45:30 +00005142Porting Linux to U-Boot based systems:
5143---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005144
wdenk6c59edc2004-05-03 20:45:30 +00005145U-Boot cannot save you from doing all the necessary modifications to
5146configure the Linux device drivers for use with your target hardware
5147(no, we don't intend to provide a full virtual machine interface to
5148Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005149
Stefan Roese88fbf932010-04-15 16:07:28 +02005150But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005151
wdenk6c59edc2004-05-03 20:45:30 +00005152Just make sure your machine specific header file (for instance
5153include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005154Information structure as we define in include/asm-<arch>/u-boot.h,
5155and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005156as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005157
Simon Glassd097e592014-06-11 23:29:46 -06005158Note that U-Boot now has a driver model, a unified model for drivers.
5159If you are adding a new driver, plumb it into driver model. If there
5160is no uclass available, you are encouraged to create one. See
5161doc/driver-model.
5162
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk6c59edc2004-05-03 20:45:30 +00005164Configuring the Linux kernel:
5165-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk6c59edc2004-05-03 20:45:30 +00005167No specific requirements for U-Boot. Make sure you have some root
5168device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005169
wdenkc6097192002-11-03 00:24:07 +00005170
wdenk6c59edc2004-05-03 20:45:30 +00005171Building a Linux Image:
5172-----------------------
wdenkc6097192002-11-03 00:24:07 +00005173
wdenk6c59edc2004-05-03 20:45:30 +00005174With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5175not used. If you use recent kernel source, a new build target
5176"uImage" will exist which automatically builds an image usable by
5177U-Boot. Most older kernels also have support for a "pImage" target,
5178which was introduced for our predecessor project PPCBoot and uses a
5179100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005180
wdenk6c59edc2004-05-03 20:45:30 +00005181Example:
wdenkc6097192002-11-03 00:24:07 +00005182
Holger Freyther7ba4e572014-08-04 09:26:05 +02005183 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005184 make oldconfig
5185 make dep
5186 make uImage
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk6c59edc2004-05-03 20:45:30 +00005188The "uImage" build target uses a special tool (in 'tools/mkimage') to
5189encapsulate a compressed Linux kernel image with header information,
5190CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk6c59edc2004-05-03 20:45:30 +00005192* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005193
wdenk6c59edc2004-05-03 20:45:30 +00005194* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005195
wdenk6c59edc2004-05-03 20:45:30 +00005196 ${CROSS_COMPILE}-objcopy -O binary \
5197 -R .note -R .comment \
5198 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005199
wdenk6c59edc2004-05-03 20:45:30 +00005200* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005201
wdenk6c59edc2004-05-03 20:45:30 +00005202 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005203
wdenk6c59edc2004-05-03 20:45:30 +00005204* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005205
wdenk6c59edc2004-05-03 20:45:30 +00005206 mkimage -A ppc -O linux -T kernel -C gzip \
5207 -a 0 -e 0 -n "Linux Kernel Image" \
5208 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005209
wdenkc6097192002-11-03 00:24:07 +00005210
wdenk6c59edc2004-05-03 20:45:30 +00005211The "mkimage" tool can also be used to create ramdisk images for use
5212with U-Boot, either separated from the Linux kernel image, or
5213combined into one file. "mkimage" encapsulates the images with a 64
5214byte header containing information about target architecture,
5215operating system, image type, compression method, entry points, time
5216stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218"mkimage" can be called in two ways: to verify existing images and
5219print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005220
wdenk6c59edc2004-05-03 20:45:30 +00005221In the first form (with "-l" option) mkimage lists the information
5222contained in the header of an existing U-Boot image; this includes
5223checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005224
wdenk6c59edc2004-05-03 20:45:30 +00005225 tools/mkimage -l image
5226 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005227
wdenk6c59edc2004-05-03 20:45:30 +00005228The second form (with "-d" option) is used to build a U-Boot image
5229from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005230
wdenk6c59edc2004-05-03 20:45:30 +00005231 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5232 -n name -d data_file image
5233 -A ==> set architecture to 'arch'
5234 -O ==> set operating system to 'os'
5235 -T ==> set image type to 'type'
5236 -C ==> set compression type 'comp'
5237 -a ==> set load address to 'addr' (hex)
5238 -e ==> set entry point to 'ep' (hex)
5239 -n ==> set image name to 'name'
5240 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005241
wdenkcd914452004-05-29 16:53:29 +00005242Right now, all Linux kernels for PowerPC systems use the same load
5243address (0x00000000), but the entry point address depends on the
5244kernel version:
wdenkc6097192002-11-03 00:24:07 +00005245
wdenk6c59edc2004-05-03 20:45:30 +00005246- 2.2.x kernels have the entry point at 0x0000000C,
5247- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005248
wdenk6c59edc2004-05-03 20:45:30 +00005249So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005250
wdenk6c59edc2004-05-03 20:45:30 +00005251 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5252 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005253 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005254 > examples/uImage.TQM850L
5255 Image Name: 2.4.4 kernel for TQM850L
5256 Created: Wed Jul 19 02:34:59 2000
5257 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5258 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5259 Load Address: 0x00000000
5260 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk6c59edc2004-05-03 20:45:30 +00005262To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005263
wdenk6c59edc2004-05-03 20:45:30 +00005264 -> tools/mkimage -l examples/uImage.TQM850L
5265 Image Name: 2.4.4 kernel for TQM850L
5266 Created: Wed Jul 19 02:34:59 2000
5267 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5268 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5269 Load Address: 0x00000000
5270 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005271
wdenk6c59edc2004-05-03 20:45:30 +00005272NOTE: for embedded systems where boot time is critical you can trade
5273speed for memory and install an UNCOMPRESSED image instead: this
5274needs more space in Flash, but boots much faster since it does not
5275need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005276
Stefan Roese88fbf932010-04-15 16:07:28 +02005277 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005278 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5279 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005280 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005281 > examples/uImage.TQM850L-uncompressed
5282 Image Name: 2.4.4 kernel for TQM850L
5283 Created: Wed Jul 19 02:34:59 2000
5284 Image Type: PowerPC Linux Kernel Image (uncompressed)
5285 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5286 Load Address: 0x00000000
5287 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005288
wdenkc6097192002-11-03 00:24:07 +00005289
wdenk6c59edc2004-05-03 20:45:30 +00005290Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5291when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005292
wdenk6c59edc2004-05-03 20:45:30 +00005293 -> tools/mkimage -n 'Simple Ramdisk Image' \
5294 > -A ppc -O linux -T ramdisk -C gzip \
5295 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5296 Image Name: Simple Ramdisk Image
5297 Created: Wed Jan 12 14:01:50 2000
5298 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5299 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5300 Load Address: 0x00000000
5301 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005302
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005303The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5304option performs the converse operation of the mkimage's second form (the "-d"
5305option). Given an image built by mkimage, the dumpimage extracts a "data file"
5306from the image:
5307
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005308 tools/dumpimage -i image -T type -p position data_file
5309 -i ==> extract from the 'image' a specific 'data_file'
5310 -T ==> set image type to 'type'
5311 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005312
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk6c59edc2004-05-03 20:45:30 +00005314Installing a Linux Image:
5315-------------------------
wdenkc6097192002-11-03 00:24:07 +00005316
wdenk6c59edc2004-05-03 20:45:30 +00005317To downloading a U-Boot image over the serial (console) interface,
5318you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk6c59edc2004-05-03 20:45:30 +00005320 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005321
wdenk6c59edc2004-05-03 20:45:30 +00005322The 'objcopy' does not understand the information in the U-Boot
5323image header, so the resulting S-Record file will be relative to
5324address 0x00000000. To load it to a given address, you need to
5325specify the target address as 'offset' parameter with the 'loads'
5326command.
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk6c59edc2004-05-03 20:45:30 +00005328Example: install the image to address 0x40100000 (which on the
5329TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005332
wdenk6c59edc2004-05-03 20:45:30 +00005333 .......... done
5334 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005335
wdenk6c59edc2004-05-03 20:45:30 +00005336 => loads 40100000
5337 ## Ready for S-Record download ...
5338 ~>examples/image.srec
5339 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5340 ...
5341 15989 15990 15991 15992
5342 [file transfer complete]
5343 [connected]
5344 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005345
wdenkc6097192002-11-03 00:24:07 +00005346
wdenk6c59edc2004-05-03 20:45:30 +00005347You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005348this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005349corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005352
wdenk6c59edc2004-05-03 20:45:30 +00005353 ## Checking Image at 40100000 ...
5354 Image Name: 2.2.13 for initrd on TQM850L
5355 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5356 Data Size: 335725 Bytes = 327 kB = 0 MB
5357 Load Address: 00000000
5358 Entry Point: 0000000c
5359 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005360
5361
wdenk6c59edc2004-05-03 20:45:30 +00005362Boot Linux:
5363-----------
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk6c59edc2004-05-03 20:45:30 +00005365The "bootm" command is used to boot an application that is stored in
5366memory (RAM or Flash). In case of a Linux kernel image, the contents
5367of the "bootargs" environment variable is passed to the kernel as
5368parameters. You can check and modify this variable using the
5369"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005370
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372 => printenv bootargs
5373 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk6c59edc2004-05-03 20:45:30 +00005375 => 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 +00005376
wdenk6c59edc2004-05-03 20:45:30 +00005377 => printenv bootargs
5378 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 +00005379
wdenk6c59edc2004-05-03 20:45:30 +00005380 => bootm 40020000
5381 ## Booting Linux kernel at 40020000 ...
5382 Image Name: 2.2.13 for NFS on TQM850L
5383 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5384 Data Size: 381681 Bytes = 372 kB = 0 MB
5385 Load Address: 00000000
5386 Entry Point: 0000000c
5387 Verifying Checksum ... OK
5388 Uncompressing Kernel Image ... OK
5389 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
5390 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5391 time_init: decrementer frequency = 187500000/60
5392 Calibrating delay loop... 49.77 BogoMIPS
5393 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5394 ...
wdenkc6097192002-11-03 00:24:07 +00005395
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005396If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005397the memory addresses of both the kernel and the initrd image (PPBCOOT
5398format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005399
wdenk6c59edc2004-05-03 20:45:30 +00005400 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005401
wdenk6c59edc2004-05-03 20:45:30 +00005402 ## Checking Image at 40100000 ...
5403 Image Name: 2.2.13 for initrd on TQM850L
5404 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5405 Data Size: 335725 Bytes = 327 kB = 0 MB
5406 Load Address: 00000000
5407 Entry Point: 0000000c
5408 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005409
wdenk6c59edc2004-05-03 20:45:30 +00005410 ## Checking Image at 40200000 ...
5411 Image Name: Simple Ramdisk Image
5412 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5413 Data Size: 566530 Bytes = 553 kB = 0 MB
5414 Load Address: 00000000
5415 Entry Point: 00000000
5416 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005417
wdenk6c59edc2004-05-03 20:45:30 +00005418 => bootm 40100000 40200000
5419 ## Booting Linux kernel at 40100000 ...
5420 Image Name: 2.2.13 for initrd on TQM850L
5421 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5422 Data Size: 335725 Bytes = 327 kB = 0 MB
5423 Load Address: 00000000
5424 Entry Point: 0000000c
5425 Verifying Checksum ... OK
5426 Uncompressing Kernel Image ... OK
5427 ## Loading RAMDisk Image at 40200000 ...
5428 Image Name: Simple Ramdisk Image
5429 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5430 Data Size: 566530 Bytes = 553 kB = 0 MB
5431 Load Address: 00000000
5432 Entry Point: 00000000
5433 Verifying Checksum ... OK
5434 Loading Ramdisk ... OK
5435 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
5436 Boot arguments: root=/dev/ram
5437 time_init: decrementer frequency = 187500000/60
5438 Calibrating delay loop... 49.77 BogoMIPS
5439 ...
5440 RAMDISK: Compressed image found at block 0
5441 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005442
wdenk6c59edc2004-05-03 20:45:30 +00005443 bash#
wdenkc6097192002-11-03 00:24:07 +00005444
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005445Boot Linux and pass a flat device tree:
5446-----------
5447
5448First, U-Boot must be compiled with the appropriate defines. See the section
5449titled "Linux Kernel Interface" above for a more in depth explanation. The
5450following is an example of how to start a kernel and pass an updated
5451flat device tree:
5452
5453=> print oftaddr
5454oftaddr=0x300000
5455=> print oft
5456oft=oftrees/mpc8540ads.dtb
5457=> tftp $oftaddr $oft
5458Speed: 1000, full duplex
5459Using TSEC0 device
5460TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5461Filename 'oftrees/mpc8540ads.dtb'.
5462Load address: 0x300000
5463Loading: #
5464done
5465Bytes transferred = 4106 (100a hex)
5466=> tftp $loadaddr $bootfile
5467Speed: 1000, full duplex
5468Using TSEC0 device
5469TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5470Filename 'uImage'.
5471Load address: 0x200000
5472Loading:############
5473done
5474Bytes transferred = 1029407 (fb51f hex)
5475=> print loadaddr
5476loadaddr=200000
5477=> print oftaddr
5478oftaddr=0x300000
5479=> bootm $loadaddr - $oftaddr
5480## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005481 Image Name: Linux-2.6.17-dirty
5482 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5483 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005484 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005485 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005486 Verifying Checksum ... OK
5487 Uncompressing Kernel Image ... OK
5488Booting using flat device tree at 0x300000
5489Using MPC85xx ADS machine description
5490Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5491[snip]
5492
5493
wdenk6c59edc2004-05-03 20:45:30 +00005494More About U-Boot Image Types:
5495------------------------------
wdenkc6097192002-11-03 00:24:07 +00005496
wdenk6c59edc2004-05-03 20:45:30 +00005497U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005498
wdenk6c59edc2004-05-03 20:45:30 +00005499 "Standalone Programs" are directly runnable in the environment
5500 provided by U-Boot; it is expected that (if they behave
5501 well) you can continue to work in U-Boot after return from
5502 the Standalone Program.
5503 "OS Kernel Images" are usually images of some Embedded OS which
5504 will take over control completely. Usually these programs
5505 will install their own set of exception handlers, device
5506 drivers, set up the MMU, etc. - this means, that you cannot
5507 expect to re-enter U-Boot except by resetting the CPU.
5508 "RAMDisk Images" are more or less just data blocks, and their
5509 parameters (address, size) are passed to an OS kernel that is
5510 being started.
5511 "Multi-File Images" contain several images, typically an OS
5512 (Linux) kernel image and one or more data images like
5513 RAMDisks. This construct is useful for instance when you want
5514 to boot over the network using BOOTP etc., where the boot
5515 server provides just a single image file, but you want to get
5516 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005517
wdenk6c59edc2004-05-03 20:45:30 +00005518 "Multi-File Images" start with a list of image sizes, each
5519 image size (in bytes) specified by an "uint32_t" in network
5520 byte order. This list is terminated by an "(uint32_t)0".
5521 Immediately after the terminating 0 follow the images, one by
5522 one, all aligned on "uint32_t" boundaries (size rounded up to
5523 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005524
wdenk6c59edc2004-05-03 20:45:30 +00005525 "Firmware Images" are binary images containing firmware (like
5526 U-Boot or FPGA images) which usually will be programmed to
5527 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005528
wdenk6c59edc2004-05-03 20:45:30 +00005529 "Script files" are command sequences that will be executed by
5530 U-Boot's command interpreter; this feature is especially
5531 useful when you configure U-Boot to use a real shell (hush)
5532 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005533
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005534Booting the Linux zImage:
5535-------------------------
5536
5537On some platforms, it's possible to boot Linux zImage. This is done
5538using the "bootz" command. The syntax of "bootz" command is the same
5539as the syntax of "bootm" command.
5540
Tom Rini45f46d12013-05-16 11:40:11 -04005541Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005542kernel with raw initrd images. The syntax is slightly different, the
5543address of the initrd must be augmented by it's size, in the following
5544format: "<initrd addres>:<initrd size>".
5545
stroeseb9c17c52003-04-04 15:53:41 +00005546
wdenk6c59edc2004-05-03 20:45:30 +00005547Standalone HOWTO:
5548=================
stroeseb9c17c52003-04-04 15:53:41 +00005549
wdenk6c59edc2004-05-03 20:45:30 +00005550One of the features of U-Boot is that you can dynamically load and
5551run "standalone" applications, which can use some resources of
5552U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005553
wdenk6c59edc2004-05-03 20:45:30 +00005554Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556"Hello World" Demo:
5557-------------------
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559'examples/hello_world.c' contains a small "Hello World" Demo
5560application; it is automatically compiled when you build U-Boot.
5561It's configured to run at address 0x00040004, so you can play with it
5562like that:
wdenkc6097192002-11-03 00:24:07 +00005563
wdenk6c59edc2004-05-03 20:45:30 +00005564 => loads
5565 ## Ready for S-Record download ...
5566 ~>examples/hello_world.srec
5567 1 2 3 4 5 6 7 8 9 10 11 ...
5568 [file transfer complete]
5569 [connected]
5570 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005571
wdenk6c59edc2004-05-03 20:45:30 +00005572 => go 40004 Hello World! This is a test.
5573 ## Starting application at 0x00040004 ...
5574 Hello World
5575 argc = 7
5576 argv[0] = "40004"
5577 argv[1] = "Hello"
5578 argv[2] = "World!"
5579 argv[3] = "This"
5580 argv[4] = "is"
5581 argv[5] = "a"
5582 argv[6] = "test."
5583 argv[7] = "<NULL>"
5584 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005585
wdenk6c59edc2004-05-03 20:45:30 +00005586 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005587
wdenk6c59edc2004-05-03 20:45:30 +00005588Another example, which demonstrates how to register a CPM interrupt
5589handler with the U-Boot code, can be found in 'examples/timer.c'.
5590Here, a CPM timer is set up to generate an interrupt every second.
5591The interrupt service routine is trivial, just printing a '.'
5592character, but this is just a demo program. The application can be
5593controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005594
wdenk6c59edc2004-05-03 20:45:30 +00005595 ? - print current values og the CPM Timer registers
5596 b - enable interrupts and start timer
5597 e - stop timer and disable interrupts
5598 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005599
wdenk6c59edc2004-05-03 20:45:30 +00005600 => loads
5601 ## Ready for S-Record download ...
5602 ~>examples/timer.srec
5603 1 2 3 4 5 6 7 8 9 10 11 ...
5604 [file transfer complete]
5605 [connected]
5606 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608 => go 40004
5609 ## Starting application at 0x00040004 ...
5610 TIMERS=0xfff00980
5611 Using timer 1
5612 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005613
wdenk6c59edc2004-05-03 20:45:30 +00005614Hit 'b':
5615 [q, b, e, ?] Set interval 1000000 us
5616 Enabling timer
5617Hit '?':
5618 [q, b, e, ?] ........
5619 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5620Hit '?':
5621 [q, b, e, ?] .
5622 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5623Hit '?':
5624 [q, b, e, ?] .
5625 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5626Hit '?':
5627 [q, b, e, ?] .
5628 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5629Hit 'e':
5630 [q, b, e, ?] ...Stopping timer
5631Hit 'q':
5632 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005633
wdenkc6097192002-11-03 00:24:07 +00005634
wdenk6c59edc2004-05-03 20:45:30 +00005635Minicom warning:
5636================
wdenkc6097192002-11-03 00:24:07 +00005637
wdenk6c59edc2004-05-03 20:45:30 +00005638Over time, many people have reported problems when trying to use the
5639"minicom" terminal emulation program for serial download. I (wd)
5640consider minicom to be broken, and recommend not to use it. Under
5641Unix, I recommend to use C-Kermit for general purpose use (and
5642especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005643use "cu" for S-Record download ("loads" command). See
5644http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5645for help with kermit.
5646
wdenkc6097192002-11-03 00:24:07 +00005647
wdenk6c59edc2004-05-03 20:45:30 +00005648Nevertheless, if you absolutely want to use it try adding this
5649configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005650
wdenk6c59edc2004-05-03 20:45:30 +00005651 Name Program Name U/D FullScr IO-Red. Multi
5652 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5653 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005654
wdenk8dba0502003-03-31 16:34:49 +00005655
wdenk6c59edc2004-05-03 20:45:30 +00005656NetBSD Notes:
5657=============
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk6c59edc2004-05-03 20:45:30 +00005659Starting at version 0.9.2, U-Boot supports NetBSD both as host
5660(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005661
wdenk6c59edc2004-05-03 20:45:30 +00005662Building requires a cross environment; it is known to work on
5663NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5664need gmake since the Makefiles are not compatible with BSD make).
5665Note that the cross-powerpc package does not install include files;
5666attempting to build U-Boot will fail because <machine/ansi.h> is
5667missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005668
wdenk6c59edc2004-05-03 20:45:30 +00005669 # cd /usr/pkg/cross/powerpc-netbsd/include
5670 # mkdir powerpc
5671 # ln -s powerpc machine
5672 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5673 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005674
wdenk6c59edc2004-05-03 20:45:30 +00005675Native builds *don't* work due to incompatibilities between native
5676and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk6c59edc2004-05-03 20:45:30 +00005678Booting assumes that (the first part of) the image booted is a
5679stage-2 loader which in turn loads and then invokes the kernel
5680proper. Loader sources will eventually appear in the NetBSD source
5681tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005682meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005683
wdenkc6097192002-11-03 00:24:07 +00005684
wdenk6c59edc2004-05-03 20:45:30 +00005685Implementation Internals:
5686=========================
wdenkc6097192002-11-03 00:24:07 +00005687
wdenk6c59edc2004-05-03 20:45:30 +00005688The following is not intended to be a complete description of every
5689implementation detail. However, it should help to understand the
5690inner workings of U-Boot and make it easier to port it to custom
5691hardware.
wdenkc6097192002-11-03 00:24:07 +00005692
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694Initial Stack, Global Data:
5695---------------------------
wdenkc6097192002-11-03 00:24:07 +00005696
wdenk6c59edc2004-05-03 20:45:30 +00005697The implementation of U-Boot is complicated by the fact that U-Boot
5698starts running out of ROM (flash memory), usually without access to
5699system RAM (because the memory controller is not initialized yet).
5700This means that we don't have writable Data or BSS segments, and BSS
5701is not initialized as zero. To be able to get a C environment working
5702at all, we have to allocate at least a minimal stack. Implementation
5703options for this are defined and restricted by the CPU used: Some CPU
5704models provide on-chip memory (like the IMMR area on MPC8xx and
5705MPC826x processors), on others (parts of) the data cache can be
5706locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005707
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005708 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005709 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk6c59edc2004-05-03 20:45:30 +00005711 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5712 From: "Chris Hallinan" <clh@net1plus.com>
5713 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5714 ...
wdenkc6097192002-11-03 00:24:07 +00005715
wdenk6c59edc2004-05-03 20:45:30 +00005716 Correct me if I'm wrong, folks, but the way I understand it
5717 is this: Using DCACHE as initial RAM for Stack, etc, does not
5718 require any physical RAM backing up the cache. The cleverness
5719 is that the cache is being used as a temporary supply of
5720 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005721 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005722 can see how this works by studying the cache architecture and
5723 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5726 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005727 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005728 option should work for you. Using CS 4 should be fine if your
5729 board designers haven't used it for something that would
5730 cause you grief during the initial boot! It is frequently not
5731 used.
wdenkc6097192002-11-03 00:24:07 +00005732
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005733 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005734 with your processor/board/system design. The default value
5735 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005736 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005737 than your SDRAM module. If you have a 64MB SDRAM module, set
5738 it above 400_0000. Just make sure your board has no resources
5739 that are supposed to respond to that address! That code in
5740 start.S has been around a while and should work as is when
5741 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005742
wdenk6c59edc2004-05-03 20:45:30 +00005743 -Chris Hallinan
5744 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005745
wdenk6c59edc2004-05-03 20:45:30 +00005746It is essential to remember this, since it has some impact on the C
5747code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005748
wdenk6c59edc2004-05-03 20:45:30 +00005749* Initialized global data (data segment) is read-only. Do not attempt
5750 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005751
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005752* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005753 as zero data - BSS segment) at all - this is undefined, initiali-
5754 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756* Stack space is very limited. Avoid big data buffers or things like
5757 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005758
wdenk6c59edc2004-05-03 20:45:30 +00005759Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005760normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005761turned out that the implementation of U-Boot can be greatly
5762simplified by making a global data structure (gd_t) available to all
5763functions. We could pass a pointer to this data as argument to _all_
5764functions, but this would bloat the code. Instead we use a feature of
5765the GCC compiler (Global Register Variables) to share the data: we
5766place a pointer (gd) to the global data into a register which we
5767reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769When choosing a register for such a purpose we are restricted by the
5770relevant (E)ABI specifications for the current architecture, and by
5771GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005772
wdenk6c59edc2004-05-03 20:45:30 +00005773For PowerPC, the following registers have specific use:
5774 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005775 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005776 R3-R4: parameter passing and return values
5777 R5-R10: parameter passing
5778 R13: small data area pointer
5779 R30: GOT pointer
5780 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005781
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005782 (U-Boot also uses R12 as internal GOT pointer. r12
5783 is a volatile register so r12 needs to be reset when
5784 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005785
Wolfgang Denk69c09642008-02-14 22:43:22 +01005786 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005787
wdenk6c59edc2004-05-03 20:45:30 +00005788 Note: on PPC, we could use a static initializer (since the
5789 address of the global data structure is known at compile time),
5790 but it turned out that reserving a register results in somewhat
5791 smaller code - although the code savings are not that big (on
5792 average for all boards 752 bytes for the whole U-Boot image,
5793 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005794
wdenk6c59edc2004-05-03 20:45:30 +00005795On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005796
wdenk6c59edc2004-05-03 20:45:30 +00005797 R0: function argument word/integer result
5798 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005799 R9: platform specific
5800 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005801 R11: argument (frame) pointer
5802 R12: temporary workspace
5803 R13: stack pointer
5804 R14: link register
5805 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005806
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005807 ==> U-Boot will use R9 to hold a pointer to the global data
5808
5809 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005810
Thomas Chou8fa38582010-05-21 11:08:03 +08005811On Nios II, the ABI is documented here:
5812 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5813
5814 ==> U-Boot will use gp to hold a pointer to the global data
5815
5816 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5817 to access small data sections, so gp is free.
5818
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005819On NDS32, the following registers are used:
5820
5821 R0-R1: argument/return
5822 R2-R5: argument
5823 R15: temporary register for assembler
5824 R16: trampoline register
5825 R28: frame pointer (FP)
5826 R29: global pointer (GP)
5827 R30: link register (LP)
5828 R31: stack pointer (SP)
5829 PC: program counter (PC)
5830
5831 ==> U-Boot will use R10 to hold a pointer to the global data
5832
Wolfgang Denk6405a152006-03-31 18:32:53 +02005833NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5834or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk6c59edc2004-05-03 20:45:30 +00005836Memory Management:
5837------------------
wdenkc6097192002-11-03 00:24:07 +00005838
wdenk6c59edc2004-05-03 20:45:30 +00005839U-Boot runs in system state and uses physical addresses, i.e. the
5840MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005841
wdenk6c59edc2004-05-03 20:45:30 +00005842The available memory is mapped to fixed addresses using the memory
5843controller. In this process, a contiguous block is formed for each
5844memory type (Flash, SDRAM, SRAM), even when it consists of several
5845physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005846
wdenk6c59edc2004-05-03 20:45:30 +00005847U-Boot is installed in the first 128 kB of the first Flash bank (on
5848TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5849booting and sizing and initializing DRAM, the code relocates itself
5850to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005851memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005852configuration setting]. Below that, a structure with global Board
5853Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005854
wdenk6c59edc2004-05-03 20:45:30 +00005855Additionally, some exception handler code is copied to the low 8 kB
5856of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005857
wdenk6c59edc2004-05-03 20:45:30 +00005858So a typical memory configuration with 16 MB of DRAM could look like
5859this:
wdenkc6097192002-11-03 00:24:07 +00005860
wdenk6c59edc2004-05-03 20:45:30 +00005861 0x0000 0000 Exception Vector code
5862 :
5863 0x0000 1FFF
5864 0x0000 2000 Free for Application Use
5865 :
5866 :
wdenkc6097192002-11-03 00:24:07 +00005867
wdenk6c59edc2004-05-03 20:45:30 +00005868 :
5869 :
5870 0x00FB FF20 Monitor Stack (Growing downward)
5871 0x00FB FFAC Board Info Data and permanent copy of global data
5872 0x00FC 0000 Malloc Arena
5873 :
5874 0x00FD FFFF
5875 0x00FE 0000 RAM Copy of Monitor Code
5876 ... eventually: LCD or video framebuffer
5877 ... eventually: pRAM (Protected RAM - unchanged by reset)
5878 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005879
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk6c59edc2004-05-03 20:45:30 +00005881System Initialization:
5882----------------------
wdenkc6097192002-11-03 00:24:07 +00005883
wdenk6c59edc2004-05-03 20:45:30 +00005884In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005885(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005886configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005887To be able to re-map memory U-Boot then jumps to its link address.
5888To be able to implement the initialization code in C, a (small!)
5889initial stack is set up in the internal Dual Ported RAM (in case CPUs
5890which provide such a feature like MPC8xx or MPC8260), or in a locked
5891part of the data cache. After that, U-Boot initializes the CPU core,
5892the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005893
wdenk6c59edc2004-05-03 20:45:30 +00005894Next, all (potentially) available memory banks are mapped using a
5895preliminary mapping. For example, we put them on 512 MB boundaries
5896(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5897on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5898programmed for SDRAM access. Using the temporary configuration, a
5899simple memory test is run that determines the size of the SDRAM
5900banks.
wdenkc6097192002-11-03 00:24:07 +00005901
wdenk6c59edc2004-05-03 20:45:30 +00005902When there is more than one SDRAM bank, and the banks are of
5903different size, the largest is mapped first. For equal size, the first
5904bank (CS2#) is mapped first. The first mapping is always for address
59050x00000000, with any additional banks following immediately to create
5906contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005907
wdenk6c59edc2004-05-03 20:45:30 +00005908Then, the monitor installs itself at the upper end of the SDRAM area
5909and allocates memory for use by malloc() and for the global Board
5910Info data; also, the exception vector code is copied to the low RAM
5911pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005912
wdenk6c59edc2004-05-03 20:45:30 +00005913Only after this relocation will you have a "normal" C environment;
5914until that you are restricted in several ways, mostly because you are
5915running from ROM, and because the code will have to be relocated to a
5916new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005917
wdenkc6097192002-11-03 00:24:07 +00005918
wdenk6c59edc2004-05-03 20:45:30 +00005919U-Boot Porting Guide:
5920----------------------
wdenkc6097192002-11-03 00:24:07 +00005921
wdenk6c59edc2004-05-03 20:45:30 +00005922[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5923list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005924
wdenkc6097192002-11-03 00:24:07 +00005925
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005926int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005927{
5928 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005929
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005930 signal(SIGALRM, no_more_time);
5931 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005932
wdenk6c59edc2004-05-03 20:45:30 +00005933 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005934 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005935 return 0;
5936 }
wdenkc6097192002-11-03 00:24:07 +00005937
wdenk6c59edc2004-05-03 20:45:30 +00005938 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005939
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005940 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005941
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005942 if (clueless)
5943 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005944
wdenk6c59edc2004-05-03 20:45:30 +00005945 while (learning) {
5946 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005947 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5948 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005949 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005950 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005951 }
wdenkc6097192002-11-03 00:24:07 +00005952
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005953 if (available_money > toLocalCurrency ($2500))
5954 Buy a BDI3000;
5955 else
wdenk6c59edc2004-05-03 20:45:30 +00005956 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005957
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005958 if (a similar board exists) { /* hopefully... */
5959 cp -a board/<similar> board/<myboard>
5960 cp include/configs/<similar>.h include/configs/<myboard>.h
5961 } else {
5962 Create your own board support subdirectory;
5963 Create your own board include/configs/<myboard>.h file;
5964 }
5965 Edit new board/<myboard> files
5966 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005967
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005968 while (!accepted) {
5969 while (!running) {
5970 do {
5971 Add / modify source code;
5972 } until (compiles);
5973 Debug;
5974 if (clueless)
5975 email("Hi, I am having problems...");
5976 }
5977 Send patch file to the U-Boot email list;
5978 if (reasonable critiques)
5979 Incorporate improvements from email list code review;
5980 else
5981 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005982 }
wdenkc6097192002-11-03 00:24:07 +00005983
wdenk6c59edc2004-05-03 20:45:30 +00005984 return 0;
5985}
wdenkc6097192002-11-03 00:24:07 +00005986
wdenk6c59edc2004-05-03 20:45:30 +00005987void no_more_time (int sig)
5988{
5989 hire_a_guru();
5990}
wdenkc6097192002-11-03 00:24:07 +00005991
wdenkc6097192002-11-03 00:24:07 +00005992
wdenk6c59edc2004-05-03 20:45:30 +00005993Coding Standards:
5994-----------------
wdenkc6097192002-11-03 00:24:07 +00005995
wdenk6c59edc2004-05-03 20:45:30 +00005996All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005997coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005998"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005999
6000Source files originating from a different project (for example the
6001MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006002reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006003sources.
wdenkc6097192002-11-03 00:24:07 +00006004
Detlev Zundelaa63d482006-09-01 15:39:02 +02006005Please note that U-Boot is implemented in C (and to some small parts in
6006Assembler); no C++ is used, so please do not use C++ style comments (//)
6007in your code.
wdenkad276f22004-01-04 16:28:35 +00006008
wdenk6c59edc2004-05-03 20:45:30 +00006009Please also stick to the following formatting rules:
6010- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006011- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006012- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006013- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006014- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006015
wdenk6c59edc2004-05-03 20:45:30 +00006016Submissions which do not conform to the standards may be returned
6017with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006018
wdenkc6097192002-11-03 00:24:07 +00006019
wdenk6c59edc2004-05-03 20:45:30 +00006020Submitting Patches:
6021-------------------
wdenkc6097192002-11-03 00:24:07 +00006022
wdenk6c59edc2004-05-03 20:45:30 +00006023Since the number of patches for U-Boot is growing, we need to
6024establish some rules. Submissions which do not conform to these rules
6025may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006026
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006027Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006028
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006029Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6030see http://lists.denx.de/mailman/listinfo/u-boot
6031
wdenk6c59edc2004-05-03 20:45:30 +00006032When you send a patch, please include the following information with
6033it:
wdenkc6097192002-11-03 00:24:07 +00006034
wdenk6c59edc2004-05-03 20:45:30 +00006035* For bug fixes: a description of the bug and how your patch fixes
6036 this bug. Please try to include a way of demonstrating that the
6037 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006038
wdenk6c59edc2004-05-03 20:45:30 +00006039* For new features: a description of the feature and your
6040 implementation.
wdenkc6097192002-11-03 00:24:07 +00006041
wdenk6c59edc2004-05-03 20:45:30 +00006042* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006043
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006044* For major contributions, add a MAINTAINERS file with your
6045 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006046
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006047* When you add support for a new board, don't forget to add a
6048 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006049
wdenk6c59edc2004-05-03 20:45:30 +00006050* If your patch adds new configuration options, don't forget to
6051 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006052
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006053* The patch itself. If you are using git (which is *strongly*
6054 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006055 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006056 the U-Boot mailing list, you will avoid most of the common problems
6057 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006058
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006059 If you cannot use git, use "diff -purN OLD NEW". If your version of
6060 diff does not support these options, then get the latest version of
6061 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006062
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006063 The current directory when running this command shall be the parent
6064 directory of the U-Boot source tree (i. e. please make sure that
6065 your patch includes sufficient directory information for the
6066 affected files).
6067
6068 We prefer patches as plain text. MIME attachments are discouraged,
6069 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006070
wdenk6c59edc2004-05-03 20:45:30 +00006071* If one logical set of modifications affects or creates several
6072 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006073
wdenk6c59edc2004-05-03 20:45:30 +00006074* Changesets that contain different, unrelated modifications shall be
6075 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006076
wdenkc6097192002-11-03 00:24:07 +00006077
wdenk6c59edc2004-05-03 20:45:30 +00006078Notes:
wdenkc6097192002-11-03 00:24:07 +00006079
Simon Glassdc27def2016-07-27 20:33:08 -06006080* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006081 source tree and make sure that no errors or warnings are reported
6082 for any of the boards.
6083
6084* Keep your modifications to the necessary minimum: A patch
6085 containing several unrelated changes or arbitrary reformats will be
6086 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006087
wdenk6c59edc2004-05-03 20:45:30 +00006088* If you modify existing code, make sure that your new code does not
6089 add to the memory footprint of the code ;-) Small is beautiful!
6090 When adding new features, these should compile conditionally only
6091 (using #ifdef), and the resulting code with the new feature
6092 disabled must not need more memory than the old code without your
6093 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006094
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006095* Remember that there is a size limit of 100 kB per message on the
6096 u-boot mailing list. Bigger patches will be moderated. If they are
6097 reasonable and not too big, they will be acknowledged. But patches
6098 bigger than the size limit should be avoided.