blob: 71d8de0ba8f650a23dd0e4d66f5930191bc350c8 [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
295 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
296 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
834 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
835 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
836 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500837 CONFIG_CMD_DTT * Digital Therm and Thermostat
838 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500839 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500840 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanov37dda1c2016-04-16 17:55:03 +0300841 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500842 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -0600843 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -0600844 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -0500845 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500846 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000847 CONFIG_CMD_EXT2 * ext2 command support
848 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700849 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
850 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100851 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500852 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500853 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +0000854 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500855 CONFIG_CMD_FLASH flinfo, erase, protect
856 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200857 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +0000858 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -0500859 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000860 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +0000861 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_I2C * I2C serial bus support
863 CONFIG_CMD_IDE * IDE harddisk support
864 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000865 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200866 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500867 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -0600868 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500869 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000870 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500871 CONFIG_CMD_IRQ * irqinfo
872 CONFIG_CMD_ITEST Integer/string test of 2 values
873 CONFIG_CMD_JFFS2 * JFFS2 Support
874 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200875 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000876 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
877 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500878 CONFIG_CMD_LOADB loadb
879 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200880 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400881 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000882 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500883 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000884 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200885 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500886 CONFIG_CMD_MISC Misc functions like sleep etc
887 CONFIG_CMD_MMC * MMC memory mapped support
888 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100889 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500890 CONFIG_CMD_NAND * NAND support
891 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200892 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600893 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000894 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500895 CONFIG_CMD_PCI * pciinfo
896 CONFIG_CMD_PCMCIA * PCMCIA support
897 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
898 host
899 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000900 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500901 CONFIG_CMD_REGINFO * Register dump
902 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000903 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500904 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600905 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500906 CONFIG_CMD_SDRAM * print SDRAM configuration information
907 (requires CONFIG_CMD_I2C)
908 CONFIG_CMD_SETGETDCR Support for DCR Register access
909 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700910 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200911 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400912 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800913 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200914 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500915 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000916 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000917 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000918 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
919 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500920 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500921 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000922 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200923 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200924 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000925
926 EXAMPLE: If you want all functions except of network
927 support you can write:
928
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500929 #include "config_cmd_all.h"
930 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000931
Gerald Van Barend6abef42007-03-31 12:23:51 -0400932 Other Commands:
933 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000934
935 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500936 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000937 what you (and your U-Boot users) are doing. Data
938 cache cannot be enabled on systems like the 8xx or
939 8260 (where accesses to the IMMR region must be
940 uncached), and it cannot be disabled on all other
941 systems where we (mis-) use the data cache to hold an
942 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000943
944
945 XXX - this list needs to get updated!
946
Simon Glassaa34ef22016-03-13 19:07:28 -0600947- Removal of commands
948 If no commands are needed to boot, you can disable
949 CONFIG_CMDLINE to remove them. In this case, the command line
950 will not be available, and when U-Boot wants to execute the
951 boot command (on start-up) it will call board_run_command()
952 instead. This can reduce image size significantly for very
953 simple boot procedures.
954
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000955- Regular expression support:
956 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200957 If this variable is defined, U-Boot is linked against
958 the SLRE (Super Light Regular Expression) library,
959 which adds regex support to some commands, as for
960 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000961
Simon Glass3d686442011-10-15 05:48:20 +0000962- Device tree:
963 CONFIG_OF_CONTROL
964 If this variable is defined, U-Boot will use a device tree
965 to configure its devices, instead of relying on statically
966 compiled #defines in the board file. This option is
967 experimental and only available on a few boards. The device
968 tree is available in the global data as gd->fdt_blob.
969
Simon Glass5cb34db2011-10-24 19:15:31 +0000970 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700971 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000972
973 CONFIG_OF_EMBED
974 If this variable is defined, U-Boot will embed a device tree
975 binary in its image. This device tree file should be in the
976 board directory and called <soc>-<board>.dts. The binary file
977 is then picked up in board_init_f() and made available through
978 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000979
Simon Glass5cb34db2011-10-24 19:15:31 +0000980 CONFIG_OF_SEPARATE
981 If this variable is defined, U-Boot will build a device tree
982 binary. It will be called u-boot.dtb. Architecture-specific
983 code will locate it at run-time. Generally this works by:
984
985 cat u-boot.bin u-boot.dtb >image.bin
986
987 and in fact, U-Boot does this for you, creating a file called
988 u-boot-dtb.bin which is useful in the common case. You can
989 still use the individual files if you need something more
990 exotic.
991
Alex Deymo5b661ec2017-04-02 01:25:20 -0700992 CONFIG_OF_BOARD
993 If this variable is defined, U-Boot will use the device tree
994 provided by the board at runtime instead of embedding one with
995 the image. Only boards defining board_fdt_blob_setup() support
996 this option (see include/fdtdec.h file).
997
wdenkc6097192002-11-03 00:24:07 +0000998- Watchdog:
999 CONFIG_WATCHDOG
1000 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001001 support for the SoC. There must be support in the SoC
1002 specific code for a watchdog. For the 8xx and 8260
1003 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1004 register. When supported for a specific SoC is
1005 available, then no further board specific code should
1006 be needed to use it.
1007
1008 CONFIG_HW_WATCHDOG
1009 When using a watchdog circuitry external to the used
1010 SoC, then define this variable and provide board
1011 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001012
Heiko Schocher735326c2015-01-21 08:38:22 +01001013 CONFIG_AT91_HW_WDT_TIMEOUT
1014 specify the timeout in seconds. default 2 seconds.
1015
stroeseb9c17c52003-04-04 15:53:41 +00001016- U-Boot Version:
1017 CONFIG_VERSION_VARIABLE
1018 If this variable is defined, an environment variable
1019 named "ver" is created by U-Boot showing the U-Boot
1020 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001021 Any change to this variable will be reverted at the
1022 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001023
wdenkc6097192002-11-03 00:24:07 +00001024- Real-Time Clock:
1025
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001026 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001027 has to be selected, too. Define exactly one of the
1028 following options:
1029
1030 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1031 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001032 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001033 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001034 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001035 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001036 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001037 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001038 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001039 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001040 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001041 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001042 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1043 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001044
wdenkb9bbd242003-06-30 16:24:52 +00001045 Note that if the RTC uses I2C, then the I2C interface
1046 must also be configured. See I2C Support, below.
1047
Peter Tyser9902e422008-12-17 16:36:21 -06001048- GPIO Support:
1049 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001050
Chris Packham9b383202010-12-19 10:12:13 +00001051 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1052 chip-ngpio pairs that tell the PCA953X driver the number of
1053 pins supported by a particular chip.
1054
Peter Tyser9902e422008-12-17 16:36:21 -06001055 Note that if the GPIO device uses I2C, then the I2C interface
1056 must also be configured. See I2C Support, below.
1057
Simon Glass4dc47ca2014-06-11 23:29:41 -06001058- I/O tracing:
1059 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1060 accesses and can checksum them or write a list of them out
1061 to memory. See the 'iotrace' command for details. This is
1062 useful for testing device drivers since it can confirm that
1063 the driver behaves the same way before and after a code
1064 change. Currently this is supported on sandbox and arm. To
1065 add support for your architecture, add '#include <iotrace.h>'
1066 to the bottom of arch/<arch>/include/asm/io.h and test.
1067
1068 Example output from the 'iotrace stats' command is below.
1069 Note that if the trace buffer is exhausted, the checksum will
1070 still continue to operate.
1071
1072 iotrace is enabled
1073 Start: 10000000 (buffer start address)
1074 Size: 00010000 (buffer size)
1075 Offset: 00000120 (current buffer offset)
1076 Output: 10000120 (start + offset)
1077 Count: 00000018 (number of trace records)
1078 CRC32: 9526fb66 (CRC32 of all trace records)
1079
wdenkc6097192002-11-03 00:24:07 +00001080- Timestamp Support:
1081
wdenk4a5c8a72003-03-06 00:02:04 +00001082 When CONFIG_TIMESTAMP is selected, the timestamp
1083 (date and time) of an image is printed by image
1084 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001085 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001086
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001087- Partition Labels (disklabels) Supported:
1088 Zero or more of the following:
1089 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1090 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1091 Intel architecture, USB sticks, etc.
1092 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1093 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1094 bootloader. Note 2TB partition limit; see
1095 disk/part_efi.c
1096 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001097
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001098 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001099 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001100 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001101
1102- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001103 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1104 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001105
wdenk369d43d2004-03-14 14:09:05 +00001106 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1107 be performed by calling the function
1108 ide_set_reset(int reset)
1109 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001110
1111- ATAPI Support:
1112 CONFIG_ATAPI
1113
1114 Set this to enable ATAPI support.
1115
wdenkf602aa02004-03-13 23:29:43 +00001116- LBA48 Support
1117 CONFIG_LBA48
1118
1119 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001120 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001121 Whithout these , LBA48 support uses 32bit variables and will 'only'
1122 support disks up to 2.1TB.
1123
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001124 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001125 When enabled, makes the IDE subsystem use 64bit sector addresses.
1126 Default is 32bit.
1127
wdenkc6097192002-11-03 00:24:07 +00001128- SCSI Support:
1129 At the moment only there is only support for the
1130 SYM53C8XX SCSI controller; define
1131 CONFIG_SCSI_SYM53C8XX to enable it.
1132
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001133 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1134 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1135 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001136 maximum numbers of LUNs, SCSI ID's and target
1137 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001138 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001139
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001140 The environment variable 'scsidevs' is set to the number of
1141 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001142
wdenkc6097192002-11-03 00:24:07 +00001143- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001144 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001145 Support for Intel 8254x/8257x gigabit chips.
1146
1147 CONFIG_E1000_SPI
1148 Utility code for direct access to the SPI bus on Intel 8257x.
1149 This does not do anything useful unless you set at least one
1150 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1151
1152 CONFIG_E1000_SPI_GENERIC
1153 Allow generic access to the SPI bus on the Intel 8257x, for
1154 example with the "sspi" command.
1155
1156 CONFIG_CMD_E1000
1157 Management command for E1000 devices. When used on devices
1158 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001159
wdenkc6097192002-11-03 00:24:07 +00001160 CONFIG_EEPRO100
1161 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001162 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001163 write routine for first time initialisation.
1164
1165 CONFIG_TULIP
1166 Support for Digital 2114x chips.
1167 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1168 modem chip initialisation (KS8761/QS6611).
1169
1170 CONFIG_NATSEMI
1171 Support for National dp83815 chips.
1172
1173 CONFIG_NS8382X
1174 Support for National dp8382[01] gigabit chips.
1175
wdenkaa603362003-05-12 21:50:16 +00001176- NETWORK Support (other):
1177
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001178 CONFIG_DRIVER_AT91EMAC
1179 Support for AT91RM9200 EMAC.
1180
1181 CONFIG_RMII
1182 Define this to use reduced MII inteface
1183
1184 CONFIG_DRIVER_AT91EMAC_QUIET
1185 If this defined, the driver is quiet.
1186 The driver doen't show link status messages.
1187
Rob Herringc9830dc2011-12-15 11:15:49 +00001188 CONFIG_CALXEDA_XGMAC
1189 Support for the Calxeda XGMAC device
1190
Ashok93fb8722012-10-15 06:20:47 +00001191 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001192 Support for SMSC's LAN91C96 chips.
1193
wdenkaa603362003-05-12 21:50:16 +00001194 CONFIG_LAN91C96_USE_32_BIT
1195 Define this to enable 32 bit addressing
1196
Ashok93fb8722012-10-15 06:20:47 +00001197 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001198 Support for SMSC's LAN91C111 chip
1199
1200 CONFIG_SMC91111_BASE
1201 Define this to hold the physical address
1202 of the device (I/O space)
1203
1204 CONFIG_SMC_USE_32_BIT
1205 Define this if data bus is 32 bits
1206
1207 CONFIG_SMC_USE_IOFUNCS
1208 Define this to use i/o functions instead of macros
1209 (some hardware wont work with macros)
1210
Heiko Schocher7d037f72011-11-15 10:00:04 -05001211 CONFIG_DRIVER_TI_EMAC
1212 Support for davinci emac
1213
1214 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1215 Define this if you have more then 3 PHYs.
1216
Macpaul Lin199c6252010-12-21 16:59:46 +08001217 CONFIG_FTGMAC100
1218 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1219
1220 CONFIG_FTGMAC100_EGIGA
1221 Define this to use GE link update with gigabit PHY.
1222 Define this if FTGMAC100 is connected to gigabit PHY.
1223 If your system has 10/100 PHY only, it might not occur
1224 wrong behavior. Because PHY usually return timeout or
1225 useless data when polling gigabit status and gigabit
1226 control registers. This behavior won't affect the
1227 correctnessof 10/100 link speed update.
1228
Mike Rapoportf4761af2009-11-11 10:03:03 +02001229 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001230 Support for SMSC's LAN911x and LAN921x chips
1231
Mike Rapoportf4761af2009-11-11 10:03:03 +02001232 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001233 Define this to hold the physical address
1234 of the device (I/O space)
1235
Mike Rapoportf4761af2009-11-11 10:03:03 +02001236 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001237 Define this if data bus is 32 bits
1238
Mike Rapoportf4761af2009-11-11 10:03:03 +02001239 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001240 Define this if data bus is 16 bits. If your processor
1241 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001242 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001243
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001244 CONFIG_SH_ETHER
1245 Support for Renesas on-chip Ethernet controller
1246
1247 CONFIG_SH_ETHER_USE_PORT
1248 Define the number of ports to be used
1249
1250 CONFIG_SH_ETHER_PHY_ADDR
1251 Define the ETH PHY's address
1252
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001253 CONFIG_SH_ETHER_CACHE_WRITEBACK
1254 If this option is set, the driver enables cache flush.
1255
Heiko Schocher2b387762014-07-18 06:07:19 +02001256- PWM Support:
1257 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001258 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001259
Vadim Bendeburydac69642011-10-17 08:36:14 +00001260- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001261 CONFIG_TPM
1262 Support TPM devices.
1263
Christophe Ricard8759ff82015-10-06 22:54:41 +02001264 CONFIG_TPM_TIS_INFINEON
1265 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001266 per system is supported at this time.
1267
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001268 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1269 Define the burst count bytes upper limit
1270
Christophe Ricard88249232016-01-21 23:27:13 +01001271 CONFIG_TPM_ST33ZP24
1272 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1273
1274 CONFIG_TPM_ST33ZP24_I2C
1275 Support for STMicroelectronics ST33ZP24 I2C devices.
1276 Requires TPM_ST33ZP24 and I2C.
1277
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001278 CONFIG_TPM_ST33ZP24_SPI
1279 Support for STMicroelectronics ST33ZP24 SPI devices.
1280 Requires TPM_ST33ZP24 and SPI.
1281
Dirk Eibach20489092013-06-26 15:55:15 +02001282 CONFIG_TPM_ATMEL_TWI
1283 Support for Atmel TWI TPM device. Requires I2C support.
1284
Che-liang Chiouacea5702013-04-12 11:04:34 +00001285 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001286 Support for generic parallel port TPM devices. Only one device
1287 per system is supported at this time.
1288
1289 CONFIG_TPM_TIS_BASE_ADDRESS
1290 Base address where the generic TPM device is mapped
1291 to. Contemporary x86 systems usually map it at
1292 0xfed40000.
1293
Reinhard Pfau4fece432013-06-26 15:55:13 +02001294 CONFIG_CMD_TPM
1295 Add tpm monitor functions.
1296 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1297 provides monitor access to authorized functions.
1298
1299 CONFIG_TPM
1300 Define this to enable the TPM support library which provides
1301 functional interfaces to some TPM commands.
1302 Requires support for a TPM device.
1303
1304 CONFIG_TPM_AUTH_SESSIONS
1305 Define this to enable authorized functions in the TPM library.
1306 Requires CONFIG_TPM and CONFIG_SHA1.
1307
wdenkc6097192002-11-03 00:24:07 +00001308- USB Support:
1309 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001310 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001311 CONFIG_USB_UHCI to enable it.
1312 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001313 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001314 storage devices.
1315 Note:
1316 Supported are USB Keyboards and USB Floppy drives
1317 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001318 MPC5200 USB requires additional defines:
1319 CONFIG_USB_CLOCK
1320 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001321 CONFIG_PSC3_USB
1322 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001323 CONFIG_USB_CONFIG
1324 for differential drivers: 0x00001000
1325 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001326 for differential drivers on PSC3: 0x00000100
1327 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001328 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001329 May be defined to allow interrupt polling
1330 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001331
Simon Glass5978cdb2012-02-27 10:52:47 +00001332 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1333 txfilltuning field in the EHCI controller on reset.
1334
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001335 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1336 HW module registers.
1337
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001338- USB Device:
1339 Define the below if you wish to use the USB console.
1340 Once firmware is rebuilt from a serial console issue the
1341 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001342 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001343 it has found a new device. The environment variable usbtty
1344 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001345 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001346 Common Device Class Abstract Control Model serial device.
1347 If you select usbtty = gserial you should be able to enumerate
1348 a Linux host by
1349 # modprobe usbserial vendor=0xVendorID product=0xProductID
1350 else if using cdc_acm, simply setting the environment
1351 variable usbtty to be cdc_acm should suffice. The following
1352 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001353
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001354 CONFIG_USB_DEVICE
1355 Define this to build a UDC device
1356
1357 CONFIG_USB_TTY
1358 Define this to have a tty type of device available to
1359 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001360
Vipin KUMARbdb17702012-03-26 15:38:06 +05301361 CONFIG_USBD_HS
1362 Define this to enable the high speed support for usb
1363 device and usbtty. If this feature is enabled, a routine
1364 int is_usbd_high_speed(void)
1365 also needs to be defined by the driver to dynamically poll
1366 whether the enumeration has succeded at high speed or full
1367 speed.
1368
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001369 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001370 Define this if you want stdin, stdout &/or stderr to
1371 be set to usbtty.
1372
1373 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001374 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001375 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001376 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001377
Wolfgang Denke2601822006-06-14 18:14:56 +02001378 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001379 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001380 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001381 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1382 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1383 should pretend to be a Linux device to it's target host.
1384
1385 CONFIG_USBD_MANUFACTURER
1386 Define this string as the name of your company for
1387 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001388
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001389 CONFIG_USBD_PRODUCT_NAME
1390 Define this string as the name of your product
1391 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001392
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001393 CONFIG_USBD_VENDORID
1394 Define this as your assigned Vendor ID from the USB
1395 Implementors Forum. This *must* be a genuine Vendor ID
1396 to avoid polluting the USB namespace.
1397 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001398
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001399 CONFIG_USBD_PRODUCTID
1400 Define this as the unique Product ID
1401 for your device
1402 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001403
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001404- ULPI Layer Support:
1405 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1406 the generic ULPI layer. The generic layer accesses the ULPI PHY
1407 via the platform viewport, so you need both the genric layer and
1408 the viewport enabled. Currently only Chipidea/ARC based
1409 viewport is supported.
1410 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1411 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001412 If your ULPI phy needs a different reference clock than the
1413 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1414 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001415
wdenk7a428cc2003-06-15 22:40:42 +00001416- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001417 The MMC controller on the Intel PXA is supported. To
1418 enable this define CONFIG_MMC. The MMC can be
1419 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001420 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001421 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1422 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001423
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001424 CONFIG_SH_MMCIF
1425 Support for Renesas on-chip MMCIF controller
1426
1427 CONFIG_SH_MMCIF_ADDR
1428 Define the base address of MMCIF registers
1429
1430 CONFIG_SH_MMCIF_CLK
1431 Define the clock frequency for MMCIF
1432
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001433 CONFIG_SUPPORT_EMMC_BOOT
1434 Enable some additional features of the eMMC boot partitions.
1435
1436 CONFIG_SUPPORT_EMMC_RPMB
1437 Enable the commands for reading, writing and programming the
1438 key for the Replay Protection Memory Block partition in eMMC.
1439
Tom Rini58a8d322013-03-14 05:32:47 +00001440- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001441 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001442 This enables the USB portion of the DFU USB class
1443
1444 CONFIG_CMD_DFU
1445 This enables the command "dfu" which is used to have
1446 U-Boot create a DFU class device via USB. This command
1447 requires that the "dfu_alt_info" environment variable be
1448 set and define the alt settings to expose to the host.
1449
1450 CONFIG_DFU_MMC
1451 This enables support for exposing (e)MMC devices via DFU.
1452
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001453 CONFIG_DFU_NAND
1454 This enables support for exposing NAND devices via DFU.
1455
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301456 CONFIG_DFU_RAM
1457 This enables support for exposing RAM via DFU.
1458 Note: DFU spec refer to non-volatile memory usage, but
1459 allow usages beyond the scope of spec - here RAM usage,
1460 one that would help mostly the developer.
1461
Heiko Schochera2f831e2013-06-12 06:05:51 +02001462 CONFIG_SYS_DFU_DATA_BUF_SIZE
1463 Dfu transfer uses a buffer before writing data to the
1464 raw storage device. Make the size (in bytes) of this buffer
1465 configurable. The size of this buffer is also configurable
1466 through the "dfu_bufsiz" environment variable.
1467
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001468 CONFIG_SYS_DFU_MAX_FILE_SIZE
1469 When updating files rather than the raw storage device,
1470 we use a static buffer to copy the file into and then write
1471 the buffer once we've been given the whole file. Define
1472 this to the maximum filesize (in bytes) for the buffer.
1473 Default is 4 MiB if undefined.
1474
Heiko Schochere1ba1512014-03-18 08:09:56 +01001475 DFU_DEFAULT_POLL_TIMEOUT
1476 Poll timeout [ms], is the timeout a device can send to the
1477 host. The host must wait for this timeout before sending
1478 a subsequent DFU_GET_STATUS request to the device.
1479
1480 DFU_MANIFEST_POLL_TIMEOUT
1481 Poll timeout [ms], which the device sends to the host when
1482 entering dfuMANIFEST state. Host waits this timeout, before
1483 sending again an USB request to the device.
1484
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001485- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001486 CONFIG_USB_FUNCTION_FASTBOOT
1487 This enables the USB part of the fastboot gadget
1488
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001489 CONFIG_CMD_FASTBOOT
1490 This enables the command "fastboot" which enables the Android
1491 fastboot mode for the platform's USB device. Fastboot is a USB
1492 protocol for downloading images, flashing and device control
1493 used on Android devices.
1494 See doc/README.android-fastboot for more information.
1495
1496 CONFIG_ANDROID_BOOT_IMAGE
1497 This enables support for booting images which use the Android
1498 image format header.
1499
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001500 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001501 The fastboot protocol requires a large memory buffer for
1502 downloads. Define this to the starting RAM address to use for
1503 downloaded images.
1504
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001505 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001506 The fastboot protocol requires a large memory buffer for
1507 downloads. This buffer should be as large as possible for a
1508 platform. Define this to the size available RAM for fastboot.
1509
Steve Raebfb9ba42014-08-26 11:47:28 -07001510 CONFIG_FASTBOOT_FLASH
1511 The fastboot protocol includes a "flash" command for writing
1512 the downloaded image to a non-volatile storage device. Define
1513 this to enable the "fastboot flash" command.
1514
1515 CONFIG_FASTBOOT_FLASH_MMC_DEV
1516 The fastboot "flash" command requires additional information
1517 regarding the non-volatile storage device. Define this to
1518 the eMMC device that fastboot should use to store the image.
1519
Steve Rae7d059342014-12-12 15:51:54 -08001520 CONFIG_FASTBOOT_GPT_NAME
1521 The fastboot "flash" command supports writing the downloaded
1522 image to the Protective MBR and the Primary GUID Partition
1523 Table. (Additionally, this downloaded image is post-processed
1524 to generate and write the Backup GUID Partition Table.)
1525 This occurs when the specified "partition name" on the
1526 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001527 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001528
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001529 CONFIG_FASTBOOT_MBR_NAME
1530 The fastboot "flash" command supports writing the downloaded
1531 image to DOS MBR.
1532 This occurs when the "partition name" specified on the
1533 "fastboot flash" command line matches this value.
1534 If not defined the default value "mbr" is used.
1535
wdenkda04a8b2004-08-02 23:22:59 +00001536- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001537 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001538 Define these for a default partition on a NAND device
1539
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001540 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1541 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001542 Define these for a default partition on a NOR device
1543
Donggeun Kim8f814002011-10-24 21:15:28 +00001544- FAT(File Allocation Table) filesystem write function support:
1545 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001546
1547 Define this to enable support for saving memory data as a
1548 file in FAT formatted partition.
1549
1550 This will also enable the command "fatwrite" enabling the
1551 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001552
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301553- FAT(File Allocation Table) filesystem cluster size:
1554 CONFIG_FS_FAT_MAX_CLUSTSIZE
1555
1556 Define the max cluster size for fat operations else
1557 a default value of 65536 will be defined.
1558
wdenkc6097192002-11-03 00:24:07 +00001559- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001560 See Kconfig help for available keyboard drivers.
1561
1562 CONFIG_KEYBOARD
1563
1564 Define this to enable a custom keyboard support.
1565 This simply calls drv_keyboard_init() which must be
1566 defined in your board-specific files. This option is deprecated
1567 and is only used by novena. For new boards, use driver model
1568 instead.
wdenkc6097192002-11-03 00:24:07 +00001569
1570- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001571 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001572 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001573 SOCs that have a DIU should define this macro to enable DIU
1574 support, and should also define these other macros:
1575
1576 CONFIG_SYS_DIU_ADDR
1577 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001578 CONFIG_CFB_CONSOLE
1579 CONFIG_VIDEO_SW_CURSOR
1580 CONFIG_VGA_AS_SINGLE_DEVICE
1581 CONFIG_VIDEO_LOGO
1582 CONFIG_VIDEO_BMP_LOGO
1583
Timur Tabi32f709e2011-04-11 14:18:22 -05001584 The DIU driver will look for the 'video-mode' environment
1585 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001586 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001587 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001588
wdenkc6097192002-11-03 00:24:07 +00001589- LCD Support: CONFIG_LCD
1590
1591 Define this to enable LCD support (for output to LCD
1592 display); also select one of the supported displays
1593 by defining one of these:
1594
Stelian Popf6f86652008-05-09 21:57:18 +02001595 CONFIG_ATMEL_LCD:
1596
1597 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1598
wdenkc0d54ae2003-11-25 16:55:19 +00001599 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001600
wdenkc0d54ae2003-11-25 16:55:19 +00001601 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001602
wdenkc0d54ae2003-11-25 16:55:19 +00001603 CONFIG_NEC_NL6448BC20
1604
1605 NEC NL6448BC20-08. 6.5", 640x480.
1606 Active, color, single scan.
1607
1608 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001609
wdenkc0d54ae2003-11-25 16:55:19 +00001610 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001611 Active, color, single scan.
1612
1613 CONFIG_SHARP_16x9
1614
1615 Sharp 320x240. Active, color, single scan.
1616 It isn't 16x9, and I am not sure what it is.
1617
1618 CONFIG_SHARP_LQ64D341
1619
1620 Sharp LQ64D341 display, 640x480.
1621 Active, color, single scan.
1622
1623 CONFIG_HLD1045
1624
1625 HLD1045 display, 640x480.
1626 Active, color, single scan.
1627
1628 CONFIG_OPTREX_BW
1629
1630 Optrex CBL50840-2 NF-FW 99 22 M5
1631 or
1632 Hitachi LMG6912RPFC-00T
1633 or
1634 Hitachi SP14Q002
1635
1636 320x240. Black & white.
1637
Simon Glass599a4df2012-10-17 13:24:54 +00001638 CONFIG_LCD_ALIGNMENT
1639
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001640 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001641 defined then the LCD will be aligned to this value instead.
1642 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1643 here, since it is cheaper to change data cache settings on
1644 a per-section basis.
1645
1646
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001647 CONFIG_LCD_ROTATION
1648
1649 Sometimes, for example if the display is mounted in portrait
1650 mode or even if it's mounted landscape but rotated by 180degree,
1651 we need to rotate our content of the display relative to the
1652 framebuffer, so that user can read the messages which are
1653 printed out.
1654 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1655 initialized with a given rotation from "vl_rot" out of
1656 "vidinfo_t" which is provided by the board specific code.
1657 The value for vl_rot is coded as following (matching to
1658 fbcon=rotate:<n> linux-kernel commandline):
1659 0 = no rotation respectively 0 degree
1660 1 = 90 degree rotation
1661 2 = 180 degree rotation
1662 3 = 270 degree rotation
1663
1664 If CONFIG_LCD_ROTATION is not defined, the console will be
1665 initialized with 0degree rotation.
1666
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001667 CONFIG_LCD_BMP_RLE8
1668
1669 Support drawing of RLE8-compressed bitmaps on the LCD.
1670
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001671 CONFIG_I2C_EDID
1672
1673 Enables an 'i2c edid' command which can read EDID
1674 information over I2C from an attached LCD display.
1675
wdenkeb20ad32003-09-05 23:19:14 +00001676- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001677
wdenk57b2d802003-06-27 21:31:46 +00001678 If this option is set, the environment is checked for
1679 a variable "splashimage". If found, the usual display
1680 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001681 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001682 specified in "splashimage" is loaded instead. The
1683 console is redirected to the "nulldev", too. This
1684 allows for a "silent" boot where a splash screen is
1685 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001686
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001687 CONFIG_SPLASHIMAGE_GUARD
1688
1689 If this option is set, then U-Boot will prevent the environment
1690 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001691 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001692 This option is useful for targets where, due to alignment
1693 restrictions, an improperly aligned BMP image will cause a data
1694 abort. If you think you will not have problems with unaligned
1695 accesses (for example because your toolchain prevents them)
1696 there is no need to set this option.
1697
Matthias Weisser53884182009-07-09 16:07:30 +02001698 CONFIG_SPLASH_SCREEN_ALIGN
1699
1700 If this option is set the splash image can be freely positioned
1701 on the screen. Environment variable "splashpos" specifies the
1702 position as "x,y". If a positive number is given it is used as
1703 number of pixel from left/top. If a negative number is given it
1704 is used as number of pixel from right/bottom. You can also
1705 specify 'm' for centering the image.
1706
1707 Example:
1708 setenv splashpos m,m
1709 => image at center of screen
1710
1711 setenv splashpos 30,20
1712 => image at x = 30 and y = 20
1713
1714 setenv splashpos -10,m
1715 => vertically centered image
1716 at x = dspWidth - bmpWidth - 9
1717
Stefan Roesed9d97742005-09-22 09:04:17 +02001718- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1719
1720 If this option is set, additionally to standard BMP
1721 images, gzipped BMP images can be displayed via the
1722 splashscreen support or the bmp command.
1723
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001724- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1725
1726 If this option is set, 8-bit RLE compressed BMP images
1727 can be displayed via the splashscreen support or the
1728 bmp command.
1729
wdenk710e3502003-08-29 20:57:53 +00001730- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001731 CONFIG_GZIP
1732
1733 Enabled by default to support gzip compressed images.
1734
wdenk710e3502003-08-29 20:57:53 +00001735 CONFIG_BZIP2
1736
1737 If this option is set, support for bzip2 compressed
1738 images is included. If not, only uncompressed and gzip
1739 compressed images are supported.
1740
wdenk9c53f402003-10-15 23:53:47 +00001741 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001742 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001743 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001744
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001745 CONFIG_LZMA
1746
1747 If this option is set, support for lzma compressed
1748 images is included.
1749
1750 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1751 requires an amount of dynamic memory that is given by the
1752 formula:
1753
1754 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1755
1756 Where lc and lp stand for, respectively, Literal context bits
1757 and Literal pos bits.
1758
1759 This value is upper-bounded by 14MB in the worst case. Anyway,
1760 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1761 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1762 a very small buffer.
1763
1764 Use the lzmainfo tool to determinate the lc and lp values and
1765 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001766 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001767
Kees Cook5b06e642013-08-16 07:59:12 -07001768 CONFIG_LZO
1769
1770 If this option is set, support for LZO compressed images
1771 is included.
1772
wdenk0e2bd9c2004-06-06 21:51:03 +00001773- MII/PHY support:
1774 CONFIG_PHY_ADDR
1775
1776 The address of PHY on MII bus.
1777
1778 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1779
1780 The clock frequency of the MII bus
1781
1782 CONFIG_PHY_GIGE
1783
1784 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001785 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001786
1787 CONFIG_PHY_RESET_DELAY
1788
1789 Some PHY like Intel LXT971A need extra delay after
1790 reset before any MII register access is possible.
1791 For such PHY, set this option to the usec delay
1792 required. (minimum 300usec for LXT971A)
1793
1794 CONFIG_PHY_CMD_DELAY (ppc4xx)
1795
1796 Some PHY like Intel LXT971A need extra delay after
1797 command issued before MII status register can be read
1798
wdenkc6097192002-11-03 00:24:07 +00001799- IP address:
1800 CONFIG_IPADDR
1801
1802 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001803 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001804 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001805 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001806
1807- Server IP address:
1808 CONFIG_SERVERIP
1809
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001810 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001811 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001812 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001813
Robin Getz470a6d42009-07-21 12:15:28 -04001814 CONFIG_KEEP_SERVERADDR
1815
1816 Keeps the server's MAC address, in the env 'serveraddr'
1817 for passing to bootargs (like Linux's netconsole option)
1818
Wolfgang Denk26da2992011-10-26 10:21:22 +00001819- Gateway IP address:
1820 CONFIG_GATEWAYIP
1821
1822 Defines a default value for the IP address of the
1823 default router where packets to other networks are
1824 sent to.
1825 (Environment variable "gatewayip")
1826
1827- Subnet mask:
1828 CONFIG_NETMASK
1829
1830 Defines a default value for the subnet mask (or
1831 routing prefix) which is used to determine if an IP
1832 address belongs to the local subnet or needs to be
1833 forwarded through a router.
1834 (Environment variable "netmask")
1835
David Updegraff7280da72007-06-11 10:41:07 -05001836- Multicast TFTP Mode:
1837 CONFIG_MCAST_TFTP
1838
1839 Defines whether you want to support multicast TFTP as per
1840 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001841 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001842 driver in use must provide a function: mcast() to join/leave a
1843 multicast group.
1844
wdenkc6097192002-11-03 00:24:07 +00001845- BOOTP Recovery Mode:
1846 CONFIG_BOOTP_RANDOM_DELAY
1847
1848 If you have many targets in a network that try to
1849 boot using BOOTP, you may want to avoid that all
1850 systems send out BOOTP requests at precisely the same
1851 moment (which would happen for instance at recovery
1852 from a power failure, when all systems will try to
1853 boot, thus flooding the BOOTP server. Defining
1854 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1855 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001856 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001857
1858 1st BOOTP request: delay 0 ... 1 sec
1859 2nd BOOTP request: delay 0 ... 2 sec
1860 3rd BOOTP request: delay 0 ... 4 sec
1861 4th and following
1862 BOOTP requests: delay 0 ... 8 sec
1863
Thierry Reding8977cda2014-08-19 10:21:24 +02001864 CONFIG_BOOTP_ID_CACHE_SIZE
1865
1866 BOOTP packets are uniquely identified using a 32-bit ID. The
1867 server will copy the ID from client requests to responses and
1868 U-Boot will use this to determine if it is the destination of
1869 an incoming response. Some servers will check that addresses
1870 aren't in use before handing them out (usually using an ARP
1871 ping) and therefore take up to a few hundred milliseconds to
1872 respond. Network congestion may also influence the time it
1873 takes for a response to make it back to the client. If that
1874 time is too long, U-Boot will retransmit requests. In order
1875 to allow earlier responses to still be accepted after these
1876 retransmissions, U-Boot's BOOTP client keeps a small cache of
1877 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1878 cache. The default is to keep IDs for up to four outstanding
1879 requests. Increasing this will allow U-Boot to accept offers
1880 from a BOOTP client in networks with unusually high latency.
1881
stroesee0aadfb2003-08-28 14:17:32 +00001882- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001883 You can fine tune the DHCP functionality by defining
1884 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001885
Jon Loeliger5336a762007-07-09 22:08:34 -05001886 CONFIG_BOOTP_SUBNETMASK
1887 CONFIG_BOOTP_GATEWAY
1888 CONFIG_BOOTP_HOSTNAME
1889 CONFIG_BOOTP_NISDOMAIN
1890 CONFIG_BOOTP_BOOTPATH
1891 CONFIG_BOOTP_BOOTFILESIZE
1892 CONFIG_BOOTP_DNS
1893 CONFIG_BOOTP_DNS2
1894 CONFIG_BOOTP_SEND_HOSTNAME
1895 CONFIG_BOOTP_NTPSERVER
1896 CONFIG_BOOTP_TIMEOFFSET
1897 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001898 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001899
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001900 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1901 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001902
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001903 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1904 after the configured retry count, the call will fail
1905 instead of starting over. This can be used to fail over
1906 to Link-local IP address configuration if the DHCP server
1907 is not available.
1908
stroesee0aadfb2003-08-28 14:17:32 +00001909 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1910 serverip from a DHCP server, it is possible that more
1911 than one DNS serverip is offered to the client.
1912 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1913 serverip will be stored in the additional environment
1914 variable "dnsip2". The first DNS serverip is always
1915 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001916 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001917
1918 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1919 to do a dynamic update of a DNS server. To do this, they
1920 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001921 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001922 of the "hostname" environment variable is passed as
1923 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001924
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001925 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1926
1927 A 32bit value in microseconds for a delay between
1928 receiving a "DHCP Offer" and sending the "DHCP Request".
1929 This fixes a problem with certain DHCP servers that don't
1930 respond 100% of the time to a "DHCP request". E.g. On an
1931 AT91RM9200 processor running at 180MHz, this delay needed
1932 to be *at least* 15,000 usec before a Windows Server 2003
1933 DHCP server would reply 100% of the time. I recommend at
1934 least 50,000 usec to be safe. The alternative is to hope
1935 that one of the retries will be successful but note that
1936 the DHCP timeout and retry process takes a longer than
1937 this delay.
1938
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001939 - Link-local IP address negotiation:
1940 Negotiate with other link-local clients on the local network
1941 for an address that doesn't require explicit configuration.
1942 This is especially useful if a DHCP server cannot be guaranteed
1943 to exist in all environments that the device must operate.
1944
1945 See doc/README.link-local for more information.
1946
wdenk145d2c12004-04-15 21:48:45 +00001947 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001948 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001949
1950 The device id used in CDP trigger frames.
1951
1952 CONFIG_CDP_DEVICE_ID_PREFIX
1953
1954 A two character string which is prefixed to the MAC address
1955 of the device.
1956
1957 CONFIG_CDP_PORT_ID
1958
1959 A printf format string which contains the ascii name of
1960 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001961 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001962
1963 CONFIG_CDP_CAPABILITIES
1964
1965 A 32bit integer which indicates the device capabilities;
1966 0x00000010 for a normal host which does not forwards.
1967
1968 CONFIG_CDP_VERSION
1969
1970 An ascii string containing the version of the software.
1971
1972 CONFIG_CDP_PLATFORM
1973
1974 An ascii string containing the name of the platform.
1975
1976 CONFIG_CDP_TRIGGER
1977
1978 A 32bit integer sent on the trigger.
1979
1980 CONFIG_CDP_POWER_CONSUMPTION
1981
1982 A 16bit integer containing the power consumption of the
1983 device in .1 of milliwatts.
1984
1985 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1986
1987 A byte containing the id of the VLAN.
1988
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001989- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001990
1991 Several configurations allow to display the current
1992 status using a LED. For instance, the LED will blink
1993 fast while running U-Boot code, stop blinking as
1994 soon as a reply to a BOOTP request was received, and
1995 start blinking slow once the Linux kernel is running
1996 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001997 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001998 feature in U-Boot.
1999
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002000 Additional options:
2001
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002002 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002003 The status LED can be connected to a GPIO pin.
2004 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02002005 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002006 to include the gpio_led driver in the U-Boot binary.
2007
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002008 CONFIG_GPIO_LED_INVERTED_TABLE
2009 Some GPIO connected LEDs may have inverted polarity in which
2010 case the GPIO high value corresponds to LED off state and
2011 GPIO low value corresponds to LED on state.
2012 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2013 with a list of GPIO LEDs that have inverted polarity.
2014
wdenkc6097192002-11-03 00:24:07 +00002015- CAN Support: CONFIG_CAN_DRIVER
2016
2017 Defining CONFIG_CAN_DRIVER enables CAN driver support
2018 on those systems that support this (optional)
2019 feature, like the TQM8xxL modules.
2020
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002021- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002022
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002023 This enable the NEW i2c subsystem, and will allow you to use
2024 i2c commands at the u-boot command line (as long as you set
2025 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2026 based realtime clock chips or other i2c devices. See
2027 common/cmd_i2c.c for a description of the command line
2028 interface.
2029
2030 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002031 - drivers/i2c/soft_i2c.c:
2032 - activate first bus with CONFIG_SYS_I2C_SOFT define
2033 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2034 for defining speed and slave address
2035 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2036 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2037 for defining speed and slave address
2038 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2039 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2040 for defining speed and slave address
2041 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2042 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2043 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002044
Heiko Schocherf2850742012-10-24 13:48:22 +02002045 - drivers/i2c/fsl_i2c.c:
2046 - activate i2c driver with CONFIG_SYS_I2C_FSL
2047 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2048 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2049 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2050 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002051 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002052 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2053 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2054 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2055 second bus.
2056
Simon Glass026fefb2012-10-30 07:28:53 +00002057 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002058 - activate this driver with CONFIG_SYS_I2C_TEGRA
2059 - This driver adds 4 i2c buses with a fix speed from
2060 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002061
Dirk Eibach42b204f2013-04-25 02:40:01 +00002062 - drivers/i2c/ppc4xx_i2c.c
2063 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2064 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2065 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2066
trema49f40a2013-09-21 18:13:35 +02002067 - drivers/i2c/i2c_mxc.c
2068 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002069 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2070 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2071 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2072 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002073 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2074 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2075 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2076 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2077 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2078 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002079 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2080 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002081 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002082 for speed, and 0 for slave.
2083
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002084 - drivers/i2c/rcar_i2c.c:
2085 - activate this driver with CONFIG_SYS_I2C_RCAR
2086 - This driver adds 4 i2c buses
2087
2088 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2089 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2090 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2091 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2092 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2093 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2094 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2095 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2096 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2097
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002098 - drivers/i2c/sh_i2c.c:
2099 - activate this driver with CONFIG_SYS_I2C_SH
2100 - This driver adds from 2 to 5 i2c buses
2101
2102 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2103 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2104 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2105 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2106 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2107 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2108 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2109 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2110 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2111 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002112 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002113
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002114 - drivers/i2c/omap24xx_i2c.c
2115 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2116 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2117 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2118 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2119 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2120 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2121 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2122 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2123 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2124 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2125 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2126
Heiko Schocher465819a2013-11-08 07:30:53 +01002127 - drivers/i2c/zynq_i2c.c
2128 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2129 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2130 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2131
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302132 - drivers/i2c/s3c24x0_i2c.c:
2133 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2134 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2135 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2136 with a fix speed from 100000 and the slave addr 0!
2137
Dirk Eibachb9577432014-07-03 09:28:18 +02002138 - drivers/i2c/ihs_i2c.c
2139 - activate this driver with CONFIG_SYS_I2C_IHS
2140 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2141 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2142 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2143 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2144 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2145 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2146 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2147 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2148 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2149 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2150 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2151 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002152 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2153 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2154 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2155 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2156 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2157 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2158 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2159 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2160 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002161
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002162 additional defines:
2163
2164 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002165 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002166
2167 CONFIG_SYS_I2C_DIRECT_BUS
2168 define this, if you don't use i2c muxes on your hardware.
2169 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2170 omit this define.
2171
2172 CONFIG_SYS_I2C_MAX_HOPS
2173 define how many muxes are maximal consecutively connected
2174 on one i2c bus. If you not use i2c muxes, omit this
2175 define.
2176
2177 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002178 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002179 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2180 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2181 CONFIG_SYS_NUM_I2C_BUSES = 9:
2182
2183 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2184 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2185 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2186 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2187 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2188 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2189 {1, {I2C_NULL_HOP}}, \
2190 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2191 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2192 }
2193
2194 which defines
2195 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002196 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2197 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2198 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2199 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2200 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002201 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002202 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2203 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002204
2205 If you do not have i2c muxes on your board, omit this define.
2206
Simon Glass1a46a722017-05-12 21:09:56 -06002207----under removal:
2208
2209- Legacy I2C Support: CONFIG_SOFT_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002210
2211 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2212 provides the following compelling advantages:
2213
2214 - more than one i2c adapter is usable
2215 - approved multibus support
2216 - better i2c mux support
2217
Simon Glass1a46a722017-05-12 21:09:56 -06002218 ** CONFIG_SOFT_I2C is now being removed **
wdenkc6097192002-11-03 00:24:07 +00002219
Simon Glass1a46a722017-05-12 21:09:56 -06002220 With CONFIG_SOFT_I2C you will need to define
2221 CONFIG_SYS_I2C_SPEED to be the frequency (in Hz) at which you
2222 wish your i2c bus to run and CONFIG_SYS_I2C_SLAVE to be the
2223 address of this node (ie the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002224
Peter Tysere4d1abc2010-04-12 22:28:21 -05002225 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002226 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002227 and so its address should therefore be cleared to 0 (See,
2228 eg, MPC823e User's Manual p.16-473). So, set
2229 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002230
Eric Millbrandt12990a42009-09-03 08:09:44 -05002231 When a board is reset during an i2c bus transfer
2232 chips might think that the current transfer is still
2233 in progress. Reset the slave devices by sending start
2234 commands until the slave device responds.
2235
wdenk21136db2003-07-16 21:53:01 +00002236 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002237
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002238 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002239 then the following macros need to be defined (examples are
2240 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002241
2242 I2C_INIT
2243
wdenkb9bbd242003-06-30 16:24:52 +00002244 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002245 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002246
wdenk544e9732004-02-06 23:19:44 +00002247 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002248
wdenkc6097192002-11-03 00:24:07 +00002249 I2C_PORT
2250
wdenk4a5c8a72003-03-06 00:02:04 +00002251 (Only for MPC8260 CPU). The I/O port to use (the code
2252 assumes both bits are on the same port). Valid values
2253 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002254
2255 I2C_ACTIVE
2256
2257 The code necessary to make the I2C data line active
2258 (driven). If the data line is open collector, this
2259 define can be null.
2260
wdenkb9bbd242003-06-30 16:24:52 +00002261 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2262
wdenkc6097192002-11-03 00:24:07 +00002263 I2C_TRISTATE
2264
2265 The code necessary to make the I2C data line tri-stated
2266 (inactive). If the data line is open collector, this
2267 define can be null.
2268
wdenkb9bbd242003-06-30 16:24:52 +00002269 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2270
wdenkc6097192002-11-03 00:24:07 +00002271 I2C_READ
2272
York Sun4a598092013-04-01 11:29:11 -07002273 Code that returns true if the I2C data line is high,
2274 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002275
wdenkb9bbd242003-06-30 16:24:52 +00002276 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2277
wdenkc6097192002-11-03 00:24:07 +00002278 I2C_SDA(bit)
2279
York Sun4a598092013-04-01 11:29:11 -07002280 If <bit> is true, sets the I2C data line high. If it
2281 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002282
wdenkb9bbd242003-06-30 16:24:52 +00002283 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002284 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002285 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002286
wdenkc6097192002-11-03 00:24:07 +00002287 I2C_SCL(bit)
2288
York Sun4a598092013-04-01 11:29:11 -07002289 If <bit> is true, sets the I2C clock line high. If it
2290 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002291
wdenkb9bbd242003-06-30 16:24:52 +00002292 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002293 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002294 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002295
wdenkc6097192002-11-03 00:24:07 +00002296 I2C_DELAY
2297
2298 This delay is invoked four times per clock cycle so this
2299 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002300 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002301 like:
2302
wdenkb9bbd242003-06-30 16:24:52 +00002303 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002304
Mike Frysingeree12d542010-07-21 13:38:02 -04002305 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2306
2307 If your arch supports the generic GPIO framework (asm/gpio.h),
2308 then you may alternatively define the two GPIOs that are to be
2309 used as SCL / SDA. Any of the previous I2C_xxx macros will
2310 have GPIO-based defaults assigned to them as appropriate.
2311
2312 You should define these to the GPIO value as given directly to
2313 the generic GPIO functions.
2314
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002315 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002316
wdenk57b2d802003-06-27 21:31:46 +00002317 When a board is reset during an i2c bus transfer
2318 chips might think that the current transfer is still
2319 in progress. On some boards it is possible to access
2320 the i2c SCLK line directly, either by using the
2321 processor pin as a GPIO or by having a second pin
2322 connected to the bus. If this option is defined a
2323 custom i2c_init_board() routine in boards/xxx/board.c
2324 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002325
Ben Warren45657152006-09-07 16:50:54 -04002326 CONFIG_I2C_MULTI_BUS
2327
2328 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002329 must have a controller. At any point in time, only one bus is
2330 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002331 Note that bus numbering is zero-based.
2332
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002333 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002334
2335 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002336 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002337 is set, specify a list of bus-device pairs. Otherwise, specify
2338 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002339
2340 e.g.
2341 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002342 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002343
2344 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2345
Wolfgang Denk092ae952011-10-26 10:21:21 +00002346 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002347 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002348
2349 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2350
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002351 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002352
2353 If defined, then this indicates the I2C bus number for DDR SPD.
2354 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002356 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002357
2358 If defined, then this indicates the I2C bus number for the RTC.
2359 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2360
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002361 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002362
2363 If defined, then this indicates the I2C bus number for the DTT.
2364 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2365
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002366 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002367
2368 If defined, specifies the I2C address of the DTT device.
2369 If not defined, then U-Boot uses predefined value for
2370 specified DTT device.
2371
Andrew Dyer58c41f92008-12-29 17:36:01 -06002372 CONFIG_SOFT_I2C_READ_REPEATED_START
2373
2374 defining this will force the i2c_read() function in
2375 the soft_i2c driver to perform an I2C repeated start
2376 between writing the address pointer and reading the
2377 data. If this define is omitted the default behaviour
2378 of doing a stop-start sequence will be used. Most I2C
2379 devices can use either method, but some require one or
2380 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002381
wdenkc6097192002-11-03 00:24:07 +00002382- SPI Support: CONFIG_SPI
2383
2384 Enables SPI driver (so far only tested with
2385 SPI EEPROM, also an instance works with Crystal A/D and
2386 D/As on the SACSng board)
2387
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002388 CONFIG_SH_SPI
2389
2390 Enables the driver for SPI controller on SuperH. Currently
2391 only SH7757 is supported.
2392
wdenkc6097192002-11-03 00:24:07 +00002393 CONFIG_SOFT_SPI
2394
wdenk4a5c8a72003-03-06 00:02:04 +00002395 Enables a software (bit-bang) SPI driver rather than
2396 using hardware support. This is a general purpose
2397 driver that only requires three general I/O port pins
2398 (two outputs, one input) to function. If this is
2399 defined, the board configuration must define several
2400 SPI configuration items (port pins to use, etc). For
2401 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002402
Ben Warren7efe9272008-01-16 22:37:35 -05002403 CONFIG_HARD_SPI
2404
2405 Enables a hardware SPI driver for general-purpose reads
2406 and writes. As with CONFIG_SOFT_SPI, the board configuration
2407 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002408 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002409 example, see include/configs/mpc8349emds.h.
2410
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002411 CONFIG_MXC_SPI
2412
2413 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002414 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002415
Heiko Schocherb77c8882014-07-14 10:22:11 +02002416 CONFIG_SYS_SPI_MXC_WAIT
2417 Timeout for waiting until spi transfer completed.
2418 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2419
Matthias Fuchsa4400872007-12-27 17:12:34 +01002420- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002421
Matthias Fuchsa4400872007-12-27 17:12:34 +01002422 Enables FPGA subsystem.
2423
2424 CONFIG_FPGA_<vendor>
2425
2426 Enables support for specific chip vendors.
2427 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002428
Matthias Fuchsa4400872007-12-27 17:12:34 +01002429 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002430
Matthias Fuchsa4400872007-12-27 17:12:34 +01002431 Enables support for FPGA family.
2432 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2433
2434 CONFIG_FPGA_COUNT
2435
2436 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002437
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302438 CONFIG_CMD_FPGA_LOADMK
2439
2440 Enable support for fpga loadmk command
2441
Michal Simek64c70982014-05-02 13:43:39 +02002442 CONFIG_CMD_FPGA_LOADP
2443
2444 Enable support for fpga loadp command - load partial bitstream
2445
2446 CONFIG_CMD_FPGA_LOADBP
2447
2448 Enable support for fpga loadbp command - load partial bitstream
2449 (Xilinx only)
2450
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002451 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002452
wdenk57b2d802003-06-27 21:31:46 +00002453 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002454
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002455 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002456
wdenk4a5c8a72003-03-06 00:02:04 +00002457 Enable checks on FPGA configuration interface busy
2458 status by the configuration function. This option
2459 will require a board or device specific function to
2460 be written.
wdenkc6097192002-11-03 00:24:07 +00002461
2462 CONFIG_FPGA_DELAY
2463
2464 If defined, a function that provides delays in the FPGA
2465 configuration driver.
2466
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002467 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002468 Allow Control-C to interrupt FPGA configuration
2469
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002470 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002471
wdenk4a5c8a72003-03-06 00:02:04 +00002472 Check for configuration errors during FPGA bitfile
2473 loading. For example, abort during Virtex II
2474 configuration if the INIT_B line goes low (which
2475 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002476
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002477 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002478
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002479 Maximum time to wait for the INIT_B line to de-assert
2480 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002481 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002482 ms.
wdenkc6097192002-11-03 00:24:07 +00002483
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002484 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002485
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002486 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002487 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002488
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002489 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002490
wdenk4a5c8a72003-03-06 00:02:04 +00002491 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002492 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002493
2494- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002495 CONFIG_BUILD_TARGET
2496
2497 Some SoCs need special image types (e.g. U-Boot binary
2498 with a special header) as build targets. By defining
2499 CONFIG_BUILD_TARGET in the SoC / board header, this
2500 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002501 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002502
wdenkc6097192002-11-03 00:24:07 +00002503 CONFIG_IDENT_STRING
2504
wdenk4a5c8a72003-03-06 00:02:04 +00002505 If defined, this string will be added to the U-Boot
2506 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002507
2508- Vendor Parameter Protection:
2509
wdenk4a5c8a72003-03-06 00:02:04 +00002510 U-Boot considers the values of the environment
2511 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002512 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002513 are set once by the board vendor / manufacturer, and
2514 protects these variables from casual modification by
2515 the user. Once set, these variables are read-only,
2516 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002517 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002518
2519 If CONFIG_ENV_OVERWRITE is #defined in your config
2520 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002521 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002522 these parameters.
2523
Joe Hershberger76f353e2015-05-04 14:55:14 -05002524 Alternatively, if you define _both_ an ethaddr in the
2525 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002526 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002527 which can be changed exactly ONCE by the user. [The
2528 serial# is unaffected by this, i. e. it remains
2529 read-only.]
2530
Joe Hershberger71497d02012-12-11 22:16:31 -06002531 The same can be accomplished in a more flexible way
2532 for any variable by configuring the type of access
2533 to allow for those variables in the ".flags" variable
2534 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2535
wdenkc6097192002-11-03 00:24:07 +00002536- Protected RAM:
2537 CONFIG_PRAM
2538
2539 Define this variable to enable the reservation of
2540 "protected RAM", i. e. RAM which is not overwritten
2541 by U-Boot. Define CONFIG_PRAM to hold the number of
2542 kB you want to reserve for pRAM. You can overwrite
2543 this default value by defining an environment
2544 variable "pram" to the number of kB you want to
2545 reserve. Note that the board info structure will
2546 still show the full amount of RAM. If pRAM is
2547 reserved, a new environment variable "mem" will
2548 automatically be defined to hold the amount of
2549 remaining RAM in a form that can be passed as boot
2550 argument to Linux, for instance like that:
2551
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002552 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002553 saveenv
2554
2555 This way you can tell Linux not to use this memory,
2556 either, which results in a memory region that will
2557 not be affected by reboots.
2558
2559 *WARNING* If your board configuration uses automatic
2560 detection of the RAM size, you must make sure that
2561 this memory test is non-destructive. So far, the
2562 following board configurations are known to be
2563 "pRAM-clean":
2564
Wolfgang Denk90326762012-10-24 02:36:15 +00002565 IVMS8, IVML24, SPD8xx, TQM8xxL,
2566 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002567 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002568
Gabe Blacka2f3a932012-12-02 04:55:18 +00002569- Access to physical memory region (> 4GB)
2570 Some basic support is provided for operations on memory not
2571 normally accessible to U-Boot - e.g. some architectures
2572 support access to more than 4GB of memory on 32-bit
2573 machines using physical address extension or similar.
2574 Define CONFIG_PHYSMEM to access this basic support, which
2575 currently only supports clearing the memory.
2576
wdenkc6097192002-11-03 00:24:07 +00002577- Error Recovery:
2578 CONFIG_PANIC_HANG
2579
2580 Define this variable to stop the system in case of a
2581 fatal error, so that you have to reset it manually.
2582 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002583 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002584 automatically as fast as possible, but it may be
2585 useful during development since you can try to debug
2586 the conditions that lead to the situation.
2587
2588 CONFIG_NET_RETRY_COUNT
2589
wdenk4a5c8a72003-03-06 00:02:04 +00002590 This variable defines the number of retries for
2591 network operations like ARP, RARP, TFTP, or BOOTP
2592 before giving up the operation. If not defined, a
2593 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002594
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002595 CONFIG_ARP_TIMEOUT
2596
2597 Timeout waiting for an ARP reply in milliseconds.
2598
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002599 CONFIG_NFS_TIMEOUT
2600
2601 Timeout in milliseconds used in NFS protocol.
2602 If you encounter "ERROR: Cannot umount" in nfs command,
2603 try longer timeout such as
2604 #define CONFIG_NFS_TIMEOUT 10000UL
2605
wdenkc6097192002-11-03 00:24:07 +00002606- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002607 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002608
2609 Enable auto completion of commands using TAB.
2610
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002611 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002612
2613 This defines the secondary prompt string, which is
2614 printed when the command interpreter needs more input
2615 to complete a command. Usually "> ".
2616
2617 Note:
2618
wdenk57b2d802003-06-27 21:31:46 +00002619 In the current implementation, the local variables
2620 space and global environment variables space are
2621 separated. Local variables are those you define by
2622 simply typing `name=value'. To access a local
2623 variable later on, you have write `$name' or
2624 `${name}'; to execute the contents of a variable
2625 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002626
wdenk4a5c8a72003-03-06 00:02:04 +00002627 Global environment variables are those you use
2628 setenv/printenv to work with. To run a command stored
2629 in such a variable, you need to use the run command,
2630 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002631
2632 To store commands and special characters in a
2633 variable, please use double quotation marks
2634 surrounding the whole text of the variable, instead
2635 of the backslashes before semicolons and special
2636 symbols.
2637
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002638- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002639 CONFIG_CMDLINE_EDITING
2640
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002641 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002642 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002643
Marek Vasut734fb042016-01-27 04:47:55 +01002644- Command Line PS1/PS2 support:
2645 CONFIG_CMDLINE_PS_SUPPORT
2646
2647 Enable support for changing the command prompt string
2648 at run-time. Only static string is supported so far.
2649 The string is obtained from environment variables PS1
2650 and PS2.
2651
wdenkc0aa5c52003-12-06 19:49:23 +00002652- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002653 CONFIG_EXTRA_ENV_SETTINGS
2654
wdenk4a5c8a72003-03-06 00:02:04 +00002655 Define this to contain any number of null terminated
2656 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002657 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002658
wdenk4a5c8a72003-03-06 00:02:04 +00002659 For example, place something like this in your
2660 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002661
2662 #define CONFIG_EXTRA_ENV_SETTINGS \
2663 "myvar1=value1\0" \
2664 "myvar2=value2\0"
2665
wdenk4a5c8a72003-03-06 00:02:04 +00002666 Warning: This method is based on knowledge about the
2667 internal format how the environment is stored by the
2668 U-Boot code. This is NOT an official, exported
2669 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002670 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002671 You better know what you are doing here.
2672
wdenk4a5c8a72003-03-06 00:02:04 +00002673 Note: overly (ab)use of the default environment is
2674 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002675 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002676 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002677
Stephen Warren1465d5f2012-05-22 09:21:54 +00002678 CONFIG_ENV_VARS_UBOOT_CONFIG
2679
2680 Define this in order to add variables describing the
2681 U-Boot build configuration to the default environment.
2682 These will be named arch, cpu, board, vendor, and soc.
2683
2684 Enabling this option will cause the following to be defined:
2685
2686 - CONFIG_SYS_ARCH
2687 - CONFIG_SYS_CPU
2688 - CONFIG_SYS_BOARD
2689 - CONFIG_SYS_VENDOR
2690 - CONFIG_SYS_SOC
2691
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002692 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2693
2694 Define this in order to add variables describing certain
2695 run-time determined information about the hardware to the
2696 environment. These will be named board_name, board_rev.
2697
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002698 CONFIG_DELAY_ENVIRONMENT
2699
2700 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002701 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002702 that so that the environment is not available until
2703 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2704 this is instead controlled by the value of
2705 /config/load-environment.
2706
wdenkc0aa5c52003-12-06 19:49:23 +00002707- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002708 CONFIG_HAS_DATAFLASH
2709
wdenk57b2d802003-06-27 21:31:46 +00002710 Defining this option enables DataFlash features and
2711 allows to read/write in Dataflash via the standard
2712 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002713
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002714- Serial Flash support
2715 CONFIG_CMD_SF
2716
2717 Defining this option enables SPI flash commands
2718 'sf probe/read/write/erase/update'.
2719
2720 Usage requires an initial 'probe' to define the serial
2721 flash parameters, followed by read/write/erase/update
2722 commands.
2723
2724 The following defaults may be provided by the platform
2725 to handle the common case when only a single serial
2726 flash is present on the system.
2727
2728 CONFIG_SF_DEFAULT_BUS Bus identifier
2729 CONFIG_SF_DEFAULT_CS Chip-select
2730 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2731 CONFIG_SF_DEFAULT_SPEED in Hz
2732
Simon Glass4b5545e2012-10-08 13:16:02 +00002733 CONFIG_CMD_SF_TEST
2734
2735 Define this option to include a destructive SPI flash
2736 test ('sf test').
2737
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302738 CONFIG_SF_DUAL_FLASH Dual flash memories
2739
2740 Define this option to use dual flash support where two flash
2741 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002742 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302743
wdenkef893942004-02-23 16:11:30 +00002744- SystemACE Support:
2745 CONFIG_SYSTEMACE
2746
2747 Adding this option adds support for Xilinx SystemACE
2748 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002749 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002750 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002751
2752 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002753 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002754
2755 When SystemACE support is added, the "ace" device type
2756 becomes available to the fat commands, i.e. fatls.
2757
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002758- TFTP Fixed UDP Port:
2759 CONFIG_TFTP_PORT
2760
Wolfgang Denk227b5192005-09-24 23:25:46 +02002761 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002762 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002763 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002764 number generator is used.
2765
Wolfgang Denk227b5192005-09-24 23:25:46 +02002766 Also, the environment variable tftpdstp is used to supply
2767 the TFTP UDP destination port value. If tftpdstp isn't
2768 defined, the normal port 69 is used.
2769
2770 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002771 blindly start the TFTP transfer using the pre-configured
2772 target IP address and UDP port. This has the effect of
2773 "punching through" the (Windows XP) firewall, allowing
2774 the remainder of the TFTP transfer to proceed normally.
2775 A better solution is to properly configure the firewall,
2776 but sometimes that is not allowed.
2777
Simon Glass058bb8d2012-12-05 14:46:38 +00002778- Hashing support:
2779 CONFIG_CMD_HASH
2780
2781 This enables a generic 'hash' command which can produce
2782 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
2783
2784 CONFIG_HASH_VERIFY
2785
2786 Enable the hash verify command (hash -v). This adds to code
2787 size a little.
2788
gaurav ranaef201592015-02-20 12:51:46 +05302789 CONFIG_SHA1 - This option enables support of hashing using SHA1
2790 algorithm. The hash is calculated in software.
2791 CONFIG_SHA256 - This option enables support of hashing using
2792 SHA256 algorithm. The hash is calculated in software.
2793 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
2794 for SHA1/SHA256 hashing.
2795 This affects the 'hash' command and also the
2796 hash_lookup_algo() function.
2797 CONFIG_SHA_PROG_HW_ACCEL - This option enables
2798 hardware-acceleration for SHA1/SHA256 progressive hashing.
2799 Data can be streamed in a block at a time and the hashing
2800 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00002801
2802 Note: There is also a sha1sum command, which should perhaps
2803 be deprecated in favour of 'hash sha1'.
2804
Robert Winkler765ccf42013-07-24 17:57:06 -07002805- Freescale i.MX specific commands:
2806 CONFIG_CMD_HDMIDETECT
2807 This enables 'hdmidet' command which returns true if an
2808 HDMI monitor is detected. This command is i.MX 6 specific.
2809
Heiko Schocher443ca402014-01-25 07:27:13 +01002810- bootcount support:
2811 CONFIG_BOOTCOUNT_LIMIT
2812
2813 This enables the bootcounter support, see:
2814 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2815
2816 CONFIG_AT91SAM9XE
2817 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002818 CONFIG_SOC_DA8XX
2819 enable special bootcounter support on da850 based boards.
2820 CONFIG_BOOTCOUNT_RAM
2821 enable support for the bootcounter in RAM
2822 CONFIG_BOOTCOUNT_I2C
2823 enable support for the bootcounter on an i2c (like RTC) device.
2824 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2825 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2826 the bootcounter.
2827 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002828
wdenkc0aa5c52003-12-06 19:49:23 +00002829- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002830 CONFIG_SHOW_BOOT_PROGRESS
2831
wdenk4a5c8a72003-03-06 00:02:04 +00002832 Defining this option allows to add some board-
2833 specific code (calling a user-provided function
2834 "show_boot_progress(int)") that enables you to show
2835 the system's boot progress on some display (for
2836 example, some LED's) on your board. At the moment,
2837 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002838
Simon Glass0fa36a42012-09-28 08:56:37 +00002839
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002840Legacy uImage format:
2841
wdenkc6097192002-11-03 00:24:07 +00002842 Arg Where When
2843 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002844 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002845 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002846 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002847 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002848 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002849 4 common/cmd_bootm.c Image data has correct checksum
2850 -4 common/cmd_bootm.c Image is for unsupported architecture
2851 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002852 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002853 6 common/cmd_bootm.c Image Type check OK
2854 -6 common/cmd_bootm.c gunzip uncompression error
2855 -7 common/cmd_bootm.c Unimplemented compression type
2856 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002857 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002858 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002859
2860 9 common/image.c Start initial ramdisk verification
2861 -10 common/image.c Ramdisk header has bad magic number
2862 -11 common/image.c Ramdisk header has bad checksum
2863 10 common/image.c Ramdisk header is OK
2864 -12 common/image.c Ramdisk data has bad checksum
2865 11 common/image.c Ramdisk data has correct checksum
2866 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002867 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002868 13 common/image.c Start multifile image verification
2869 14 common/image.c No initial ramdisk, no multifile, continue.
2870
Wolfgang Denk092ae952011-10-26 10:21:21 +00002871 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002872
Stefan Roese88fbf932010-04-15 16:07:28 +02002873 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002874 -31 post/post.c POST test failed, detected by post_output_backlog()
2875 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002876
Heiko Schocher633e03a2007-06-22 19:11:54 +02002877 34 common/cmd_doc.c before loading a Image from a DOC device
2878 -35 common/cmd_doc.c Bad usage of "doc" command
2879 35 common/cmd_doc.c correct usage of "doc" command
2880 -36 common/cmd_doc.c No boot device
2881 36 common/cmd_doc.c correct boot device
2882 -37 common/cmd_doc.c Unknown Chip ID on boot device
2883 37 common/cmd_doc.c correct chip ID found, device available
2884 -38 common/cmd_doc.c Read Error on boot device
2885 38 common/cmd_doc.c reading Image header from DOC device OK
2886 -39 common/cmd_doc.c Image header has bad magic number
2887 39 common/cmd_doc.c Image header has correct magic number
2888 -40 common/cmd_doc.c Error reading Image from DOC device
2889 40 common/cmd_doc.c Image header has correct magic number
2890 41 common/cmd_ide.c before loading a Image from a IDE device
2891 -42 common/cmd_ide.c Bad usage of "ide" command
2892 42 common/cmd_ide.c correct usage of "ide" command
2893 -43 common/cmd_ide.c No boot device
2894 43 common/cmd_ide.c boot device found
2895 -44 common/cmd_ide.c Device not available
2896 44 common/cmd_ide.c Device available
2897 -45 common/cmd_ide.c wrong partition selected
2898 45 common/cmd_ide.c partition selected
2899 -46 common/cmd_ide.c Unknown partition table
2900 46 common/cmd_ide.c valid partition table found
2901 -47 common/cmd_ide.c Invalid partition type
2902 47 common/cmd_ide.c correct partition type
2903 -48 common/cmd_ide.c Error reading Image Header on boot device
2904 48 common/cmd_ide.c reading Image Header from IDE device OK
2905 -49 common/cmd_ide.c Image header has bad magic number
2906 49 common/cmd_ide.c Image header has correct magic number
2907 -50 common/cmd_ide.c Image header has bad checksum
2908 50 common/cmd_ide.c Image header has correct checksum
2909 -51 common/cmd_ide.c Error reading Image from IDE device
2910 51 common/cmd_ide.c reading Image from IDE device OK
2911 52 common/cmd_nand.c before loading a Image from a NAND device
2912 -53 common/cmd_nand.c Bad usage of "nand" command
2913 53 common/cmd_nand.c correct usage of "nand" command
2914 -54 common/cmd_nand.c No boot device
2915 54 common/cmd_nand.c boot device found
2916 -55 common/cmd_nand.c Unknown Chip ID on boot device
2917 55 common/cmd_nand.c correct chip ID found, device available
2918 -56 common/cmd_nand.c Error reading Image Header on boot device
2919 56 common/cmd_nand.c reading Image Header from NAND device OK
2920 -57 common/cmd_nand.c Image header has bad magic number
2921 57 common/cmd_nand.c Image header has correct magic number
2922 -58 common/cmd_nand.c Error reading Image from NAND device
2923 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002924
Heiko Schocher633e03a2007-06-22 19:11:54 +02002925 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002926
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002927 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002928 -64 net/eth.c no Ethernet found.
2929 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002930
Heiko Schocher633e03a2007-06-22 19:11:54 +02002931 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002932 80 common/cmd_net.c before calling net_loop()
2933 -81 common/cmd_net.c some error in net_loop() occurred
2934 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002935 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2936 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002937 83 common/cmd_net.c running "source" command
2938 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002939 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002940
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002941FIT uImage format:
2942
2943 Arg Where When
2944 100 common/cmd_bootm.c Kernel FIT Image has correct format
2945 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2946 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2947 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2948 102 common/cmd_bootm.c Kernel unit name specified
2949 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002950 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002951 104 common/cmd_bootm.c Got kernel subimage node offset
2952 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2953 105 common/cmd_bootm.c Kernel subimage hash verification OK
2954 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2955 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002956 -106 common/cmd_bootm.c Kernel subimage has wrong type
2957 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002958 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2959 108 common/cmd_bootm.c Got kernel subimage data/size
2960 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2961 -109 common/cmd_bootm.c Can't get kernel subimage type
2962 -110 common/cmd_bootm.c Can't get kernel subimage comp
2963 -111 common/cmd_bootm.c Can't get kernel subimage os
2964 -112 common/cmd_bootm.c Can't get kernel subimage load address
2965 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2966
2967 120 common/image.c Start initial ramdisk verification
2968 -120 common/image.c Ramdisk FIT image has incorrect format
2969 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002970 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002971 -122 common/image.c Can't get configuration for ramdisk subimage
2972 123 common/image.c Ramdisk unit name specified
2973 -124 common/image.c Can't get ramdisk subimage node offset
2974 125 common/image.c Got ramdisk subimage node offset
2975 -125 common/image.c Ramdisk subimage hash verification failed
2976 126 common/image.c Ramdisk subimage hash verification OK
2977 -126 common/image.c Ramdisk subimage for unsupported architecture
2978 127 common/image.c Architecture check OK
2979 -127 common/image.c Can't get ramdisk subimage data/size
2980 128 common/image.c Got ramdisk subimage data/size
2981 129 common/image.c Can't get ramdisk load address
2982 -129 common/image.c Got ramdisk load address
2983
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002984 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002985 131 common/cmd_doc.c FIT image format OK
2986
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002987 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002988 141 common/cmd_ide.c FIT image format OK
2989
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002990 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002991 151 common/cmd_nand.c FIT image format OK
2992
Heiko Schocher515eb122014-05-28 11:33:33 +02002993- legacy image format:
2994 CONFIG_IMAGE_FORMAT_LEGACY
2995 enables the legacy image format support in U-Boot.
2996
2997 Default:
2998 enabled if CONFIG_FIT_SIGNATURE is not defined.
2999
3000 CONFIG_DISABLE_IMAGE_LEGACY
3001 disable the legacy image format
3002
3003 This define is introduced, as the legacy image format is
3004 enabled per default for backward compatibility.
3005
Gabe Blackd572e162012-10-25 16:31:10 +00003006- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003007 CONFIG_FIT_DISABLE_SHA256
3008 Supporting SHA256 hashes has quite an impact on binary size.
3009 For constrained systems sha256 hash support can be disabled
3010 with this option.
3011
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003012 TODO(sjg@chromium.org): Adjust this option to be positive,
3013 and move it to Kconfig
3014
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003015- Standalone program support:
3016 CONFIG_STANDALONE_LOAD_ADDR
3017
Wolfgang Denk23f78482011-10-09 21:06:34 +02003018 This option defines a board specific value for the
3019 address where standalone program gets loaded, thus
3020 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003021 settings.
3022
3023- Frame Buffer Address:
3024 CONFIG_FB_ADDR
3025
3026 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003027 address for frame buffer. This is typically the case
3028 when using a graphics controller has separate video
3029 memory. U-Boot will then place the frame buffer at
3030 the given address instead of dynamically reserving it
3031 in system RAM by calling lcd_setmem(), which grabs
3032 the memory for the frame buffer depending on the
3033 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003034
3035 Please see board_init_f function.
3036
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003037- Automatic software updates via TFTP server
3038 CONFIG_UPDATE_TFTP
3039 CONFIG_UPDATE_TFTP_CNT_MAX
3040 CONFIG_UPDATE_TFTP_MSEC_MAX
3041
3042 These options enable and control the auto-update feature;
3043 for a more detailed description refer to doc/README.update.
3044
3045- MTD Support (mtdparts command, UBI support)
3046 CONFIG_MTD_DEVICE
3047
3048 Adds the MTD device infrastructure from the Linux kernel.
3049 Needed for mtdparts command support.
3050
3051 CONFIG_MTD_PARTITIONS
3052
3053 Adds the MTD partitioning infrastructure from the Linux
3054 kernel. Needed for UBI support.
3055
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003056- UBI support
3057 CONFIG_CMD_UBI
3058
3059 Adds commands for interacting with MTD partitions formatted
3060 with the UBI flash translation layer
3061
3062 Requires also defining CONFIG_RBTREE
3063
Joe Hershberger47550fc2013-04-08 10:32:49 +00003064 CONFIG_UBI_SILENCE_MSG
3065
3066 Make the verbose messages from UBI stop printing. This leaves
3067 warnings and errors enabled.
3068
Heiko Schocherf5895d12014-06-24 10:10:04 +02003069
3070 CONFIG_MTD_UBI_WL_THRESHOLD
3071 This parameter defines the maximum difference between the highest
3072 erase counter value and the lowest erase counter value of eraseblocks
3073 of UBI devices. When this threshold is exceeded, UBI starts performing
3074 wear leveling by means of moving data from eraseblock with low erase
3075 counter to eraseblocks with high erase counter.
3076
3077 The default value should be OK for SLC NAND flashes, NOR flashes and
3078 other flashes which have eraseblock life-cycle 100000 or more.
3079 However, in case of MLC NAND flashes which typically have eraseblock
3080 life-cycle less than 10000, the threshold should be lessened (e.g.,
3081 to 128 or 256, although it does not have to be power of 2).
3082
3083 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003084
Heiko Schocherf5895d12014-06-24 10:10:04 +02003085 CONFIG_MTD_UBI_BEB_LIMIT
3086 This option specifies the maximum bad physical eraseblocks UBI
3087 expects on the MTD device (per 1024 eraseblocks). If the
3088 underlying flash does not admit of bad eraseblocks (e.g. NOR
3089 flash), this value is ignored.
3090
3091 NAND datasheets often specify the minimum and maximum NVM
3092 (Number of Valid Blocks) for the flashes' endurance lifetime.
3093 The maximum expected bad eraseblocks per 1024 eraseblocks
3094 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3095 which gives 20 for most NANDs (MaxNVB is basically the total
3096 count of eraseblocks on the chip).
3097
3098 To put it differently, if this value is 20, UBI will try to
3099 reserve about 1.9% of physical eraseblocks for bad blocks
3100 handling. And that will be 1.9% of eraseblocks on the entire
3101 NAND chip, not just the MTD partition UBI attaches. This means
3102 that if you have, say, a NAND flash chip admits maximum 40 bad
3103 eraseblocks, and it is split on two MTD partitions of the same
3104 size, UBI will reserve 40 eraseblocks when attaching a
3105 partition.
3106
3107 default: 20
3108
3109 CONFIG_MTD_UBI_FASTMAP
3110 Fastmap is a mechanism which allows attaching an UBI device
3111 in nearly constant time. Instead of scanning the whole MTD device it
3112 only has to locate a checkpoint (called fastmap) on the device.
3113 The on-flash fastmap contains all information needed to attach
3114 the device. Using fastmap makes only sense on large devices where
3115 attaching by scanning takes long. UBI will not automatically install
3116 a fastmap on old images, but you can set the UBI parameter
3117 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3118 that fastmap-enabled images are still usable with UBI implementations
3119 without fastmap support. On typical flash devices the whole fastmap
3120 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3121
3122 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3123 Set this parameter to enable fastmap automatically on images
3124 without a fastmap.
3125 default: 0
3126
Heiko Schocher94b66de2015-10-22 06:19:21 +02003127 CONFIG_MTD_UBI_FM_DEBUG
3128 Enable UBI fastmap debug
3129 default: 0
3130
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003131- UBIFS support
3132 CONFIG_CMD_UBIFS
3133
3134 Adds commands for interacting with UBI volumes formatted as
3135 UBIFS. UBIFS is read-only in u-boot.
3136
3137 Requires UBI support as well as CONFIG_LZO
3138
Joe Hershberger47550fc2013-04-08 10:32:49 +00003139 CONFIG_UBIFS_SILENCE_MSG
3140
3141 Make the verbose messages from UBIFS stop printing. This leaves
3142 warnings and errors enabled.
3143
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003144- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003145 CONFIG_SPL
3146 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003147
Tom Rini36853852012-02-14 07:29:40 +00003148 CONFIG_SPL_LDSCRIPT
3149 LDSCRIPT for linking the SPL binary.
3150
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003151 CONFIG_SPL_MAX_FOOTPRINT
3152 Maximum size in memory allocated to the SPL, BSS included.
3153 When defined, the linker checks that the actual memory
3154 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003155 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003156 must not be both defined at the same time.
3157
Tom Rini36853852012-02-14 07:29:40 +00003158 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003159 Maximum size of the SPL image (text, data, rodata, and
3160 linker lists sections), BSS excluded.
3161 When defined, the linker checks that the actual size does
3162 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003163
Wolfgang Denk825223d2011-09-11 21:24:09 +02003164 CONFIG_SPL_TEXT_BASE
3165 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003166
Scott Woodc4f0d002012-09-20 19:05:12 -05003167 CONFIG_SPL_RELOC_TEXT_BASE
3168 Address to relocate to. If unspecified, this is equal to
3169 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3170
Tom Rini36853852012-02-14 07:29:40 +00003171 CONFIG_SPL_BSS_START_ADDR
3172 Link address for the BSS within the SPL binary.
3173
3174 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003175 Maximum size in memory allocated to the SPL BSS.
3176 When defined, the linker checks that the actual memory used
3177 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003178 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003179 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003180
3181 CONFIG_SPL_STACK
3182 Adress of the start of the stack SPL will use
3183
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003184 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3185 When defined, SPL will panic() if the image it has
3186 loaded does not have a signature.
3187 Defining this is useful when code which loads images
3188 in SPL cannot guarantee that absolutely all read errors
3189 will be caught.
3190 An example is the LPC32XX MLC NAND driver, which will
3191 consider that a completely unreadable NAND block is bad,
3192 and thus should be skipped silently.
3193
Scott Woodc4f0d002012-09-20 19:05:12 -05003194 CONFIG_SPL_RELOC_STACK
3195 Adress of the start of the stack SPL will use after
3196 relocation. If unspecified, this is equal to
3197 CONFIG_SPL_STACK.
3198
Tom Rini36853852012-02-14 07:29:40 +00003199 CONFIG_SYS_SPL_MALLOC_START
3200 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003201 When this option is set the full malloc is used in SPL and
3202 it is set up by spl_init() and before that, the simple malloc()
3203 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003204
3205 CONFIG_SYS_SPL_MALLOC_SIZE
3206 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003207
Tom Rini28591df2012-08-13 12:03:19 -07003208 CONFIG_SPL_FRAMEWORK
3209 Enable the SPL framework under common/. This framework
3210 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3211 NAND loading of the Linux Kernel.
3212
Tom Rinic2b76002014-03-28 12:03:39 -04003213 CONFIG_SPL_OS_BOOT
3214 Enable booting directly to an OS from SPL.
3215 See also: doc/README.falcon
3216
Tom Rinife3b0c72012-08-13 11:37:56 -07003217 CONFIG_SPL_DISPLAY_PRINT
3218 For ARM, enable an optional function to print more information
3219 about the running system.
3220
Scott Wood7c810902012-09-20 16:35:21 -05003221 CONFIG_SPL_INIT_MINIMAL
3222 Arch init code should be built for a very small image
3223
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003224 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3225 Partition on the MMC to load U-Boot from when the MMC is being
3226 used in raw mode
3227
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003228 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3229 Sector to load kernel uImage from when MMC is being
3230 used in raw mode (for Falcon mode)
3231
3232 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3233 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3234 Sector and number of sectors to load kernel argument
3235 parameters from when MMC is being used in raw mode
3236 (for falcon mode)
3237
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003238 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3239 Partition on the MMC to load U-Boot from when the MMC is being
3240 used in fs mode
3241
Guillaume GARDET5065b712014-10-15 17:53:13 +02003242 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3243 Filename to read to load U-Boot when reading from filesystem
3244
3245 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003246 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003247 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003248
Guillaume GARDET5065b712014-10-15 17:53:13 +02003249 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003250 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003251 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003252
Scott Wood2b36fbb2012-12-06 13:33:17 +00003253 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3254 Set this for NAND SPL on PPC mpc83xx targets, so that
3255 start.S waits for the rest of the SPL to load before
3256 continuing (the hardware starts execution after just
3257 loading the first page rather than the full 4K).
3258
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303259 CONFIG_SPL_SKIP_RELOCATE
3260 Avoid SPL relocation
3261
Scott Woodc352a0c2012-09-20 19:09:07 -05003262 CONFIG_SPL_NAND_BASE
3263 Include nand_base.c in the SPL. Requires
3264 CONFIG_SPL_NAND_DRIVERS.
3265
3266 CONFIG_SPL_NAND_DRIVERS
3267 SPL uses normal NAND drivers, not minimal drivers.
3268
3269 CONFIG_SPL_NAND_ECC
3270 Include standard software ECC in the SPL
3271
Tom Rini36853852012-02-14 07:29:40 +00003272 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003273 Support for NAND boot using simple NAND drivers that
3274 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003275
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003276 CONFIG_SPL_UBI
3277 Support for a lightweight UBI (fastmap) scanner and
3278 loader
3279
Heiko Schochercf000272014-10-31 08:31:00 +01003280 CONFIG_SPL_NAND_RAW_ONLY
3281 Support to boot only raw u-boot.bin images. Use this only
3282 if you need to save space.
3283
Ying Zhangdfb2b152013-08-16 15:16:12 +08003284 CONFIG_SPL_COMMON_INIT_DDR
3285 Set for common ddr init with serial presence detect in
3286 SPL binary.
3287
Tom Rini36853852012-02-14 07:29:40 +00003288 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3289 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3290 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3291 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3292 CONFIG_SYS_NAND_ECCBYTES
3293 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003294 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003295
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303296 CONFIG_SPL_NAND_BOOT
3297 Add support NAND boot
3298
Tom Rini36853852012-02-14 07:29:40 +00003299 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003300 Location in NAND to read U-Boot from
3301
3302 CONFIG_SYS_NAND_U_BOOT_DST
3303 Location in memory to load U-Boot to
3304
3305 CONFIG_SYS_NAND_U_BOOT_SIZE
3306 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003307
3308 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003309 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003310
3311 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3312 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003313 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003314
3315 CONFIG_SPL_OMAP3_ID_NAND
3316 Support for an OMAP3-specific set of functions to return the
3317 ID and MFR of the first attached NAND chip, if present.
3318
Pavel Machekde997252012-08-30 22:42:11 +02003319 CONFIG_SPL_RAM_DEVICE
3320 Support for running image already present in ram, in SPL binary
3321
Scott Woodeb7bd972012-12-06 13:33:16 +00003322 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003323 Image offset to which the SPL should be padded before appending
3324 the SPL payload. By default, this is defined as
3325 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3326 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3327 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003328
Scott Woodf147eb72012-09-21 16:27:32 -05003329 CONFIG_SPL_TARGET
3330 Final target image containing SPL and payload. Some SPLs
3331 use an arch-specific makefile fragment instead, for
3332 example if more than one image needs to be produced.
3333
Simon Glass82d94532013-05-08 08:05:59 +00003334 CONFIG_FIT_SPL_PRINT
3335 Printing information about a FIT image adds quite a bit of
3336 code to SPL. So this is normally disabled in SPL. Use this
3337 option to re-enable it. This will affect the output of the
3338 bootm command when booting a FIT image.
3339
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003340- TPL framework
3341 CONFIG_TPL
3342 Enable building of TPL globally.
3343
3344 CONFIG_TPL_PAD_TO
3345 Image offset to which the TPL should be padded before appending
3346 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003347 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3348 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3349 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003350
wdenkc0aa5c52003-12-06 19:49:23 +00003351- Interrupt support (PPC):
3352
wdenk1ebf41e2004-01-02 14:00:00 +00003353 There are common interrupt_init() and timer_interrupt()
3354 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003355 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003356 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003357 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003358 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003359 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003360 specific handling. If board has watchdog / status_led
3361 / other_activity_monitor it works automatically from
3362 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003363
wdenkc6097192002-11-03 00:24:07 +00003364
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003365Board initialization settings:
3366------------------------------
3367
3368During Initialization u-boot calls a number of board specific functions
3369to allow the preparation of board specific prerequisites, e.g. pin setup
3370before drivers are initialized. To enable these callbacks the
3371following configuration macros have to be defined. Currently this is
3372architecture specific, so please check arch/your_architecture/lib/board.c
3373typically in board_init_f() and board_init_r().
3374
3375- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3376- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3377- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3378- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003379
wdenkc6097192002-11-03 00:24:07 +00003380Configuration Settings:
3381-----------------------
3382
York Sun6c480012014-02-26 17:03:19 -08003383- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3384 Optionally it can be defined to support 64-bit memory commands.
3385
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003386- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003387 undefine this when you're short of memory.
3388
Peter Tyserdfb72b82009-01-27 18:03:12 -06003389- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3390 width of the commands listed in the 'help' command output.
3391
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003392- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003393 prompt for user input.
3394
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003395- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003396
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003397- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003398
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003399- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003400
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003401- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003402 the application (usually a Linux kernel) when it is
3403 booted
3404
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003405- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003406 List of legal baudrate settings for this board.
3407
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003408- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003409 Begin and End addresses of the area used by the
3410 simple memory test.
3411
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003412- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003413 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003414
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003415- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003416 Scratch address used by the alternate memory test
3417 You only need to set this if address zero isn't writeable
3418
York Sun5d286cd2015-12-04 11:57:07 -08003419- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003420 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003421 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3422 is substracted from total RAM and won't be reported to OS.
3423 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003424 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003425 the RAM base is not zero, or RAM is divided into banks,
3426 this variable needs to be recalcuated to get the address.
3427
York Sun50739372015-12-07 11:05:29 -08003428- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003429 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003430 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003431 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003432 fixing up gd->ram_size the Linux kernel should gets passed
3433 the now "corrected" memory size and won't touch it either.
3434 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003435 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003436 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003437 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003438
3439 This option can be used as a workaround for the 440EPx/GRx
3440 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3441 be touched.
3442
3443 WARNING: Please make sure that this value is a multiple of
3444 the Linux page size (normally 4k). If this is not the case,
3445 then the end address of the Linux memory will be located at a
3446 non page size aligned address and this could cause major
3447 problems.
3448
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003449- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003450 Enable temporary baudrate change while serial download
3451
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003452- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003453 Physical start address of SDRAM. _Must_ be 0 here.
3454
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003455- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003456 Physical start address of Flash memory.
3457
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003458- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003459 Physical start address of boot monitor code (set by
3460 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003461 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003462 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003463
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003464- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003465 Size of memory reserved for monitor code, used to
3466 determine _at_compile_time_ (!) if the environment is
3467 embedded within the U-Boot image, or in a separate
3468 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003469
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003470- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003471 Size of DRAM reserved for malloc() use.
3472
Simon Glass863e4042014-07-10 22:23:28 -06003473- CONFIG_SYS_MALLOC_F_LEN
3474 Size of the malloc() pool for use before relocation. If
3475 this is defined, then a very simple malloc() implementation
3476 will become available before relocation. The address is just
3477 below the global data, and the stack is moved down to make
3478 space.
3479
3480 This feature allocates regions with increasing addresses
3481 within the region. calloc() is supported, but realloc()
3482 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003483 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003484 U-Boot relocates itself.
3485
Simon Glass9fa901b2014-11-10 17:16:54 -07003486- CONFIG_SYS_MALLOC_SIMPLE
3487 Provides a simple and small malloc() and calloc() for those
3488 boards which do not use the full malloc in SPL (which is
3489 enabled with CONFIG_SYS_SPL_MALLOC_START).
3490
Thierry Redingc97d9742014-12-09 22:25:22 -07003491- CONFIG_SYS_NONCACHED_MEMORY:
3492 Size of non-cached memory area. This area of memory will be
3493 typically located right below the malloc() area and mapped
3494 uncached in the MMU. This is useful for drivers that would
3495 otherwise require a lot of explicit cache maintenance. For
3496 some drivers it's also impossible to properly maintain the
3497 cache. For example if the regions that need to be flushed
3498 are not a multiple of the cache-line size, *and* padding
3499 cannot be allocated between the regions to align them (i.e.
3500 if the HW requires a contiguous array of regions, and the
3501 size of each region is not cache-aligned), then a flush of
3502 one region may result in overwriting data that hardware has
3503 written to another region in the same cache-line. This can
3504 happen for example in network drivers where descriptors for
3505 buffers are typically smaller than the CPU cache-line (e.g.
3506 16 bytes vs. 32 or 64 bytes).
3507
3508 Non-cached memory is only supported on 32-bit ARM at present.
3509
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003510- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003511 Normally compressed uImages are limited to an
3512 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003513 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003514 to adjust this setting to your needs.
3515
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003516- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003517 Maximum size of memory mapped by the startup code of
3518 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003519 the Linux kernel (bd_info, boot arguments, FDT blob if
3520 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003521 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003522 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003523 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003524 variable "bootm_mapsize" will override the value of
3525 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3526 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003527
John Rigbyeea8e692010-10-13 13:57:35 -06003528- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3529 Enable initrd_high functionality. If defined then the
3530 initrd_high feature is enabled and the bootm ramdisk subcommand
3531 is enabled.
3532
3533- CONFIG_SYS_BOOT_GET_CMDLINE:
3534 Enables allocating and saving kernel cmdline in space between
3535 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3536
3537- CONFIG_SYS_BOOT_GET_KBD:
3538 Enables allocating and saving a kernel copy of the bd_info in
3539 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003541- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003542 Max number of Flash memory banks
3543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003544- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003545 Max number of sectors on a Flash chip
3546
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003547- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003548 Timeout for Flash erase operations (in ms)
3549
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003550- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003551 Timeout for Flash write operations (in ms)
3552
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003553- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003554 Timeout for Flash set sector lock bit operation (in ms)
3555
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003556- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003557 Timeout for Flash clear lock bits operation (in ms)
3558
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003559- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003560 If defined, hardware flash sectors protection is used
3561 instead of U-Boot software protection.
3562
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003563- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003564
3565 Enable TFTP transfers directly to flash memory;
3566 without this option such a download has to be
3567 performed in two steps: (1) download to RAM, and (2)
3568 copy from RAM to flash.
3569
3570 The two-step approach is usually more reliable, since
3571 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003572 the flash, but in some situations (when system RAM is
3573 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003574 downloaded image) this option may be very useful.
3575
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003576- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003577 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003578 common flash structure for storing flash geometry.
3579
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003580- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003581 This option also enables the building of the cfi_flash driver
3582 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003583
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003584- CONFIG_FLASH_CFI_MTD
3585 This option enables the building of the cfi_mtd driver
3586 in the drivers directory. The driver exports CFI flash
3587 to the MTD layer.
3588
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003589- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003590 Use buffered writes to flash.
3591
3592- CONFIG_FLASH_SPANSION_S29WS_N
3593 s29ws-n MirrorBit flash has non-standard addresses for buffered
3594 write commands.
3595
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003596- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003597 If this option is defined, the common CFI flash doesn't
3598 print it's warning upon not recognized FLASH banks. This
3599 is useful, if some of the configured banks are only
3600 optionally available.
3601
Jerry Van Barenaae73572008-03-08 13:48:01 -05003602- CONFIG_FLASH_SHOW_PROGRESS
3603 If defined (must be an integer), print out countdown
3604 digits and dots. Recommended value: 45 (9..1) for 80
3605 column displays, 15 (3..1) for 40 column displays.
3606
Stefan Roesed20cba52013-04-04 15:53:14 +02003607- CONFIG_FLASH_VERIFY
3608 If defined, the content of the flash (destination) is compared
3609 against the source after the write operation. An error message
3610 will be printed when the contents are not identical.
3611 Please note that this option is useless in nearly all cases,
3612 since such flash programming errors usually are detected earlier
3613 while unprotecting/erasing/programming. Please only enable
3614 this option if you really know what you are doing.
3615
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003616- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003617 Defines the number of Ethernet receive buffers. On some
3618 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003619 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3620 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003621 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003622 Defaults to 4 if not defined.
3623
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003624- CONFIG_ENV_MAX_ENTRIES
3625
Wolfgang Denk1136f69e2010-10-27 22:48:30 +02003626 Maximum number of entries in the hash table that is used
3627 internally to store the environment settings. The default
3628 setting is supposed to be generous and should work in most
3629 cases. This setting can be used to tune behaviour; see
3630 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003631
Joe Hershberger71497d02012-12-11 22:16:31 -06003632- CONFIG_ENV_FLAGS_LIST_DEFAULT
3633- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003634 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003635 calling env set. Variables can be restricted to only decimal,
3636 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3637 the variables can also be restricted to IP address or MAC address.
3638
3639 The format of the list is:
3640 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003641 access_attribute = [a|r|o|c]
3642 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003643 entry = variable_name[:attributes]
3644 list = entry[,list]
3645
3646 The type attributes are:
3647 s - String (default)
3648 d - Decimal
3649 x - Hexadecimal
3650 b - Boolean ([1yYtT|0nNfF])
3651 i - IP address
3652 m - MAC address
3653
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003654 The access attributes are:
3655 a - Any (default)
3656 r - Read-only
3657 o - Write-once
3658 c - Change-default
3659
Joe Hershberger71497d02012-12-11 22:16:31 -06003660 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3661 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003662 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003663
3664 - CONFIG_ENV_FLAGS_LIST_STATIC
3665 Define this to a list (string) to define validation that
3666 should be done if an entry is not found in the ".flags"
3667 environment variable. To override a setting in the static
3668 list, simply add an entry for the same variable name to the
3669 ".flags" variable.
3670
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003671 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3672 regular expression. This allows multiple variables to define the same
3673 flags without explicitly listing them for each variable.
3674
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003675- CONFIG_ENV_ACCESS_IGNORE_FORCE
3676 If defined, don't allow the -f switch to env set override variable
3677 access flags.
3678
Lokesh Vutla100c2d82013-04-17 20:49:40 +00003679- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
3680 This is set by OMAP boards for the max time that reset should
3681 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003682 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00003683
Gabe Black3687fe42014-10-15 04:38:30 -06003684- CONFIG_USE_STDINT
3685 If stdint.h is available with your toolchain you can define this
3686 option to enable it. You can provide option 'USE_STDINT=1' when
3687 building U-Boot to enable this.
3688
wdenkc6097192002-11-03 00:24:07 +00003689The following definitions that deal with the placement and management
3690of environment data (variable area); in general, we support the
3691following configurations:
3692
Mike Frysinger63b8f122011-07-08 10:44:25 +00003693- CONFIG_BUILD_ENVCRC:
3694
3695 Builds up envcrc with the target environment so that external utils
3696 may easily extract it and embed it in final U-Boot images.
3697
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003698- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003699
3700 Define this if the environment is in flash memory.
3701
3702 a) The environment occupies one whole flash sector, which is
3703 "embedded" in the text segment with the U-Boot code. This
3704 happens usually with "bottom boot sector" or "top boot
3705 sector" type flash chips, which have several smaller
3706 sectors at the start or the end. For instance, such a
3707 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3708 such a case you would place the environment in one of the
3709 4 kB sectors - with U-Boot code before and after it. With
3710 "top boot sector" type flash chips, you would put the
3711 environment in one of the last sectors, leaving a gap
3712 between U-Boot and the environment.
3713
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003714 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003715
3716 Offset of environment data (variable area) to the
3717 beginning of flash memory; for instance, with bottom boot
3718 type flash chips the second sector can be used: the offset
3719 for this sector is given here.
3720
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003721 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003722
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003723 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003724
3725 This is just another way to specify the start address of
3726 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003727 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003728
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003729 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003730
3731 Size of the sector containing the environment.
3732
3733
3734 b) Sometimes flash chips have few, equal sized, BIG sectors.
3735 In such a case you don't want to spend a whole sector for
3736 the environment.
3737
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003738 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003739
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003740 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003741 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003742 of this flash sector for the environment. This saves
3743 memory for the RAM copy of the environment.
3744
3745 It may also save flash memory if you decide to use this
3746 when your environment is "embedded" within U-Boot code,
3747 since then the remainder of the flash sector could be used
3748 for U-Boot code. It should be pointed out that this is
3749 STRONGLY DISCOURAGED from a robustness point of view:
3750 updating the environment in flash makes it always
3751 necessary to erase the WHOLE sector. If something goes
3752 wrong before the contents has been restored from a copy in
3753 RAM, your target system will be dead.
3754
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003755 - CONFIG_ENV_ADDR_REDUND
3756 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003757
wdenk4a5c8a72003-03-06 00:02:04 +00003758 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003759 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003760 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003761 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003762
3763BE CAREFUL! Any changes to the flash layout, and some changes to the
3764source code will make it necessary to adapt <board>/u-boot.lds*
3765accordingly!
3766
3767
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003768- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003769
3770 Define this if you have some non-volatile memory device
3771 (NVRAM, battery buffered SRAM) which you want to use for the
3772 environment.
3773
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003774 - CONFIG_ENV_ADDR:
3775 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003776
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003777 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003778 want to use for environment. It is assumed that this memory
3779 can just be read and written to, without any special
3780 provision.
3781
3782BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003783in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003784console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003785U-Boot will hang.
3786
3787Please note that even with NVRAM we still use a copy of the
3788environment in RAM: we could work on NVRAM directly, but we want to
3789keep settings there always unmodified except somebody uses "saveenv"
3790to save the current settings.
3791
3792
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003793- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003794
3795 Use this if you have an EEPROM or similar serial access
3796 device and a driver for it.
3797
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003798 - CONFIG_ENV_OFFSET:
3799 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003800
3801 These two #defines specify the offset and size of the
3802 environment area within the total memory of your EEPROM.
3803
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003804 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003805 If defined, specified the chip address of the EEPROM device.
3806 The default address is zero.
3807
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003808 - CONFIG_SYS_I2C_EEPROM_BUS:
3809 If defined, specified the i2c bus of the EEPROM device.
3810
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003811 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003812 If defined, the number of bits used to address bytes in a
3813 single page in the EEPROM device. A 64 byte page, for example
3814 would require six bits.
3815
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003816 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003817 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003818 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003819
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003820 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003821 The length in bytes of the EEPROM memory array address. Note
3822 that this is NOT the chip address length!
3823
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003824 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003825 EEPROM chips that implement "address overflow" are ones
3826 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3827 address and the extra bits end up in the "chip address" bit
3828 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3829 byte chips.
3830
3831 Note that we consider the length of the address field to
3832 still be one byte because the extra address bits are hidden
3833 in the chip address.
3834
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003835 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003836 The size in bytes of the EEPROM device.
3837
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003838 - CONFIG_ENV_EEPROM_IS_ON_I2C
3839 define this, if you have I2C and SPI activated, and your
3840 EEPROM, which holds the environment, is on the I2C bus.
3841
3842 - CONFIG_I2C_ENV_EEPROM_BUS
3843 if you have an Environment on an EEPROM reached over
3844 I2C muxes, you can define here, how to reach this
3845 EEPROM. For example:
3846
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003847 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003848
3849 EEPROM which holds the environment, is reached over
3850 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003851
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003852- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003853
wdenk1ebf41e2004-01-02 14:00:00 +00003854 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003855 want to use for the environment.
3856
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003857 - CONFIG_ENV_OFFSET:
3858 - CONFIG_ENV_ADDR:
3859 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003860
3861 These three #defines specify the offset and size of the
3862 environment area within the total memory of your DataFlash placed
3863 at the specified address.
3864
Wu, Josh76db7bf2014-07-01 19:30:13 +08003865- CONFIG_ENV_IS_IN_SPI_FLASH:
3866
3867 Define this if you have a SPI Flash memory device which you
3868 want to use for the environment.
3869
3870 - CONFIG_ENV_OFFSET:
3871 - CONFIG_ENV_SIZE:
3872
3873 These two #defines specify the offset and size of the
3874 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3875 aligned to an erase sector boundary.
3876
3877 - CONFIG_ENV_SECT_SIZE:
3878
3879 Define the SPI flash's sector size.
3880
3881 - CONFIG_ENV_OFFSET_REDUND (optional):
3882
3883 This setting describes a second storage area of CONFIG_ENV_SIZE
3884 size used to hold a redundant copy of the environment data, so
3885 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003886 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003887 aligned to an erase sector boundary.
3888
3889 - CONFIG_ENV_SPI_BUS (optional):
3890 - CONFIG_ENV_SPI_CS (optional):
3891
3892 Define the SPI bus and chip select. If not defined they will be 0.
3893
3894 - CONFIG_ENV_SPI_MAX_HZ (optional):
3895
3896 Define the SPI max work clock. If not defined then use 1MHz.
3897
3898 - CONFIG_ENV_SPI_MODE (optional):
3899
3900 Define the SPI work mode. If not defined then use SPI_MODE_3.
3901
Liu Gang85bcd732012-03-08 00:33:20 +00003902- CONFIG_ENV_IS_IN_REMOTE:
3903
3904 Define this if you have a remote memory space which you
3905 want to use for the local device's environment.
3906
3907 - CONFIG_ENV_ADDR:
3908 - CONFIG_ENV_SIZE:
3909
3910 These two #defines specify the address and size of the
3911 environment area within the remote memory space. The
3912 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003913 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003914
3915BE CAREFUL! For some special cases, the local device can not use
3916"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003917environment stored in a remote NOR flash by SRIO or PCIE link,
3918but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003919
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003920- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003921
3922 Define this if you have a NAND device which you want to use
3923 for the environment.
3924
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003925 - CONFIG_ENV_OFFSET:
3926 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003927
3928 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003929 area within the first NAND device. CONFIG_ENV_OFFSET must be
3930 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003931
Scott Wood08239322010-09-17 14:38:37 -05003932 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003933
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003934 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003935 size used to hold a redundant copy of the environment data, so
3936 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003937 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003938 aligned to an erase block boundary.
3939
3940 - CONFIG_ENV_RANGE (optional):
3941
3942 Specifies the length of the region in which the environment
3943 can be written. This should be a multiple of the NAND device's
3944 block size. Specifying a range with more erase blocks than
3945 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3946 the range to be avoided.
3947
3948 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003949
Scott Wood08239322010-09-17 14:38:37 -05003950 Enables support for dynamically retrieving the offset of the
3951 environment from block zero's out-of-band data. The
3952 "nand env.oob" command can be used to record this offset.
3953 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3954 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003955
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003956- CONFIG_NAND_ENV_DST
3957
3958 Defines address in RAM to which the nand_spl code should copy the
3959 environment. If redundant environment is used, it will be copied to
3960 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3961
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003962- CONFIG_ENV_IS_IN_UBI:
3963
3964 Define this if you have an UBI volume that you want to use for the
3965 environment. This has the benefit of wear-leveling the environment
3966 accesses, which is important on NAND.
3967
3968 - CONFIG_ENV_UBI_PART:
3969
3970 Define this to a string that is the mtd partition containing the UBI.
3971
3972 - CONFIG_ENV_UBI_VOLUME:
3973
3974 Define this to the name of the volume that you want to store the
3975 environment in.
3976
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003977 - CONFIG_ENV_UBI_VOLUME_REDUND:
3978
3979 Define this to the name of another volume to store a second copy of
3980 the environment in. This will enable redundant environments in UBI.
3981 It is assumed that both volumes are in the same MTD partition.
3982
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003983 - CONFIG_UBI_SILENCE_MSG
3984 - CONFIG_UBIFS_SILENCE_MSG
3985
3986 You will probably want to define these to avoid a really noisy system
3987 when storing the env in UBI.
3988
Wu, Josha7d0c872014-06-24 17:31:03 +08003989- CONFIG_ENV_IS_IN_FAT:
3990 Define this if you want to use the FAT file system for the environment.
3991
3992 - FAT_ENV_INTERFACE:
3993
3994 Define this to a string that is the name of the block device.
3995
Nicolae Rosia86811f22016-11-21 17:33:58 +02003996 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003997
3998 Define this to a string to specify the partition of the device. It can
3999 be as following:
4000
4001 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4002 - "D:P": device D partition P. Error occurs if device D has no
4003 partition table.
4004 - "D:0": device D.
4005 - "D" or "D:": device D partition 1 if device D has partition
4006 table, or the whole device D if has no partition
4007 table.
4008 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004009 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004010 partition table then means device D.
4011
4012 - FAT_ENV_FILE:
4013
4014 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004015 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004016
4017 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004018 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004019
Stephen Warreneedcacd2013-06-11 15:14:00 -06004020- CONFIG_ENV_IS_IN_MMC:
4021
4022 Define this if you have an MMC device which you want to use for the
4023 environment.
4024
4025 - CONFIG_SYS_MMC_ENV_DEV:
4026
4027 Specifies which MMC device the environment is stored in.
4028
4029 - CONFIG_SYS_MMC_ENV_PART (optional):
4030
4031 Specifies which MMC partition the environment is stored in. If not
4032 set, defaults to partition 0, the user area. Common values might be
4033 1 (first MMC boot partition), 2 (second MMC boot partition).
4034
4035 - CONFIG_ENV_OFFSET:
4036 - CONFIG_ENV_SIZE:
4037
4038 These two #defines specify the offset and size of the environment
4039 area within the specified MMC device.
4040
Stephen Warren24dc2032013-06-11 15:14:02 -06004041 If offset is positive (the usual case), it is treated as relative to
4042 the start of the MMC partition. If offset is negative, it is treated
4043 as relative to the end of the MMC partition. This can be useful if
4044 your board may be fitted with different MMC devices, which have
4045 different sizes for the MMC partitions, and you always want the
4046 environment placed at the very end of the partition, to leave the
4047 maximum possible space before it, to store other data.
4048
Stephen Warreneedcacd2013-06-11 15:14:00 -06004049 These two values are in units of bytes, but must be aligned to an
4050 MMC sector boundary.
4051
4052 - CONFIG_ENV_OFFSET_REDUND (optional):
4053
4054 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4055 hold a redundant copy of the environment data. This provides a
4056 valid backup copy in case the other copy is corrupted, e.g. due
4057 to a power failure during a "saveenv" operation.
4058
Stephen Warren24dc2032013-06-11 15:14:02 -06004059 This value may also be positive or negative; this is handled in the
4060 same way as CONFIG_ENV_OFFSET.
4061
Stephen Warreneedcacd2013-06-11 15:14:00 -06004062 This value is also in units of bytes, but must also be aligned to
4063 an MMC sector boundary.
4064
4065 - CONFIG_ENV_SIZE_REDUND (optional):
4066
4067 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4068 set. If this value is set, it must be set to the same value as
4069 CONFIG_ENV_SIZE.
4070
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004071- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004072
4073 Defines offset to the initial SPI buffer area in DPRAM. The
4074 area is used at an early stage (ROM part) if the environment
4075 is configured to reside in the SPI EEPROM: We need a 520 byte
4076 scratch DPRAM area. It is used between the two initialization
4077 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4078 to be a good choice since it makes it far enough from the
4079 start of the data area as well as from the stack pointer.
4080
Bruce Adleredecc942007-11-02 13:15:42 -07004081Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004082has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004083created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004084until then to read environment variables.
4085
wdenk8dba0502003-03-31 16:34:49 +00004086The environment is protected by a CRC32 checksum. Before the monitor
4087is relocated into RAM, as a result of a bad CRC you will be working
4088with the compiled-in default environment - *silently*!!! [This is
4089necessary, because the first environment variable we need is the
4090"baudrate" setting for the console - if we have a bad CRC, we don't
4091have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004092
4093Note: once the monitor has been relocated, then it will complain if
4094the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004095use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004096
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004097- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004098 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004099
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004100 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004101 also needs to be defined.
4102
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004103- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004104 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004105
Ron Madriddfa028a2009-02-18 14:30:44 -08004106- CONFIG_NS16550_MIN_FUNCTIONS:
4107 Define this if you desire to only have use of the NS16550_init
4108 and NS16550_putc functions for the serial driver located at
4109 drivers/serial/ns16550.c. This option is useful for saving
4110 space for already greatly restricted images, including but not
4111 limited to NAND_SPL configurations.
4112
Simon Glass28a9e332012-11-30 13:01:18 +00004113- CONFIG_DISPLAY_BOARDINFO
4114 Display information about the board that U-Boot is running on
4115 when U-Boot starts up. The board function checkboard() is called
4116 to do this.
4117
Simon Glasse8822012012-11-30 13:01:19 +00004118- CONFIG_DISPLAY_BOARDINFO_LATE
4119 Similar to the previous option, but display this information
4120 later, once stdio is running and output goes to the LCD, if
4121 present.
4122
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004123- CONFIG_BOARD_SIZE_LIMIT:
4124 Maximum size of the U-Boot image. When defined, the
4125 build system checks that the actual size does not
4126 exceed it.
4127
wdenkc6097192002-11-03 00:24:07 +00004128Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004129---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004130
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004131- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004132 Cache Line Size of the CPU.
4133
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004134- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004135 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004136
wdenk9c53f402003-10-15 23:53:47 +00004137 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4138 and RPXsuper) to be able to adjust the position of
4139 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004140
Timur Tabid8f341c2011-08-04 18:03:41 -05004141- CONFIG_SYS_CCSRBAR_DEFAULT:
4142 Default (power-on reset) physical address of CCSR on Freescale
4143 PowerPC SOCs.
4144
4145- CONFIG_SYS_CCSRBAR:
4146 Virtual address of CCSR. On a 32-bit build, this is typically
4147 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4148
4149 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4150 for cross-platform code that uses that macro instead.
4151
4152- CONFIG_SYS_CCSRBAR_PHYS:
4153 Physical address of CCSR. CCSR can be relocated to a new
4154 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004155 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004156 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4157 is typically relocated on 36-bit builds. It is recommended
4158 that this macro be defined via the _HIGH and _LOW macros:
4159
4160 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4161 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4162
4163- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004164 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4165 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004166 used in assembly code, so it must not contain typecasts or
4167 integer size suffixes (e.g. "ULL").
4168
4169- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4170 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4171 used in assembly code, so it must not contain typecasts or
4172 integer size suffixes (e.g. "ULL").
4173
4174- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4175 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4176 forced to a value that ensures that CCSR is not relocated.
4177
wdenk1272e232002-11-10 22:06:23 +00004178- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004179 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004180
4181 the default drive number (default value 0)
4182
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004183 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004184
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004185 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004186 (default value 1)
4187
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004188 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004189
wdenk4a5c8a72003-03-06 00:02:04 +00004190 defines the offset of register from address. It
4191 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004192 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004193
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004194 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4195 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004196 default value.
wdenk1272e232002-11-10 22:06:23 +00004197
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004198 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004199 fdc_hw_init() is called at the beginning of the FDC
4200 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004201 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004202 initializations.
wdenk1272e232002-11-10 22:06:23 +00004203
Macpaul Lind1e49942011-04-11 20:45:32 +00004204- CONFIG_IDE_AHB:
4205 Most IDE controllers were designed to be connected with PCI
4206 interface. Only few of them were designed for AHB interface.
4207 When software is doing ATA command and data transfer to
4208 IDE devices through IDE-AHB controller, some additional
4209 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004210 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004211
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004212- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004213 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004214 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004215
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004216- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004217
wdenkeb20ad32003-09-05 23:19:14 +00004218 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004219 initial data and stack; please note that this must be
4220 writable memory that is working WITHOUT special
4221 initialization, i. e. you CANNOT use normal RAM which
4222 will become available only after programming the
4223 memory controller and running certain initialization
4224 sequences.
4225
4226 U-Boot uses the following memory types:
4227 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4228 - MPC824X: data cache
4229 - PPC4xx: data cache
4230
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004231- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004232
4233 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004234 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4235 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004236 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004237 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004238 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004239 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4240 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004241
4242 Note:
4243 On the MPC824X (or other systems that use the data
4244 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004245 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004246 point to an otherwise UNUSED address space between
4247 the top of RAM and the start of the PCI space.
4248
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004249- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004250
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004251- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004252
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004253- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004254
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004255- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004256
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004257- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004258
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004259- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004260
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004261- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004262 SDRAM timing
4263
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004264- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004265 periodic timer for refresh
4266
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004267- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004268
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004269- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4270 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4271 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4272 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004273 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4274
4275- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004276 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4277 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004278 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4279
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004280- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4281 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004282 Machine Mode Register and Memory Periodic Timer
4283 Prescaler definitions (SDRAM timing)
4284
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004285- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004286 enable I2C microcode relocation patch (MPC8xx);
4287 define relocation offset in DPRAM [DSP2]
4288
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004289- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004290 enable SMC microcode relocation patch (MPC8xx);
4291 define relocation offset in DPRAM [SMC1]
4292
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004293- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004294 enable SPI microcode relocation patch (MPC8xx);
4295 define relocation offset in DPRAM [SCC4]
4296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004297- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004298 Offset of the bootmode word in DPRAM used by post
4299 (Power On Self Tests). This definition overrides
4300 #define'd default value in commproc.h resp.
4301 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004303- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4304 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4305 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4306 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4307 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4308 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4309 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4310 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004311 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004312
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004313- CONFIG_PCI_DISABLE_PCIE:
4314 Disable PCI-Express on systems where it is supported but not
4315 required.
4316
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004317- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004318 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004319 Don't do any setup work, presumably because someone or
4320 something has already done it, and we don't need to do it
4321 a second time. Useful for platforms that are pre-booted
4322 by coreboot or similar.
4323
Gabor Juhosb4458732013-05-30 07:06:12 +00004324- CONFIG_PCI_INDIRECT_BRIDGE:
4325 Enable support for indirect PCI bridges.
4326
Kumar Gala8975d7a2010-12-30 12:09:53 -06004327- CONFIG_SYS_SRIO:
4328 Chip has SRIO or not
4329
4330- CONFIG_SRIO1:
4331 Board has SRIO 1 port available
4332
4333- CONFIG_SRIO2:
4334 Board has SRIO 2 port available
4335
Liu Gang27afb9c2013-05-07 16:30:46 +08004336- CONFIG_SRIO_PCIE_BOOT_MASTER
4337 Board can support master function for Boot from SRIO and PCIE
4338
Kumar Gala8975d7a2010-12-30 12:09:53 -06004339- CONFIG_SYS_SRIOn_MEM_VIRT:
4340 Virtual Address of SRIO port 'n' memory region
4341
4342- CONFIG_SYS_SRIOn_MEM_PHYS:
4343 Physical Address of SRIO port 'n' memory region
4344
4345- CONFIG_SYS_SRIOn_MEM_SIZE:
4346 Size of SRIO port 'n' memory region
4347
Fabio Estevamf17e8782013-04-11 09:35:34 +00004348- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4349 Defined to tell the NAND controller that the NAND chip is using
4350 a 16 bit bus.
4351 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004352 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004353 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004354 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004355
4356- CONFIG_SYS_NDFC_EBC0_CFG
4357 Sets the EBC0_CFG register for the NDFC. If not defined
4358 a default value will be used.
4359
Ben Warren45657152006-09-07 16:50:54 -04004360- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004361 Get DDR timing information from an I2C EEPROM. Common
4362 with pluggable memory modules such as SODIMMs
4363
Ben Warren45657152006-09-07 16:50:54 -04004364 SPD_EEPROM_ADDRESS
4365 I2C address of the SPD EEPROM
4366
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004367- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004368 If SPD EEPROM is on an I2C bus other than the first
4369 one, specify here. Note that the value must resolve
4370 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004371
York Sune73cc042011-06-07 09:42:16 +08004372- CONFIG_SYS_DDR_RAW_TIMING
4373 Get DDR timing information from other than SPD. Common with
4374 soldered DDR chips onboard without SPD. DDR raw timing
4375 parameters are extracted from datasheet and hard-coded into
4376 header files or board specific files.
4377
York Sunbd495cf2011-09-16 13:21:35 -07004378- CONFIG_FSL_DDR_INTERACTIVE
4379 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4380
York Sun8ced0502015-01-06 13:18:55 -08004381- CONFIG_FSL_DDR_SYNC_REFRESH
4382 Enable sync of refresh for multiple controllers.
4383
York Sunb6a35f82015-03-19 09:30:28 -07004384- CONFIG_FSL_DDR_BIST
4385 Enable built-in memory test for Freescale DDR controllers.
4386
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004387- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004388 Only for 83xx systems. If specified, then DDR should
4389 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004390
wdenk6203e402004-04-18 10:13:26 +00004391- CONFIG_ETHER_ON_FEC[12]
4392 Define to enable FEC[12] on a 8xx series processor.
4393
4394- CONFIG_FEC[12]_PHY
4395 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004396 to the given FEC; i. e.
4397 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004398 means that the PHY with address 4 is connected to FEC1
4399
4400 When set to -1, means to probe for first available.
4401
4402- CONFIG_FEC[12]_PHY_NORXERR
4403 The PHY does not have a RXERR line (RMII only).
4404 (so program the FEC to ignore it).
4405
4406- CONFIG_RMII
4407 Enable RMII mode for all FECs.
4408 Note that this is a global option, we can't
4409 have one FEC in standard MII mode and another in RMII mode.
4410
wdenk20c98a62004-04-23 20:32:05 +00004411- CONFIG_CRC32_VERIFY
4412 Add a verify option to the crc32 command.
4413 The syntax is:
4414
4415 => crc32 -v <address> <count> <crc32>
4416
4417 Where address/count indicate a memory area
4418 and crc32 is the correct crc32 which the
4419 area should have.
4420
wdenk64519362004-07-11 17:40:54 +00004421- CONFIG_LOOPW
4422 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004423 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004424
stroesecc3af832004-12-16 18:46:55 +00004425- CONFIG_MX_CYCLIC
4426 Add the "mdc" and "mwc" memory commands. These are cyclic
4427 "md/mw" commands.
4428 Examples:
4429
wdenk07d7e6b2004-12-16 21:44:03 +00004430 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004431 This command will print 4 bytes (10,11,12,13) each 500 ms.
4432
wdenk07d7e6b2004-12-16 21:44:03 +00004433 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004434 This command will write 12345678 to address 100 all 10 ms.
4435
wdenk07d7e6b2004-12-16 21:44:03 +00004436 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004437 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004438
wdenk3d3d99f2005-04-04 12:44:11 +00004439- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004440 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004441 low level initializations (like setting up the memory
4442 controller) are omitted and/or U-Boot does not
4443 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004444
Wolfgang Denk302141d2010-11-27 23:30:56 +01004445 Normally this variable MUST NOT be defined. The only
4446 exception is when U-Boot is loaded (to RAM) by some
4447 other boot loader or by a debugger which performs
4448 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004449
Simon Glass90844072016-05-05 07:28:06 -06004450- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4451 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004452 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004453 instruction cache) is still performed.
4454
Aneesh V552a3192011-07-13 05:11:07 +00004455- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004456 Modifies the behaviour of start.S when compiling a loader
4457 that is executed before the actual U-Boot. E.g. when
4458 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004459
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004460- CONFIG_TPL_BUILD
4461 Modifies the behaviour of start.S when compiling a loader
4462 that is executed after the SPL and before the actual U-Boot.
4463 It is loaded by the SPL.
4464
Ying Zhang0d4f5442013-05-20 14:07:23 +08004465- CONFIG_SYS_MPC85XX_NO_RESETVEC
4466 Only for 85xx systems. If this variable is specified, the section
4467 .resetvec is not kept and the section .bootpg is placed in the
4468 previous 4k of the .text section.
4469
Simon Glass17dabf02013-02-24 17:33:14 +00004470- CONFIG_ARCH_MAP_SYSMEM
4471 Generally U-Boot (and in particular the md command) uses
4472 effective address. It is therefore not necessary to regard
4473 U-Boot address as virtual addresses that need to be translated
4474 to physical addresses. However, sandbox requires this, since
4475 it maintains its own little RAM buffer which contains all
4476 addressable memory. This option causes some memory accesses
4477 to be mapped through map_sysmem() / unmap_sysmem().
4478
Simon Glassbfb59802013-02-14 04:18:54 +00004479- CONFIG_X86_RESET_VECTOR
4480 If defined, the x86 reset vector code is included. This is not
4481 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004482
Heiko Schocher2233e462013-11-04 14:05:00 +01004483- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4484 Enables the RTC32K OSC on AM33xx based plattforms
4485
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004486- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4487 Option to disable subpage write in NAND driver
4488 driver that uses this:
4489 drivers/mtd/nand/davinci_nand.c
4490
Timur Tabi275f4bb2011-11-22 09:21:25 -06004491Freescale QE/FMAN Firmware Support:
4492-----------------------------------
4493
4494The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4495loading of "firmware", which is encoded in the QE firmware binary format.
4496This firmware often needs to be loaded during U-Boot booting, so macros
4497are used to identify the storage device (NOR flash, SPI, etc) and the address
4498within that device.
4499
Zhao Qiang83a90842014-03-21 16:21:44 +08004500- CONFIG_SYS_FMAN_FW_ADDR
4501 The address in the storage device where the FMAN microcode is located. The
4502 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4503 is also specified.
4504
4505- CONFIG_SYS_QE_FW_ADDR
4506 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004507 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4508 is also specified.
4509
4510- CONFIG_SYS_QE_FMAN_FW_LENGTH
4511 The maximum possible size of the firmware. The firmware binary format
4512 has a field that specifies the actual size of the firmware, but it
4513 might not be possible to read any part of the firmware unless some
4514 local storage is allocated to hold the entire firmware first.
4515
4516- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4517 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4518 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4519 virtual address in NOR flash.
4520
4521- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4522 Specifies that QE/FMAN firmware is located in NAND flash.
4523 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4524
4525- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4526 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4527 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4528
Liu Gang1e084582012-03-08 00:33:18 +00004529- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4530 Specifies that QE/FMAN firmware is located in the remote (master)
4531 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004532 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4533 window->master inbound window->master LAW->the ucode address in
4534 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004535
J. German Rivera8ff14b72014-06-23 15:15:55 -07004536Freescale Layerscape Management Complex Firmware Support:
4537---------------------------------------------------------
4538The Freescale Layerscape Management Complex (MC) supports the loading of
4539"firmware".
4540This firmware often needs to be loaded during U-Boot booting, so macros
4541are used to identify the storage device (NOR flash, SPI, etc) and the address
4542within that device.
4543
4544- CONFIG_FSL_MC_ENET
4545 Enable the MC driver for Layerscape SoCs.
4546
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304547Freescale Layerscape Debug Server Support:
4548-------------------------------------------
4549The Freescale Layerscape Debug Server Support supports the loading of
4550"Debug Server firmware" and triggering SP boot-rom.
4551This firmware often needs to be loaded during U-Boot booting.
4552
York Sun928b6812015-12-07 11:08:58 -08004553- CONFIG_SYS_MC_RSV_MEM_ALIGN
4554 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304555
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004556Reproducible builds
4557-------------------
4558
4559In order to achieve reproducible builds, timestamps used in the U-Boot build
4560process have to be set to a fixed value.
4561
4562This is done using the SOURCE_DATE_EPOCH environment variable.
4563SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4564option for U-Boot or an environment variable in U-Boot.
4565
4566SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4567
wdenkc6097192002-11-03 00:24:07 +00004568Building the Software:
4569======================
4570
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004571Building U-Boot has been tested in several native build environments
4572and in many different cross environments. Of course we cannot support
4573all possibly existing versions of cross development tools in all
4574(potentially obsolete) versions. In case of tool chain problems we
4575recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4576which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004577
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004578If you are not using a native environment, it is assumed that you
4579have GNU cross compiling tools available in your path. In this case,
4580you must set the environment variable CROSS_COMPILE in your shell.
4581Note that no changes to the Makefile or any other source files are
4582necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004583
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004584 $ CROSS_COMPILE=ppc_4xx-
4585 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004586
Peter Tyserb06976d2009-03-13 18:54:51 -05004587Note: If you wish to generate Windows versions of the utilities in
4588 the tools directory you can use the MinGW toolchain
4589 (http://www.mingw.org). Set your HOST tools to the MinGW
4590 toolchain and execute 'make tools'. For example:
4591
4592 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4593
4594 Binaries such as tools/mkimage.exe will be created which can
4595 be executed on computers running Windows.
4596
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004597U-Boot is intended to be simple to build. After installing the
4598sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004599is done by typing:
4600
Holger Freyther7ba4e572014-08-04 09:26:05 +02004601 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004602
Holger Freyther7ba4e572014-08-04 09:26:05 +02004603where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004604rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004605
wdenk6c59edc2004-05-03 20:45:30 +00004606Note: for some board special configuration names may exist; check if
4607 additional information is available from the board vendor; for
4608 instance, the TQM823L systems are available without (standard)
4609 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004610 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004611
Holger Freyther7ba4e572014-08-04 09:26:05 +02004612 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004613 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004614
Holger Freyther7ba4e572014-08-04 09:26:05 +02004615 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004616 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004617
wdenk6c59edc2004-05-03 20:45:30 +00004618 etc.
wdenkc6097192002-11-03 00:24:07 +00004619
wdenkc6097192002-11-03 00:24:07 +00004620
wdenk6c59edc2004-05-03 20:45:30 +00004621Finally, type "make all", and you should get some working U-Boot
4622images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004623
wdenk6c59edc2004-05-03 20:45:30 +00004624- "u-boot.bin" is a raw binary image
4625- "u-boot" is an image in ELF binary format
4626- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004627
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004628By default the build is performed locally and the objects are saved
4629in the source directory. One of the two methods can be used to change
4630this behavior and build U-Boot to some external directory:
4631
46321. Add O= to the make command line invocations:
4633
4634 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004635 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004636 make O=/tmp/build all
4637
Timo Ketolac8c67602014-11-06 14:39:05 +020046382. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004639
Timo Ketolac8c67602014-11-06 14:39:05 +02004640 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004641 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004642 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004643 make all
4644
Timo Ketolac8c67602014-11-06 14:39:05 +02004645Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004646variable.
4647
wdenkc6097192002-11-03 00:24:07 +00004648
wdenk6c59edc2004-05-03 20:45:30 +00004649Please be aware that the Makefiles assume you are using GNU make, so
4650for instance on NetBSD you might need to use "gmake" instead of
4651native "make".
wdenkc6097192002-11-03 00:24:07 +00004652
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654If the system board that you have is not listed, then you will need
4655to port U-Boot to your hardware platform. To do this, follow these
4656steps:
wdenkc6097192002-11-03 00:24:07 +00004657
Phil Sutterc77b4882015-12-25 14:41:18 +010046581. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004659 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004660 the "Makefile" and a "<board>.c".
46612. Create a new configuration file "include/configs/<board>.h" for
4662 your board.
wdenk6c59edc2004-05-03 20:45:30 +000046633. If you're porting U-Boot to a new CPU, then also create a new
4664 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020046654. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000046665. Type "make", and you should get a working "u-boot.srec" file
4667 to be installed on your target system.
46686. Debug and solve any problems that might arise.
4669 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004670
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk6c59edc2004-05-03 20:45:30 +00004672Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4673==============================================================
wdenkc6097192002-11-03 00:24:07 +00004674
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004675If you have modified U-Boot sources (for instance added a new board
4676or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004677provide feedback to the other developers. The feedback normally takes
4678the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004679official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004680
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004681But before you submit such a patch, please verify that your modifi-
4682cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004683the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004684just run the buildman script (tools/buildman/buildman), which will
4685configure and build U-Boot for ALL supported system. Be warned, this
4686will take a while. Please see the buildman README, or run 'buildman -H'
4687for documentation.
wdenkc6097192002-11-03 00:24:07 +00004688
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004689
wdenk6c59edc2004-05-03 20:45:30 +00004690See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004691
wdenkc6097192002-11-03 00:24:07 +00004692
wdenk6c59edc2004-05-03 20:45:30 +00004693Monitor Commands - Overview:
4694============================
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696go - start application at address 'addr'
4697run - run commands in an environment variable
4698bootm - boot application image from memory
4699bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004700bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004701tftpboot- boot image via network using TFTP protocol
4702 and env variables "ipaddr" and "serverip"
4703 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004704tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004705rarpboot- boot image via network using RARP/TFTP protocol
4706diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4707loads - load S-Record file over serial line
4708loadb - load binary file over serial line (kermit mode)
4709md - memory display
4710mm - memory modify (auto-incrementing)
4711nm - memory modify (constant address)
4712mw - memory write (fill)
4713cp - memory copy
4714cmp - memory compare
4715crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004716i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004717sspi - SPI utility commands
4718base - print or set address offset
4719printenv- print environment variables
4720setenv - set environment variables
4721saveenv - save environment variables to persistent storage
4722protect - enable or disable FLASH write protection
4723erase - erase FLASH memory
4724flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004725nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004726bdinfo - print Board Info structure
4727iminfo - print header information for application image
4728coninfo - print console devices and informations
4729ide - IDE sub-system
4730loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004731loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004732mtest - simple RAM test
4733icache - enable or disable instruction cache
4734dcache - enable or disable data cache
4735reset - Perform RESET of the CPU
4736echo - echo args to console
4737version - print monitor version
4738help - print online help
4739? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004740
wdenkc6097192002-11-03 00:24:07 +00004741
wdenk6c59edc2004-05-03 20:45:30 +00004742Monitor Commands - Detailed Description:
4743========================================
wdenkc6097192002-11-03 00:24:07 +00004744
wdenk6c59edc2004-05-03 20:45:30 +00004745TODO.
wdenkc6097192002-11-03 00:24:07 +00004746
wdenk6c59edc2004-05-03 20:45:30 +00004747For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004748
4749
wdenk6c59edc2004-05-03 20:45:30 +00004750Environment Variables:
4751======================
wdenkc6097192002-11-03 00:24:07 +00004752
wdenk6c59edc2004-05-03 20:45:30 +00004753U-Boot supports user configuration using Environment Variables which
4754can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004755
wdenk6c59edc2004-05-03 20:45:30 +00004756Environment Variables are set using "setenv", printed using
4757"printenv", and saved to Flash using "saveenv". Using "setenv"
4758without a value can be used to delete a variable from the
4759environment. As long as you don't save the environment you are
4760working with an in-memory copy. In case the Flash area containing the
4761environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004762
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004763Some configuration options can be set using Environment Variables.
4764
4765List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk6c59edc2004-05-03 20:45:30 +00004767 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004770
wdenk6c59edc2004-05-03 20:45:30 +00004771 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004772
wdenk6c59edc2004-05-03 20:45:30 +00004773 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004774
wdenk6c59edc2004-05-03 20:45:30 +00004775 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004776
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004777 bootm_low - Memory range available for image processing in the bootm
4778 command can be restricted. This variable is given as
4779 a hexadecimal number and defines lowest address allowed
4780 for use by the bootm command. See also "bootm_size"
4781 environment variable. Address defined by "bootm_low" is
4782 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004783 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4784 bootm_mapsize.
4785
Wolfgang Denk092ae952011-10-26 10:21:21 +00004786 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004787 This variable is given as a hexadecimal number and it
4788 defines the size of the memory region starting at base
4789 address bootm_low that is accessible by the Linux kernel
4790 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4791 as the default value if it is defined, and bootm_size is
4792 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004793
4794 bootm_size - Memory range available for image processing in the bootm
4795 command can be restricted. This variable is given as
4796 a hexadecimal number and defines the size of the region
4797 allowed for use by the bootm command. See also "bootm_low"
4798 environment variable.
4799
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004800 updatefile - Location of the software update file on a TFTP server, used
4801 by the automatic software update feature. Please refer to
4802 documentation in doc/README.update for more details.
4803
wdenk6c59edc2004-05-03 20:45:30 +00004804 autoload - if set to "no" (any string beginning with 'n'),
4805 "bootp" will just load perform a lookup of the
4806 configuration from the BOOTP server, but not try to
4807 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004808
wdenk6c59edc2004-05-03 20:45:30 +00004809 autostart - if set to "yes", an image loaded using the "bootp",
4810 "rarpboot", "tftpboot" or "diskboot" commands will
4811 be automatically started (by internally calling
4812 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004813
wdenk6c59edc2004-05-03 20:45:30 +00004814 If set to "no", a standalone image passed to the
4815 "bootm" command will be copied to the load address
4816 (and eventually uncompressed), but NOT be started.
4817 This can be used to load and uncompress arbitrary
4818 data.
wdenkc6097192002-11-03 00:24:07 +00004819
David A. Longd558a4e2011-07-09 16:40:19 -04004820 fdt_high - if set this restricts the maximum address that the
4821 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004822 For example, if you have a system with 1 GB memory
4823 at physical address 0x10000000, while Linux kernel
4824 only recognizes the first 704 MB as low memory, you
4825 may need to set fdt_high as 0x3C000000 to have the
4826 device tree blob be copied to the maximum address
4827 of the 704 MB low memory, so that Linux kernel can
4828 access it during the boot procedure.
4829
David A. Longd558a4e2011-07-09 16:40:19 -04004830 If this is set to the special value 0xFFFFFFFF then
4831 the fdt will not be copied at all on boot. For this
4832 to work it must reside in writable memory, have
4833 sufficient padding on the end of it for u-boot to
4834 add the information it needs into it, and the memory
4835 must be accessible by the kernel.
4836
Simon Glassdc6fa642011-10-24 19:15:34 +00004837 fdtcontroladdr- if set this is the address of the control flattened
4838 device tree used by U-Boot when CONFIG_OF_CONTROL is
4839 defined.
4840
wdenk0e2bd9c2004-06-06 21:51:03 +00004841 i2cfast - (PPC405GP|PPC405EP only)
4842 if set to 'y' configures Linux I2C driver for fast
4843 mode (400kHZ). This environment variable is used in
4844 initialization code. So, for changes to be effective
4845 it must be saved and board must be reset.
4846
wdenk6c59edc2004-05-03 20:45:30 +00004847 initrd_high - restrict positioning of initrd images:
4848 If this variable is not set, initrd images will be
4849 copied to the highest possible address in RAM; this
4850 is usually what you want since it allows for
4851 maximum initrd size. If for some reason you want to
4852 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004853 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004854 variable to a value of "no" or "off" or "0".
4855 Alternatively, you can set it to a maximum upper
4856 address to use (U-Boot will still check that it
4857 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004858
wdenk6c59edc2004-05-03 20:45:30 +00004859 For instance, when you have a system with 16 MB
4860 RAM, and want to reserve 4 MB from use by Linux,
4861 you can do this by adding "mem=12M" to the value of
4862 the "bootargs" variable. However, now you must make
4863 sure that the initrd image is placed in the first
4864 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004865
wdenk6c59edc2004-05-03 20:45:30 +00004866 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004867
wdenk6c59edc2004-05-03 20:45:30 +00004868 If you set initrd_high to 0xFFFFFFFF, this is an
4869 indication to U-Boot that all addresses are legal
4870 for the Linux kernel, including addresses in flash
4871 memory. In this case U-Boot will NOT COPY the
4872 ramdisk at all. This may be useful to reduce the
4873 boot time on your system, but requires that this
4874 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004875
wdenk6c59edc2004-05-03 20:45:30 +00004876 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004877
wdenk6c59edc2004-05-03 20:45:30 +00004878 loadaddr - Default load address for commands like "bootp",
4879 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004880
wdenk6c59edc2004-05-03 20:45:30 +00004881 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004882
wdenk6c59edc2004-05-03 20:45:30 +00004883 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004884
wdenk6c59edc2004-05-03 20:45:30 +00004885 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004886
wdenk6c59edc2004-05-03 20:45:30 +00004887 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk6c59edc2004-05-03 20:45:30 +00004889 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004890
Mike Frysingera23230c2011-10-02 10:01:27 +00004891 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004892
Mike Frysingera23230c2011-10-02 10:01:27 +00004893 ethact - controls which interface is currently active.
4894 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004895
Heiko Schocherc5e84052010-07-20 17:45:02 +02004896 => setenv ethact FEC
4897 => ping 192.168.0.1 # traffic sent on FEC
4898 => setenv ethact SCC
4899 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004900
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004901 ethrotate - When set to "no" U-Boot does not go through all
4902 available network interfaces.
4903 It just stays at the currently selected interface.
4904
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004905 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004906 either succeed or fail without retrying.
4907 When set to "once" the network operation will
4908 fail when all the available network interfaces
4909 are tried once without success.
4910 Useful on scripts which control the retry operation
4911 themselves.
wdenkc6097192002-11-03 00:24:07 +00004912
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004913 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004914
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004915 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004916 changing the console to be empty. If "yes" it will be
4917 made silent. If "no" it will not be made silent. If
4918 unset, then it will be made silent if the U-Boot console
4919 is silent.
4920
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004921 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004922 UDP source port.
4923
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004924 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004925 destination port instead of the Well Know Port 69.
4926
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004927 tftpblocksize - Block size to use for TFTP transfers; if not set,
4928 we use the TFTP server's default block size
4929
4930 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4931 seconds, minimum value is 1000 = 1 second). Defines
4932 when a packet is considered to be lost so it has to
4933 be retransmitted. The default is 5000 = 5 seconds.
4934 Lowering this value may make downloads succeed
4935 faster in networks with high packet loss rates or
4936 with unreliable TFTP servers.
4937
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004938 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4939 unit, minimum value = 0). Defines how many timeouts
4940 can happen during a single file transfer before that
4941 transfer is aborted. The default is 10, and 0 means
4942 'no timeouts allowed'. Increasing this value may help
4943 downloads succeed with high packet loss rates, or with
4944 unreliable TFTP servers or client hardware.
4945
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004946 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004947 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004948 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004949
Alexandre Messier15971322016-02-01 17:08:57 -05004950 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4951 Unsigned value, in milliseconds. If not set, the period will
4952 be either the default (28000), or a value based on
4953 CONFIG_NET_RETRY_COUNT, if defined. This value has
4954 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4955
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004956The following image location variables contain the location of images
4957used in booting. The "Image" column gives the role of the image and is
4958not an environment variable name. The other columns are environment
4959variable names. "File Name" gives the name of the file on a TFTP
4960server, "RAM Address" gives the location in RAM the image will be
4961loaded to, and "Flash Location" gives the image's address in NOR
4962flash or offset in NAND flash.
4963
4964*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004965boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004966boards use these variables for other purposes.
4967
Wolfgang Denk092ae952011-10-26 10:21:21 +00004968Image File Name RAM Address Flash Location
4969----- --------- ----------- --------------
4970u-boot u-boot u-boot_addr_r u-boot_addr
4971Linux kernel bootfile kernel_addr_r kernel_addr
4972device tree blob fdtfile fdt_addr_r fdt_addr
4973ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004974
wdenk6c59edc2004-05-03 20:45:30 +00004975The following environment variables may be used and automatically
4976updated by the network boot commands ("bootp" and "rarpboot"),
4977depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004978
wdenk6c59edc2004-05-03 20:45:30 +00004979 bootfile - see above
4980 dnsip - IP address of your Domain Name Server
4981 dnsip2 - IP address of your secondary Domain Name Server
4982 gatewayip - IP address of the Gateway (Router) to use
4983 hostname - Target hostname
4984 ipaddr - see above
4985 netmask - Subnet Mask
4986 rootpath - Pathname of the root filesystem on the NFS server
4987 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004988
wdenk145d2c12004-04-15 21:48:45 +00004989
wdenk6c59edc2004-05-03 20:45:30 +00004990There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004991
wdenk6c59edc2004-05-03 20:45:30 +00004992 serial# - contains hardware identification information such
4993 as type string and/or serial number
4994 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004995
wdenk6c59edc2004-05-03 20:45:30 +00004996These variables can be set only once (usually during manufacturing of
4997the board). U-Boot refuses to delete or overwrite these variables
4998once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004999
5000
wdenk6c59edc2004-05-03 20:45:30 +00005001Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005002
wdenk6c59edc2004-05-03 20:45:30 +00005003 ver - Contains the U-Boot version string as printed
5004 with the "version" command. This variable is
5005 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005006
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +00005008Please note that changes to some configuration parameters may take
5009only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005010
stroeseb9c17c52003-04-04 15:53:41 +00005011
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005012Callback functions for environment variables:
5013---------------------------------------------
5014
5015For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005016when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005017be associated with arbitrary variables. On creation, overwrite, or
5018deletion, the callback will provide the opportunity for some side
5019effect to happen or for the change to be rejected.
5020
5021The callbacks are named and associated with a function using the
5022U_BOOT_ENV_CALLBACK macro in your board or driver code.
5023
5024These callbacks are associated with variables in one of two ways. The
5025static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5026in the board configuration to a string that defines a list of
5027associations. The list must be in the following format:
5028
5029 entry = variable_name[:callback_name]
5030 list = entry[,list]
5031
5032If the callback name is not specified, then the callback is deleted.
5033Spaces are also allowed anywhere in the list.
5034
5035Callbacks can also be associated by defining the ".callbacks" variable
5036with the same list format above. Any association in ".callbacks" will
5037override any association in the static list. You can define
5038CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005039".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005040
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005041If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5042regular expression. This allows multiple variables to be connected to
5043the same callback without explicitly listing them all out.
5044
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005045
wdenk6c59edc2004-05-03 20:45:30 +00005046Command Line Parsing:
5047=====================
stroeseb9c17c52003-04-04 15:53:41 +00005048
wdenk6c59edc2004-05-03 20:45:30 +00005049There are two different command line parsers available with U-Boot:
5050the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005051
wdenk6c59edc2004-05-03 20:45:30 +00005052Old, simple command line parser:
5053--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005054
wdenk6c59edc2004-05-03 20:45:30 +00005055- supports environment variables (through setenv / saveenv commands)
5056- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005057- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005058- special characters ('$', ';') can be escaped by prefixing with '\',
5059 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005060 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005061- You can also escape text by enclosing in single apostrophes, for example:
5062 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005063
wdenk6c59edc2004-05-03 20:45:30 +00005064Hush shell:
5065-----------
wdenkf4688a22003-05-28 08:06:31 +00005066
wdenk6c59edc2004-05-03 20:45:30 +00005067- similar to Bourne shell, with control structures like
5068 if...then...else...fi, for...do...done; while...do...done,
5069 until...do...done, ...
5070- supports environment ("global") variables (through setenv / saveenv
5071 commands) and local shell variables (through standard shell syntax
5072 "name=value"); only environment variables can be used with "run"
5073 command
wdenkf4688a22003-05-28 08:06:31 +00005074
wdenk6c59edc2004-05-03 20:45:30 +00005075General rules:
5076--------------
wdenkf4688a22003-05-28 08:06:31 +00005077
wdenk6c59edc2004-05-03 20:45:30 +00005078(1) If a command line (or an environment variable executed by a "run"
5079 command) contains several commands separated by semicolon, and
5080 one of these commands fails, then the remaining commands will be
5081 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005082
wdenk6c59edc2004-05-03 20:45:30 +00005083(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005084 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005085 command will cause "run" to terminate, i. e. the remaining
5086 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005087
wdenk6c59edc2004-05-03 20:45:30 +00005088Note for Redundant Ethernet Interfaces:
5089=======================================
wdenkf4688a22003-05-28 08:06:31 +00005090
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005091Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005092such configurations and is capable of automatic selection of a
5093"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005094
wdenk6c59edc2004-05-03 20:45:30 +00005095Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5096MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5097"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005098
wdenk6c59edc2004-05-03 20:45:30 +00005099If the network interface stores some valid MAC address (for instance
5100in SROM), this is used as default address if there is NO correspon-
5101ding setting in the environment; if the corresponding environment
5102variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005103
wdenk6c59edc2004-05-03 20:45:30 +00005104o If the SROM has a valid MAC address, and there is no address in the
5105 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005106
wdenk6c59edc2004-05-03 20:45:30 +00005107o If there is no valid address in the SROM, and a definition in the
5108 environment exists, then the value from the environment variable is
5109 used.
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111o If both the SROM and the environment contain a MAC address, and
5112 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005113
wdenk6c59edc2004-05-03 20:45:30 +00005114o If both the SROM and the environment contain a MAC address, and the
5115 addresses differ, the value from the environment is used and a
5116 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk6c59edc2004-05-03 20:45:30 +00005118o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005119 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5120 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005121
Ben Warren6db991a2010-04-26 11:11:46 -07005122If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005123will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005124may be skipped by setting the appropriate 'ethmacskip' environment variable.
5125The naming convention is as follows:
5126"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005127
wdenk6c59edc2004-05-03 20:45:30 +00005128Image Formats:
5129==============
wdenkc6097192002-11-03 00:24:07 +00005130
Marian Balakowicz18710b82008-03-12 12:13:13 +01005131U-Boot is capable of booting (and performing other auxiliary operations on)
5132images in two formats:
5133
5134New uImage format (FIT)
5135-----------------------
5136
5137Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5138to Flattened Device Tree). It allows the use of images with multiple
5139components (several kernels, ramdisks, etc.), with contents protected by
5140SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5141
5142
5143Old uImage format
5144-----------------
5145
5146Old image format is based on binary files which can be basically anything,
5147preceded by a special header; see the definitions in include/image.h for
5148details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005149
wdenk6c59edc2004-05-03 20:45:30 +00005150* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5151 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005152 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5153 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5154 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005155* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005156 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5157 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005158* Compression Type (uncompressed, gzip, bzip2)
5159* Load Address
5160* Entry Point
5161* Image Name
5162* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk6c59edc2004-05-03 20:45:30 +00005164The header is marked by a special Magic Number, and both the header
5165and the data portions of the image are secured against corruption by
5166CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005167
wdenkc6097192002-11-03 00:24:07 +00005168
wdenk6c59edc2004-05-03 20:45:30 +00005169Linux Support:
5170==============
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk6c59edc2004-05-03 20:45:30 +00005172Although U-Boot should support any OS or standalone application
5173easily, the main focus has always been on Linux during the design of
5174U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk6c59edc2004-05-03 20:45:30 +00005176U-Boot includes many features that so far have been part of some
5177special "boot loader" code within the Linux kernel. Also, any
5178"initrd" images to be used are no longer part of one big Linux image;
5179instead, kernel and "initrd" are separate images. This implementation
5180serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk6c59edc2004-05-03 20:45:30 +00005182- the same features can be used for other OS or standalone
5183 applications (for instance: using compressed images to reduce the
5184 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005185
wdenk6c59edc2004-05-03 20:45:30 +00005186- it becomes much easier to port new Linux kernel versions because
5187 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk6c59edc2004-05-03 20:45:30 +00005189- the same Linux kernel image can now be used with different "initrd"
5190 images; of course this also means that different kernel images can
5191 be run with the same "initrd". This makes testing easier (you don't
5192 have to build a new "zImage.initrd" Linux image when you just
5193 change a file in your "initrd"). Also, a field-upgrade of the
5194 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005195
wdenkc6097192002-11-03 00:24:07 +00005196
wdenk6c59edc2004-05-03 20:45:30 +00005197Linux HOWTO:
5198============
wdenkc6097192002-11-03 00:24:07 +00005199
wdenk6c59edc2004-05-03 20:45:30 +00005200Porting Linux to U-Boot based systems:
5201---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005202
wdenk6c59edc2004-05-03 20:45:30 +00005203U-Boot cannot save you from doing all the necessary modifications to
5204configure the Linux device drivers for use with your target hardware
5205(no, we don't intend to provide a full virtual machine interface to
5206Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005207
Stefan Roese88fbf932010-04-15 16:07:28 +02005208But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk6c59edc2004-05-03 20:45:30 +00005210Just make sure your machine specific header file (for instance
5211include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005212Information structure as we define in include/asm-<arch>/u-boot.h,
5213and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005214as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005215
Simon Glassd097e592014-06-11 23:29:46 -06005216Note that U-Boot now has a driver model, a unified model for drivers.
5217If you are adding a new driver, plumb it into driver model. If there
5218is no uclass available, you are encouraged to create one. See
5219doc/driver-model.
5220
wdenkc6097192002-11-03 00:24:07 +00005221
wdenk6c59edc2004-05-03 20:45:30 +00005222Configuring the Linux kernel:
5223-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005224
wdenk6c59edc2004-05-03 20:45:30 +00005225No specific requirements for U-Boot. Make sure you have some root
5226device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005227
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk6c59edc2004-05-03 20:45:30 +00005229Building a Linux Image:
5230-----------------------
wdenkc6097192002-11-03 00:24:07 +00005231
wdenk6c59edc2004-05-03 20:45:30 +00005232With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5233not used. If you use recent kernel source, a new build target
5234"uImage" will exist which automatically builds an image usable by
5235U-Boot. Most older kernels also have support for a "pImage" target,
5236which was introduced for our predecessor project PPCBoot and uses a
5237100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005238
wdenk6c59edc2004-05-03 20:45:30 +00005239Example:
wdenkc6097192002-11-03 00:24:07 +00005240
Holger Freyther7ba4e572014-08-04 09:26:05 +02005241 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005242 make oldconfig
5243 make dep
5244 make uImage
wdenkc6097192002-11-03 00:24:07 +00005245
wdenk6c59edc2004-05-03 20:45:30 +00005246The "uImage" build target uses a special tool (in 'tools/mkimage') to
5247encapsulate a compressed Linux kernel image with header information,
5248CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005249
wdenk6c59edc2004-05-03 20:45:30 +00005250* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005251
wdenk6c59edc2004-05-03 20:45:30 +00005252* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005253
wdenk6c59edc2004-05-03 20:45:30 +00005254 ${CROSS_COMPILE}-objcopy -O binary \
5255 -R .note -R .comment \
5256 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005257
wdenk6c59edc2004-05-03 20:45:30 +00005258* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005259
wdenk6c59edc2004-05-03 20:45:30 +00005260 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005261
wdenk6c59edc2004-05-03 20:45:30 +00005262* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005263
wdenk6c59edc2004-05-03 20:45:30 +00005264 mkimage -A ppc -O linux -T kernel -C gzip \
5265 -a 0 -e 0 -n "Linux Kernel Image" \
5266 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005267
wdenkc6097192002-11-03 00:24:07 +00005268
wdenk6c59edc2004-05-03 20:45:30 +00005269The "mkimage" tool can also be used to create ramdisk images for use
5270with U-Boot, either separated from the Linux kernel image, or
5271combined into one file. "mkimage" encapsulates the images with a 64
5272byte header containing information about target architecture,
5273operating system, image type, compression method, entry points, time
5274stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276"mkimage" can be called in two ways: to verify existing images and
5277print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279In the first form (with "-l" option) mkimage lists the information
5280contained in the header of an existing U-Boot image; this includes
5281checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005282
wdenk6c59edc2004-05-03 20:45:30 +00005283 tools/mkimage -l image
5284 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005285
wdenk6c59edc2004-05-03 20:45:30 +00005286The second form (with "-d" option) is used to build a U-Boot image
5287from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005288
wdenk6c59edc2004-05-03 20:45:30 +00005289 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5290 -n name -d data_file image
5291 -A ==> set architecture to 'arch'
5292 -O ==> set operating system to 'os'
5293 -T ==> set image type to 'type'
5294 -C ==> set compression type 'comp'
5295 -a ==> set load address to 'addr' (hex)
5296 -e ==> set entry point to 'ep' (hex)
5297 -n ==> set image name to 'name'
5298 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005299
wdenkcd914452004-05-29 16:53:29 +00005300Right now, all Linux kernels for PowerPC systems use the same load
5301address (0x00000000), but the entry point address depends on the
5302kernel version:
wdenkc6097192002-11-03 00:24:07 +00005303
wdenk6c59edc2004-05-03 20:45:30 +00005304- 2.2.x kernels have the entry point at 0x0000000C,
5305- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk6c59edc2004-05-03 20:45:30 +00005307So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005308
wdenk6c59edc2004-05-03 20:45:30 +00005309 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5310 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005311 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005312 > examples/uImage.TQM850L
5313 Image Name: 2.4.4 kernel for TQM850L
5314 Created: Wed Jul 19 02:34:59 2000
5315 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5316 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5317 Load Address: 0x00000000
5318 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk6c59edc2004-05-03 20:45:30 +00005320To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005321
wdenk6c59edc2004-05-03 20:45:30 +00005322 -> tools/mkimage -l examples/uImage.TQM850L
5323 Image Name: 2.4.4 kernel for TQM850L
5324 Created: Wed Jul 19 02:34:59 2000
5325 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5326 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5327 Load Address: 0x00000000
5328 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330NOTE: for embedded systems where boot time is critical you can trade
5331speed for memory and install an UNCOMPRESSED image instead: this
5332needs more space in Flash, but boots much faster since it does not
5333need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005334
Stefan Roese88fbf932010-04-15 16:07:28 +02005335 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005336 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5337 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005338 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005339 > examples/uImage.TQM850L-uncompressed
5340 Image Name: 2.4.4 kernel for TQM850L
5341 Created: Wed Jul 19 02:34:59 2000
5342 Image Type: PowerPC Linux Kernel Image (uncompressed)
5343 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5344 Load Address: 0x00000000
5345 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005346
wdenkc6097192002-11-03 00:24:07 +00005347
wdenk6c59edc2004-05-03 20:45:30 +00005348Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5349when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351 -> tools/mkimage -n 'Simple Ramdisk Image' \
5352 > -A ppc -O linux -T ramdisk -C gzip \
5353 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5354 Image Name: Simple Ramdisk Image
5355 Created: Wed Jan 12 14:01:50 2000
5356 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5357 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5358 Load Address: 0x00000000
5359 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005360
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005361The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5362option performs the converse operation of the mkimage's second form (the "-d"
5363option). Given an image built by mkimage, the dumpimage extracts a "data file"
5364from the image:
5365
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005366 tools/dumpimage -i image -T type -p position data_file
5367 -i ==> extract from the 'image' a specific 'data_file'
5368 -T ==> set image type to 'type'
5369 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005370
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk6c59edc2004-05-03 20:45:30 +00005372Installing a Linux Image:
5373-------------------------
wdenkc6097192002-11-03 00:24:07 +00005374
wdenk6c59edc2004-05-03 20:45:30 +00005375To downloading a U-Boot image over the serial (console) interface,
5376you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk6c59edc2004-05-03 20:45:30 +00005378 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005379
wdenk6c59edc2004-05-03 20:45:30 +00005380The 'objcopy' does not understand the information in the U-Boot
5381image header, so the resulting S-Record file will be relative to
5382address 0x00000000. To load it to a given address, you need to
5383specify the target address as 'offset' parameter with the 'loads'
5384command.
wdenkc6097192002-11-03 00:24:07 +00005385
wdenk6c59edc2004-05-03 20:45:30 +00005386Example: install the image to address 0x40100000 (which on the
5387TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005388
wdenk6c59edc2004-05-03 20:45:30 +00005389 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005390
wdenk6c59edc2004-05-03 20:45:30 +00005391 .......... done
5392 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394 => loads 40100000
5395 ## Ready for S-Record download ...
5396 ~>examples/image.srec
5397 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5398 ...
5399 15989 15990 15991 15992
5400 [file transfer complete]
5401 [connected]
5402 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005403
wdenkc6097192002-11-03 00:24:07 +00005404
wdenk6c59edc2004-05-03 20:45:30 +00005405You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005406this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005407corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005408
wdenk6c59edc2004-05-03 20:45:30 +00005409 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005410
wdenk6c59edc2004-05-03 20:45:30 +00005411 ## Checking Image at 40100000 ...
5412 Image Name: 2.2.13 for initrd on TQM850L
5413 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5414 Data Size: 335725 Bytes = 327 kB = 0 MB
5415 Load Address: 00000000
5416 Entry Point: 0000000c
5417 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005418
5419
wdenk6c59edc2004-05-03 20:45:30 +00005420Boot Linux:
5421-----------
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk6c59edc2004-05-03 20:45:30 +00005423The "bootm" command is used to boot an application that is stored in
5424memory (RAM or Flash). In case of a Linux kernel image, the contents
5425of the "bootargs" environment variable is passed to the kernel as
5426parameters. You can check and modify this variable using the
5427"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005428
wdenkc6097192002-11-03 00:24:07 +00005429
wdenk6c59edc2004-05-03 20:45:30 +00005430 => printenv bootargs
5431 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk6c59edc2004-05-03 20:45:30 +00005433 => 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 +00005434
wdenk6c59edc2004-05-03 20:45:30 +00005435 => printenv bootargs
5436 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 +00005437
wdenk6c59edc2004-05-03 20:45:30 +00005438 => bootm 40020000
5439 ## Booting Linux kernel at 40020000 ...
5440 Image Name: 2.2.13 for NFS on TQM850L
5441 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5442 Data Size: 381681 Bytes = 372 kB = 0 MB
5443 Load Address: 00000000
5444 Entry Point: 0000000c
5445 Verifying Checksum ... OK
5446 Uncompressing Kernel Image ... OK
5447 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
5448 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5449 time_init: decrementer frequency = 187500000/60
5450 Calibrating delay loop... 49.77 BogoMIPS
5451 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5452 ...
wdenkc6097192002-11-03 00:24:07 +00005453
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005454If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005455the memory addresses of both the kernel and the initrd image (PPBCOOT
5456format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005457
wdenk6c59edc2004-05-03 20:45:30 +00005458 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005459
wdenk6c59edc2004-05-03 20:45:30 +00005460 ## Checking Image at 40100000 ...
5461 Image Name: 2.2.13 for initrd on TQM850L
5462 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5463 Data Size: 335725 Bytes = 327 kB = 0 MB
5464 Load Address: 00000000
5465 Entry Point: 0000000c
5466 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk6c59edc2004-05-03 20:45:30 +00005468 ## Checking Image at 40200000 ...
5469 Image Name: Simple Ramdisk Image
5470 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5471 Data Size: 566530 Bytes = 553 kB = 0 MB
5472 Load Address: 00000000
5473 Entry Point: 00000000
5474 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005475
wdenk6c59edc2004-05-03 20:45:30 +00005476 => bootm 40100000 40200000
5477 ## Booting Linux kernel at 40100000 ...
5478 Image Name: 2.2.13 for initrd on TQM850L
5479 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5480 Data Size: 335725 Bytes = 327 kB = 0 MB
5481 Load Address: 00000000
5482 Entry Point: 0000000c
5483 Verifying Checksum ... OK
5484 Uncompressing Kernel Image ... OK
5485 ## Loading RAMDisk Image at 40200000 ...
5486 Image Name: Simple Ramdisk Image
5487 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5488 Data Size: 566530 Bytes = 553 kB = 0 MB
5489 Load Address: 00000000
5490 Entry Point: 00000000
5491 Verifying Checksum ... OK
5492 Loading Ramdisk ... OK
5493 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
5494 Boot arguments: root=/dev/ram
5495 time_init: decrementer frequency = 187500000/60
5496 Calibrating delay loop... 49.77 BogoMIPS
5497 ...
5498 RAMDISK: Compressed image found at block 0
5499 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005500
wdenk6c59edc2004-05-03 20:45:30 +00005501 bash#
wdenkc6097192002-11-03 00:24:07 +00005502
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005503Boot Linux and pass a flat device tree:
5504-----------
5505
5506First, U-Boot must be compiled with the appropriate defines. See the section
5507titled "Linux Kernel Interface" above for a more in depth explanation. The
5508following is an example of how to start a kernel and pass an updated
5509flat device tree:
5510
5511=> print oftaddr
5512oftaddr=0x300000
5513=> print oft
5514oft=oftrees/mpc8540ads.dtb
5515=> tftp $oftaddr $oft
5516Speed: 1000, full duplex
5517Using TSEC0 device
5518TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5519Filename 'oftrees/mpc8540ads.dtb'.
5520Load address: 0x300000
5521Loading: #
5522done
5523Bytes transferred = 4106 (100a hex)
5524=> tftp $loadaddr $bootfile
5525Speed: 1000, full duplex
5526Using TSEC0 device
5527TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5528Filename 'uImage'.
5529Load address: 0x200000
5530Loading:############
5531done
5532Bytes transferred = 1029407 (fb51f hex)
5533=> print loadaddr
5534loadaddr=200000
5535=> print oftaddr
5536oftaddr=0x300000
5537=> bootm $loadaddr - $oftaddr
5538## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005539 Image Name: Linux-2.6.17-dirty
5540 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5541 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005542 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005543 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005544 Verifying Checksum ... OK
5545 Uncompressing Kernel Image ... OK
5546Booting using flat device tree at 0x300000
5547Using MPC85xx ADS machine description
5548Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5549[snip]
5550
5551
wdenk6c59edc2004-05-03 20:45:30 +00005552More About U-Boot Image Types:
5553------------------------------
wdenkc6097192002-11-03 00:24:07 +00005554
wdenk6c59edc2004-05-03 20:45:30 +00005555U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005556
wdenk6c59edc2004-05-03 20:45:30 +00005557 "Standalone Programs" are directly runnable in the environment
5558 provided by U-Boot; it is expected that (if they behave
5559 well) you can continue to work in U-Boot after return from
5560 the Standalone Program.
5561 "OS Kernel Images" are usually images of some Embedded OS which
5562 will take over control completely. Usually these programs
5563 will install their own set of exception handlers, device
5564 drivers, set up the MMU, etc. - this means, that you cannot
5565 expect to re-enter U-Boot except by resetting the CPU.
5566 "RAMDisk Images" are more or less just data blocks, and their
5567 parameters (address, size) are passed to an OS kernel that is
5568 being started.
5569 "Multi-File Images" contain several images, typically an OS
5570 (Linux) kernel image and one or more data images like
5571 RAMDisks. This construct is useful for instance when you want
5572 to boot over the network using BOOTP etc., where the boot
5573 server provides just a single image file, but you want to get
5574 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005575
wdenk6c59edc2004-05-03 20:45:30 +00005576 "Multi-File Images" start with a list of image sizes, each
5577 image size (in bytes) specified by an "uint32_t" in network
5578 byte order. This list is terminated by an "(uint32_t)0".
5579 Immediately after the terminating 0 follow the images, one by
5580 one, all aligned on "uint32_t" boundaries (size rounded up to
5581 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk6c59edc2004-05-03 20:45:30 +00005583 "Firmware Images" are binary images containing firmware (like
5584 U-Boot or FPGA images) which usually will be programmed to
5585 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005586
wdenk6c59edc2004-05-03 20:45:30 +00005587 "Script files" are command sequences that will be executed by
5588 U-Boot's command interpreter; this feature is especially
5589 useful when you configure U-Boot to use a real shell (hush)
5590 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005591
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005592Booting the Linux zImage:
5593-------------------------
5594
5595On some platforms, it's possible to boot Linux zImage. This is done
5596using the "bootz" command. The syntax of "bootz" command is the same
5597as the syntax of "bootm" command.
5598
Tom Rini45f46d12013-05-16 11:40:11 -04005599Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005600kernel with raw initrd images. The syntax is slightly different, the
5601address of the initrd must be augmented by it's size, in the following
5602format: "<initrd addres>:<initrd size>".
5603
stroeseb9c17c52003-04-04 15:53:41 +00005604
wdenk6c59edc2004-05-03 20:45:30 +00005605Standalone HOWTO:
5606=================
stroeseb9c17c52003-04-04 15:53:41 +00005607
wdenk6c59edc2004-05-03 20:45:30 +00005608One of the features of U-Boot is that you can dynamically load and
5609run "standalone" applications, which can use some resources of
5610U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005611
wdenk6c59edc2004-05-03 20:45:30 +00005612Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005613
wdenk6c59edc2004-05-03 20:45:30 +00005614"Hello World" Demo:
5615-------------------
wdenkc6097192002-11-03 00:24:07 +00005616
wdenk6c59edc2004-05-03 20:45:30 +00005617'examples/hello_world.c' contains a small "Hello World" Demo
5618application; it is automatically compiled when you build U-Boot.
5619It's configured to run at address 0x00040004, so you can play with it
5620like that:
wdenkc6097192002-11-03 00:24:07 +00005621
wdenk6c59edc2004-05-03 20:45:30 +00005622 => loads
5623 ## Ready for S-Record download ...
5624 ~>examples/hello_world.srec
5625 1 2 3 4 5 6 7 8 9 10 11 ...
5626 [file transfer complete]
5627 [connected]
5628 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005629
wdenk6c59edc2004-05-03 20:45:30 +00005630 => go 40004 Hello World! This is a test.
5631 ## Starting application at 0x00040004 ...
5632 Hello World
5633 argc = 7
5634 argv[0] = "40004"
5635 argv[1] = "Hello"
5636 argv[2] = "World!"
5637 argv[3] = "This"
5638 argv[4] = "is"
5639 argv[5] = "a"
5640 argv[6] = "test."
5641 argv[7] = "<NULL>"
5642 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk6c59edc2004-05-03 20:45:30 +00005644 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005645
wdenk6c59edc2004-05-03 20:45:30 +00005646Another example, which demonstrates how to register a CPM interrupt
5647handler with the U-Boot code, can be found in 'examples/timer.c'.
5648Here, a CPM timer is set up to generate an interrupt every second.
5649The interrupt service routine is trivial, just printing a '.'
5650character, but this is just a demo program. The application can be
5651controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk6c59edc2004-05-03 20:45:30 +00005653 ? - print current values og the CPM Timer registers
5654 b - enable interrupts and start timer
5655 e - stop timer and disable interrupts
5656 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk6c59edc2004-05-03 20:45:30 +00005658 => loads
5659 ## Ready for S-Record download ...
5660 ~>examples/timer.srec
5661 1 2 3 4 5 6 7 8 9 10 11 ...
5662 [file transfer complete]
5663 [connected]
5664 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005665
wdenk6c59edc2004-05-03 20:45:30 +00005666 => go 40004
5667 ## Starting application at 0x00040004 ...
5668 TIMERS=0xfff00980
5669 Using timer 1
5670 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk6c59edc2004-05-03 20:45:30 +00005672Hit 'b':
5673 [q, b, e, ?] Set interval 1000000 us
5674 Enabling timer
5675Hit '?':
5676 [q, b, e, ?] ........
5677 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5678Hit '?':
5679 [q, b, e, ?] .
5680 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5681Hit '?':
5682 [q, b, e, ?] .
5683 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5684Hit '?':
5685 [q, b, e, ?] .
5686 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5687Hit 'e':
5688 [q, b, e, ?] ...Stopping timer
5689Hit 'q':
5690 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005691
wdenkc6097192002-11-03 00:24:07 +00005692
wdenk6c59edc2004-05-03 20:45:30 +00005693Minicom warning:
5694================
wdenkc6097192002-11-03 00:24:07 +00005695
wdenk6c59edc2004-05-03 20:45:30 +00005696Over time, many people have reported problems when trying to use the
5697"minicom" terminal emulation program for serial download. I (wd)
5698consider minicom to be broken, and recommend not to use it. Under
5699Unix, I recommend to use C-Kermit for general purpose use (and
5700especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005701use "cu" for S-Record download ("loads" command). See
5702http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5703for help with kermit.
5704
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706Nevertheless, if you absolutely want to use it try adding this
5707configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005708
wdenk6c59edc2004-05-03 20:45:30 +00005709 Name Program Name U/D FullScr IO-Red. Multi
5710 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5711 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005712
wdenk8dba0502003-03-31 16:34:49 +00005713
wdenk6c59edc2004-05-03 20:45:30 +00005714NetBSD Notes:
5715=============
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk6c59edc2004-05-03 20:45:30 +00005717Starting at version 0.9.2, U-Boot supports NetBSD both as host
5718(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005719
wdenk6c59edc2004-05-03 20:45:30 +00005720Building requires a cross environment; it is known to work on
5721NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5722need gmake since the Makefiles are not compatible with BSD make).
5723Note that the cross-powerpc package does not install include files;
5724attempting to build U-Boot will fail because <machine/ansi.h> is
5725missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727 # cd /usr/pkg/cross/powerpc-netbsd/include
5728 # mkdir powerpc
5729 # ln -s powerpc machine
5730 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5731 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005732
wdenk6c59edc2004-05-03 20:45:30 +00005733Native builds *don't* work due to incompatibilities between native
5734and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk6c59edc2004-05-03 20:45:30 +00005736Booting assumes that (the first part of) the image booted is a
5737stage-2 loader which in turn loads and then invokes the kernel
5738proper. Loader sources will eventually appear in the NetBSD source
5739tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005740meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005741
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk6c59edc2004-05-03 20:45:30 +00005743Implementation Internals:
5744=========================
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk6c59edc2004-05-03 20:45:30 +00005746The following is not intended to be a complete description of every
5747implementation detail. However, it should help to understand the
5748inner workings of U-Boot and make it easier to port it to custom
5749hardware.
wdenkc6097192002-11-03 00:24:07 +00005750
wdenkc6097192002-11-03 00:24:07 +00005751
wdenk6c59edc2004-05-03 20:45:30 +00005752Initial Stack, Global Data:
5753---------------------------
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk6c59edc2004-05-03 20:45:30 +00005755The implementation of U-Boot is complicated by the fact that U-Boot
5756starts running out of ROM (flash memory), usually without access to
5757system RAM (because the memory controller is not initialized yet).
5758This means that we don't have writable Data or BSS segments, and BSS
5759is not initialized as zero. To be able to get a C environment working
5760at all, we have to allocate at least a minimal stack. Implementation
5761options for this are defined and restricted by the CPU used: Some CPU
5762models provide on-chip memory (like the IMMR area on MPC8xx and
5763MPC826x processors), on others (parts of) the data cache can be
5764locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005765
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005766 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005767 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5770 From: "Chris Hallinan" <clh@net1plus.com>
5771 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5772 ...
wdenkc6097192002-11-03 00:24:07 +00005773
wdenk6c59edc2004-05-03 20:45:30 +00005774 Correct me if I'm wrong, folks, but the way I understand it
5775 is this: Using DCACHE as initial RAM for Stack, etc, does not
5776 require any physical RAM backing up the cache. The cleverness
5777 is that the cache is being used as a temporary supply of
5778 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005779 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005780 can see how this works by studying the cache architecture and
5781 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005782
wdenk6c59edc2004-05-03 20:45:30 +00005783 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5784 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005785 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005786 option should work for you. Using CS 4 should be fine if your
5787 board designers haven't used it for something that would
5788 cause you grief during the initial boot! It is frequently not
5789 used.
wdenkc6097192002-11-03 00:24:07 +00005790
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005791 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005792 with your processor/board/system design. The default value
5793 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005794 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005795 than your SDRAM module. If you have a 64MB SDRAM module, set
5796 it above 400_0000. Just make sure your board has no resources
5797 that are supposed to respond to that address! That code in
5798 start.S has been around a while and should work as is when
5799 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005800
wdenk6c59edc2004-05-03 20:45:30 +00005801 -Chris Hallinan
5802 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005803
wdenk6c59edc2004-05-03 20:45:30 +00005804It is essential to remember this, since it has some impact on the C
5805code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005806
wdenk6c59edc2004-05-03 20:45:30 +00005807* Initialized global data (data segment) is read-only. Do not attempt
5808 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005809
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005810* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005811 as zero data - BSS segment) at all - this is undefined, initiali-
5812 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814* Stack space is very limited. Avoid big data buffers or things like
5815 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005816
wdenk6c59edc2004-05-03 20:45:30 +00005817Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005818normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005819turned out that the implementation of U-Boot can be greatly
5820simplified by making a global data structure (gd_t) available to all
5821functions. We could pass a pointer to this data as argument to _all_
5822functions, but this would bloat the code. Instead we use a feature of
5823the GCC compiler (Global Register Variables) to share the data: we
5824place a pointer (gd) to the global data into a register which we
5825reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005826
wdenk6c59edc2004-05-03 20:45:30 +00005827When choosing a register for such a purpose we are restricted by the
5828relevant (E)ABI specifications for the current architecture, and by
5829GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk6c59edc2004-05-03 20:45:30 +00005831For PowerPC, the following registers have specific use:
5832 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005833 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005834 R3-R4: parameter passing and return values
5835 R5-R10: parameter passing
5836 R13: small data area pointer
5837 R30: GOT pointer
5838 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005839
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005840 (U-Boot also uses R12 as internal GOT pointer. r12
5841 is a volatile register so r12 needs to be reset when
5842 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005843
Wolfgang Denk69c09642008-02-14 22:43:22 +01005844 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005845
wdenk6c59edc2004-05-03 20:45:30 +00005846 Note: on PPC, we could use a static initializer (since the
5847 address of the global data structure is known at compile time),
5848 but it turned out that reserving a register results in somewhat
5849 smaller code - although the code savings are not that big (on
5850 average for all boards 752 bytes for the whole U-Boot image,
5851 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk6c59edc2004-05-03 20:45:30 +00005853On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005854
wdenk6c59edc2004-05-03 20:45:30 +00005855 R0: function argument word/integer result
5856 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005857 R9: platform specific
5858 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005859 R11: argument (frame) pointer
5860 R12: temporary workspace
5861 R13: stack pointer
5862 R14: link register
5863 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005864
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005865 ==> U-Boot will use R9 to hold a pointer to the global data
5866
5867 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005868
Thomas Chou8fa38582010-05-21 11:08:03 +08005869On Nios II, the ABI is documented here:
5870 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5871
5872 ==> U-Boot will use gp to hold a pointer to the global data
5873
5874 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5875 to access small data sections, so gp is free.
5876
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005877On NDS32, the following registers are used:
5878
5879 R0-R1: argument/return
5880 R2-R5: argument
5881 R15: temporary register for assembler
5882 R16: trampoline register
5883 R28: frame pointer (FP)
5884 R29: global pointer (GP)
5885 R30: link register (LP)
5886 R31: stack pointer (SP)
5887 PC: program counter (PC)
5888
5889 ==> U-Boot will use R10 to hold a pointer to the global data
5890
Wolfgang Denk6405a152006-03-31 18:32:53 +02005891NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5892or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005893
wdenk6c59edc2004-05-03 20:45:30 +00005894Memory Management:
5895------------------
wdenkc6097192002-11-03 00:24:07 +00005896
wdenk6c59edc2004-05-03 20:45:30 +00005897U-Boot runs in system state and uses physical addresses, i.e. the
5898MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005899
wdenk6c59edc2004-05-03 20:45:30 +00005900The available memory is mapped to fixed addresses using the memory
5901controller. In this process, a contiguous block is formed for each
5902memory type (Flash, SDRAM, SRAM), even when it consists of several
5903physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005904
wdenk6c59edc2004-05-03 20:45:30 +00005905U-Boot is installed in the first 128 kB of the first Flash bank (on
5906TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5907booting and sizing and initializing DRAM, the code relocates itself
5908to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005909memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005910configuration setting]. Below that, a structure with global Board
5911Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005912
wdenk6c59edc2004-05-03 20:45:30 +00005913Additionally, some exception handler code is copied to the low 8 kB
5914of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005915
wdenk6c59edc2004-05-03 20:45:30 +00005916So a typical memory configuration with 16 MB of DRAM could look like
5917this:
wdenkc6097192002-11-03 00:24:07 +00005918
wdenk6c59edc2004-05-03 20:45:30 +00005919 0x0000 0000 Exception Vector code
5920 :
5921 0x0000 1FFF
5922 0x0000 2000 Free for Application Use
5923 :
5924 :
wdenkc6097192002-11-03 00:24:07 +00005925
wdenk6c59edc2004-05-03 20:45:30 +00005926 :
5927 :
5928 0x00FB FF20 Monitor Stack (Growing downward)
5929 0x00FB FFAC Board Info Data and permanent copy of global data
5930 0x00FC 0000 Malloc Arena
5931 :
5932 0x00FD FFFF
5933 0x00FE 0000 RAM Copy of Monitor Code
5934 ... eventually: LCD or video framebuffer
5935 ... eventually: pRAM (Protected RAM - unchanged by reset)
5936 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005937
wdenkc6097192002-11-03 00:24:07 +00005938
wdenk6c59edc2004-05-03 20:45:30 +00005939System Initialization:
5940----------------------
wdenkc6097192002-11-03 00:24:07 +00005941
wdenk6c59edc2004-05-03 20:45:30 +00005942In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005943(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005944configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005945To be able to re-map memory U-Boot then jumps to its link address.
5946To be able to implement the initialization code in C, a (small!)
5947initial stack is set up in the internal Dual Ported RAM (in case CPUs
5948which provide such a feature like MPC8xx or MPC8260), or in a locked
5949part of the data cache. After that, U-Boot initializes the CPU core,
5950the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005951
wdenk6c59edc2004-05-03 20:45:30 +00005952Next, all (potentially) available memory banks are mapped using a
5953preliminary mapping. For example, we put them on 512 MB boundaries
5954(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5955on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5956programmed for SDRAM access. Using the temporary configuration, a
5957simple memory test is run that determines the size of the SDRAM
5958banks.
wdenkc6097192002-11-03 00:24:07 +00005959
wdenk6c59edc2004-05-03 20:45:30 +00005960When there is more than one SDRAM bank, and the banks are of
5961different size, the largest is mapped first. For equal size, the first
5962bank (CS2#) is mapped first. The first mapping is always for address
59630x00000000, with any additional banks following immediately to create
5964contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005965
wdenk6c59edc2004-05-03 20:45:30 +00005966Then, the monitor installs itself at the upper end of the SDRAM area
5967and allocates memory for use by malloc() and for the global Board
5968Info data; also, the exception vector code is copied to the low RAM
5969pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005970
wdenk6c59edc2004-05-03 20:45:30 +00005971Only after this relocation will you have a "normal" C environment;
5972until that you are restricted in several ways, mostly because you are
5973running from ROM, and because the code will have to be relocated to a
5974new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005975
wdenkc6097192002-11-03 00:24:07 +00005976
wdenk6c59edc2004-05-03 20:45:30 +00005977U-Boot Porting Guide:
5978----------------------
wdenkc6097192002-11-03 00:24:07 +00005979
wdenk6c59edc2004-05-03 20:45:30 +00005980[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5981list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005982
wdenkc6097192002-11-03 00:24:07 +00005983
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005984int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005985{
5986 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005987
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005988 signal(SIGALRM, no_more_time);
5989 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005990
wdenk6c59edc2004-05-03 20:45:30 +00005991 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005992 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005993 return 0;
5994 }
wdenkc6097192002-11-03 00:24:07 +00005995
wdenk6c59edc2004-05-03 20:45:30 +00005996 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005997
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005998 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005999
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006000 if (clueless)
6001 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006002
wdenk6c59edc2004-05-03 20:45:30 +00006003 while (learning) {
6004 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006005 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6006 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006007 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006008 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006009 }
wdenkc6097192002-11-03 00:24:07 +00006010
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006011 if (available_money > toLocalCurrency ($2500))
6012 Buy a BDI3000;
6013 else
wdenk6c59edc2004-05-03 20:45:30 +00006014 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006015
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006016 if (a similar board exists) { /* hopefully... */
6017 cp -a board/<similar> board/<myboard>
6018 cp include/configs/<similar>.h include/configs/<myboard>.h
6019 } else {
6020 Create your own board support subdirectory;
6021 Create your own board include/configs/<myboard>.h file;
6022 }
6023 Edit new board/<myboard> files
6024 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006025
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006026 while (!accepted) {
6027 while (!running) {
6028 do {
6029 Add / modify source code;
6030 } until (compiles);
6031 Debug;
6032 if (clueless)
6033 email("Hi, I am having problems...");
6034 }
6035 Send patch file to the U-Boot email list;
6036 if (reasonable critiques)
6037 Incorporate improvements from email list code review;
6038 else
6039 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006040 }
wdenkc6097192002-11-03 00:24:07 +00006041
wdenk6c59edc2004-05-03 20:45:30 +00006042 return 0;
6043}
wdenkc6097192002-11-03 00:24:07 +00006044
wdenk6c59edc2004-05-03 20:45:30 +00006045void no_more_time (int sig)
6046{
6047 hire_a_guru();
6048}
wdenkc6097192002-11-03 00:24:07 +00006049
wdenkc6097192002-11-03 00:24:07 +00006050
wdenk6c59edc2004-05-03 20:45:30 +00006051Coding Standards:
6052-----------------
wdenkc6097192002-11-03 00:24:07 +00006053
wdenk6c59edc2004-05-03 20:45:30 +00006054All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006055coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006056"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006057
6058Source files originating from a different project (for example the
6059MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006060reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006061sources.
wdenkc6097192002-11-03 00:24:07 +00006062
Detlev Zundelaa63d482006-09-01 15:39:02 +02006063Please note that U-Boot is implemented in C (and to some small parts in
6064Assembler); no C++ is used, so please do not use C++ style comments (//)
6065in your code.
wdenkad276f22004-01-04 16:28:35 +00006066
wdenk6c59edc2004-05-03 20:45:30 +00006067Please also stick to the following formatting rules:
6068- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006069- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006070- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006071- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006072- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006073
wdenk6c59edc2004-05-03 20:45:30 +00006074Submissions which do not conform to the standards may be returned
6075with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006076
wdenkc6097192002-11-03 00:24:07 +00006077
wdenk6c59edc2004-05-03 20:45:30 +00006078Submitting Patches:
6079-------------------
wdenkc6097192002-11-03 00:24:07 +00006080
wdenk6c59edc2004-05-03 20:45:30 +00006081Since the number of patches for U-Boot is growing, we need to
6082establish some rules. Submissions which do not conform to these rules
6083may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006084
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006085Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006086
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006087Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6088see http://lists.denx.de/mailman/listinfo/u-boot
6089
wdenk6c59edc2004-05-03 20:45:30 +00006090When you send a patch, please include the following information with
6091it:
wdenkc6097192002-11-03 00:24:07 +00006092
wdenk6c59edc2004-05-03 20:45:30 +00006093* For bug fixes: a description of the bug and how your patch fixes
6094 this bug. Please try to include a way of demonstrating that the
6095 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006096
wdenk6c59edc2004-05-03 20:45:30 +00006097* For new features: a description of the feature and your
6098 implementation.
wdenkc6097192002-11-03 00:24:07 +00006099
wdenk6c59edc2004-05-03 20:45:30 +00006100* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006101
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006102* For major contributions, add a MAINTAINERS file with your
6103 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006104
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006105* When you add support for a new board, don't forget to add a
6106 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006107
wdenk6c59edc2004-05-03 20:45:30 +00006108* If your patch adds new configuration options, don't forget to
6109 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006110
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006111* The patch itself. If you are using git (which is *strongly*
6112 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006113 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006114 the U-Boot mailing list, you will avoid most of the common problems
6115 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006116
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006117 If you cannot use git, use "diff -purN OLD NEW". If your version of
6118 diff does not support these options, then get the latest version of
6119 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006120
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006121 The current directory when running this command shall be the parent
6122 directory of the U-Boot source tree (i. e. please make sure that
6123 your patch includes sufficient directory information for the
6124 affected files).
6125
6126 We prefer patches as plain text. MIME attachments are discouraged,
6127 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006128
wdenk6c59edc2004-05-03 20:45:30 +00006129* If one logical set of modifications affects or creates several
6130 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006131
wdenk6c59edc2004-05-03 20:45:30 +00006132* Changesets that contain different, unrelated modifications shall be
6133 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006134
wdenkc6097192002-11-03 00:24:07 +00006135
wdenk6c59edc2004-05-03 20:45:30 +00006136Notes:
wdenkc6097192002-11-03 00:24:07 +00006137
Simon Glassdc27def2016-07-27 20:33:08 -06006138* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006139 source tree and make sure that no errors or warnings are reported
6140 for any of the boards.
6141
6142* Keep your modifications to the necessary minimum: A patch
6143 containing several unrelated changes or arbitrary reformats will be
6144 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006145
wdenk6c59edc2004-05-03 20:45:30 +00006146* If you modify existing code, make sure that your new code does not
6147 add to the memory footprint of the code ;-) Small is beautiful!
6148 When adding new features, these should compile conditionally only
6149 (using #ifdef), and the resulting code with the new feature
6150 disabled must not need more memory than the old code without your
6151 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006152
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006153* Remember that there is a size limit of 100 kB per message on the
6154 u-boot mailing list. Bigger patches will be moderated. If they are
6155 reasonable and not too big, they will be acknowledged. But patches
6156 bigger than the size limit should be avoided.