blob: dd567df8541b94c20d99db2460e3290c932fdd3f [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denk1234ce72013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenkce4832c2004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Day974ed2f2012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser8804a612008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denkb240aef2008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day076ed9b2015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denkb240aef2008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denkb240aef2008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschin08337f32008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denkb240aef2008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Liljaf3b287b2008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
wdenkc6097192002-11-03 00:24:07 +0000112
wdenk24ee89b2002-11-03 17:56:27 +0000113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
115
wdenkc6097192002-11-03 00:24:07 +0000116
wdenk7474aca2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Webere89e6282010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk7474aca2002-12-17 17:55:09 +0000126
Thomas Webere89e6282010-09-28 08:06:25 +0200127Examples:
Wolfgang Denk092ae952011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Webere89e6282010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa30245ca2016-10-30 17:30:30 +0100130 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk7474aca2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tysere4d1abc2010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamadaef6ebff2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500140 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000143 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500144 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400145 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200146 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500147 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500148 /sh Files generic to SH architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400149 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150/api Machine/arch independent API for external apps
151/board Board dependent files
Xu Ziyuanfb1f9392016-08-26 19:54:49 +0800152/cmd U-Boot commands functions
Peter Tysere4d1abc2010-04-12 22:28:21 -0500153/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500154/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500155/disk Code for disk drive partition handling
156/doc Documentation (don't expect too much)
157/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400158/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500159/examples Example code for standalone applications, etc.
160/fs Filesystem code (cramfs, ext2, jffs2, etc.)
161/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500162/lib Library routines generic to all architectures
163/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500164/net Networking code
165/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500166/scripts Various build scripts and Makefiles
167/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500168/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000169
wdenkc6097192002-11-03 00:24:07 +0000170Software Configuration:
171=======================
172
173Configuration is usually done using C preprocessor defines; the
174rationale behind that is to avoid dead code whenever possible.
175
176There are two classes of configuration variables:
177
178* Configuration _OPTIONS_:
179 These are selectable by the user and have names beginning with
180 "CONFIG_".
181
182* Configuration _SETTINGS_:
183 These depend on the hardware etc. and should not be meddled with if
184 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200185 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000186
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500187Previously, all configuration was done by hand, which involved creating
188symbolic links and editing configuration files manually. More recently,
189U-Boot has added the Kbuild infrastructure used by the Linux kernel,
190allowing you to use the "make menuconfig" command to configure your
191build.
wdenkc6097192002-11-03 00:24:07 +0000192
193
194Selection of Processor Architecture and Board Type:
195---------------------------------------------------
196
197For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200198configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000199
200Example: For a TQM823L module type:
201
202 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200203 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000204
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500205Note: If you're looking for the default configuration file for a board
206you're sure used to be there but is now missing, check the file
207doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000208
Simon Glass53552c92014-03-22 17:12:59 -0600209Sandbox Environment:
210--------------------
211
212U-Boot can be built natively to run on a Linux host using the 'sandbox'
213board. This allows feature development which is not board- or architecture-
214specific to be undertaken on a native platform. The sandbox is also used to
215run some of U-Boot's tests.
216
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530217See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600218
219
Simon Glassd8711af2015-03-03 08:03:00 -0700220Board Initialisation Flow:
221--------------------------
222
223This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500224SPL and U-Boot proper (i.e. they both follow the same rules).
225
226Note: "SPL" stands for "Secondary Program Loader," which is explained in
227more detail later in this file.
228
229At present, SPL mostly uses a separate code path, but the function names
230and roles of each function are the same. Some boards or architectures
231may not conform to this. At least most ARM boards which use
232CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700233
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500234Execution typically starts with an architecture-specific (and possibly
235CPU-specific) start.S file, such as:
236
237 - arch/arm/cpu/armv7/start.S
238 - arch/powerpc/cpu/mpc83xx/start.S
239 - arch/mips/cpu/start.S
240
241and so on. From there, three functions are called; the purpose and
242limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700243
244lowlevel_init():
245 - purpose: essential init to permit execution to reach board_init_f()
246 - no global_data or BSS
247 - there is no stack (ARMv7 may have one but it will soon be removed)
248 - must not set up SDRAM or use console
249 - must only do the bare minimum to allow execution to continue to
250 board_init_f()
251 - this is almost never needed
252 - return normally from this function
253
254board_init_f():
255 - purpose: set up the machine ready for running board_init_r():
256 i.e. SDRAM and serial UART
257 - global_data is available
258 - stack is in SRAM
259 - BSS is not available, so you cannot use global/static variables,
260 only stack variables and global_data
261
262 Non-SPL-specific notes:
263 - dram_init() is called to set up DRAM. If already done in SPL this
264 can do nothing
265
266 SPL-specific notes:
267 - you can override the entire board_init_f() function with your own
268 version as needed.
269 - preloader_console_init() can be called here in extremis
270 - should set up SDRAM, and anything needed to make the UART work
271 - these is no need to clear BSS, it will be done by crt0.S
272 - must return normally from this function (don't call board_init_r()
273 directly)
274
275Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
276this point the stack and global_data are relocated to below
277CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
278memory.
279
280board_init_r():
281 - purpose: main execution, common code
282 - global_data is available
283 - SDRAM is available
284 - BSS is available, all static/global variables can be used
285 - execution eventually continues to main_loop()
286
287 Non-SPL-specific notes:
288 - U-Boot is relocated to the top of memory and is now running from
289 there.
290
291 SPL-specific notes:
292 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
293 CONFIG_SPL_STACK_R_ADDR points into SDRAM
294 - preloader_console_init() can be called here - typically this is
Ley Foon Tan48fcc4a2017-05-03 17:13:32 +0800295 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassd8711af2015-03-03 08:03:00 -0700296 spl_board_init() function containing this call
297 - loads U-Boot or (in falcon mode) Linux
298
299
300
wdenkc6097192002-11-03 00:24:07 +0000301Configuration Options:
302----------------------
303
304Configuration depends on the combination of board and CPU type; all
305such information is kept in a configuration file
306"include/configs/<board_name>.h".
307
308Example: For a TQM823L module, all configuration settings are in
309"include/configs/TQM823L.h".
310
311
wdenk1272e232002-11-10 22:06:23 +0000312Many of the options are named exactly as the corresponding Linux
313kernel configuration options. The intention is to make it easier to
314build a config tool - later.
315
316
wdenkc6097192002-11-03 00:24:07 +0000317The following options need to be configured:
318
Kim Phillips203fee32007-08-10 13:28:25 -0500319- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000320
Kim Phillips203fee32007-08-10 13:28:25 -0500321- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200322
323- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100324 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000325
Lei Wen20014762011-02-09 18:06:58 +0530326- Marvell Family Member
327 CONFIG_SYS_MVFS - define it if you want to enable
328 multiple fs option at one time
329 for marvell soc family
330
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200331- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
333 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000334 e.g. if there is no 32KHz
335 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
337 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000338
wdenk20bddb32004-09-28 17:59:53 +0000339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200340 CONFIG_SYS_8xx_CPUCLK_MIN
341 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000342 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000343 See doc/README.MPC866
344
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200345 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000346
wdenk544e9732004-02-06 23:19:44 +0000347 Define this to measure the actual CPU clock instead
348 of relying on the correctness of the configured
349 values. Mostly useful for board bringup to make sure
350 the PLL is locked at the intended frequency. Note
351 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200352 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000353
Heiko Schocher734f0272009-03-12 07:37:15 +0100354 CONFIG_SYS_DELAYED_ICACHE
355
356 Define this option if you want to enable the
357 ICache only when Code runs from RAM.
358
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600359- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000360 CONFIG_SYS_PPC64
361
362 Specifies that the core is a 64-bit PowerPC implementation (implements
363 the "64" category of the Power ISA). This is necessary for ePAPR
364 compliance, among other possible reasons.
365
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600366 CONFIG_SYS_FSL_TBCLK_DIV
367
368 Defines the core time base clock divider ratio compared to the
369 system clock. On most PQ3 devices this is 8, on newer QorIQ
370 devices it can be 16 or 32. The ratio varies from SoC to Soc.
371
Kumar Gala179b1b22011-05-20 00:39:21 -0500372 CONFIG_SYS_FSL_PCIE_COMPAT
373
374 Defines the string to utilize when trying to match PCIe device
375 tree nodes for the given platform.
376
Scott Wood80806962012-08-14 10:14:53 +0000377 CONFIG_SYS_FSL_ERRATUM_A004510
378
379 Enables a workaround for erratum A004510. If set,
380 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
381 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
382
383 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
384 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
385
386 Defines one or two SoC revisions (low 8 bits of SVR)
387 for which the A004510 workaround should be applied.
388
389 The rest of SVR is either not relevant to the decision
390 of whether the erratum is present (e.g. p2040 versus
391 p2041) or is implied by the build target, which controls
392 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
393
394 See Freescale App Note 4493 for more information about
395 this erratum.
396
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530397 CONFIG_A003399_NOR_WORKAROUND
398 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800399 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530400
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530401 CONFIG_A008044_WORKAROUND
402 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800403 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530404
Scott Wood80806962012-08-14 10:14:53 +0000405 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
406
407 This is the value to write into CCSR offset 0x18600
408 according to the A004510 workaround.
409
Priyanka Jainc73b9032013-07-02 09:21:04 +0530410 CONFIG_SYS_FSL_DSP_DDR_ADDR
411 This value denotes start offset of DDR memory which is
412 connected exclusively to the DSP cores.
413
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530414 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
415 This value denotes start offset of M2 memory
416 which is directly connected to the DSP core.
417
Priyanka Jainc73b9032013-07-02 09:21:04 +0530418 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
419 This value denotes start offset of M3 memory which is directly
420 connected to the DSP core.
421
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530422 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
423 This value denotes start offset of DSP CCSR space.
424
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530425 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
426 Single Source Clock is clocking mode present in some of FSL SoC's.
427 In this mode, a single differential clock is used to supply
428 clocks to the sysclock, ddrclock and usbclock.
429
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530430 CONFIG_SYS_CPC_REINIT_F
431 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng75574052016-02-05 19:30:11 -0800432 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530433
Tang Yuantiana7364af2014-04-17 15:33:46 +0800434 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800435 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800436 supported, core will start to execute uboot when wakes up.
437
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000438- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700439 CONFIG_SYS_GENERIC_GLOBAL_DATA
440 Defines global data is initialized in generic board board_init_f().
441 If this macro is defined, global data is created and cleared in
442 generic board board_init_f(). Without this macro, architecture/board
443 should initialize global data before calling board_init_f().
444
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000445 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
446
447 Defines the endianess of the CPU. Implementation of those
448 values is arch specific.
449
York Sunf0626592013-09-30 09:22:09 -0700450 CONFIG_SYS_FSL_DDR
451 Freescale DDR driver in use. This type of DDR controller is
452 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
453 SoCs.
454
455 CONFIG_SYS_FSL_DDR_ADDR
456 Freescale DDR memory-mapped register base.
457
458 CONFIG_SYS_FSL_DDR_EMU
459 Specify emulator support for DDR. Some DDR features such as
460 deskew training are not available.
461
462 CONFIG_SYS_FSL_DDRC_GEN1
463 Freescale DDR1 controller.
464
465 CONFIG_SYS_FSL_DDRC_GEN2
466 Freescale DDR2 controller.
467
468 CONFIG_SYS_FSL_DDRC_GEN3
469 Freescale DDR3 controller.
470
York Sun2896cb72014-03-27 17:54:47 -0700471 CONFIG_SYS_FSL_DDRC_GEN4
472 Freescale DDR4 controller.
473
York Sun461c9392013-09-30 14:20:51 -0700474 CONFIG_SYS_FSL_DDRC_ARM_GEN3
475 Freescale DDR3 controller for ARM-based SoCs.
476
York Sunf0626592013-09-30 09:22:09 -0700477 CONFIG_SYS_FSL_DDR1
478 Board config to use DDR1. It can be enabled for SoCs with
479 Freescale DDR1 or DDR2 controllers, depending on the board
480 implemetation.
481
482 CONFIG_SYS_FSL_DDR2
Robert P. J. Day8d56db92016-07-15 13:44:45 -0400483 Board config to use DDR2. It can be enabled for SoCs with
York Sunf0626592013-09-30 09:22:09 -0700484 Freescale DDR2 or DDR3 controllers, depending on the board
485 implementation.
486
487 CONFIG_SYS_FSL_DDR3
488 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700489 Freescale DDR3 or DDR3L controllers.
490
491 CONFIG_SYS_FSL_DDR3L
492 Board config to use DDR3L. It can be enabled for SoCs with
493 DDR3L controllers.
494
495 CONFIG_SYS_FSL_DDR4
496 Board config to use DDR4. It can be enabled for SoCs with
497 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700498
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530499 CONFIG_SYS_FSL_IFC_BE
500 Defines the IFC controller register space as Big Endian
501
502 CONFIG_SYS_FSL_IFC_LE
503 Defines the IFC controller register space as Little Endian
504
Prabhakar Kushwaha3c48f582017-02-02 15:01:26 +0530505 CONFIG_SYS_FSL_IFC_CLK_DIV
506 Defines divider of platform clock(clock input to IFC controller).
507
Prabhakar Kushwahabedc5622017-02-02 15:02:00 +0530508 CONFIG_SYS_FSL_LBC_CLK_DIV
509 Defines divider of platform clock(clock input to eLBC controller).
510
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530511 CONFIG_SYS_FSL_PBL_PBI
512 It enables addition of RCW (Power on reset configuration) in built image.
513 Please refer doc/README.pblimage for more details
514
515 CONFIG_SYS_FSL_PBL_RCW
516 It adds PBI(pre-boot instructions) commands in u-boot build image.
517 PBI commands can be used to configure SoC before it starts the execution.
518 Please refer doc/README.pblimage for more details
519
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530520 CONFIG_SPL_FSL_PBL
521 It adds a target to create boot binary having SPL binary in PBI format
522 concatenated with u-boot binary.
523
York Sun29647ab2014-02-10 13:59:42 -0800524 CONFIG_SYS_FSL_DDR_BE
525 Defines the DDR controller register space as Big Endian
526
527 CONFIG_SYS_FSL_DDR_LE
528 Defines the DDR controller register space as Little Endian
529
York Sun3a0916d2014-02-10 13:59:43 -0800530 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
531 Physical address from the view of DDR controllers. It is the
532 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
533 it could be different for ARM SoCs.
534
York Sunc459ae62014-02-10 13:59:44 -0800535 CONFIG_SYS_FSL_DDR_INTLV_256B
536 DDR controller interleaving on 256-byte. This is a special
537 interleaving mode, handled by Dickens for Freescale layerscape
538 SoCs with ARM core.
539
York Sun79a779b2014-08-01 15:51:00 -0700540 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
541 Number of controllers used as main memory.
542
543 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
544 Number of controllers used for other than main memory.
545
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530546 CONFIG_SYS_FSL_HAS_DP_DDR
547 Defines the SoC has DP-DDR used for DPAA.
548
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530549 CONFIG_SYS_FSL_SEC_BE
550 Defines the SEC controller register space as Big Endian
551
552 CONFIG_SYS_FSL_SEC_LE
553 Defines the SEC controller register space as Little Endian
554
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200555- MIPS CPU options:
556 CONFIG_SYS_INIT_SP_OFFSET
557
558 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
559 pointer. This is needed for the temporary stack before
560 relocation.
561
562 CONFIG_SYS_MIPS_CACHE_MODE
563
564 Cache operation mode for the MIPS CPU.
565 See also arch/mips/include/asm/mipsregs.h.
566 Possible values are:
567 CONF_CM_CACHABLE_NO_WA
568 CONF_CM_CACHABLE_WA
569 CONF_CM_UNCACHED
570 CONF_CM_CACHABLE_NONCOHERENT
571 CONF_CM_CACHABLE_CE
572 CONF_CM_CACHABLE_COW
573 CONF_CM_CACHABLE_CUW
574 CONF_CM_CACHABLE_ACCELERATED
575
576 CONFIG_SYS_XWAY_EBU_BOOTCFG
577
578 Special option for Lantiq XWAY SoCs for booting from NOR flash.
579 See also arch/mips/cpu/mips32/start.S.
580
581 CONFIG_XWAY_SWAP_BYTES
582
583 Enable compilation of tools/xway-swap-bytes needed for Lantiq
584 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
585 be swapped if a flash programmer is used.
586
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000587- ARM options:
588 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589
590 Select high exception vectors of the ARM core, e.g., do not
591 clear the V bit of the c1 register of CP15.
592
York Sun77a10972015-03-20 19:28:08 -0700593 COUNTER_FREQUENCY
594 Generic timer clock source frequency.
595
596 COUNTER_FREQUENCY_REAL
597 Generic timer clock source frequency if the real clock is
598 different from COUNTER_FREQUENCY, and can only be determined
599 at run time.
600
Stephen Warren8d1fb312015-01-19 16:25:52 -0700601- Tegra SoC options:
602 CONFIG_TEGRA_SUPPORT_NON_SECURE
603
604 Support executing U-Boot in non-secure (NS) mode. Certain
605 impossible actions will be skipped if the CPU is in NS mode,
606 such as ARM architectural timer initialization.
607
wdenk9b7f3842003-10-09 20:09:04 +0000608- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000609 CONFIG_CLOCKS_IN_MHZ
610
611 U-Boot stores all clock information in Hz
612 internally. For binary compatibility with older Linux
613 kernels (which expect the clocks passed in the
614 bd_info data to be in MHz) the environment variable
615 "clocks_in_mhz" can be defined so that U-Boot
616 converts clock data to MHZ before passing it to the
617 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000618 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100619 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000620 default environment.
621
wdenk9b7f3842003-10-09 20:09:04 +0000622 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
623
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800624 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000625 expect it to be in bytes, others in MB.
626 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
627
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400628 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200629
630 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400631 passed using flattened device trees (based on open firmware
632 concepts).
633
634 CONFIG_OF_LIBFDT
635 * New libfdt-based support
636 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500637 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400638
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200639 OF_CPU - The proper name of the cpus node (only required for
640 MPC512X and MPC5xxx based boards).
641 OF_SOC - The proper name of the soc node (only required for
642 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200643 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600644 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200645
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200646 boards with QUICC Engines require OF_QE to set UCC MAC
647 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500648
Kumar Gala1e26aa52006-01-11 13:54:17 -0600649 CONFIG_OF_BOARD_SETUP
650
651 Board code has addition modification that it wants to make
652 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000653
Simon Glass6c0be912014-10-23 18:58:54 -0600654 CONFIG_OF_SYSTEM_SETUP
655
656 Other code has addition modification that it wants to make
657 to the flat device tree before handing it off to the kernel.
658 This causes ft_system_setup() to be called before booting
659 the kernel.
660
Heiko Schocherffb293a2009-09-23 07:56:08 +0200661 CONFIG_OF_IDE_FIXUP
662
663 U-Boot can detect if an IDE device is present or not.
664 If not, and this new config option is activated, U-Boot
665 removes the ATA node from the DTS before booting Linux,
666 so the Linux IDE driver does not probe the device and
667 crash. This is needed for buggy hardware (uc101) where
668 no pull down resistor is connected to the signal IDE5V_DD7.
669
Igor Grinberg06890672011-07-14 05:45:07 +0000670 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
671
672 This setting is mandatory for all boards that have only one
673 machine type and must be used to specify the machine type
674 number as it appears in the ARM machine registry
675 (see http://www.arm.linux.org.uk/developer/machines/).
676 Only boards that have multiple machine types supported
677 in a single configuration file and the machine type is
678 runtime discoverable, do not have to use this setting.
679
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100680- vxWorks boot parameters:
681
682 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700683 environments variables: bootdev, bootfile, ipaddr, netmask,
684 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100685 It loads the vxWorks image pointed bootfile.
686
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100687 Note: If a "bootargs" environment is defined, it will overwride
688 the defaults discussed just above.
689
Aneesh V960f5c02011-06-16 23:30:47 +0000690- Cache Configuration:
691 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
692 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
693 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
694
Aneesh V686a0752011-06-16 23:30:51 +0000695- Cache Configuration for ARM:
696 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
697 controller
698 CONFIG_SYS_PL310_BASE - Physical base address of PL310
699 controller register space
700
wdenkda04a8b2004-08-02 23:22:59 +0000701- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200702 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000703
704 Define this if you want support for Amba PrimeCell PL010 UARTs.
705
Andreas Engel0813b122008-09-08 14:30:53 +0200706 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000707
708 Define this if you want support for Amba PrimeCell PL011 UARTs.
709
710 CONFIG_PL011_CLOCK
711
712 If you have Amba PrimeCell PL011 UARTs, set this variable to
713 the clock speed of the UARTs.
714
715 CONFIG_PL01x_PORTS
716
717 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
718 define this to a list of base addresses for each (supported)
719 port. See e.g. include/configs/versatile.h
720
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400721 CONFIG_SERIAL_HW_FLOW_CONTROL
722
723 Define this variable to enable hw flow control in serial driver.
724 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000725
wdenkc6097192002-11-03 00:24:07 +0000726- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000727 Depending on board, define exactly one serial port
728 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
729 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
730 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000731
732 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
733 port routines must be defined elsewhere
734 (i.e. serial_init(), serial_getc(), ...)
735
wdenkc6097192002-11-03 00:24:07 +0000736- Console Baudrate:
737 CONFIG_BAUDRATE - in bps
738 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200739 CONFIG_SYS_BAUDRATE_TABLE, see below.
740 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000741
Heiko Schocher327480a2009-01-30 12:55:38 +0100742- Console Rx buffer length
743 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
744 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100745 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100746 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
747 must be defined, to setup the maximum idle timeout for
748 the SMC.
749
wdenkc6097192002-11-03 00:24:07 +0000750- Autoboot Command:
751 CONFIG_BOOTCOMMAND
752 Only needed when CONFIG_BOOTDELAY is enabled;
753 define a command string that is automatically executed
754 when no character is read on the console interface
755 within "Boot Delay" after reset.
756
757 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000758 This can be used to pass arguments to the bootm
759 command. The value of CONFIG_BOOTARGS goes into the
760 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000761
762 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000763 The value of these goes into the environment as
764 "ramboot" and "nfsboot" respectively, and can be used
765 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200766 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000767
Heiko Schocher040c5c32013-11-04 14:04:59 +0100768- Bootcount:
769 CONFIG_BOOTCOUNT_LIMIT
770 Implements a mechanism for detecting a repeating reboot
771 cycle, see:
772 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
773
774 CONFIG_BOOTCOUNT_ENV
775 If no softreset save registers are found on the hardware
776 "bootcount" is stored in the environment. To prevent a
777 saveenv on all reboots, the environment variable
778 "upgrade_available" is used. If "upgrade_available" is
779 0, "bootcount" is always 0, if "upgrade_available" is
780 1 "bootcount" is incremented in the environment.
781 So the Userspace Applikation must set the "upgrade_available"
782 and "bootcount" variable to 0, if a boot was successfully.
783
wdenkc6097192002-11-03 00:24:07 +0000784- Pre-Boot Commands:
785 CONFIG_PREBOOT
786
787 When this option is #defined, the existence of the
788 environment variable "preboot" will be checked
789 immediately before starting the CONFIG_BOOTDELAY
790 countdown and/or running the auto-boot command resp.
791 entering interactive mode.
792
793 This feature is especially useful when "preboot" is
794 automatically generated or modified. For an example
795 see the LWMON board specific code: here "preboot" is
796 modified when the user holds down a certain
797 combination of keys on the (special) keyboard when
798 booting the systems
799
800- Serial Download Echo Mode:
801 CONFIG_LOADS_ECHO
802 If defined to 1, all characters received during a
803 serial download (using the "loads" command) are
804 echoed back. This might be needed by some terminal
805 emulations (like "cu"), but may as well just take
806 time on others. This setting #define's the initial
807 value of the "loads_echo" environment variable.
808
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500809- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000810 CONFIG_KGDB_BAUDRATE
811 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200812 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000813
814- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500815 Monitor commands can be included or excluded
816 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000817 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500818 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000819
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500820 The default command configuration includes all commands
821 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000822
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100823 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500824 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500825 CONFIG_CMD_BDI bdinfo
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500826 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400827 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500828 CONFIG_CMD_CACHE * icache, dcache
829 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500830 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500831 CONFIG_CMD_DHCP * DHCP support
832 CONFIG_CMD_DIAG * Diagnostics
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500833 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500834 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500835 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder94463402013-10-22 19:07:34 -0500836 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500837 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000838 CONFIG_CMD_EXT2 * ext2 command support
839 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700840 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
841 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100842 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500843 CONFIG_CMD_SAVEENV saveenv
Stephen Warren4f8662d2012-10-22 06:43:50 +0000844 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500845 CONFIG_CMD_FLASH flinfo, erase, protect
846 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysinger2ed02412010-12-26 23:32:22 -0500847 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000848 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500849 CONFIG_CMD_I2C * I2C serial bus support
850 CONFIG_CMD_IDE * IDE harddisk support
851 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000852 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200853 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500854 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -0600855 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500856 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000857 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500858 CONFIG_CMD_IRQ * irqinfo
859 CONFIG_CMD_ITEST Integer/string test of 2 values
860 CONFIG_CMD_JFFS2 * JFFS2 Support
861 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200862 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000863 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
864 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500865 CONFIG_CMD_LOADB loadb
866 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200867 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400868 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000869 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500870 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000871 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200872 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500873 CONFIG_CMD_MISC Misc functions like sleep etc
874 CONFIG_CMD_MMC * MMC memory mapped support
875 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100876 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500877 CONFIG_CMD_NAND * NAND support
878 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200879 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600880 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000881 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500882 CONFIG_CMD_PCI * pciinfo
883 CONFIG_CMD_PCMCIA * PCMCIA support
884 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
885 host
886 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000887 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500888 CONFIG_CMD_REGINFO * Register dump
889 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000890 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500891 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600892 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500893 CONFIG_CMD_SDRAM * print SDRAM configuration information
894 (requires CONFIG_CMD_I2C)
895 CONFIG_CMD_SETGETDCR Support for DCR Register access
896 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700897 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200898 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400899 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +0800900 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200901 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500902 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000903 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000904 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000905 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
906 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500907 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500908 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000909 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200910 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200911 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000912
913 EXAMPLE: If you want all functions except of network
914 support you can write:
915
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500916 #include "config_cmd_all.h"
917 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000918
Gerald Van Barend6abef42007-03-31 12:23:51 -0400919 Other Commands:
920 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000921
922 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500923 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000924 what you (and your U-Boot users) are doing. Data
925 cache cannot be enabled on systems like the 8xx or
926 8260 (where accesses to the IMMR region must be
927 uncached), and it cannot be disabled on all other
928 systems where we (mis-) use the data cache to hold an
929 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000930
931
932 XXX - this list needs to get updated!
933
Simon Glassaa34ef22016-03-13 19:07:28 -0600934- Removal of commands
935 If no commands are needed to boot, you can disable
936 CONFIG_CMDLINE to remove them. In this case, the command line
937 will not be available, and when U-Boot wants to execute the
938 boot command (on start-up) it will call board_run_command()
939 instead. This can reduce image size significantly for very
940 simple boot procedures.
941
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000942- Regular expression support:
943 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200944 If this variable is defined, U-Boot is linked against
945 the SLRE (Super Light Regular Expression) library,
946 which adds regex support to some commands, as for
947 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000948
Simon Glass3d686442011-10-15 05:48:20 +0000949- Device tree:
950 CONFIG_OF_CONTROL
951 If this variable is defined, U-Boot will use a device tree
952 to configure its devices, instead of relying on statically
953 compiled #defines in the board file. This option is
954 experimental and only available on a few boards. The device
955 tree is available in the global data as gd->fdt_blob.
956
Simon Glass5cb34db2011-10-24 19:15:31 +0000957 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700958 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000959
960 CONFIG_OF_EMBED
961 If this variable is defined, U-Boot will embed a device tree
962 binary in its image. This device tree file should be in the
963 board directory and called <soc>-<board>.dts. The binary file
964 is then picked up in board_init_f() and made available through
965 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000966
Simon Glass5cb34db2011-10-24 19:15:31 +0000967 CONFIG_OF_SEPARATE
968 If this variable is defined, U-Boot will build a device tree
969 binary. It will be called u-boot.dtb. Architecture-specific
970 code will locate it at run-time. Generally this works by:
971
972 cat u-boot.bin u-boot.dtb >image.bin
973
974 and in fact, U-Boot does this for you, creating a file called
975 u-boot-dtb.bin which is useful in the common case. You can
976 still use the individual files if you need something more
977 exotic.
978
Alex Deymo5b661ec2017-04-02 01:25:20 -0700979 CONFIG_OF_BOARD
980 If this variable is defined, U-Boot will use the device tree
981 provided by the board at runtime instead of embedding one with
982 the image. Only boards defining board_fdt_blob_setup() support
983 this option (see include/fdtdec.h file).
984
wdenkc6097192002-11-03 00:24:07 +0000985- Watchdog:
986 CONFIG_WATCHDOG
987 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000988 support for the SoC. There must be support in the SoC
989 specific code for a watchdog. For the 8xx and 8260
990 CPUs, the SIU Watchdog feature is enabled in the SYPCR
991 register. When supported for a specific SoC is
992 available, then no further board specific code should
993 be needed to use it.
994
995 CONFIG_HW_WATCHDOG
996 When using a watchdog circuitry external to the used
997 SoC, then define this variable and provide board
998 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000999
Heiko Schocher735326c2015-01-21 08:38:22 +01001000 CONFIG_AT91_HW_WDT_TIMEOUT
1001 specify the timeout in seconds. default 2 seconds.
1002
stroeseb9c17c52003-04-04 15:53:41 +00001003- U-Boot Version:
1004 CONFIG_VERSION_VARIABLE
1005 If this variable is defined, an environment variable
1006 named "ver" is created by U-Boot showing the U-Boot
1007 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001008 Any change to this variable will be reverted at the
1009 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001010
wdenkc6097192002-11-03 00:24:07 +00001011- Real-Time Clock:
1012
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001013 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001014 has to be selected, too. Define exactly one of the
1015 following options:
1016
1017 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1018 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001019 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001020 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001021 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001022 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001023 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001024 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001025 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001026 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001027 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001028 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001029 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1030 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001031
wdenkb9bbd242003-06-30 16:24:52 +00001032 Note that if the RTC uses I2C, then the I2C interface
1033 must also be configured. See I2C Support, below.
1034
Peter Tyser9902e422008-12-17 16:36:21 -06001035- GPIO Support:
1036 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001037
Chris Packham9b383202010-12-19 10:12:13 +00001038 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1039 chip-ngpio pairs that tell the PCA953X driver the number of
1040 pins supported by a particular chip.
1041
Peter Tyser9902e422008-12-17 16:36:21 -06001042 Note that if the GPIO device uses I2C, then the I2C interface
1043 must also be configured. See I2C Support, below.
1044
Simon Glass4dc47ca2014-06-11 23:29:41 -06001045- I/O tracing:
1046 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1047 accesses and can checksum them or write a list of them out
1048 to memory. See the 'iotrace' command for details. This is
1049 useful for testing device drivers since it can confirm that
1050 the driver behaves the same way before and after a code
1051 change. Currently this is supported on sandbox and arm. To
1052 add support for your architecture, add '#include <iotrace.h>'
1053 to the bottom of arch/<arch>/include/asm/io.h and test.
1054
1055 Example output from the 'iotrace stats' command is below.
1056 Note that if the trace buffer is exhausted, the checksum will
1057 still continue to operate.
1058
1059 iotrace is enabled
1060 Start: 10000000 (buffer start address)
1061 Size: 00010000 (buffer size)
1062 Offset: 00000120 (current buffer offset)
1063 Output: 10000120 (start + offset)
1064 Count: 00000018 (number of trace records)
1065 CRC32: 9526fb66 (CRC32 of all trace records)
1066
wdenkc6097192002-11-03 00:24:07 +00001067- Timestamp Support:
1068
wdenk4a5c8a72003-03-06 00:02:04 +00001069 When CONFIG_TIMESTAMP is selected, the timestamp
1070 (date and time) of an image is printed by image
1071 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001072 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001073
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001074- Partition Labels (disklabels) Supported:
1075 Zero or more of the following:
1076 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1077 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1078 Intel architecture, USB sticks, etc.
1079 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1080 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1081 bootloader. Note 2TB partition limit; see
1082 disk/part_efi.c
1083 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001084
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001085 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001086 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001087 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001088
1089- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001090 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1091 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001092
wdenk369d43d2004-03-14 14:09:05 +00001093 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1094 be performed by calling the function
1095 ide_set_reset(int reset)
1096 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001097
1098- ATAPI Support:
1099 CONFIG_ATAPI
1100
1101 Set this to enable ATAPI support.
1102
wdenkf602aa02004-03-13 23:29:43 +00001103- LBA48 Support
1104 CONFIG_LBA48
1105
1106 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001107 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001108 Whithout these , LBA48 support uses 32bit variables and will 'only'
1109 support disks up to 2.1TB.
1110
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001111 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001112 When enabled, makes the IDE subsystem use 64bit sector addresses.
1113 Default is 32bit.
1114
wdenkc6097192002-11-03 00:24:07 +00001115- SCSI Support:
1116 At the moment only there is only support for the
1117 SYM53C8XX SCSI controller; define
1118 CONFIG_SCSI_SYM53C8XX to enable it.
1119
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001120 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1121 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1122 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001123 maximum numbers of LUNs, SCSI ID's and target
1124 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001125 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001126
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001127 The environment variable 'scsidevs' is set to the number of
1128 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001129
wdenkc6097192002-11-03 00:24:07 +00001130- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001131 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001132 Support for Intel 8254x/8257x gigabit chips.
1133
1134 CONFIG_E1000_SPI
1135 Utility code for direct access to the SPI bus on Intel 8257x.
1136 This does not do anything useful unless you set at least one
1137 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1138
1139 CONFIG_E1000_SPI_GENERIC
1140 Allow generic access to the SPI bus on the Intel 8257x, for
1141 example with the "sspi" command.
1142
1143 CONFIG_CMD_E1000
1144 Management command for E1000 devices. When used on devices
1145 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001146
wdenkc6097192002-11-03 00:24:07 +00001147 CONFIG_EEPRO100
1148 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001149 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001150 write routine for first time initialisation.
1151
1152 CONFIG_TULIP
1153 Support for Digital 2114x chips.
1154 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1155 modem chip initialisation (KS8761/QS6611).
1156
1157 CONFIG_NATSEMI
1158 Support for National dp83815 chips.
1159
1160 CONFIG_NS8382X
1161 Support for National dp8382[01] gigabit chips.
1162
wdenkaa603362003-05-12 21:50:16 +00001163- NETWORK Support (other):
1164
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001165 CONFIG_DRIVER_AT91EMAC
1166 Support for AT91RM9200 EMAC.
1167
1168 CONFIG_RMII
1169 Define this to use reduced MII inteface
1170
1171 CONFIG_DRIVER_AT91EMAC_QUIET
1172 If this defined, the driver is quiet.
1173 The driver doen't show link status messages.
1174
Rob Herringc9830dc2011-12-15 11:15:49 +00001175 CONFIG_CALXEDA_XGMAC
1176 Support for the Calxeda XGMAC device
1177
Ashok93fb8722012-10-15 06:20:47 +00001178 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001179 Support for SMSC's LAN91C96 chips.
1180
wdenkaa603362003-05-12 21:50:16 +00001181 CONFIG_LAN91C96_USE_32_BIT
1182 Define this to enable 32 bit addressing
1183
Ashok93fb8722012-10-15 06:20:47 +00001184 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001185 Support for SMSC's LAN91C111 chip
1186
1187 CONFIG_SMC91111_BASE
1188 Define this to hold the physical address
1189 of the device (I/O space)
1190
1191 CONFIG_SMC_USE_32_BIT
1192 Define this if data bus is 32 bits
1193
1194 CONFIG_SMC_USE_IOFUNCS
1195 Define this to use i/o functions instead of macros
1196 (some hardware wont work with macros)
1197
Heiko Schocher7d037f72011-11-15 10:00:04 -05001198 CONFIG_DRIVER_TI_EMAC
1199 Support for davinci emac
1200
1201 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1202 Define this if you have more then 3 PHYs.
1203
Macpaul Lin199c6252010-12-21 16:59:46 +08001204 CONFIG_FTGMAC100
1205 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1206
1207 CONFIG_FTGMAC100_EGIGA
1208 Define this to use GE link update with gigabit PHY.
1209 Define this if FTGMAC100 is connected to gigabit PHY.
1210 If your system has 10/100 PHY only, it might not occur
1211 wrong behavior. Because PHY usually return timeout or
1212 useless data when polling gigabit status and gigabit
1213 control registers. This behavior won't affect the
1214 correctnessof 10/100 link speed update.
1215
Mike Rapoportf4761af2009-11-11 10:03:03 +02001216 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001217 Support for SMSC's LAN911x and LAN921x chips
1218
Mike Rapoportf4761af2009-11-11 10:03:03 +02001219 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001220 Define this to hold the physical address
1221 of the device (I/O space)
1222
Mike Rapoportf4761af2009-11-11 10:03:03 +02001223 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001224 Define this if data bus is 32 bits
1225
Mike Rapoportf4761af2009-11-11 10:03:03 +02001226 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001227 Define this if data bus is 16 bits. If your processor
1228 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001229 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001230
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001231 CONFIG_SH_ETHER
1232 Support for Renesas on-chip Ethernet controller
1233
1234 CONFIG_SH_ETHER_USE_PORT
1235 Define the number of ports to be used
1236
1237 CONFIG_SH_ETHER_PHY_ADDR
1238 Define the ETH PHY's address
1239
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001240 CONFIG_SH_ETHER_CACHE_WRITEBACK
1241 If this option is set, the driver enables cache flush.
1242
Heiko Schocher2b387762014-07-18 06:07:19 +02001243- PWM Support:
1244 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001245 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001246
Vadim Bendeburydac69642011-10-17 08:36:14 +00001247- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001248 CONFIG_TPM
1249 Support TPM devices.
1250
Christophe Ricard8759ff82015-10-06 22:54:41 +02001251 CONFIG_TPM_TIS_INFINEON
1252 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001253 per system is supported at this time.
1254
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001255 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1256 Define the burst count bytes upper limit
1257
Christophe Ricard88249232016-01-21 23:27:13 +01001258 CONFIG_TPM_ST33ZP24
1259 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1260
1261 CONFIG_TPM_ST33ZP24_I2C
1262 Support for STMicroelectronics ST33ZP24 I2C devices.
1263 Requires TPM_ST33ZP24 and I2C.
1264
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001265 CONFIG_TPM_ST33ZP24_SPI
1266 Support for STMicroelectronics ST33ZP24 SPI devices.
1267 Requires TPM_ST33ZP24 and SPI.
1268
Dirk Eibach20489092013-06-26 15:55:15 +02001269 CONFIG_TPM_ATMEL_TWI
1270 Support for Atmel TWI TPM device. Requires I2C support.
1271
Che-liang Chiouacea5702013-04-12 11:04:34 +00001272 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001273 Support for generic parallel port TPM devices. Only one device
1274 per system is supported at this time.
1275
1276 CONFIG_TPM_TIS_BASE_ADDRESS
1277 Base address where the generic TPM device is mapped
1278 to. Contemporary x86 systems usually map it at
1279 0xfed40000.
1280
Reinhard Pfau4fece432013-06-26 15:55:13 +02001281 CONFIG_CMD_TPM
1282 Add tpm monitor functions.
1283 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1284 provides monitor access to authorized functions.
1285
1286 CONFIG_TPM
1287 Define this to enable the TPM support library which provides
1288 functional interfaces to some TPM commands.
1289 Requires support for a TPM device.
1290
1291 CONFIG_TPM_AUTH_SESSIONS
1292 Define this to enable authorized functions in the TPM library.
1293 Requires CONFIG_TPM and CONFIG_SHA1.
1294
wdenkc6097192002-11-03 00:24:07 +00001295- USB Support:
1296 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001297 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001298 CONFIG_USB_UHCI to enable it.
1299 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001300 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001301 storage devices.
1302 Note:
1303 Supported are USB Keyboards and USB Floppy drives
1304 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001305 MPC5200 USB requires additional defines:
1306 CONFIG_USB_CLOCK
1307 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001308 CONFIG_PSC3_USB
1309 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001310 CONFIG_USB_CONFIG
1311 for differential drivers: 0x00001000
1312 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001313 for differential drivers on PSC3: 0x00000100
1314 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001315 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001316 May be defined to allow interrupt polling
1317 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001318
Simon Glass5978cdb2012-02-27 10:52:47 +00001319 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1320 txfilltuning field in the EHCI controller on reset.
1321
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001322 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1323 HW module registers.
1324
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001325- USB Device:
1326 Define the below if you wish to use the USB console.
1327 Once firmware is rebuilt from a serial console issue the
1328 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001329 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001330 it has found a new device. The environment variable usbtty
1331 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001332 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001333 Common Device Class Abstract Control Model serial device.
1334 If you select usbtty = gserial you should be able to enumerate
1335 a Linux host by
1336 # modprobe usbserial vendor=0xVendorID product=0xProductID
1337 else if using cdc_acm, simply setting the environment
1338 variable usbtty to be cdc_acm should suffice. The following
1339 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001340
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001341 CONFIG_USB_DEVICE
1342 Define this to build a UDC device
1343
1344 CONFIG_USB_TTY
1345 Define this to have a tty type of device available to
1346 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001347
Vipin KUMARbdb17702012-03-26 15:38:06 +05301348 CONFIG_USBD_HS
1349 Define this to enable the high speed support for usb
1350 device and usbtty. If this feature is enabled, a routine
1351 int is_usbd_high_speed(void)
1352 also needs to be defined by the driver to dynamically poll
1353 whether the enumeration has succeded at high speed or full
1354 speed.
1355
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001356 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001357 Define this if you want stdin, stdout &/or stderr to
1358 be set to usbtty.
1359
1360 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001361 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001362 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001363 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001364
Wolfgang Denke2601822006-06-14 18:14:56 +02001365 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001366 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001367 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001368 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1369 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1370 should pretend to be a Linux device to it's target host.
1371
1372 CONFIG_USBD_MANUFACTURER
1373 Define this string as the name of your company for
1374 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001375
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001376 CONFIG_USBD_PRODUCT_NAME
1377 Define this string as the name of your product
1378 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001379
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001380 CONFIG_USBD_VENDORID
1381 Define this as your assigned Vendor ID from the USB
1382 Implementors Forum. This *must* be a genuine Vendor ID
1383 to avoid polluting the USB namespace.
1384 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001385
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001386 CONFIG_USBD_PRODUCTID
1387 Define this as the unique Product ID
1388 for your device
1389 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001390
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001391- ULPI Layer Support:
1392 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1393 the generic ULPI layer. The generic layer accesses the ULPI PHY
1394 via the platform viewport, so you need both the genric layer and
1395 the viewport enabled. Currently only Chipidea/ARC based
1396 viewport is supported.
1397 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1398 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001399 If your ULPI phy needs a different reference clock than the
1400 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1401 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001402
wdenk7a428cc2003-06-15 22:40:42 +00001403- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001404 The MMC controller on the Intel PXA is supported. To
1405 enable this define CONFIG_MMC. The MMC can be
1406 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001407 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001408 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1409 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001410
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001411 CONFIG_SH_MMCIF
1412 Support for Renesas on-chip MMCIF controller
1413
1414 CONFIG_SH_MMCIF_ADDR
1415 Define the base address of MMCIF registers
1416
1417 CONFIG_SH_MMCIF_CLK
1418 Define the clock frequency for MMCIF
1419
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001420 CONFIG_SUPPORT_EMMC_BOOT
1421 Enable some additional features of the eMMC boot partitions.
1422
1423 CONFIG_SUPPORT_EMMC_RPMB
1424 Enable the commands for reading, writing and programming the
1425 key for the Replay Protection Memory Block partition in eMMC.
1426
Tom Rini58a8d322013-03-14 05:32:47 +00001427- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001428 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001429 This enables the USB portion of the DFU USB class
1430
1431 CONFIG_CMD_DFU
1432 This enables the command "dfu" which is used to have
1433 U-Boot create a DFU class device via USB. This command
1434 requires that the "dfu_alt_info" environment variable be
1435 set and define the alt settings to expose to the host.
1436
1437 CONFIG_DFU_MMC
1438 This enables support for exposing (e)MMC devices via DFU.
1439
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001440 CONFIG_DFU_NAND
1441 This enables support for exposing NAND devices via DFU.
1442
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301443 CONFIG_DFU_RAM
1444 This enables support for exposing RAM via DFU.
1445 Note: DFU spec refer to non-volatile memory usage, but
1446 allow usages beyond the scope of spec - here RAM usage,
1447 one that would help mostly the developer.
1448
Heiko Schochera2f831e2013-06-12 06:05:51 +02001449 CONFIG_SYS_DFU_DATA_BUF_SIZE
1450 Dfu transfer uses a buffer before writing data to the
1451 raw storage device. Make the size (in bytes) of this buffer
1452 configurable. The size of this buffer is also configurable
1453 through the "dfu_bufsiz" environment variable.
1454
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001455 CONFIG_SYS_DFU_MAX_FILE_SIZE
1456 When updating files rather than the raw storage device,
1457 we use a static buffer to copy the file into and then write
1458 the buffer once we've been given the whole file. Define
1459 this to the maximum filesize (in bytes) for the buffer.
1460 Default is 4 MiB if undefined.
1461
Heiko Schochere1ba1512014-03-18 08:09:56 +01001462 DFU_DEFAULT_POLL_TIMEOUT
1463 Poll timeout [ms], is the timeout a device can send to the
1464 host. The host must wait for this timeout before sending
1465 a subsequent DFU_GET_STATUS request to the device.
1466
1467 DFU_MANIFEST_POLL_TIMEOUT
1468 Poll timeout [ms], which the device sends to the host when
1469 entering dfuMANIFEST state. Host waits this timeout, before
1470 sending again an USB request to the device.
1471
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001472- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001473 CONFIG_USB_FUNCTION_FASTBOOT
1474 This enables the USB part of the fastboot gadget
1475
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001476 CONFIG_CMD_FASTBOOT
1477 This enables the command "fastboot" which enables the Android
1478 fastboot mode for the platform's USB device. Fastboot is a USB
1479 protocol for downloading images, flashing and device control
1480 used on Android devices.
1481 See doc/README.android-fastboot for more information.
1482
1483 CONFIG_ANDROID_BOOT_IMAGE
1484 This enables support for booting images which use the Android
1485 image format header.
1486
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001487 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001488 The fastboot protocol requires a large memory buffer for
1489 downloads. Define this to the starting RAM address to use for
1490 downloaded images.
1491
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001492 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001493 The fastboot protocol requires a large memory buffer for
1494 downloads. This buffer should be as large as possible for a
1495 platform. Define this to the size available RAM for fastboot.
1496
Steve Raebfb9ba42014-08-26 11:47:28 -07001497 CONFIG_FASTBOOT_FLASH
1498 The fastboot protocol includes a "flash" command for writing
1499 the downloaded image to a non-volatile storage device. Define
1500 this to enable the "fastboot flash" command.
1501
1502 CONFIG_FASTBOOT_FLASH_MMC_DEV
1503 The fastboot "flash" command requires additional information
1504 regarding the non-volatile storage device. Define this to
1505 the eMMC device that fastboot should use to store the image.
1506
Steve Rae7d059342014-12-12 15:51:54 -08001507 CONFIG_FASTBOOT_GPT_NAME
1508 The fastboot "flash" command supports writing the downloaded
1509 image to the Protective MBR and the Primary GUID Partition
1510 Table. (Additionally, this downloaded image is post-processed
1511 to generate and write the Backup GUID Partition Table.)
1512 This occurs when the specified "partition name" on the
1513 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001514 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001515
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001516 CONFIG_FASTBOOT_MBR_NAME
1517 The fastboot "flash" command supports writing the downloaded
1518 image to DOS MBR.
1519 This occurs when the "partition name" specified on the
1520 "fastboot flash" command line matches this value.
1521 If not defined the default value "mbr" is used.
1522
wdenkda04a8b2004-08-02 23:22:59 +00001523- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001524 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001525 Define these for a default partition on a NAND device
1526
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001527 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1528 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001529 Define these for a default partition on a NOR device
1530
Donggeun Kim8f814002011-10-24 21:15:28 +00001531- FAT(File Allocation Table) filesystem write function support:
1532 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001533
1534 Define this to enable support for saving memory data as a
1535 file in FAT formatted partition.
1536
1537 This will also enable the command "fatwrite" enabling the
1538 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001539
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301540- FAT(File Allocation Table) filesystem cluster size:
1541 CONFIG_FS_FAT_MAX_CLUSTSIZE
1542
1543 Define the max cluster size for fat operations else
1544 a default value of 65536 will be defined.
1545
wdenkc6097192002-11-03 00:24:07 +00001546- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001547 See Kconfig help for available keyboard drivers.
1548
1549 CONFIG_KEYBOARD
1550
1551 Define this to enable a custom keyboard support.
1552 This simply calls drv_keyboard_init() which must be
1553 defined in your board-specific files. This option is deprecated
1554 and is only used by novena. For new boards, use driver model
1555 instead.
wdenkc6097192002-11-03 00:24:07 +00001556
1557- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001558 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001559 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001560 SOCs that have a DIU should define this macro to enable DIU
1561 support, and should also define these other macros:
1562
1563 CONFIG_SYS_DIU_ADDR
1564 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001565 CONFIG_CFB_CONSOLE
1566 CONFIG_VIDEO_SW_CURSOR
1567 CONFIG_VGA_AS_SINGLE_DEVICE
1568 CONFIG_VIDEO_LOGO
1569 CONFIG_VIDEO_BMP_LOGO
1570
Timur Tabi32f709e2011-04-11 14:18:22 -05001571 The DIU driver will look for the 'video-mode' environment
1572 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001573 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001574 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001575
wdenkc6097192002-11-03 00:24:07 +00001576- LCD Support: CONFIG_LCD
1577
1578 Define this to enable LCD support (for output to LCD
1579 display); also select one of the supported displays
1580 by defining one of these:
1581
Stelian Popf6f86652008-05-09 21:57:18 +02001582 CONFIG_ATMEL_LCD:
1583
1584 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1585
wdenkc0d54ae2003-11-25 16:55:19 +00001586 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001587
wdenkc0d54ae2003-11-25 16:55:19 +00001588 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001589
wdenkc0d54ae2003-11-25 16:55:19 +00001590 CONFIG_NEC_NL6448BC20
1591
1592 NEC NL6448BC20-08. 6.5", 640x480.
1593 Active, color, single scan.
1594
1595 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001596
wdenkc0d54ae2003-11-25 16:55:19 +00001597 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001598 Active, color, single scan.
1599
1600 CONFIG_SHARP_16x9
1601
1602 Sharp 320x240. Active, color, single scan.
1603 It isn't 16x9, and I am not sure what it is.
1604
1605 CONFIG_SHARP_LQ64D341
1606
1607 Sharp LQ64D341 display, 640x480.
1608 Active, color, single scan.
1609
1610 CONFIG_HLD1045
1611
1612 HLD1045 display, 640x480.
1613 Active, color, single scan.
1614
1615 CONFIG_OPTREX_BW
1616
1617 Optrex CBL50840-2 NF-FW 99 22 M5
1618 or
1619 Hitachi LMG6912RPFC-00T
1620 or
1621 Hitachi SP14Q002
1622
1623 320x240. Black & white.
1624
Simon Glass599a4df2012-10-17 13:24:54 +00001625 CONFIG_LCD_ALIGNMENT
1626
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001627 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001628 defined then the LCD will be aligned to this value instead.
1629 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1630 here, since it is cheaper to change data cache settings on
1631 a per-section basis.
1632
1633
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001634 CONFIG_LCD_ROTATION
1635
1636 Sometimes, for example if the display is mounted in portrait
1637 mode or even if it's mounted landscape but rotated by 180degree,
1638 we need to rotate our content of the display relative to the
1639 framebuffer, so that user can read the messages which are
1640 printed out.
1641 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1642 initialized with a given rotation from "vl_rot" out of
1643 "vidinfo_t" which is provided by the board specific code.
1644 The value for vl_rot is coded as following (matching to
1645 fbcon=rotate:<n> linux-kernel commandline):
1646 0 = no rotation respectively 0 degree
1647 1 = 90 degree rotation
1648 2 = 180 degree rotation
1649 3 = 270 degree rotation
1650
1651 If CONFIG_LCD_ROTATION is not defined, the console will be
1652 initialized with 0degree rotation.
1653
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001654 CONFIG_LCD_BMP_RLE8
1655
1656 Support drawing of RLE8-compressed bitmaps on the LCD.
1657
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001658 CONFIG_I2C_EDID
1659
1660 Enables an 'i2c edid' command which can read EDID
1661 information over I2C from an attached LCD display.
1662
wdenkeb20ad32003-09-05 23:19:14 +00001663- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001664
wdenk57b2d802003-06-27 21:31:46 +00001665 If this option is set, the environment is checked for
1666 a variable "splashimage". If found, the usual display
1667 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001668 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001669 specified in "splashimage" is loaded instead. The
1670 console is redirected to the "nulldev", too. This
1671 allows for a "silent" boot where a splash screen is
1672 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001673
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001674 CONFIG_SPLASHIMAGE_GUARD
1675
1676 If this option is set, then U-Boot will prevent the environment
1677 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001678 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001679 This option is useful for targets where, due to alignment
1680 restrictions, an improperly aligned BMP image will cause a data
1681 abort. If you think you will not have problems with unaligned
1682 accesses (for example because your toolchain prevents them)
1683 there is no need to set this option.
1684
Matthias Weisser53884182009-07-09 16:07:30 +02001685 CONFIG_SPLASH_SCREEN_ALIGN
1686
1687 If this option is set the splash image can be freely positioned
1688 on the screen. Environment variable "splashpos" specifies the
1689 position as "x,y". If a positive number is given it is used as
1690 number of pixel from left/top. If a negative number is given it
1691 is used as number of pixel from right/bottom. You can also
1692 specify 'm' for centering the image.
1693
1694 Example:
1695 setenv splashpos m,m
1696 => image at center of screen
1697
1698 setenv splashpos 30,20
1699 => image at x = 30 and y = 20
1700
1701 setenv splashpos -10,m
1702 => vertically centered image
1703 at x = dspWidth - bmpWidth - 9
1704
Stefan Roesed9d97742005-09-22 09:04:17 +02001705- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1706
1707 If this option is set, additionally to standard BMP
1708 images, gzipped BMP images can be displayed via the
1709 splashscreen support or the bmp command.
1710
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001711- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1712
1713 If this option is set, 8-bit RLE compressed BMP images
1714 can be displayed via the splashscreen support or the
1715 bmp command.
1716
wdenk710e3502003-08-29 20:57:53 +00001717- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001718 CONFIG_GZIP
1719
1720 Enabled by default to support gzip compressed images.
1721
wdenk710e3502003-08-29 20:57:53 +00001722 CONFIG_BZIP2
1723
1724 If this option is set, support for bzip2 compressed
1725 images is included. If not, only uncompressed and gzip
1726 compressed images are supported.
1727
wdenk9c53f402003-10-15 23:53:47 +00001728 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001729 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001730 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001731
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001732 CONFIG_LZMA
1733
1734 If this option is set, support for lzma compressed
1735 images is included.
1736
1737 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1738 requires an amount of dynamic memory that is given by the
1739 formula:
1740
1741 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1742
1743 Where lc and lp stand for, respectively, Literal context bits
1744 and Literal pos bits.
1745
1746 This value is upper-bounded by 14MB in the worst case. Anyway,
1747 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1748 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1749 a very small buffer.
1750
1751 Use the lzmainfo tool to determinate the lc and lp values and
1752 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001753 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001754
Kees Cook5b06e642013-08-16 07:59:12 -07001755 CONFIG_LZO
1756
1757 If this option is set, support for LZO compressed images
1758 is included.
1759
wdenk0e2bd9c2004-06-06 21:51:03 +00001760- MII/PHY support:
1761 CONFIG_PHY_ADDR
1762
1763 The address of PHY on MII bus.
1764
1765 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1766
1767 The clock frequency of the MII bus
1768
1769 CONFIG_PHY_GIGE
1770
1771 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001772 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001773
1774 CONFIG_PHY_RESET_DELAY
1775
1776 Some PHY like Intel LXT971A need extra delay after
1777 reset before any MII register access is possible.
1778 For such PHY, set this option to the usec delay
1779 required. (minimum 300usec for LXT971A)
1780
1781 CONFIG_PHY_CMD_DELAY (ppc4xx)
1782
1783 Some PHY like Intel LXT971A need extra delay after
1784 command issued before MII status register can be read
1785
wdenkc6097192002-11-03 00:24:07 +00001786- IP address:
1787 CONFIG_IPADDR
1788
1789 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001790 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001791 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001792 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001793
1794- Server IP address:
1795 CONFIG_SERVERIP
1796
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001797 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001798 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001799 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001800
Robin Getz470a6d42009-07-21 12:15:28 -04001801 CONFIG_KEEP_SERVERADDR
1802
1803 Keeps the server's MAC address, in the env 'serveraddr'
1804 for passing to bootargs (like Linux's netconsole option)
1805
Wolfgang Denk26da2992011-10-26 10:21:22 +00001806- Gateway IP address:
1807 CONFIG_GATEWAYIP
1808
1809 Defines a default value for the IP address of the
1810 default router where packets to other networks are
1811 sent to.
1812 (Environment variable "gatewayip")
1813
1814- Subnet mask:
1815 CONFIG_NETMASK
1816
1817 Defines a default value for the subnet mask (or
1818 routing prefix) which is used to determine if an IP
1819 address belongs to the local subnet or needs to be
1820 forwarded through a router.
1821 (Environment variable "netmask")
1822
David Updegraff7280da72007-06-11 10:41:07 -05001823- Multicast TFTP Mode:
1824 CONFIG_MCAST_TFTP
1825
1826 Defines whether you want to support multicast TFTP as per
1827 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001828 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001829 driver in use must provide a function: mcast() to join/leave a
1830 multicast group.
1831
wdenkc6097192002-11-03 00:24:07 +00001832- BOOTP Recovery Mode:
1833 CONFIG_BOOTP_RANDOM_DELAY
1834
1835 If you have many targets in a network that try to
1836 boot using BOOTP, you may want to avoid that all
1837 systems send out BOOTP requests at precisely the same
1838 moment (which would happen for instance at recovery
1839 from a power failure, when all systems will try to
1840 boot, thus flooding the BOOTP server. Defining
1841 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1842 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001843 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001844
1845 1st BOOTP request: delay 0 ... 1 sec
1846 2nd BOOTP request: delay 0 ... 2 sec
1847 3rd BOOTP request: delay 0 ... 4 sec
1848 4th and following
1849 BOOTP requests: delay 0 ... 8 sec
1850
Thierry Reding8977cda2014-08-19 10:21:24 +02001851 CONFIG_BOOTP_ID_CACHE_SIZE
1852
1853 BOOTP packets are uniquely identified using a 32-bit ID. The
1854 server will copy the ID from client requests to responses and
1855 U-Boot will use this to determine if it is the destination of
1856 an incoming response. Some servers will check that addresses
1857 aren't in use before handing them out (usually using an ARP
1858 ping) and therefore take up to a few hundred milliseconds to
1859 respond. Network congestion may also influence the time it
1860 takes for a response to make it back to the client. If that
1861 time is too long, U-Boot will retransmit requests. In order
1862 to allow earlier responses to still be accepted after these
1863 retransmissions, U-Boot's BOOTP client keeps a small cache of
1864 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1865 cache. The default is to keep IDs for up to four outstanding
1866 requests. Increasing this will allow U-Boot to accept offers
1867 from a BOOTP client in networks with unusually high latency.
1868
stroesee0aadfb2003-08-28 14:17:32 +00001869- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001870 You can fine tune the DHCP functionality by defining
1871 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001872
Jon Loeliger5336a762007-07-09 22:08:34 -05001873 CONFIG_BOOTP_SUBNETMASK
1874 CONFIG_BOOTP_GATEWAY
1875 CONFIG_BOOTP_HOSTNAME
1876 CONFIG_BOOTP_NISDOMAIN
1877 CONFIG_BOOTP_BOOTPATH
1878 CONFIG_BOOTP_BOOTFILESIZE
1879 CONFIG_BOOTP_DNS
1880 CONFIG_BOOTP_DNS2
1881 CONFIG_BOOTP_SEND_HOSTNAME
1882 CONFIG_BOOTP_NTPSERVER
1883 CONFIG_BOOTP_TIMEOFFSET
1884 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001885 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001886
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001887 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1888 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001889
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001890 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1891 after the configured retry count, the call will fail
1892 instead of starting over. This can be used to fail over
1893 to Link-local IP address configuration if the DHCP server
1894 is not available.
1895
stroesee0aadfb2003-08-28 14:17:32 +00001896 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1897 serverip from a DHCP server, it is possible that more
1898 than one DNS serverip is offered to the client.
1899 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1900 serverip will be stored in the additional environment
1901 variable "dnsip2". The first DNS serverip is always
1902 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001903 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001904
1905 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1906 to do a dynamic update of a DNS server. To do this, they
1907 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001908 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001909 of the "hostname" environment variable is passed as
1910 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001911
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001912 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1913
1914 A 32bit value in microseconds for a delay between
1915 receiving a "DHCP Offer" and sending the "DHCP Request".
1916 This fixes a problem with certain DHCP servers that don't
1917 respond 100% of the time to a "DHCP request". E.g. On an
1918 AT91RM9200 processor running at 180MHz, this delay needed
1919 to be *at least* 15,000 usec before a Windows Server 2003
1920 DHCP server would reply 100% of the time. I recommend at
1921 least 50,000 usec to be safe. The alternative is to hope
1922 that one of the retries will be successful but note that
1923 the DHCP timeout and retry process takes a longer than
1924 this delay.
1925
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001926 - Link-local IP address negotiation:
1927 Negotiate with other link-local clients on the local network
1928 for an address that doesn't require explicit configuration.
1929 This is especially useful if a DHCP server cannot be guaranteed
1930 to exist in all environments that the device must operate.
1931
1932 See doc/README.link-local for more information.
1933
wdenk145d2c12004-04-15 21:48:45 +00001934 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001935 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001936
1937 The device id used in CDP trigger frames.
1938
1939 CONFIG_CDP_DEVICE_ID_PREFIX
1940
1941 A two character string which is prefixed to the MAC address
1942 of the device.
1943
1944 CONFIG_CDP_PORT_ID
1945
1946 A printf format string which contains the ascii name of
1947 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001948 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001949
1950 CONFIG_CDP_CAPABILITIES
1951
1952 A 32bit integer which indicates the device capabilities;
1953 0x00000010 for a normal host which does not forwards.
1954
1955 CONFIG_CDP_VERSION
1956
1957 An ascii string containing the version of the software.
1958
1959 CONFIG_CDP_PLATFORM
1960
1961 An ascii string containing the name of the platform.
1962
1963 CONFIG_CDP_TRIGGER
1964
1965 A 32bit integer sent on the trigger.
1966
1967 CONFIG_CDP_POWER_CONSUMPTION
1968
1969 A 16bit integer containing the power consumption of the
1970 device in .1 of milliwatts.
1971
1972 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1973
1974 A byte containing the id of the VLAN.
1975
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001976- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001977
1978 Several configurations allow to display the current
1979 status using a LED. For instance, the LED will blink
1980 fast while running U-Boot code, stop blinking as
1981 soon as a reply to a BOOTP request was received, and
1982 start blinking slow once the Linux kernel is running
1983 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001984 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001985 feature in U-Boot.
1986
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001987 Additional options:
1988
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001989 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001990 The status LED can be connected to a GPIO pin.
1991 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001992 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001993 to include the gpio_led driver in the U-Boot binary.
1994
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001995 CONFIG_GPIO_LED_INVERTED_TABLE
1996 Some GPIO connected LEDs may have inverted polarity in which
1997 case the GPIO high value corresponds to LED off state and
1998 GPIO low value corresponds to LED on state.
1999 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2000 with a list of GPIO LEDs that have inverted polarity.
2001
wdenkc6097192002-11-03 00:24:07 +00002002- CAN Support: CONFIG_CAN_DRIVER
2003
2004 Defining CONFIG_CAN_DRIVER enables CAN driver support
2005 on those systems that support this (optional)
2006 feature, like the TQM8xxL modules.
2007
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002008- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002009
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002010 This enable the NEW i2c subsystem, and will allow you to use
2011 i2c commands at the u-boot command line (as long as you set
2012 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2013 based realtime clock chips or other i2c devices. See
2014 common/cmd_i2c.c for a description of the command line
2015 interface.
2016
2017 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002018 - drivers/i2c/soft_i2c.c:
2019 - activate first bus with CONFIG_SYS_I2C_SOFT define
2020 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2021 for defining speed and slave address
2022 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2023 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2024 for defining speed and slave address
2025 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2026 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2027 for defining speed and slave address
2028 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2029 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2030 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002031
Heiko Schocherf2850742012-10-24 13:48:22 +02002032 - drivers/i2c/fsl_i2c.c:
2033 - activate i2c driver with CONFIG_SYS_I2C_FSL
2034 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2035 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2036 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2037 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002038 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002039 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2040 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2041 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2042 second bus.
2043
Simon Glass026fefb2012-10-30 07:28:53 +00002044 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002045 - activate this driver with CONFIG_SYS_I2C_TEGRA
2046 - This driver adds 4 i2c buses with a fix speed from
2047 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002048
Dirk Eibach42b204f2013-04-25 02:40:01 +00002049 - drivers/i2c/ppc4xx_i2c.c
2050 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2051 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2052 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2053
trema49f40a2013-09-21 18:13:35 +02002054 - drivers/i2c/i2c_mxc.c
2055 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002056 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2057 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2058 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2059 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002060 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2061 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2062 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2063 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2064 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2065 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002066 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2067 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002068 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002069 for speed, and 0 for slave.
2070
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002071 - drivers/i2c/rcar_i2c.c:
2072 - activate this driver with CONFIG_SYS_I2C_RCAR
2073 - This driver adds 4 i2c buses
2074
2075 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2076 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2077 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2078 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2079 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2080 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2081 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2082 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2083 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2084
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002085 - drivers/i2c/sh_i2c.c:
2086 - activate this driver with CONFIG_SYS_I2C_SH
2087 - This driver adds from 2 to 5 i2c buses
2088
2089 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2090 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2091 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2092 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2093 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2094 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2095 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2096 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2097 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2098 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002099 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002100
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002101 - drivers/i2c/omap24xx_i2c.c
2102 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2103 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2104 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2105 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2106 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2107 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2108 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2109 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2110 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2111 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2112 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2113
Heiko Schocher465819a2013-11-08 07:30:53 +01002114 - drivers/i2c/zynq_i2c.c
2115 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2116 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2117 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2118
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302119 - drivers/i2c/s3c24x0_i2c.c:
2120 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2121 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2122 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2123 with a fix speed from 100000 and the slave addr 0!
2124
Dirk Eibachb9577432014-07-03 09:28:18 +02002125 - drivers/i2c/ihs_i2c.c
2126 - activate this driver with CONFIG_SYS_I2C_IHS
2127 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2128 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2129 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2130 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2131 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2132 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2133 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2134 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2135 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2136 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2137 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2138 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002139 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2140 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2141 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2142 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2143 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2144 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2145 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2146 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2147 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002148
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002149 additional defines:
2150
2151 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002152 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002153
2154 CONFIG_SYS_I2C_DIRECT_BUS
2155 define this, if you don't use i2c muxes on your hardware.
2156 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2157 omit this define.
2158
2159 CONFIG_SYS_I2C_MAX_HOPS
2160 define how many muxes are maximal consecutively connected
2161 on one i2c bus. If you not use i2c muxes, omit this
2162 define.
2163
2164 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002165 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002166 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2167 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2168 CONFIG_SYS_NUM_I2C_BUSES = 9:
2169
2170 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2171 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2172 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2173 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2174 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2175 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2176 {1, {I2C_NULL_HOP}}, \
2177 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2178 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2179 }
2180
2181 which defines
2182 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002183 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2184 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2185 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2186 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2187 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002188 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002189 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2190 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002191
2192 If you do not have i2c muxes on your board, omit this define.
2193
Simon Glass3efce392017-05-12 21:10:00 -06002194- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002195 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002196 then the following macros need to be defined (examples are
2197 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002198
2199 I2C_INIT
2200
wdenkb9bbd242003-06-30 16:24:52 +00002201 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002202 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002203
wdenk544e9732004-02-06 23:19:44 +00002204 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002205
wdenkc6097192002-11-03 00:24:07 +00002206 I2C_PORT
2207
wdenk4a5c8a72003-03-06 00:02:04 +00002208 (Only for MPC8260 CPU). The I/O port to use (the code
2209 assumes both bits are on the same port). Valid values
2210 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002211
2212 I2C_ACTIVE
2213
2214 The code necessary to make the I2C data line active
2215 (driven). If the data line is open collector, this
2216 define can be null.
2217
wdenkb9bbd242003-06-30 16:24:52 +00002218 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2219
wdenkc6097192002-11-03 00:24:07 +00002220 I2C_TRISTATE
2221
2222 The code necessary to make the I2C data line tri-stated
2223 (inactive). If the data line is open collector, this
2224 define can be null.
2225
wdenkb9bbd242003-06-30 16:24:52 +00002226 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2227
wdenkc6097192002-11-03 00:24:07 +00002228 I2C_READ
2229
York Sun4a598092013-04-01 11:29:11 -07002230 Code that returns true if the I2C data line is high,
2231 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002232
wdenkb9bbd242003-06-30 16:24:52 +00002233 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2234
wdenkc6097192002-11-03 00:24:07 +00002235 I2C_SDA(bit)
2236
York Sun4a598092013-04-01 11:29:11 -07002237 If <bit> is true, sets the I2C data line high. If it
2238 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002239
wdenkb9bbd242003-06-30 16:24:52 +00002240 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002241 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002242 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002243
wdenkc6097192002-11-03 00:24:07 +00002244 I2C_SCL(bit)
2245
York Sun4a598092013-04-01 11:29:11 -07002246 If <bit> is true, sets the I2C clock line high. If it
2247 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002248
wdenkb9bbd242003-06-30 16:24:52 +00002249 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002250 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002251 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002252
wdenkc6097192002-11-03 00:24:07 +00002253 I2C_DELAY
2254
2255 This delay is invoked four times per clock cycle so this
2256 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002257 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002258 like:
2259
wdenkb9bbd242003-06-30 16:24:52 +00002260 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002261
Mike Frysingeree12d542010-07-21 13:38:02 -04002262 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2263
2264 If your arch supports the generic GPIO framework (asm/gpio.h),
2265 then you may alternatively define the two GPIOs that are to be
2266 used as SCL / SDA. Any of the previous I2C_xxx macros will
2267 have GPIO-based defaults assigned to them as appropriate.
2268
2269 You should define these to the GPIO value as given directly to
2270 the generic GPIO functions.
2271
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002272 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002273
wdenk57b2d802003-06-27 21:31:46 +00002274 When a board is reset during an i2c bus transfer
2275 chips might think that the current transfer is still
2276 in progress. On some boards it is possible to access
2277 the i2c SCLK line directly, either by using the
2278 processor pin as a GPIO or by having a second pin
2279 connected to the bus. If this option is defined a
2280 custom i2c_init_board() routine in boards/xxx/board.c
2281 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002282
Ben Warren45657152006-09-07 16:50:54 -04002283 CONFIG_I2C_MULTI_BUS
2284
2285 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002286 must have a controller. At any point in time, only one bus is
2287 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002288 Note that bus numbering is zero-based.
2289
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002290 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002291
2292 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002293 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002294 is set, specify a list of bus-device pairs. Otherwise, specify
2295 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002296
2297 e.g.
2298 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002299 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002300
2301 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2302
Wolfgang Denk092ae952011-10-26 10:21:21 +00002303 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002304 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002305
2306 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2307
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002308 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002309
2310 If defined, then this indicates the I2C bus number for DDR SPD.
2311 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2312
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002313 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002314
2315 If defined, then this indicates the I2C bus number for the RTC.
2316 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2317
Andrew Dyer58c41f92008-12-29 17:36:01 -06002318 CONFIG_SOFT_I2C_READ_REPEATED_START
2319
2320 defining this will force the i2c_read() function in
2321 the soft_i2c driver to perform an I2C repeated start
2322 between writing the address pointer and reading the
2323 data. If this define is omitted the default behaviour
2324 of doing a stop-start sequence will be used. Most I2C
2325 devices can use either method, but some require one or
2326 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002327
wdenkc6097192002-11-03 00:24:07 +00002328- SPI Support: CONFIG_SPI
2329
2330 Enables SPI driver (so far only tested with
2331 SPI EEPROM, also an instance works with Crystal A/D and
2332 D/As on the SACSng board)
2333
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002334 CONFIG_SH_SPI
2335
2336 Enables the driver for SPI controller on SuperH. Currently
2337 only SH7757 is supported.
2338
wdenkc6097192002-11-03 00:24:07 +00002339 CONFIG_SOFT_SPI
2340
wdenk4a5c8a72003-03-06 00:02:04 +00002341 Enables a software (bit-bang) SPI driver rather than
2342 using hardware support. This is a general purpose
2343 driver that only requires three general I/O port pins
2344 (two outputs, one input) to function. If this is
2345 defined, the board configuration must define several
2346 SPI configuration items (port pins to use, etc). For
2347 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002348
Ben Warren7efe9272008-01-16 22:37:35 -05002349 CONFIG_HARD_SPI
2350
2351 Enables a hardware SPI driver for general-purpose reads
2352 and writes. As with CONFIG_SOFT_SPI, the board configuration
2353 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002354 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002355 example, see include/configs/mpc8349emds.h.
2356
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002357 CONFIG_MXC_SPI
2358
2359 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002360 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002361
Heiko Schocherb77c8882014-07-14 10:22:11 +02002362 CONFIG_SYS_SPI_MXC_WAIT
2363 Timeout for waiting until spi transfer completed.
2364 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2365
Matthias Fuchsa4400872007-12-27 17:12:34 +01002366- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002367
Matthias Fuchsa4400872007-12-27 17:12:34 +01002368 Enables FPGA subsystem.
2369
2370 CONFIG_FPGA_<vendor>
2371
2372 Enables support for specific chip vendors.
2373 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002374
Matthias Fuchsa4400872007-12-27 17:12:34 +01002375 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002376
Matthias Fuchsa4400872007-12-27 17:12:34 +01002377 Enables support for FPGA family.
2378 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2379
2380 CONFIG_FPGA_COUNT
2381
2382 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002383
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002384 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002385
wdenk57b2d802003-06-27 21:31:46 +00002386 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002387
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002388 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002389
wdenk4a5c8a72003-03-06 00:02:04 +00002390 Enable checks on FPGA configuration interface busy
2391 status by the configuration function. This option
2392 will require a board or device specific function to
2393 be written.
wdenkc6097192002-11-03 00:24:07 +00002394
2395 CONFIG_FPGA_DELAY
2396
2397 If defined, a function that provides delays in the FPGA
2398 configuration driver.
2399
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002400 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002401 Allow Control-C to interrupt FPGA configuration
2402
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002403 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002404
wdenk4a5c8a72003-03-06 00:02:04 +00002405 Check for configuration errors during FPGA bitfile
2406 loading. For example, abort during Virtex II
2407 configuration if the INIT_B line goes low (which
2408 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002409
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002410 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002411
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002412 Maximum time to wait for the INIT_B line to de-assert
2413 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002414 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002415 ms.
wdenkc6097192002-11-03 00:24:07 +00002416
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002417 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002418
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002419 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002420 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002421
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002422 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002423
wdenk4a5c8a72003-03-06 00:02:04 +00002424 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002425 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002426
2427- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002428 CONFIG_BUILD_TARGET
2429
2430 Some SoCs need special image types (e.g. U-Boot binary
2431 with a special header) as build targets. By defining
2432 CONFIG_BUILD_TARGET in the SoC / board header, this
2433 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002434 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002435
wdenkc6097192002-11-03 00:24:07 +00002436 CONFIG_IDENT_STRING
2437
wdenk4a5c8a72003-03-06 00:02:04 +00002438 If defined, this string will be added to the U-Boot
2439 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002440
2441- Vendor Parameter Protection:
2442
wdenk4a5c8a72003-03-06 00:02:04 +00002443 U-Boot considers the values of the environment
2444 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002445 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002446 are set once by the board vendor / manufacturer, and
2447 protects these variables from casual modification by
2448 the user. Once set, these variables are read-only,
2449 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002450 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002451
2452 If CONFIG_ENV_OVERWRITE is #defined in your config
2453 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002454 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002455 these parameters.
2456
Joe Hershberger76f353e2015-05-04 14:55:14 -05002457 Alternatively, if you define _both_ an ethaddr in the
2458 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002459 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002460 which can be changed exactly ONCE by the user. [The
2461 serial# is unaffected by this, i. e. it remains
2462 read-only.]
2463
Joe Hershberger71497d02012-12-11 22:16:31 -06002464 The same can be accomplished in a more flexible way
2465 for any variable by configuring the type of access
2466 to allow for those variables in the ".flags" variable
2467 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2468
wdenkc6097192002-11-03 00:24:07 +00002469- Protected RAM:
2470 CONFIG_PRAM
2471
2472 Define this variable to enable the reservation of
2473 "protected RAM", i. e. RAM which is not overwritten
2474 by U-Boot. Define CONFIG_PRAM to hold the number of
2475 kB you want to reserve for pRAM. You can overwrite
2476 this default value by defining an environment
2477 variable "pram" to the number of kB you want to
2478 reserve. Note that the board info structure will
2479 still show the full amount of RAM. If pRAM is
2480 reserved, a new environment variable "mem" will
2481 automatically be defined to hold the amount of
2482 remaining RAM in a form that can be passed as boot
2483 argument to Linux, for instance like that:
2484
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002485 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002486 saveenv
2487
2488 This way you can tell Linux not to use this memory,
2489 either, which results in a memory region that will
2490 not be affected by reboots.
2491
2492 *WARNING* If your board configuration uses automatic
2493 detection of the RAM size, you must make sure that
2494 this memory test is non-destructive. So far, the
2495 following board configurations are known to be
2496 "pRAM-clean":
2497
Wolfgang Denk90326762012-10-24 02:36:15 +00002498 IVMS8, IVML24, SPD8xx, TQM8xxL,
2499 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002500 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002501
Gabe Blacka2f3a932012-12-02 04:55:18 +00002502- Access to physical memory region (> 4GB)
2503 Some basic support is provided for operations on memory not
2504 normally accessible to U-Boot - e.g. some architectures
2505 support access to more than 4GB of memory on 32-bit
2506 machines using physical address extension or similar.
2507 Define CONFIG_PHYSMEM to access this basic support, which
2508 currently only supports clearing the memory.
2509
wdenkc6097192002-11-03 00:24:07 +00002510- Error Recovery:
2511 CONFIG_PANIC_HANG
2512
2513 Define this variable to stop the system in case of a
2514 fatal error, so that you have to reset it manually.
2515 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002516 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002517 automatically as fast as possible, but it may be
2518 useful during development since you can try to debug
2519 the conditions that lead to the situation.
2520
2521 CONFIG_NET_RETRY_COUNT
2522
wdenk4a5c8a72003-03-06 00:02:04 +00002523 This variable defines the number of retries for
2524 network operations like ARP, RARP, TFTP, or BOOTP
2525 before giving up the operation. If not defined, a
2526 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002527
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002528 CONFIG_ARP_TIMEOUT
2529
2530 Timeout waiting for an ARP reply in milliseconds.
2531
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002532 CONFIG_NFS_TIMEOUT
2533
2534 Timeout in milliseconds used in NFS protocol.
2535 If you encounter "ERROR: Cannot umount" in nfs command,
2536 try longer timeout such as
2537 #define CONFIG_NFS_TIMEOUT 10000UL
2538
wdenkc6097192002-11-03 00:24:07 +00002539- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002540 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002541
2542 Enable auto completion of commands using TAB.
2543
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002544 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002545
2546 This defines the secondary prompt string, which is
2547 printed when the command interpreter needs more input
2548 to complete a command. Usually "> ".
2549
2550 Note:
2551
wdenk57b2d802003-06-27 21:31:46 +00002552 In the current implementation, the local variables
2553 space and global environment variables space are
2554 separated. Local variables are those you define by
2555 simply typing `name=value'. To access a local
2556 variable later on, you have write `$name' or
2557 `${name}'; to execute the contents of a variable
2558 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002559
wdenk4a5c8a72003-03-06 00:02:04 +00002560 Global environment variables are those you use
2561 setenv/printenv to work with. To run a command stored
2562 in such a variable, you need to use the run command,
2563 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002564
2565 To store commands and special characters in a
2566 variable, please use double quotation marks
2567 surrounding the whole text of the variable, instead
2568 of the backslashes before semicolons and special
2569 symbols.
2570
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002571- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002572 CONFIG_CMDLINE_EDITING
2573
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002574 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002575 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002576
Marek Vasut734fb042016-01-27 04:47:55 +01002577- Command Line PS1/PS2 support:
2578 CONFIG_CMDLINE_PS_SUPPORT
2579
2580 Enable support for changing the command prompt string
2581 at run-time. Only static string is supported so far.
2582 The string is obtained from environment variables PS1
2583 and PS2.
2584
wdenkc0aa5c52003-12-06 19:49:23 +00002585- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002586 CONFIG_EXTRA_ENV_SETTINGS
2587
wdenk4a5c8a72003-03-06 00:02:04 +00002588 Define this to contain any number of null terminated
2589 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002590 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002591
wdenk4a5c8a72003-03-06 00:02:04 +00002592 For example, place something like this in your
2593 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002594
2595 #define CONFIG_EXTRA_ENV_SETTINGS \
2596 "myvar1=value1\0" \
2597 "myvar2=value2\0"
2598
wdenk4a5c8a72003-03-06 00:02:04 +00002599 Warning: This method is based on knowledge about the
2600 internal format how the environment is stored by the
2601 U-Boot code. This is NOT an official, exported
2602 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002603 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002604 You better know what you are doing here.
2605
wdenk4a5c8a72003-03-06 00:02:04 +00002606 Note: overly (ab)use of the default environment is
2607 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002608 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002609 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002610
Stephen Warren1465d5f2012-05-22 09:21:54 +00002611 CONFIG_ENV_VARS_UBOOT_CONFIG
2612
2613 Define this in order to add variables describing the
2614 U-Boot build configuration to the default environment.
2615 These will be named arch, cpu, board, vendor, and soc.
2616
2617 Enabling this option will cause the following to be defined:
2618
2619 - CONFIG_SYS_ARCH
2620 - CONFIG_SYS_CPU
2621 - CONFIG_SYS_BOARD
2622 - CONFIG_SYS_VENDOR
2623 - CONFIG_SYS_SOC
2624
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002625 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2626
2627 Define this in order to add variables describing certain
2628 run-time determined information about the hardware to the
2629 environment. These will be named board_name, board_rev.
2630
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002631 CONFIG_DELAY_ENVIRONMENT
2632
2633 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002634 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002635 that so that the environment is not available until
2636 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2637 this is instead controlled by the value of
2638 /config/load-environment.
2639
wdenkc0aa5c52003-12-06 19:49:23 +00002640- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002641 CONFIG_HAS_DATAFLASH
2642
wdenk57b2d802003-06-27 21:31:46 +00002643 Defining this option enables DataFlash features and
2644 allows to read/write in Dataflash via the standard
2645 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002646
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002647- Serial Flash support
2648 CONFIG_CMD_SF
2649
2650 Defining this option enables SPI flash commands
2651 'sf probe/read/write/erase/update'.
2652
2653 Usage requires an initial 'probe' to define the serial
2654 flash parameters, followed by read/write/erase/update
2655 commands.
2656
2657 The following defaults may be provided by the platform
2658 to handle the common case when only a single serial
2659 flash is present on the system.
2660
2661 CONFIG_SF_DEFAULT_BUS Bus identifier
2662 CONFIG_SF_DEFAULT_CS Chip-select
2663 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2664 CONFIG_SF_DEFAULT_SPEED in Hz
2665
Simon Glass4b5545e2012-10-08 13:16:02 +00002666 CONFIG_CMD_SF_TEST
2667
2668 Define this option to include a destructive SPI flash
2669 test ('sf test').
2670
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302671 CONFIG_SF_DUAL_FLASH Dual flash memories
2672
2673 Define this option to use dual flash support where two flash
2674 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002675 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302676
wdenkef893942004-02-23 16:11:30 +00002677- SystemACE Support:
2678 CONFIG_SYSTEMACE
2679
2680 Adding this option adds support for Xilinx SystemACE
2681 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002682 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002683 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002684
2685 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002686 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002687
2688 When SystemACE support is added, the "ace" device type
2689 becomes available to the fat commands, i.e. fatls.
2690
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002691- TFTP Fixed UDP Port:
2692 CONFIG_TFTP_PORT
2693
Wolfgang Denk227b5192005-09-24 23:25:46 +02002694 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002695 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002696 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002697 number generator is used.
2698
Wolfgang Denk227b5192005-09-24 23:25:46 +02002699 Also, the environment variable tftpdstp is used to supply
2700 the TFTP UDP destination port value. If tftpdstp isn't
2701 defined, the normal port 69 is used.
2702
2703 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002704 blindly start the TFTP transfer using the pre-configured
2705 target IP address and UDP port. This has the effect of
2706 "punching through" the (Windows XP) firewall, allowing
2707 the remainder of the TFTP transfer to proceed normally.
2708 A better solution is to properly configure the firewall,
2709 but sometimes that is not allowed.
2710
Simon Glass058bb8d2012-12-05 14:46:38 +00002711- Hashing support:
Simon Glass058bb8d2012-12-05 14:46:38 +00002712 CONFIG_HASH_VERIFY
2713
2714 Enable the hash verify command (hash -v). This adds to code
2715 size a little.
2716
Simon Glass058bb8d2012-12-05 14:46:38 +00002717 Note: There is also a sha1sum command, which should perhaps
2718 be deprecated in favour of 'hash sha1'.
2719
Robert Winkler765ccf42013-07-24 17:57:06 -07002720- Freescale i.MX specific commands:
2721 CONFIG_CMD_HDMIDETECT
2722 This enables 'hdmidet' command which returns true if an
2723 HDMI monitor is detected. This command is i.MX 6 specific.
2724
Heiko Schocher443ca402014-01-25 07:27:13 +01002725- bootcount support:
2726 CONFIG_BOOTCOUNT_LIMIT
2727
2728 This enables the bootcounter support, see:
2729 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2730
2731 CONFIG_AT91SAM9XE
2732 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002733 CONFIG_SOC_DA8XX
2734 enable special bootcounter support on da850 based boards.
2735 CONFIG_BOOTCOUNT_RAM
2736 enable support for the bootcounter in RAM
2737 CONFIG_BOOTCOUNT_I2C
2738 enable support for the bootcounter on an i2c (like RTC) device.
2739 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2740 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2741 the bootcounter.
2742 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002743
wdenkc0aa5c52003-12-06 19:49:23 +00002744- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002745 CONFIG_SHOW_BOOT_PROGRESS
2746
wdenk4a5c8a72003-03-06 00:02:04 +00002747 Defining this option allows to add some board-
2748 specific code (calling a user-provided function
2749 "show_boot_progress(int)") that enables you to show
2750 the system's boot progress on some display (for
2751 example, some LED's) on your board. At the moment,
2752 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002753
Simon Glass0fa36a42012-09-28 08:56:37 +00002754
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002755Legacy uImage format:
2756
wdenkc6097192002-11-03 00:24:07 +00002757 Arg Where When
2758 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002759 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002760 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002761 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002762 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002763 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002764 4 common/cmd_bootm.c Image data has correct checksum
2765 -4 common/cmd_bootm.c Image is for unsupported architecture
2766 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002767 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002768 6 common/cmd_bootm.c Image Type check OK
2769 -6 common/cmd_bootm.c gunzip uncompression error
2770 -7 common/cmd_bootm.c Unimplemented compression type
2771 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002772 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002773 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002774
2775 9 common/image.c Start initial ramdisk verification
2776 -10 common/image.c Ramdisk header has bad magic number
2777 -11 common/image.c Ramdisk header has bad checksum
2778 10 common/image.c Ramdisk header is OK
2779 -12 common/image.c Ramdisk data has bad checksum
2780 11 common/image.c Ramdisk data has correct checksum
2781 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002782 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002783 13 common/image.c Start multifile image verification
2784 14 common/image.c No initial ramdisk, no multifile, continue.
2785
Wolfgang Denk092ae952011-10-26 10:21:21 +00002786 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002787
Stefan Roese88fbf932010-04-15 16:07:28 +02002788 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002789 -31 post/post.c POST test failed, detected by post_output_backlog()
2790 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002791
Heiko Schocher633e03a2007-06-22 19:11:54 +02002792 34 common/cmd_doc.c before loading a Image from a DOC device
2793 -35 common/cmd_doc.c Bad usage of "doc" command
2794 35 common/cmd_doc.c correct usage of "doc" command
2795 -36 common/cmd_doc.c No boot device
2796 36 common/cmd_doc.c correct boot device
2797 -37 common/cmd_doc.c Unknown Chip ID on boot device
2798 37 common/cmd_doc.c correct chip ID found, device available
2799 -38 common/cmd_doc.c Read Error on boot device
2800 38 common/cmd_doc.c reading Image header from DOC device OK
2801 -39 common/cmd_doc.c Image header has bad magic number
2802 39 common/cmd_doc.c Image header has correct magic number
2803 -40 common/cmd_doc.c Error reading Image from DOC device
2804 40 common/cmd_doc.c Image header has correct magic number
2805 41 common/cmd_ide.c before loading a Image from a IDE device
2806 -42 common/cmd_ide.c Bad usage of "ide" command
2807 42 common/cmd_ide.c correct usage of "ide" command
2808 -43 common/cmd_ide.c No boot device
2809 43 common/cmd_ide.c boot device found
2810 -44 common/cmd_ide.c Device not available
2811 44 common/cmd_ide.c Device available
2812 -45 common/cmd_ide.c wrong partition selected
2813 45 common/cmd_ide.c partition selected
2814 -46 common/cmd_ide.c Unknown partition table
2815 46 common/cmd_ide.c valid partition table found
2816 -47 common/cmd_ide.c Invalid partition type
2817 47 common/cmd_ide.c correct partition type
2818 -48 common/cmd_ide.c Error reading Image Header on boot device
2819 48 common/cmd_ide.c reading Image Header from IDE device OK
2820 -49 common/cmd_ide.c Image header has bad magic number
2821 49 common/cmd_ide.c Image header has correct magic number
2822 -50 common/cmd_ide.c Image header has bad checksum
2823 50 common/cmd_ide.c Image header has correct checksum
2824 -51 common/cmd_ide.c Error reading Image from IDE device
2825 51 common/cmd_ide.c reading Image from IDE device OK
2826 52 common/cmd_nand.c before loading a Image from a NAND device
2827 -53 common/cmd_nand.c Bad usage of "nand" command
2828 53 common/cmd_nand.c correct usage of "nand" command
2829 -54 common/cmd_nand.c No boot device
2830 54 common/cmd_nand.c boot device found
2831 -55 common/cmd_nand.c Unknown Chip ID on boot device
2832 55 common/cmd_nand.c correct chip ID found, device available
2833 -56 common/cmd_nand.c Error reading Image Header on boot device
2834 56 common/cmd_nand.c reading Image Header from NAND device OK
2835 -57 common/cmd_nand.c Image header has bad magic number
2836 57 common/cmd_nand.c Image header has correct magic number
2837 -58 common/cmd_nand.c Error reading Image from NAND device
2838 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002839
Heiko Schocher633e03a2007-06-22 19:11:54 +02002840 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002841
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002842 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002843 -64 net/eth.c no Ethernet found.
2844 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002845
Heiko Schocher633e03a2007-06-22 19:11:54 +02002846 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002847 80 common/cmd_net.c before calling net_loop()
2848 -81 common/cmd_net.c some error in net_loop() occurred
2849 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002850 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2851 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002852 83 common/cmd_net.c running "source" command
2853 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002854 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002855
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002856FIT uImage format:
2857
2858 Arg Where When
2859 100 common/cmd_bootm.c Kernel FIT Image has correct format
2860 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2861 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2862 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2863 102 common/cmd_bootm.c Kernel unit name specified
2864 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002865 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002866 104 common/cmd_bootm.c Got kernel subimage node offset
2867 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2868 105 common/cmd_bootm.c Kernel subimage hash verification OK
2869 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2870 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002871 -106 common/cmd_bootm.c Kernel subimage has wrong type
2872 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002873 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2874 108 common/cmd_bootm.c Got kernel subimage data/size
2875 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2876 -109 common/cmd_bootm.c Can't get kernel subimage type
2877 -110 common/cmd_bootm.c Can't get kernel subimage comp
2878 -111 common/cmd_bootm.c Can't get kernel subimage os
2879 -112 common/cmd_bootm.c Can't get kernel subimage load address
2880 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2881
2882 120 common/image.c Start initial ramdisk verification
2883 -120 common/image.c Ramdisk FIT image has incorrect format
2884 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002885 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002886 -122 common/image.c Can't get configuration for ramdisk subimage
2887 123 common/image.c Ramdisk unit name specified
2888 -124 common/image.c Can't get ramdisk subimage node offset
2889 125 common/image.c Got ramdisk subimage node offset
2890 -125 common/image.c Ramdisk subimage hash verification failed
2891 126 common/image.c Ramdisk subimage hash verification OK
2892 -126 common/image.c Ramdisk subimage for unsupported architecture
2893 127 common/image.c Architecture check OK
2894 -127 common/image.c Can't get ramdisk subimage data/size
2895 128 common/image.c Got ramdisk subimage data/size
2896 129 common/image.c Can't get ramdisk load address
2897 -129 common/image.c Got ramdisk load address
2898
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002899 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002900 131 common/cmd_doc.c FIT image format OK
2901
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002902 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002903 141 common/cmd_ide.c FIT image format OK
2904
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002905 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002906 151 common/cmd_nand.c FIT image format OK
2907
Heiko Schocher515eb122014-05-28 11:33:33 +02002908- legacy image format:
2909 CONFIG_IMAGE_FORMAT_LEGACY
2910 enables the legacy image format support in U-Boot.
2911
2912 Default:
2913 enabled if CONFIG_FIT_SIGNATURE is not defined.
2914
2915 CONFIG_DISABLE_IMAGE_LEGACY
2916 disable the legacy image format
2917
2918 This define is introduced, as the legacy image format is
2919 enabled per default for backward compatibility.
2920
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002921- Standalone program support:
2922 CONFIG_STANDALONE_LOAD_ADDR
2923
Wolfgang Denk23f78482011-10-09 21:06:34 +02002924 This option defines a board specific value for the
2925 address where standalone program gets loaded, thus
2926 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002927 settings.
2928
2929- Frame Buffer Address:
2930 CONFIG_FB_ADDR
2931
2932 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002933 address for frame buffer. This is typically the case
2934 when using a graphics controller has separate video
2935 memory. U-Boot will then place the frame buffer at
2936 the given address instead of dynamically reserving it
2937 in system RAM by calling lcd_setmem(), which grabs
2938 the memory for the frame buffer depending on the
2939 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002940
2941 Please see board_init_f function.
2942
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002943- Automatic software updates via TFTP server
2944 CONFIG_UPDATE_TFTP
2945 CONFIG_UPDATE_TFTP_CNT_MAX
2946 CONFIG_UPDATE_TFTP_MSEC_MAX
2947
2948 These options enable and control the auto-update feature;
2949 for a more detailed description refer to doc/README.update.
2950
2951- MTD Support (mtdparts command, UBI support)
2952 CONFIG_MTD_DEVICE
2953
2954 Adds the MTD device infrastructure from the Linux kernel.
2955 Needed for mtdparts command support.
2956
2957 CONFIG_MTD_PARTITIONS
2958
2959 Adds the MTD partitioning infrastructure from the Linux
2960 kernel. Needed for UBI support.
2961
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002962- UBI support
2963 CONFIG_CMD_UBI
2964
2965 Adds commands for interacting with MTD partitions formatted
2966 with the UBI flash translation layer
2967
2968 Requires also defining CONFIG_RBTREE
2969
Joe Hershberger47550fc2013-04-08 10:32:49 +00002970 CONFIG_UBI_SILENCE_MSG
2971
2972 Make the verbose messages from UBI stop printing. This leaves
2973 warnings and errors enabled.
2974
Heiko Schocherf5895d12014-06-24 10:10:04 +02002975
2976 CONFIG_MTD_UBI_WL_THRESHOLD
2977 This parameter defines the maximum difference between the highest
2978 erase counter value and the lowest erase counter value of eraseblocks
2979 of UBI devices. When this threshold is exceeded, UBI starts performing
2980 wear leveling by means of moving data from eraseblock with low erase
2981 counter to eraseblocks with high erase counter.
2982
2983 The default value should be OK for SLC NAND flashes, NOR flashes and
2984 other flashes which have eraseblock life-cycle 100000 or more.
2985 However, in case of MLC NAND flashes which typically have eraseblock
2986 life-cycle less than 10000, the threshold should be lessened (e.g.,
2987 to 128 or 256, although it does not have to be power of 2).
2988
2989 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002990
Heiko Schocherf5895d12014-06-24 10:10:04 +02002991 CONFIG_MTD_UBI_BEB_LIMIT
2992 This option specifies the maximum bad physical eraseblocks UBI
2993 expects on the MTD device (per 1024 eraseblocks). If the
2994 underlying flash does not admit of bad eraseblocks (e.g. NOR
2995 flash), this value is ignored.
2996
2997 NAND datasheets often specify the minimum and maximum NVM
2998 (Number of Valid Blocks) for the flashes' endurance lifetime.
2999 The maximum expected bad eraseblocks per 1024 eraseblocks
3000 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3001 which gives 20 for most NANDs (MaxNVB is basically the total
3002 count of eraseblocks on the chip).
3003
3004 To put it differently, if this value is 20, UBI will try to
3005 reserve about 1.9% of physical eraseblocks for bad blocks
3006 handling. And that will be 1.9% of eraseblocks on the entire
3007 NAND chip, not just the MTD partition UBI attaches. This means
3008 that if you have, say, a NAND flash chip admits maximum 40 bad
3009 eraseblocks, and it is split on two MTD partitions of the same
3010 size, UBI will reserve 40 eraseblocks when attaching a
3011 partition.
3012
3013 default: 20
3014
3015 CONFIG_MTD_UBI_FASTMAP
3016 Fastmap is a mechanism which allows attaching an UBI device
3017 in nearly constant time. Instead of scanning the whole MTD device it
3018 only has to locate a checkpoint (called fastmap) on the device.
3019 The on-flash fastmap contains all information needed to attach
3020 the device. Using fastmap makes only sense on large devices where
3021 attaching by scanning takes long. UBI will not automatically install
3022 a fastmap on old images, but you can set the UBI parameter
3023 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3024 that fastmap-enabled images are still usable with UBI implementations
3025 without fastmap support. On typical flash devices the whole fastmap
3026 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3027
3028 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3029 Set this parameter to enable fastmap automatically on images
3030 without a fastmap.
3031 default: 0
3032
Heiko Schocher94b66de2015-10-22 06:19:21 +02003033 CONFIG_MTD_UBI_FM_DEBUG
3034 Enable UBI fastmap debug
3035 default: 0
3036
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003037- UBIFS support
3038 CONFIG_CMD_UBIFS
3039
3040 Adds commands for interacting with UBI volumes formatted as
3041 UBIFS. UBIFS is read-only in u-boot.
3042
3043 Requires UBI support as well as CONFIG_LZO
3044
Joe Hershberger47550fc2013-04-08 10:32:49 +00003045 CONFIG_UBIFS_SILENCE_MSG
3046
3047 Make the verbose messages from UBIFS stop printing. This leaves
3048 warnings and errors enabled.
3049
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003050- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003051 CONFIG_SPL
3052 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003053
Tom Rini36853852012-02-14 07:29:40 +00003054 CONFIG_SPL_LDSCRIPT
3055 LDSCRIPT for linking the SPL binary.
3056
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003057 CONFIG_SPL_MAX_FOOTPRINT
3058 Maximum size in memory allocated to the SPL, BSS included.
3059 When defined, the linker checks that the actual memory
3060 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003061 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003062 must not be both defined at the same time.
3063
Tom Rini36853852012-02-14 07:29:40 +00003064 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003065 Maximum size of the SPL image (text, data, rodata, and
3066 linker lists sections), BSS excluded.
3067 When defined, the linker checks that the actual size does
3068 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003069
Wolfgang Denk825223d2011-09-11 21:24:09 +02003070 CONFIG_SPL_TEXT_BASE
3071 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003072
Scott Woodc4f0d002012-09-20 19:05:12 -05003073 CONFIG_SPL_RELOC_TEXT_BASE
3074 Address to relocate to. If unspecified, this is equal to
3075 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3076
Tom Rini36853852012-02-14 07:29:40 +00003077 CONFIG_SPL_BSS_START_ADDR
3078 Link address for the BSS within the SPL binary.
3079
3080 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003081 Maximum size in memory allocated to the SPL BSS.
3082 When defined, the linker checks that the actual memory used
3083 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003084 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003085 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003086
3087 CONFIG_SPL_STACK
3088 Adress of the start of the stack SPL will use
3089
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003090 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3091 When defined, SPL will panic() if the image it has
3092 loaded does not have a signature.
3093 Defining this is useful when code which loads images
3094 in SPL cannot guarantee that absolutely all read errors
3095 will be caught.
3096 An example is the LPC32XX MLC NAND driver, which will
3097 consider that a completely unreadable NAND block is bad,
3098 and thus should be skipped silently.
3099
Scott Woodc4f0d002012-09-20 19:05:12 -05003100 CONFIG_SPL_RELOC_STACK
3101 Adress of the start of the stack SPL will use after
3102 relocation. If unspecified, this is equal to
3103 CONFIG_SPL_STACK.
3104
Tom Rini36853852012-02-14 07:29:40 +00003105 CONFIG_SYS_SPL_MALLOC_START
3106 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003107 When this option is set the full malloc is used in SPL and
3108 it is set up by spl_init() and before that, the simple malloc()
3109 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003110
3111 CONFIG_SYS_SPL_MALLOC_SIZE
3112 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003113
Tom Rini28591df2012-08-13 12:03:19 -07003114 CONFIG_SPL_FRAMEWORK
3115 Enable the SPL framework under common/. This framework
3116 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3117 NAND loading of the Linux Kernel.
3118
Tom Rinic2b76002014-03-28 12:03:39 -04003119 CONFIG_SPL_OS_BOOT
3120 Enable booting directly to an OS from SPL.
3121 See also: doc/README.falcon
3122
Tom Rinife3b0c72012-08-13 11:37:56 -07003123 CONFIG_SPL_DISPLAY_PRINT
3124 For ARM, enable an optional function to print more information
3125 about the running system.
3126
Scott Wood7c810902012-09-20 16:35:21 -05003127 CONFIG_SPL_INIT_MINIMAL
3128 Arch init code should be built for a very small image
3129
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003130 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3131 Partition on the MMC to load U-Boot from when the MMC is being
3132 used in raw mode
3133
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003134 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3135 Sector to load kernel uImage from when MMC is being
3136 used in raw mode (for Falcon mode)
3137
3138 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3139 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3140 Sector and number of sectors to load kernel argument
3141 parameters from when MMC is being used in raw mode
3142 (for falcon mode)
3143
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003144 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3145 Partition on the MMC to load U-Boot from when the MMC is being
3146 used in fs mode
3147
Guillaume GARDET5065b712014-10-15 17:53:13 +02003148 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3149 Filename to read to load U-Boot when reading from filesystem
3150
3151 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003152 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003153 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003154
Guillaume GARDET5065b712014-10-15 17:53:13 +02003155 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003156 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003157 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003158
Scott Wood2b36fbb2012-12-06 13:33:17 +00003159 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3160 Set this for NAND SPL on PPC mpc83xx targets, so that
3161 start.S waits for the rest of the SPL to load before
3162 continuing (the hardware starts execution after just
3163 loading the first page rather than the full 4K).
3164
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303165 CONFIG_SPL_SKIP_RELOCATE
3166 Avoid SPL relocation
3167
Scott Woodc352a0c2012-09-20 19:09:07 -05003168 CONFIG_SPL_NAND_BASE
3169 Include nand_base.c in the SPL. Requires
3170 CONFIG_SPL_NAND_DRIVERS.
3171
3172 CONFIG_SPL_NAND_DRIVERS
3173 SPL uses normal NAND drivers, not minimal drivers.
3174
3175 CONFIG_SPL_NAND_ECC
3176 Include standard software ECC in the SPL
3177
Tom Rini36853852012-02-14 07:29:40 +00003178 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003179 Support for NAND boot using simple NAND drivers that
3180 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003181
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003182 CONFIG_SPL_UBI
3183 Support for a lightweight UBI (fastmap) scanner and
3184 loader
3185
Heiko Schochercf000272014-10-31 08:31:00 +01003186 CONFIG_SPL_NAND_RAW_ONLY
3187 Support to boot only raw u-boot.bin images. Use this only
3188 if you need to save space.
3189
Ying Zhangdfb2b152013-08-16 15:16:12 +08003190 CONFIG_SPL_COMMON_INIT_DDR
3191 Set for common ddr init with serial presence detect in
3192 SPL binary.
3193
Tom Rini36853852012-02-14 07:29:40 +00003194 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3195 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3196 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3197 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3198 CONFIG_SYS_NAND_ECCBYTES
3199 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003200 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003201
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303202 CONFIG_SPL_NAND_BOOT
3203 Add support NAND boot
3204
Tom Rini36853852012-02-14 07:29:40 +00003205 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003206 Location in NAND to read U-Boot from
3207
3208 CONFIG_SYS_NAND_U_BOOT_DST
3209 Location in memory to load U-Boot to
3210
3211 CONFIG_SYS_NAND_U_BOOT_SIZE
3212 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003213
3214 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003215 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003216
3217 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3218 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003219 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003220
3221 CONFIG_SPL_OMAP3_ID_NAND
3222 Support for an OMAP3-specific set of functions to return the
3223 ID and MFR of the first attached NAND chip, if present.
3224
Pavel Machekde997252012-08-30 22:42:11 +02003225 CONFIG_SPL_RAM_DEVICE
3226 Support for running image already present in ram, in SPL binary
3227
Scott Woodeb7bd972012-12-06 13:33:16 +00003228 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003229 Image offset to which the SPL should be padded before appending
3230 the SPL payload. By default, this is defined as
3231 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3232 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3233 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003234
Scott Woodf147eb72012-09-21 16:27:32 -05003235 CONFIG_SPL_TARGET
3236 Final target image containing SPL and payload. Some SPLs
3237 use an arch-specific makefile fragment instead, for
3238 example if more than one image needs to be produced.
3239
Simon Glass82d94532013-05-08 08:05:59 +00003240 CONFIG_FIT_SPL_PRINT
3241 Printing information about a FIT image adds quite a bit of
3242 code to SPL. So this is normally disabled in SPL. Use this
3243 option to re-enable it. This will affect the output of the
3244 bootm command when booting a FIT image.
3245
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003246- TPL framework
3247 CONFIG_TPL
3248 Enable building of TPL globally.
3249
3250 CONFIG_TPL_PAD_TO
3251 Image offset to which the TPL should be padded before appending
3252 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003253 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3254 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3255 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003256
wdenkc0aa5c52003-12-06 19:49:23 +00003257- Interrupt support (PPC):
3258
wdenk1ebf41e2004-01-02 14:00:00 +00003259 There are common interrupt_init() and timer_interrupt()
3260 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003261 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003262 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003263 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003264 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003265 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003266 specific handling. If board has watchdog / status_led
3267 / other_activity_monitor it works automatically from
3268 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003269
wdenkc6097192002-11-03 00:24:07 +00003270
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003271Board initialization settings:
3272------------------------------
3273
3274During Initialization u-boot calls a number of board specific functions
3275to allow the preparation of board specific prerequisites, e.g. pin setup
3276before drivers are initialized. To enable these callbacks the
3277following configuration macros have to be defined. Currently this is
3278architecture specific, so please check arch/your_architecture/lib/board.c
3279typically in board_init_f() and board_init_r().
3280
3281- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3282- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3283- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3284- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003285
wdenkc6097192002-11-03 00:24:07 +00003286Configuration Settings:
3287-----------------------
3288
York Sun6c480012014-02-26 17:03:19 -08003289- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3290 Optionally it can be defined to support 64-bit memory commands.
3291
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003292- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003293 undefine this when you're short of memory.
3294
Peter Tyserdfb72b82009-01-27 18:03:12 -06003295- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3296 width of the commands listed in the 'help' command output.
3297
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003298- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003299 prompt for user input.
3300
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003301- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003302
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003303- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003304
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003305- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003306
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003307- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003308 the application (usually a Linux kernel) when it is
3309 booted
3310
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003311- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003312 List of legal baudrate settings for this board.
3313
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003314- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003315 Begin and End addresses of the area used by the
3316 simple memory test.
3317
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003318- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003319 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003320
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003321- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003322 Scratch address used by the alternate memory test
3323 You only need to set this if address zero isn't writeable
3324
York Sun5d286cd2015-12-04 11:57:07 -08003325- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003326 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003327 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3328 is substracted from total RAM and won't be reported to OS.
3329 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003330 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003331 the RAM base is not zero, or RAM is divided into banks,
3332 this variable needs to be recalcuated to get the address.
3333
York Sun50739372015-12-07 11:05:29 -08003334- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003335 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003336 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003337 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003338 fixing up gd->ram_size the Linux kernel should gets passed
3339 the now "corrected" memory size and won't touch it either.
3340 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003341 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003342 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003343 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003344
3345 This option can be used as a workaround for the 440EPx/GRx
3346 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3347 be touched.
3348
3349 WARNING: Please make sure that this value is a multiple of
3350 the Linux page size (normally 4k). If this is not the case,
3351 then the end address of the Linux memory will be located at a
3352 non page size aligned address and this could cause major
3353 problems.
3354
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003355- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003356 Enable temporary baudrate change while serial download
3357
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003358- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003359 Physical start address of SDRAM. _Must_ be 0 here.
3360
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003361- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003362 Physical start address of Flash memory.
3363
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003364- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003365 Physical start address of boot monitor code (set by
3366 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003367 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003368 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003369
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003370- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003371 Size of memory reserved for monitor code, used to
3372 determine _at_compile_time_ (!) if the environment is
3373 embedded within the U-Boot image, or in a separate
3374 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003375
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003376- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003377 Size of DRAM reserved for malloc() use.
3378
Simon Glass863e4042014-07-10 22:23:28 -06003379- CONFIG_SYS_MALLOC_F_LEN
3380 Size of the malloc() pool for use before relocation. If
3381 this is defined, then a very simple malloc() implementation
3382 will become available before relocation. The address is just
3383 below the global data, and the stack is moved down to make
3384 space.
3385
3386 This feature allocates regions with increasing addresses
3387 within the region. calloc() is supported, but realloc()
3388 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003389 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003390 U-Boot relocates itself.
3391
Simon Glass9fa901b2014-11-10 17:16:54 -07003392- CONFIG_SYS_MALLOC_SIMPLE
3393 Provides a simple and small malloc() and calloc() for those
3394 boards which do not use the full malloc in SPL (which is
3395 enabled with CONFIG_SYS_SPL_MALLOC_START).
3396
Thierry Redingc97d9742014-12-09 22:25:22 -07003397- CONFIG_SYS_NONCACHED_MEMORY:
3398 Size of non-cached memory area. This area of memory will be
3399 typically located right below the malloc() area and mapped
3400 uncached in the MMU. This is useful for drivers that would
3401 otherwise require a lot of explicit cache maintenance. For
3402 some drivers it's also impossible to properly maintain the
3403 cache. For example if the regions that need to be flushed
3404 are not a multiple of the cache-line size, *and* padding
3405 cannot be allocated between the regions to align them (i.e.
3406 if the HW requires a contiguous array of regions, and the
3407 size of each region is not cache-aligned), then a flush of
3408 one region may result in overwriting data that hardware has
3409 written to another region in the same cache-line. This can
3410 happen for example in network drivers where descriptors for
3411 buffers are typically smaller than the CPU cache-line (e.g.
3412 16 bytes vs. 32 or 64 bytes).
3413
3414 Non-cached memory is only supported on 32-bit ARM at present.
3415
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003416- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003417 Normally compressed uImages are limited to an
3418 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003419 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003420 to adjust this setting to your needs.
3421
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003422- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003423 Maximum size of memory mapped by the startup code of
3424 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003425 the Linux kernel (bd_info, boot arguments, FDT blob if
3426 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003427 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003428 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003429 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003430 variable "bootm_mapsize" will override the value of
3431 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3432 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003433
John Rigbyeea8e692010-10-13 13:57:35 -06003434- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3435 Enable initrd_high functionality. If defined then the
3436 initrd_high feature is enabled and the bootm ramdisk subcommand
3437 is enabled.
3438
3439- CONFIG_SYS_BOOT_GET_CMDLINE:
3440 Enables allocating and saving kernel cmdline in space between
3441 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3442
3443- CONFIG_SYS_BOOT_GET_KBD:
3444 Enables allocating and saving a kernel copy of the bd_info in
3445 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3446
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003447- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003448 Max number of Flash memory banks
3449
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003450- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003451 Max number of sectors on a Flash chip
3452
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003453- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003454 Timeout for Flash erase operations (in ms)
3455
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003456- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003457 Timeout for Flash write operations (in ms)
3458
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003459- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003460 Timeout for Flash set sector lock bit operation (in ms)
3461
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003462- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003463 Timeout for Flash clear lock bits operation (in ms)
3464
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003465- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003466 If defined, hardware flash sectors protection is used
3467 instead of U-Boot software protection.
3468
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003469- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003470
3471 Enable TFTP transfers directly to flash memory;
3472 without this option such a download has to be
3473 performed in two steps: (1) download to RAM, and (2)
3474 copy from RAM to flash.
3475
3476 The two-step approach is usually more reliable, since
3477 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003478 the flash, but in some situations (when system RAM is
3479 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003480 downloaded image) this option may be very useful.
3481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003482- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003483 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003484 common flash structure for storing flash geometry.
3485
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003486- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003487 This option also enables the building of the cfi_flash driver
3488 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003489
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003490- CONFIG_FLASH_CFI_MTD
3491 This option enables the building of the cfi_mtd driver
3492 in the drivers directory. The driver exports CFI flash
3493 to the MTD layer.
3494
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003495- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003496 Use buffered writes to flash.
3497
3498- CONFIG_FLASH_SPANSION_S29WS_N
3499 s29ws-n MirrorBit flash has non-standard addresses for buffered
3500 write commands.
3501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003502- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003503 If this option is defined, the common CFI flash doesn't
3504 print it's warning upon not recognized FLASH banks. This
3505 is useful, if some of the configured banks are only
3506 optionally available.
3507
Jerry Van Barenaae73572008-03-08 13:48:01 -05003508- CONFIG_FLASH_SHOW_PROGRESS
3509 If defined (must be an integer), print out countdown
3510 digits and dots. Recommended value: 45 (9..1) for 80
3511 column displays, 15 (3..1) for 40 column displays.
3512
Stefan Roesed20cba52013-04-04 15:53:14 +02003513- CONFIG_FLASH_VERIFY
3514 If defined, the content of the flash (destination) is compared
3515 against the source after the write operation. An error message
3516 will be printed when the contents are not identical.
3517 Please note that this option is useless in nearly all cases,
3518 since such flash programming errors usually are detected earlier
3519 while unprotecting/erasing/programming. Please only enable
3520 this option if you really know what you are doing.
3521
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003522- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003523 Defines the number of Ethernet receive buffers. On some
3524 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003525 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3526 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003527 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003528 Defaults to 4 if not defined.
3529
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003530- CONFIG_ENV_MAX_ENTRIES
3531
Wolfgang Denk1136f692010-10-27 22:48:30 +02003532 Maximum number of entries in the hash table that is used
3533 internally to store the environment settings. The default
3534 setting is supposed to be generous and should work in most
3535 cases. This setting can be used to tune behaviour; see
3536 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003537
Joe Hershberger71497d02012-12-11 22:16:31 -06003538- CONFIG_ENV_FLAGS_LIST_DEFAULT
3539- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003540 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003541 calling env set. Variables can be restricted to only decimal,
3542 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3543 the variables can also be restricted to IP address or MAC address.
3544
3545 The format of the list is:
3546 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003547 access_attribute = [a|r|o|c]
3548 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003549 entry = variable_name[:attributes]
3550 list = entry[,list]
3551
3552 The type attributes are:
3553 s - String (default)
3554 d - Decimal
3555 x - Hexadecimal
3556 b - Boolean ([1yYtT|0nNfF])
3557 i - IP address
3558 m - MAC address
3559
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003560 The access attributes are:
3561 a - Any (default)
3562 r - Read-only
3563 o - Write-once
3564 c - Change-default
3565
Joe Hershberger71497d02012-12-11 22:16:31 -06003566 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3567 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003568 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003569
3570 - CONFIG_ENV_FLAGS_LIST_STATIC
3571 Define this to a list (string) to define validation that
3572 should be done if an entry is not found in the ".flags"
3573 environment variable. To override a setting in the static
3574 list, simply add an entry for the same variable name to the
3575 ".flags" variable.
3576
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003577 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3578 regular expression. This allows multiple variables to define the same
3579 flags without explicitly listing them for each variable.
3580
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003581- CONFIG_ENV_ACCESS_IGNORE_FORCE
3582 If defined, don't allow the -f switch to env set override variable
3583 access flags.
3584
Gabe Black3687fe42014-10-15 04:38:30 -06003585- CONFIG_USE_STDINT
3586 If stdint.h is available with your toolchain you can define this
3587 option to enable it. You can provide option 'USE_STDINT=1' when
3588 building U-Boot to enable this.
3589
wdenkc6097192002-11-03 00:24:07 +00003590The following definitions that deal with the placement and management
3591of environment data (variable area); in general, we support the
3592following configurations:
3593
Mike Frysinger63b8f122011-07-08 10:44:25 +00003594- CONFIG_BUILD_ENVCRC:
3595
3596 Builds up envcrc with the target environment so that external utils
3597 may easily extract it and embed it in final U-Boot images.
3598
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003599- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003600
3601 Define this if the environment is in flash memory.
3602
3603 a) The environment occupies one whole flash sector, which is
3604 "embedded" in the text segment with the U-Boot code. This
3605 happens usually with "bottom boot sector" or "top boot
3606 sector" type flash chips, which have several smaller
3607 sectors at the start or the end. For instance, such a
3608 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3609 such a case you would place the environment in one of the
3610 4 kB sectors - with U-Boot code before and after it. With
3611 "top boot sector" type flash chips, you would put the
3612 environment in one of the last sectors, leaving a gap
3613 between U-Boot and the environment.
3614
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003615 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003616
3617 Offset of environment data (variable area) to the
3618 beginning of flash memory; for instance, with bottom boot
3619 type flash chips the second sector can be used: the offset
3620 for this sector is given here.
3621
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003622 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003623
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003624 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003625
3626 This is just another way to specify the start address of
3627 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003628 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003629
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003630 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003631
3632 Size of the sector containing the environment.
3633
3634
3635 b) Sometimes flash chips have few, equal sized, BIG sectors.
3636 In such a case you don't want to spend a whole sector for
3637 the environment.
3638
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003639 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003640
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003641 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003642 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003643 of this flash sector for the environment. This saves
3644 memory for the RAM copy of the environment.
3645
3646 It may also save flash memory if you decide to use this
3647 when your environment is "embedded" within U-Boot code,
3648 since then the remainder of the flash sector could be used
3649 for U-Boot code. It should be pointed out that this is
3650 STRONGLY DISCOURAGED from a robustness point of view:
3651 updating the environment in flash makes it always
3652 necessary to erase the WHOLE sector. If something goes
3653 wrong before the contents has been restored from a copy in
3654 RAM, your target system will be dead.
3655
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003656 - CONFIG_ENV_ADDR_REDUND
3657 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003658
wdenk4a5c8a72003-03-06 00:02:04 +00003659 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003660 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003661 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003662 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003663
3664BE CAREFUL! Any changes to the flash layout, and some changes to the
3665source code will make it necessary to adapt <board>/u-boot.lds*
3666accordingly!
3667
3668
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003669- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003670
3671 Define this if you have some non-volatile memory device
3672 (NVRAM, battery buffered SRAM) which you want to use for the
3673 environment.
3674
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003675 - CONFIG_ENV_ADDR:
3676 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003677
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003678 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003679 want to use for environment. It is assumed that this memory
3680 can just be read and written to, without any special
3681 provision.
3682
3683BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003684in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003685console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003686U-Boot will hang.
3687
3688Please note that even with NVRAM we still use a copy of the
3689environment in RAM: we could work on NVRAM directly, but we want to
3690keep settings there always unmodified except somebody uses "saveenv"
3691to save the current settings.
3692
3693
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003694- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003695
3696 Use this if you have an EEPROM or similar serial access
3697 device and a driver for it.
3698
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003699 - CONFIG_ENV_OFFSET:
3700 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003701
3702 These two #defines specify the offset and size of the
3703 environment area within the total memory of your EEPROM.
3704
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003705 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003706 If defined, specified the chip address of the EEPROM device.
3707 The default address is zero.
3708
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003709 - CONFIG_SYS_I2C_EEPROM_BUS:
3710 If defined, specified the i2c bus of the EEPROM device.
3711
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003712 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003713 If defined, the number of bits used to address bytes in a
3714 single page in the EEPROM device. A 64 byte page, for example
3715 would require six bits.
3716
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003717 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003718 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003719 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003720
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003721 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003722 The length in bytes of the EEPROM memory array address. Note
3723 that this is NOT the chip address length!
3724
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003725 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003726 EEPROM chips that implement "address overflow" are ones
3727 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3728 address and the extra bits end up in the "chip address" bit
3729 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3730 byte chips.
3731
3732 Note that we consider the length of the address field to
3733 still be one byte because the extra address bits are hidden
3734 in the chip address.
3735
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003736 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003737 The size in bytes of the EEPROM device.
3738
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003739 - CONFIG_ENV_EEPROM_IS_ON_I2C
3740 define this, if you have I2C and SPI activated, and your
3741 EEPROM, which holds the environment, is on the I2C bus.
3742
3743 - CONFIG_I2C_ENV_EEPROM_BUS
3744 if you have an Environment on an EEPROM reached over
3745 I2C muxes, you can define here, how to reach this
3746 EEPROM. For example:
3747
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003748 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003749
3750 EEPROM which holds the environment, is reached over
3751 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003752
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003753- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003754
wdenk1ebf41e2004-01-02 14:00:00 +00003755 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003756 want to use for the environment.
3757
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003758 - CONFIG_ENV_OFFSET:
3759 - CONFIG_ENV_ADDR:
3760 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003761
3762 These three #defines specify the offset and size of the
3763 environment area within the total memory of your DataFlash placed
3764 at the specified address.
3765
Wu, Josh76db7bf2014-07-01 19:30:13 +08003766- CONFIG_ENV_IS_IN_SPI_FLASH:
3767
3768 Define this if you have a SPI Flash memory device which you
3769 want to use for the environment.
3770
3771 - CONFIG_ENV_OFFSET:
3772 - CONFIG_ENV_SIZE:
3773
3774 These two #defines specify the offset and size of the
3775 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3776 aligned to an erase sector boundary.
3777
3778 - CONFIG_ENV_SECT_SIZE:
3779
3780 Define the SPI flash's sector size.
3781
3782 - CONFIG_ENV_OFFSET_REDUND (optional):
3783
3784 This setting describes a second storage area of CONFIG_ENV_SIZE
3785 size used to hold a redundant copy of the environment data, so
3786 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003787 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003788 aligned to an erase sector boundary.
3789
3790 - CONFIG_ENV_SPI_BUS (optional):
3791 - CONFIG_ENV_SPI_CS (optional):
3792
3793 Define the SPI bus and chip select. If not defined they will be 0.
3794
3795 - CONFIG_ENV_SPI_MAX_HZ (optional):
3796
3797 Define the SPI max work clock. If not defined then use 1MHz.
3798
3799 - CONFIG_ENV_SPI_MODE (optional):
3800
3801 Define the SPI work mode. If not defined then use SPI_MODE_3.
3802
Liu Gang85bcd732012-03-08 00:33:20 +00003803- CONFIG_ENV_IS_IN_REMOTE:
3804
3805 Define this if you have a remote memory space which you
3806 want to use for the local device's environment.
3807
3808 - CONFIG_ENV_ADDR:
3809 - CONFIG_ENV_SIZE:
3810
3811 These two #defines specify the address and size of the
3812 environment area within the remote memory space. The
3813 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003814 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003815
3816BE CAREFUL! For some special cases, the local device can not use
3817"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003818environment stored in a remote NOR flash by SRIO or PCIE link,
3819but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003820
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003821- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003822
3823 Define this if you have a NAND device which you want to use
3824 for the environment.
3825
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003826 - CONFIG_ENV_OFFSET:
3827 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003828
3829 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003830 area within the first NAND device. CONFIG_ENV_OFFSET must be
3831 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003832
Scott Wood08239322010-09-17 14:38:37 -05003833 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003834
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003835 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003836 size used to hold a redundant copy of the environment data, so
3837 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003838 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003839 aligned to an erase block boundary.
3840
3841 - CONFIG_ENV_RANGE (optional):
3842
3843 Specifies the length of the region in which the environment
3844 can be written. This should be a multiple of the NAND device's
3845 block size. Specifying a range with more erase blocks than
3846 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3847 the range to be avoided.
3848
3849 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003850
Scott Wood08239322010-09-17 14:38:37 -05003851 Enables support for dynamically retrieving the offset of the
3852 environment from block zero's out-of-band data. The
3853 "nand env.oob" command can be used to record this offset.
3854 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3855 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003856
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003857- CONFIG_NAND_ENV_DST
3858
3859 Defines address in RAM to which the nand_spl code should copy the
3860 environment. If redundant environment is used, it will be copied to
3861 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3862
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003863- CONFIG_ENV_IS_IN_UBI:
3864
3865 Define this if you have an UBI volume that you want to use for the
3866 environment. This has the benefit of wear-leveling the environment
3867 accesses, which is important on NAND.
3868
3869 - CONFIG_ENV_UBI_PART:
3870
3871 Define this to a string that is the mtd partition containing the UBI.
3872
3873 - CONFIG_ENV_UBI_VOLUME:
3874
3875 Define this to the name of the volume that you want to store the
3876 environment in.
3877
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003878 - CONFIG_ENV_UBI_VOLUME_REDUND:
3879
3880 Define this to the name of another volume to store a second copy of
3881 the environment in. This will enable redundant environments in UBI.
3882 It is assumed that both volumes are in the same MTD partition.
3883
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003884 - CONFIG_UBI_SILENCE_MSG
3885 - CONFIG_UBIFS_SILENCE_MSG
3886
3887 You will probably want to define these to avoid a really noisy system
3888 when storing the env in UBI.
3889
Wu, Josha7d0c872014-06-24 17:31:03 +08003890- CONFIG_ENV_IS_IN_FAT:
3891 Define this if you want to use the FAT file system for the environment.
3892
3893 - FAT_ENV_INTERFACE:
3894
3895 Define this to a string that is the name of the block device.
3896
Nicolae Rosia86811f22016-11-21 17:33:58 +02003897 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003898
3899 Define this to a string to specify the partition of the device. It can
3900 be as following:
3901
3902 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3903 - "D:P": device D partition P. Error occurs if device D has no
3904 partition table.
3905 - "D:0": device D.
3906 - "D" or "D:": device D partition 1 if device D has partition
3907 table, or the whole device D if has no partition
3908 table.
3909 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003910 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08003911 partition table then means device D.
3912
3913 - FAT_ENV_FILE:
3914
3915 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003916 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08003917
3918 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003919 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08003920
Stephen Warreneedcacd2013-06-11 15:14:00 -06003921- CONFIG_ENV_IS_IN_MMC:
3922
3923 Define this if you have an MMC device which you want to use for the
3924 environment.
3925
3926 - CONFIG_SYS_MMC_ENV_DEV:
3927
3928 Specifies which MMC device the environment is stored in.
3929
3930 - CONFIG_SYS_MMC_ENV_PART (optional):
3931
3932 Specifies which MMC partition the environment is stored in. If not
3933 set, defaults to partition 0, the user area. Common values might be
3934 1 (first MMC boot partition), 2 (second MMC boot partition).
3935
3936 - CONFIG_ENV_OFFSET:
3937 - CONFIG_ENV_SIZE:
3938
3939 These two #defines specify the offset and size of the environment
3940 area within the specified MMC device.
3941
Stephen Warren24dc2032013-06-11 15:14:02 -06003942 If offset is positive (the usual case), it is treated as relative to
3943 the start of the MMC partition. If offset is negative, it is treated
3944 as relative to the end of the MMC partition. This can be useful if
3945 your board may be fitted with different MMC devices, which have
3946 different sizes for the MMC partitions, and you always want the
3947 environment placed at the very end of the partition, to leave the
3948 maximum possible space before it, to store other data.
3949
Stephen Warreneedcacd2013-06-11 15:14:00 -06003950 These two values are in units of bytes, but must be aligned to an
3951 MMC sector boundary.
3952
3953 - CONFIG_ENV_OFFSET_REDUND (optional):
3954
3955 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3956 hold a redundant copy of the environment data. This provides a
3957 valid backup copy in case the other copy is corrupted, e.g. due
3958 to a power failure during a "saveenv" operation.
3959
Stephen Warren24dc2032013-06-11 15:14:02 -06003960 This value may also be positive or negative; this is handled in the
3961 same way as CONFIG_ENV_OFFSET.
3962
Stephen Warreneedcacd2013-06-11 15:14:00 -06003963 This value is also in units of bytes, but must also be aligned to
3964 an MMC sector boundary.
3965
3966 - CONFIG_ENV_SIZE_REDUND (optional):
3967
3968 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3969 set. If this value is set, it must be set to the same value as
3970 CONFIG_ENV_SIZE.
3971
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003972- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003973
3974 Defines offset to the initial SPI buffer area in DPRAM. The
3975 area is used at an early stage (ROM part) if the environment
3976 is configured to reside in the SPI EEPROM: We need a 520 byte
3977 scratch DPRAM area. It is used between the two initialization
3978 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3979 to be a good choice since it makes it far enough from the
3980 start of the data area as well as from the stack pointer.
3981
Bruce Adleredecc942007-11-02 13:15:42 -07003982Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003983has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003984created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003985until then to read environment variables.
3986
wdenk8dba0502003-03-31 16:34:49 +00003987The environment is protected by a CRC32 checksum. Before the monitor
3988is relocated into RAM, as a result of a bad CRC you will be working
3989with the compiled-in default environment - *silently*!!! [This is
3990necessary, because the first environment variable we need is the
3991"baudrate" setting for the console - if we have a bad CRC, we don't
3992have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003993
3994Note: once the monitor has been relocated, then it will complain if
3995the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003996use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003997
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003998- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003999 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004000
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004001 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004002 also needs to be defined.
4003
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004004- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004005 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004006
Ron Madriddfa028a2009-02-18 14:30:44 -08004007- CONFIG_NS16550_MIN_FUNCTIONS:
4008 Define this if you desire to only have use of the NS16550_init
4009 and NS16550_putc functions for the serial driver located at
4010 drivers/serial/ns16550.c. This option is useful for saving
4011 space for already greatly restricted images, including but not
4012 limited to NAND_SPL configurations.
4013
Simon Glass28a9e332012-11-30 13:01:18 +00004014- CONFIG_DISPLAY_BOARDINFO
4015 Display information about the board that U-Boot is running on
4016 when U-Boot starts up. The board function checkboard() is called
4017 to do this.
4018
Simon Glasse8822012012-11-30 13:01:19 +00004019- CONFIG_DISPLAY_BOARDINFO_LATE
4020 Similar to the previous option, but display this information
4021 later, once stdio is running and output goes to the LCD, if
4022 present.
4023
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004024- CONFIG_BOARD_SIZE_LIMIT:
4025 Maximum size of the U-Boot image. When defined, the
4026 build system checks that the actual size does not
4027 exceed it.
4028
wdenkc6097192002-11-03 00:24:07 +00004029Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004030---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004031
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004032- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004033 Cache Line Size of the CPU.
4034
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004035- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004036 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004037
wdenk9c53f402003-10-15 23:53:47 +00004038 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4039 and RPXsuper) to be able to adjust the position of
4040 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004041
Timur Tabid8f341c2011-08-04 18:03:41 -05004042- CONFIG_SYS_CCSRBAR_DEFAULT:
4043 Default (power-on reset) physical address of CCSR on Freescale
4044 PowerPC SOCs.
4045
4046- CONFIG_SYS_CCSRBAR:
4047 Virtual address of CCSR. On a 32-bit build, this is typically
4048 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4049
4050 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4051 for cross-platform code that uses that macro instead.
4052
4053- CONFIG_SYS_CCSRBAR_PHYS:
4054 Physical address of CCSR. CCSR can be relocated to a new
4055 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004056 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004057 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4058 is typically relocated on 36-bit builds. It is recommended
4059 that this macro be defined via the _HIGH and _LOW macros:
4060
4061 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4062 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4063
4064- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004065 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4066 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004067 used in assembly code, so it must not contain typecasts or
4068 integer size suffixes (e.g. "ULL").
4069
4070- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4071 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4072 used in assembly code, so it must not contain typecasts or
4073 integer size suffixes (e.g. "ULL").
4074
4075- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4076 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4077 forced to a value that ensures that CCSR is not relocated.
4078
wdenk1272e232002-11-10 22:06:23 +00004079- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004080 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004081
4082 the default drive number (default value 0)
4083
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004084 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004085
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004086 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004087 (default value 1)
4088
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004089 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004090
wdenk4a5c8a72003-03-06 00:02:04 +00004091 defines the offset of register from address. It
4092 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004093 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004094
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004095 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4096 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004097 default value.
wdenk1272e232002-11-10 22:06:23 +00004098
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004099 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004100 fdc_hw_init() is called at the beginning of the FDC
4101 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004102 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004103 initializations.
wdenk1272e232002-11-10 22:06:23 +00004104
Macpaul Lind1e49942011-04-11 20:45:32 +00004105- CONFIG_IDE_AHB:
4106 Most IDE controllers were designed to be connected with PCI
4107 interface. Only few of them were designed for AHB interface.
4108 When software is doing ATA command and data transfer to
4109 IDE devices through IDE-AHB controller, some additional
4110 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004111 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004112
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004113- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004114 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004115 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004116
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004117- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004118
wdenkeb20ad32003-09-05 23:19:14 +00004119 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004120 initial data and stack; please note that this must be
4121 writable memory that is working WITHOUT special
4122 initialization, i. e. you CANNOT use normal RAM which
4123 will become available only after programming the
4124 memory controller and running certain initialization
4125 sequences.
4126
4127 U-Boot uses the following memory types:
4128 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4129 - MPC824X: data cache
4130 - PPC4xx: data cache
4131
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004132- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004133
4134 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004135 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4136 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004137 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004138 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004139 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004140 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4141 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004142
4143 Note:
4144 On the MPC824X (or other systems that use the data
4145 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004146 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004147 point to an otherwise UNUSED address space between
4148 the top of RAM and the start of the PCI space.
4149
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004150- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004151
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004152- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004153
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004154- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004155
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004156- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004157
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004158- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004159
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004160- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004161
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004162- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004163 SDRAM timing
4164
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004165- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004166 periodic timer for refresh
4167
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004168- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004169
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004170- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4171 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4172 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4173 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004174 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4175
4176- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004177 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4178 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004179 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4180
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004181- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4182 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004183 Machine Mode Register and Memory Periodic Timer
4184 Prescaler definitions (SDRAM timing)
4185
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004186- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004187 enable I2C microcode relocation patch (MPC8xx);
4188 define relocation offset in DPRAM [DSP2]
4189
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004190- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004191 enable SMC microcode relocation patch (MPC8xx);
4192 define relocation offset in DPRAM [SMC1]
4193
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004194- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004195 enable SPI microcode relocation patch (MPC8xx);
4196 define relocation offset in DPRAM [SCC4]
4197
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004198- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004199 Offset of the bootmode word in DPRAM used by post
4200 (Power On Self Tests). This definition overrides
4201 #define'd default value in commproc.h resp.
4202 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004203
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004204- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4205 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4206 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4207 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4208 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4209 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4210 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4211 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004212 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004213
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004214- CONFIG_PCI_DISABLE_PCIE:
4215 Disable PCI-Express on systems where it is supported but not
4216 required.
4217
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004218- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004219 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004220 Don't do any setup work, presumably because someone or
4221 something has already done it, and we don't need to do it
4222 a second time. Useful for platforms that are pre-booted
4223 by coreboot or similar.
4224
Gabor Juhosb4458732013-05-30 07:06:12 +00004225- CONFIG_PCI_INDIRECT_BRIDGE:
4226 Enable support for indirect PCI bridges.
4227
Kumar Gala8975d7a2010-12-30 12:09:53 -06004228- CONFIG_SYS_SRIO:
4229 Chip has SRIO or not
4230
4231- CONFIG_SRIO1:
4232 Board has SRIO 1 port available
4233
4234- CONFIG_SRIO2:
4235 Board has SRIO 2 port available
4236
Liu Gang27afb9c2013-05-07 16:30:46 +08004237- CONFIG_SRIO_PCIE_BOOT_MASTER
4238 Board can support master function for Boot from SRIO and PCIE
4239
Kumar Gala8975d7a2010-12-30 12:09:53 -06004240- CONFIG_SYS_SRIOn_MEM_VIRT:
4241 Virtual Address of SRIO port 'n' memory region
4242
4243- CONFIG_SYS_SRIOn_MEM_PHYS:
4244 Physical Address of SRIO port 'n' memory region
4245
4246- CONFIG_SYS_SRIOn_MEM_SIZE:
4247 Size of SRIO port 'n' memory region
4248
Fabio Estevamf17e8782013-04-11 09:35:34 +00004249- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4250 Defined to tell the NAND controller that the NAND chip is using
4251 a 16 bit bus.
4252 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004253 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004254 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004255 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004256
4257- CONFIG_SYS_NDFC_EBC0_CFG
4258 Sets the EBC0_CFG register for the NDFC. If not defined
4259 a default value will be used.
4260
Ben Warren45657152006-09-07 16:50:54 -04004261- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004262 Get DDR timing information from an I2C EEPROM. Common
4263 with pluggable memory modules such as SODIMMs
4264
Ben Warren45657152006-09-07 16:50:54 -04004265 SPD_EEPROM_ADDRESS
4266 I2C address of the SPD EEPROM
4267
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004268- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004269 If SPD EEPROM is on an I2C bus other than the first
4270 one, specify here. Note that the value must resolve
4271 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004272
York Sune73cc042011-06-07 09:42:16 +08004273- CONFIG_SYS_DDR_RAW_TIMING
4274 Get DDR timing information from other than SPD. Common with
4275 soldered DDR chips onboard without SPD. DDR raw timing
4276 parameters are extracted from datasheet and hard-coded into
4277 header files or board specific files.
4278
York Sunbd495cf2011-09-16 13:21:35 -07004279- CONFIG_FSL_DDR_INTERACTIVE
4280 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4281
York Sun8ced0502015-01-06 13:18:55 -08004282- CONFIG_FSL_DDR_SYNC_REFRESH
4283 Enable sync of refresh for multiple controllers.
4284
York Sunb6a35f82015-03-19 09:30:28 -07004285- CONFIG_FSL_DDR_BIST
4286 Enable built-in memory test for Freescale DDR controllers.
4287
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004288- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004289 Only for 83xx systems. If specified, then DDR should
4290 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004291
wdenk6203e402004-04-18 10:13:26 +00004292- CONFIG_ETHER_ON_FEC[12]
4293 Define to enable FEC[12] on a 8xx series processor.
4294
4295- CONFIG_FEC[12]_PHY
4296 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004297 to the given FEC; i. e.
4298 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004299 means that the PHY with address 4 is connected to FEC1
4300
4301 When set to -1, means to probe for first available.
4302
4303- CONFIG_FEC[12]_PHY_NORXERR
4304 The PHY does not have a RXERR line (RMII only).
4305 (so program the FEC to ignore it).
4306
4307- CONFIG_RMII
4308 Enable RMII mode for all FECs.
4309 Note that this is a global option, we can't
4310 have one FEC in standard MII mode and another in RMII mode.
4311
wdenk20c98a62004-04-23 20:32:05 +00004312- CONFIG_CRC32_VERIFY
4313 Add a verify option to the crc32 command.
4314 The syntax is:
4315
4316 => crc32 -v <address> <count> <crc32>
4317
4318 Where address/count indicate a memory area
4319 and crc32 is the correct crc32 which the
4320 area should have.
4321
wdenk64519362004-07-11 17:40:54 +00004322- CONFIG_LOOPW
4323 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004324 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004325
stroesecc3af832004-12-16 18:46:55 +00004326- CONFIG_MX_CYCLIC
4327 Add the "mdc" and "mwc" memory commands. These are cyclic
4328 "md/mw" commands.
4329 Examples:
4330
wdenk07d7e6b2004-12-16 21:44:03 +00004331 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004332 This command will print 4 bytes (10,11,12,13) each 500 ms.
4333
wdenk07d7e6b2004-12-16 21:44:03 +00004334 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004335 This command will write 12345678 to address 100 all 10 ms.
4336
wdenk07d7e6b2004-12-16 21:44:03 +00004337 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004338 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004339
wdenk3d3d99f2005-04-04 12:44:11 +00004340- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004341 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004342 low level initializations (like setting up the memory
4343 controller) are omitted and/or U-Boot does not
4344 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004345
Wolfgang Denk302141d2010-11-27 23:30:56 +01004346 Normally this variable MUST NOT be defined. The only
4347 exception is when U-Boot is loaded (to RAM) by some
4348 other boot loader or by a debugger which performs
4349 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004350
Simon Glass90844072016-05-05 07:28:06 -06004351- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4352 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004353 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004354 instruction cache) is still performed.
4355
Aneesh V552a3192011-07-13 05:11:07 +00004356- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004357 Modifies the behaviour of start.S when compiling a loader
4358 that is executed before the actual U-Boot. E.g. when
4359 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004360
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004361- CONFIG_TPL_BUILD
4362 Modifies the behaviour of start.S when compiling a loader
4363 that is executed after the SPL and before the actual U-Boot.
4364 It is loaded by the SPL.
4365
Ying Zhang0d4f5442013-05-20 14:07:23 +08004366- CONFIG_SYS_MPC85XX_NO_RESETVEC
4367 Only for 85xx systems. If this variable is specified, the section
4368 .resetvec is not kept and the section .bootpg is placed in the
4369 previous 4k of the .text section.
4370
Simon Glass17dabf02013-02-24 17:33:14 +00004371- CONFIG_ARCH_MAP_SYSMEM
4372 Generally U-Boot (and in particular the md command) uses
4373 effective address. It is therefore not necessary to regard
4374 U-Boot address as virtual addresses that need to be translated
4375 to physical addresses. However, sandbox requires this, since
4376 it maintains its own little RAM buffer which contains all
4377 addressable memory. This option causes some memory accesses
4378 to be mapped through map_sysmem() / unmap_sysmem().
4379
Simon Glassbfb59802013-02-14 04:18:54 +00004380- CONFIG_X86_RESET_VECTOR
4381 If defined, the x86 reset vector code is included. This is not
4382 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004383
Heiko Schocher2233e462013-11-04 14:05:00 +01004384- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4385 Enables the RTC32K OSC on AM33xx based plattforms
4386
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004387- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4388 Option to disable subpage write in NAND driver
4389 driver that uses this:
4390 drivers/mtd/nand/davinci_nand.c
4391
Timur Tabi275f4bb2011-11-22 09:21:25 -06004392Freescale QE/FMAN Firmware Support:
4393-----------------------------------
4394
4395The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4396loading of "firmware", which is encoded in the QE firmware binary format.
4397This firmware often needs to be loaded during U-Boot booting, so macros
4398are used to identify the storage device (NOR flash, SPI, etc) and the address
4399within that device.
4400
Zhao Qiang83a90842014-03-21 16:21:44 +08004401- CONFIG_SYS_FMAN_FW_ADDR
4402 The address in the storage device where the FMAN microcode is located. The
4403 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4404 is also specified.
4405
4406- CONFIG_SYS_QE_FW_ADDR
4407 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004408 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4409 is also specified.
4410
4411- CONFIG_SYS_QE_FMAN_FW_LENGTH
4412 The maximum possible size of the firmware. The firmware binary format
4413 has a field that specifies the actual size of the firmware, but it
4414 might not be possible to read any part of the firmware unless some
4415 local storage is allocated to hold the entire firmware first.
4416
4417- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4418 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4419 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4420 virtual address in NOR flash.
4421
4422- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4423 Specifies that QE/FMAN firmware is located in NAND flash.
4424 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4425
4426- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4427 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4428 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4429
Liu Gang1e084582012-03-08 00:33:18 +00004430- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4431 Specifies that QE/FMAN firmware is located in the remote (master)
4432 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004433 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4434 window->master inbound window->master LAW->the ucode address in
4435 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004436
J. German Rivera8ff14b72014-06-23 15:15:55 -07004437Freescale Layerscape Management Complex Firmware Support:
4438---------------------------------------------------------
4439The Freescale Layerscape Management Complex (MC) supports the loading of
4440"firmware".
4441This firmware often needs to be loaded during U-Boot booting, so macros
4442are used to identify the storage device (NOR flash, SPI, etc) and the address
4443within that device.
4444
4445- CONFIG_FSL_MC_ENET
4446 Enable the MC driver for Layerscape SoCs.
4447
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304448Freescale Layerscape Debug Server Support:
4449-------------------------------------------
4450The Freescale Layerscape Debug Server Support supports the loading of
4451"Debug Server firmware" and triggering SP boot-rom.
4452This firmware often needs to be loaded during U-Boot booting.
4453
York Sun928b6812015-12-07 11:08:58 -08004454- CONFIG_SYS_MC_RSV_MEM_ALIGN
4455 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304456
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004457Reproducible builds
4458-------------------
4459
4460In order to achieve reproducible builds, timestamps used in the U-Boot build
4461process have to be set to a fixed value.
4462
4463This is done using the SOURCE_DATE_EPOCH environment variable.
4464SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4465option for U-Boot or an environment variable in U-Boot.
4466
4467SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4468
wdenkc6097192002-11-03 00:24:07 +00004469Building the Software:
4470======================
4471
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004472Building U-Boot has been tested in several native build environments
4473and in many different cross environments. Of course we cannot support
4474all possibly existing versions of cross development tools in all
4475(potentially obsolete) versions. In case of tool chain problems we
4476recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4477which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004478
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004479If you are not using a native environment, it is assumed that you
4480have GNU cross compiling tools available in your path. In this case,
4481you must set the environment variable CROSS_COMPILE in your shell.
4482Note that no changes to the Makefile or any other source files are
4483necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004484
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004485 $ CROSS_COMPILE=ppc_4xx-
4486 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004487
Peter Tyserb06976d2009-03-13 18:54:51 -05004488Note: If you wish to generate Windows versions of the utilities in
4489 the tools directory you can use the MinGW toolchain
4490 (http://www.mingw.org). Set your HOST tools to the MinGW
4491 toolchain and execute 'make tools'. For example:
4492
4493 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4494
4495 Binaries such as tools/mkimage.exe will be created which can
4496 be executed on computers running Windows.
4497
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004498U-Boot is intended to be simple to build. After installing the
4499sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004500is done by typing:
4501
Holger Freyther7ba4e572014-08-04 09:26:05 +02004502 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004503
Holger Freyther7ba4e572014-08-04 09:26:05 +02004504where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004505rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004506
wdenk6c59edc2004-05-03 20:45:30 +00004507Note: for some board special configuration names may exist; check if
4508 additional information is available from the board vendor; for
4509 instance, the TQM823L systems are available without (standard)
4510 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004511 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004512
Holger Freyther7ba4e572014-08-04 09:26:05 +02004513 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004514 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004515
Holger Freyther7ba4e572014-08-04 09:26:05 +02004516 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004517 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004518
wdenk6c59edc2004-05-03 20:45:30 +00004519 etc.
wdenkc6097192002-11-03 00:24:07 +00004520
wdenkc6097192002-11-03 00:24:07 +00004521
wdenk6c59edc2004-05-03 20:45:30 +00004522Finally, type "make all", and you should get some working U-Boot
4523images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004524
wdenk6c59edc2004-05-03 20:45:30 +00004525- "u-boot.bin" is a raw binary image
4526- "u-boot" is an image in ELF binary format
4527- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004528
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004529By default the build is performed locally and the objects are saved
4530in the source directory. One of the two methods can be used to change
4531this behavior and build U-Boot to some external directory:
4532
45331. Add O= to the make command line invocations:
4534
4535 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004536 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004537 make O=/tmp/build all
4538
Timo Ketolac8c67602014-11-06 14:39:05 +020045392. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004540
Timo Ketolac8c67602014-11-06 14:39:05 +02004541 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004542 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004543 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004544 make all
4545
Timo Ketolac8c67602014-11-06 14:39:05 +02004546Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004547variable.
4548
wdenkc6097192002-11-03 00:24:07 +00004549
wdenk6c59edc2004-05-03 20:45:30 +00004550Please be aware that the Makefiles assume you are using GNU make, so
4551for instance on NetBSD you might need to use "gmake" instead of
4552native "make".
wdenkc6097192002-11-03 00:24:07 +00004553
wdenkc6097192002-11-03 00:24:07 +00004554
wdenk6c59edc2004-05-03 20:45:30 +00004555If the system board that you have is not listed, then you will need
4556to port U-Boot to your hardware platform. To do this, follow these
4557steps:
wdenkc6097192002-11-03 00:24:07 +00004558
Phil Sutterc77b4882015-12-25 14:41:18 +010045591. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004560 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004561 the "Makefile" and a "<board>.c".
45622. Create a new configuration file "include/configs/<board>.h" for
4563 your board.
wdenk6c59edc2004-05-03 20:45:30 +000045643. If you're porting U-Boot to a new CPU, then also create a new
4565 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020045664. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000045675. Type "make", and you should get a working "u-boot.srec" file
4568 to be installed on your target system.
45696. Debug and solve any problems that might arise.
4570 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004571
wdenkc6097192002-11-03 00:24:07 +00004572
wdenk6c59edc2004-05-03 20:45:30 +00004573Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4574==============================================================
wdenkc6097192002-11-03 00:24:07 +00004575
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004576If you have modified U-Boot sources (for instance added a new board
4577or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004578provide feedback to the other developers. The feedback normally takes
4579the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004580official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004581
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004582But before you submit such a patch, please verify that your modifi-
4583cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004584the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004585just run the buildman script (tools/buildman/buildman), which will
4586configure and build U-Boot for ALL supported system. Be warned, this
4587will take a while. Please see the buildman README, or run 'buildman -H'
4588for documentation.
wdenkc6097192002-11-03 00:24:07 +00004589
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004590
wdenk6c59edc2004-05-03 20:45:30 +00004591See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004592
wdenkc6097192002-11-03 00:24:07 +00004593
wdenk6c59edc2004-05-03 20:45:30 +00004594Monitor Commands - Overview:
4595============================
wdenkc6097192002-11-03 00:24:07 +00004596
wdenk6c59edc2004-05-03 20:45:30 +00004597go - start application at address 'addr'
4598run - run commands in an environment variable
4599bootm - boot application image from memory
4600bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004601bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004602tftpboot- boot image via network using TFTP protocol
4603 and env variables "ipaddr" and "serverip"
4604 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004605tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004606rarpboot- boot image via network using RARP/TFTP protocol
4607diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4608loads - load S-Record file over serial line
4609loadb - load binary file over serial line (kermit mode)
4610md - memory display
4611mm - memory modify (auto-incrementing)
4612nm - memory modify (constant address)
4613mw - memory write (fill)
4614cp - memory copy
4615cmp - memory compare
4616crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004617i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004618sspi - SPI utility commands
4619base - print or set address offset
4620printenv- print environment variables
4621setenv - set environment variables
4622saveenv - save environment variables to persistent storage
4623protect - enable or disable FLASH write protection
4624erase - erase FLASH memory
4625flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004626nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004627bdinfo - print Board Info structure
4628iminfo - print header information for application image
4629coninfo - print console devices and informations
4630ide - IDE sub-system
4631loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004632loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004633mtest - simple RAM test
4634icache - enable or disable instruction cache
4635dcache - enable or disable data cache
4636reset - Perform RESET of the CPU
4637echo - echo args to console
4638version - print monitor version
4639help - print online help
4640? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004641
wdenkc6097192002-11-03 00:24:07 +00004642
wdenk6c59edc2004-05-03 20:45:30 +00004643Monitor Commands - Detailed Description:
4644========================================
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk6c59edc2004-05-03 20:45:30 +00004646TODO.
wdenkc6097192002-11-03 00:24:07 +00004647
wdenk6c59edc2004-05-03 20:45:30 +00004648For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004649
4650
wdenk6c59edc2004-05-03 20:45:30 +00004651Environment Variables:
4652======================
wdenkc6097192002-11-03 00:24:07 +00004653
wdenk6c59edc2004-05-03 20:45:30 +00004654U-Boot supports user configuration using Environment Variables which
4655can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004656
wdenk6c59edc2004-05-03 20:45:30 +00004657Environment Variables are set using "setenv", printed using
4658"printenv", and saved to Flash using "saveenv". Using "setenv"
4659without a value can be used to delete a variable from the
4660environment. As long as you don't save the environment you are
4661working with an in-memory copy. In case the Flash area containing the
4662environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004663
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004664Some configuration options can be set using Environment Variables.
4665
4666List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004667
wdenk6c59edc2004-05-03 20:45:30 +00004668 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004669
wdenk6c59edc2004-05-03 20:45:30 +00004670 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004671
wdenk6c59edc2004-05-03 20:45:30 +00004672 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004673
wdenk6c59edc2004-05-03 20:45:30 +00004674 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004675
wdenk6c59edc2004-05-03 20:45:30 +00004676 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004677
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004678 bootm_low - Memory range available for image processing in the bootm
4679 command can be restricted. This variable is given as
4680 a hexadecimal number and defines lowest address allowed
4681 for use by the bootm command. See also "bootm_size"
4682 environment variable. Address defined by "bootm_low" is
4683 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004684 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4685 bootm_mapsize.
4686
Wolfgang Denk092ae952011-10-26 10:21:21 +00004687 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004688 This variable is given as a hexadecimal number and it
4689 defines the size of the memory region starting at base
4690 address bootm_low that is accessible by the Linux kernel
4691 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4692 as the default value if it is defined, and bootm_size is
4693 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004694
4695 bootm_size - Memory range available for image processing in the bootm
4696 command can be restricted. This variable is given as
4697 a hexadecimal number and defines the size of the region
4698 allowed for use by the bootm command. See also "bootm_low"
4699 environment variable.
4700
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004701 updatefile - Location of the software update file on a TFTP server, used
4702 by the automatic software update feature. Please refer to
4703 documentation in doc/README.update for more details.
4704
wdenk6c59edc2004-05-03 20:45:30 +00004705 autoload - if set to "no" (any string beginning with 'n'),
4706 "bootp" will just load perform a lookup of the
4707 configuration from the BOOTP server, but not try to
4708 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004709
wdenk6c59edc2004-05-03 20:45:30 +00004710 autostart - if set to "yes", an image loaded using the "bootp",
4711 "rarpboot", "tftpboot" or "diskboot" commands will
4712 be automatically started (by internally calling
4713 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004714
wdenk6c59edc2004-05-03 20:45:30 +00004715 If set to "no", a standalone image passed to the
4716 "bootm" command will be copied to the load address
4717 (and eventually uncompressed), but NOT be started.
4718 This can be used to load and uncompress arbitrary
4719 data.
wdenkc6097192002-11-03 00:24:07 +00004720
David A. Longd558a4e2011-07-09 16:40:19 -04004721 fdt_high - if set this restricts the maximum address that the
4722 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004723 For example, if you have a system with 1 GB memory
4724 at physical address 0x10000000, while Linux kernel
4725 only recognizes the first 704 MB as low memory, you
4726 may need to set fdt_high as 0x3C000000 to have the
4727 device tree blob be copied to the maximum address
4728 of the 704 MB low memory, so that Linux kernel can
4729 access it during the boot procedure.
4730
David A. Longd558a4e2011-07-09 16:40:19 -04004731 If this is set to the special value 0xFFFFFFFF then
4732 the fdt will not be copied at all on boot. For this
4733 to work it must reside in writable memory, have
4734 sufficient padding on the end of it for u-boot to
4735 add the information it needs into it, and the memory
4736 must be accessible by the kernel.
4737
Simon Glassdc6fa642011-10-24 19:15:34 +00004738 fdtcontroladdr- if set this is the address of the control flattened
4739 device tree used by U-Boot when CONFIG_OF_CONTROL is
4740 defined.
4741
wdenk0e2bd9c2004-06-06 21:51:03 +00004742 i2cfast - (PPC405GP|PPC405EP only)
4743 if set to 'y' configures Linux I2C driver for fast
4744 mode (400kHZ). This environment variable is used in
4745 initialization code. So, for changes to be effective
4746 it must be saved and board must be reset.
4747
wdenk6c59edc2004-05-03 20:45:30 +00004748 initrd_high - restrict positioning of initrd images:
4749 If this variable is not set, initrd images will be
4750 copied to the highest possible address in RAM; this
4751 is usually what you want since it allows for
4752 maximum initrd size. If for some reason you want to
4753 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004754 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004755 variable to a value of "no" or "off" or "0".
4756 Alternatively, you can set it to a maximum upper
4757 address to use (U-Boot will still check that it
4758 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004759
wdenk6c59edc2004-05-03 20:45:30 +00004760 For instance, when you have a system with 16 MB
4761 RAM, and want to reserve 4 MB from use by Linux,
4762 you can do this by adding "mem=12M" to the value of
4763 the "bootargs" variable. However, now you must make
4764 sure that the initrd image is placed in the first
4765 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004766
wdenk6c59edc2004-05-03 20:45:30 +00004767 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004768
wdenk6c59edc2004-05-03 20:45:30 +00004769 If you set initrd_high to 0xFFFFFFFF, this is an
4770 indication to U-Boot that all addresses are legal
4771 for the Linux kernel, including addresses in flash
4772 memory. In this case U-Boot will NOT COPY the
4773 ramdisk at all. This may be useful to reduce the
4774 boot time on your system, but requires that this
4775 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004776
wdenk6c59edc2004-05-03 20:45:30 +00004777 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004778
wdenk6c59edc2004-05-03 20:45:30 +00004779 loadaddr - Default load address for commands like "bootp",
4780 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004781
wdenk6c59edc2004-05-03 20:45:30 +00004782 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004783
wdenk6c59edc2004-05-03 20:45:30 +00004784 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004785
wdenk6c59edc2004-05-03 20:45:30 +00004786 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004787
wdenk6c59edc2004-05-03 20:45:30 +00004788 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004789
wdenk6c59edc2004-05-03 20:45:30 +00004790 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004791
Mike Frysingera23230c2011-10-02 10:01:27 +00004792 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004793
Mike Frysingera23230c2011-10-02 10:01:27 +00004794 ethact - controls which interface is currently active.
4795 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004796
Heiko Schocherc5e84052010-07-20 17:45:02 +02004797 => setenv ethact FEC
4798 => ping 192.168.0.1 # traffic sent on FEC
4799 => setenv ethact SCC
4800 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004801
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004802 ethrotate - When set to "no" U-Boot does not go through all
4803 available network interfaces.
4804 It just stays at the currently selected interface.
4805
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004806 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004807 either succeed or fail without retrying.
4808 When set to "once" the network operation will
4809 fail when all the available network interfaces
4810 are tried once without success.
4811 Useful on scripts which control the retry operation
4812 themselves.
wdenkc6097192002-11-03 00:24:07 +00004813
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004814 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004815
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004816 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004817 changing the console to be empty. If "yes" it will be
4818 made silent. If "no" it will not be made silent. If
4819 unset, then it will be made silent if the U-Boot console
4820 is silent.
4821
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004822 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004823 UDP source port.
4824
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004825 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004826 destination port instead of the Well Know Port 69.
4827
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004828 tftpblocksize - Block size to use for TFTP transfers; if not set,
4829 we use the TFTP server's default block size
4830
4831 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4832 seconds, minimum value is 1000 = 1 second). Defines
4833 when a packet is considered to be lost so it has to
4834 be retransmitted. The default is 5000 = 5 seconds.
4835 Lowering this value may make downloads succeed
4836 faster in networks with high packet loss rates or
4837 with unreliable TFTP servers.
4838
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004839 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4840 unit, minimum value = 0). Defines how many timeouts
4841 can happen during a single file transfer before that
4842 transfer is aborted. The default is 10, and 0 means
4843 'no timeouts allowed'. Increasing this value may help
4844 downloads succeed with high packet loss rates, or with
4845 unreliable TFTP servers or client hardware.
4846
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004847 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004848 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004849 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004850
Alexandre Messier15971322016-02-01 17:08:57 -05004851 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4852 Unsigned value, in milliseconds. If not set, the period will
4853 be either the default (28000), or a value based on
4854 CONFIG_NET_RETRY_COUNT, if defined. This value has
4855 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4856
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004857The following image location variables contain the location of images
4858used in booting. The "Image" column gives the role of the image and is
4859not an environment variable name. The other columns are environment
4860variable names. "File Name" gives the name of the file on a TFTP
4861server, "RAM Address" gives the location in RAM the image will be
4862loaded to, and "Flash Location" gives the image's address in NOR
4863flash or offset in NAND flash.
4864
4865*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004866boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004867boards use these variables for other purposes.
4868
Wolfgang Denk092ae952011-10-26 10:21:21 +00004869Image File Name RAM Address Flash Location
4870----- --------- ----------- --------------
4871u-boot u-boot u-boot_addr_r u-boot_addr
4872Linux kernel bootfile kernel_addr_r kernel_addr
4873device tree blob fdtfile fdt_addr_r fdt_addr
4874ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004875
wdenk6c59edc2004-05-03 20:45:30 +00004876The following environment variables may be used and automatically
4877updated by the network boot commands ("bootp" and "rarpboot"),
4878depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004879
wdenk6c59edc2004-05-03 20:45:30 +00004880 bootfile - see above
4881 dnsip - IP address of your Domain Name Server
4882 dnsip2 - IP address of your secondary Domain Name Server
4883 gatewayip - IP address of the Gateway (Router) to use
4884 hostname - Target hostname
4885 ipaddr - see above
4886 netmask - Subnet Mask
4887 rootpath - Pathname of the root filesystem on the NFS server
4888 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004889
wdenk145d2c12004-04-15 21:48:45 +00004890
wdenk6c59edc2004-05-03 20:45:30 +00004891There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004892
wdenk6c59edc2004-05-03 20:45:30 +00004893 serial# - contains hardware identification information such
4894 as type string and/or serial number
4895 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004896
wdenk6c59edc2004-05-03 20:45:30 +00004897These variables can be set only once (usually during manufacturing of
4898the board). U-Boot refuses to delete or overwrite these variables
4899once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004900
4901
wdenk6c59edc2004-05-03 20:45:30 +00004902Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904 ver - Contains the U-Boot version string as printed
4905 with the "version" command. This variable is
4906 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004907
wdenkc6097192002-11-03 00:24:07 +00004908
wdenk6c59edc2004-05-03 20:45:30 +00004909Please note that changes to some configuration parameters may take
4910only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004911
stroeseb9c17c52003-04-04 15:53:41 +00004912
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004913Callback functions for environment variables:
4914---------------------------------------------
4915
4916For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004917when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004918be associated with arbitrary variables. On creation, overwrite, or
4919deletion, the callback will provide the opportunity for some side
4920effect to happen or for the change to be rejected.
4921
4922The callbacks are named and associated with a function using the
4923U_BOOT_ENV_CALLBACK macro in your board or driver code.
4924
4925These callbacks are associated with variables in one of two ways. The
4926static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4927in the board configuration to a string that defines a list of
4928associations. The list must be in the following format:
4929
4930 entry = variable_name[:callback_name]
4931 list = entry[,list]
4932
4933If the callback name is not specified, then the callback is deleted.
4934Spaces are also allowed anywhere in the list.
4935
4936Callbacks can also be associated by defining the ".callbacks" variable
4937with the same list format above. Any association in ".callbacks" will
4938override any association in the static list. You can define
4939CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004940".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004941
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004942If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4943regular expression. This allows multiple variables to be connected to
4944the same callback without explicitly listing them all out.
4945
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004946
wdenk6c59edc2004-05-03 20:45:30 +00004947Command Line Parsing:
4948=====================
stroeseb9c17c52003-04-04 15:53:41 +00004949
wdenk6c59edc2004-05-03 20:45:30 +00004950There are two different command line parsers available with U-Boot:
4951the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004952
wdenk6c59edc2004-05-03 20:45:30 +00004953Old, simple command line parser:
4954--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004955
wdenk6c59edc2004-05-03 20:45:30 +00004956- supports environment variables (through setenv / saveenv commands)
4957- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004958- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004959- special characters ('$', ';') can be escaped by prefixing with '\',
4960 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004961 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004962- You can also escape text by enclosing in single apostrophes, for example:
4963 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk6c59edc2004-05-03 20:45:30 +00004965Hush shell:
4966-----------
wdenkf4688a22003-05-28 08:06:31 +00004967
wdenk6c59edc2004-05-03 20:45:30 +00004968- similar to Bourne shell, with control structures like
4969 if...then...else...fi, for...do...done; while...do...done,
4970 until...do...done, ...
4971- supports environment ("global") variables (through setenv / saveenv
4972 commands) and local shell variables (through standard shell syntax
4973 "name=value"); only environment variables can be used with "run"
4974 command
wdenkf4688a22003-05-28 08:06:31 +00004975
wdenk6c59edc2004-05-03 20:45:30 +00004976General rules:
4977--------------
wdenkf4688a22003-05-28 08:06:31 +00004978
wdenk6c59edc2004-05-03 20:45:30 +00004979(1) If a command line (or an environment variable executed by a "run"
4980 command) contains several commands separated by semicolon, and
4981 one of these commands fails, then the remaining commands will be
4982 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004983
wdenk6c59edc2004-05-03 20:45:30 +00004984(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004985 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004986 command will cause "run" to terminate, i. e. the remaining
4987 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004988
wdenk6c59edc2004-05-03 20:45:30 +00004989Note for Redundant Ethernet Interfaces:
4990=======================================
wdenkf4688a22003-05-28 08:06:31 +00004991
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004992Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004993such configurations and is capable of automatic selection of a
4994"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004995
wdenk6c59edc2004-05-03 20:45:30 +00004996Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4997MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4998"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004999
wdenk6c59edc2004-05-03 20:45:30 +00005000If the network interface stores some valid MAC address (for instance
5001in SROM), this is used as default address if there is NO correspon-
5002ding setting in the environment; if the corresponding environment
5003variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005004
wdenk6c59edc2004-05-03 20:45:30 +00005005o If the SROM has a valid MAC address, and there is no address in the
5006 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005007
wdenk6c59edc2004-05-03 20:45:30 +00005008o If there is no valid address in the SROM, and a definition in the
5009 environment exists, then the value from the environment variable is
5010 used.
wdenkc6097192002-11-03 00:24:07 +00005011
wdenk6c59edc2004-05-03 20:45:30 +00005012o If both the SROM and the environment contain a MAC address, and
5013 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk6c59edc2004-05-03 20:45:30 +00005015o If both the SROM and the environment contain a MAC address, and the
5016 addresses differ, the value from the environment is used and a
5017 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005018
wdenk6c59edc2004-05-03 20:45:30 +00005019o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005020 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5021 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005022
Ben Warren6db991a2010-04-26 11:11:46 -07005023If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005024will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005025may be skipped by setting the appropriate 'ethmacskip' environment variable.
5026The naming convention is as follows:
5027"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005028
wdenk6c59edc2004-05-03 20:45:30 +00005029Image Formats:
5030==============
wdenkc6097192002-11-03 00:24:07 +00005031
Marian Balakowicz18710b82008-03-12 12:13:13 +01005032U-Boot is capable of booting (and performing other auxiliary operations on)
5033images in two formats:
5034
5035New uImage format (FIT)
5036-----------------------
5037
5038Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5039to Flattened Device Tree). It allows the use of images with multiple
5040components (several kernels, ramdisks, etc.), with contents protected by
5041SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5042
5043
5044Old uImage format
5045-----------------
5046
5047Old image format is based on binary files which can be basically anything,
5048preceded by a special header; see the definitions in include/image.h for
5049details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk6c59edc2004-05-03 20:45:30 +00005051* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5052 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005053 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5054 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5055 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005056* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005057 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5058 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005059* Compression Type (uncompressed, gzip, bzip2)
5060* Load Address
5061* Entry Point
5062* Image Name
5063* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005064
wdenk6c59edc2004-05-03 20:45:30 +00005065The header is marked by a special Magic Number, and both the header
5066and the data portions of the image are secured against corruption by
5067CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005068
wdenkc6097192002-11-03 00:24:07 +00005069
wdenk6c59edc2004-05-03 20:45:30 +00005070Linux Support:
5071==============
wdenkc6097192002-11-03 00:24:07 +00005072
wdenk6c59edc2004-05-03 20:45:30 +00005073Although U-Boot should support any OS or standalone application
5074easily, the main focus has always been on Linux during the design of
5075U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk6c59edc2004-05-03 20:45:30 +00005077U-Boot includes many features that so far have been part of some
5078special "boot loader" code within the Linux kernel. Also, any
5079"initrd" images to be used are no longer part of one big Linux image;
5080instead, kernel and "initrd" are separate images. This implementation
5081serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005082
wdenk6c59edc2004-05-03 20:45:30 +00005083- the same features can be used for other OS or standalone
5084 applications (for instance: using compressed images to reduce the
5085 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005086
wdenk6c59edc2004-05-03 20:45:30 +00005087- it becomes much easier to port new Linux kernel versions because
5088 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005089
wdenk6c59edc2004-05-03 20:45:30 +00005090- the same Linux kernel image can now be used with different "initrd"
5091 images; of course this also means that different kernel images can
5092 be run with the same "initrd". This makes testing easier (you don't
5093 have to build a new "zImage.initrd" Linux image when you just
5094 change a file in your "initrd"). Also, a field-upgrade of the
5095 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005096
wdenkc6097192002-11-03 00:24:07 +00005097
wdenk6c59edc2004-05-03 20:45:30 +00005098Linux HOWTO:
5099============
wdenkc6097192002-11-03 00:24:07 +00005100
wdenk6c59edc2004-05-03 20:45:30 +00005101Porting Linux to U-Boot based systems:
5102---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005103
wdenk6c59edc2004-05-03 20:45:30 +00005104U-Boot cannot save you from doing all the necessary modifications to
5105configure the Linux device drivers for use with your target hardware
5106(no, we don't intend to provide a full virtual machine interface to
5107Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005108
Stefan Roese88fbf932010-04-15 16:07:28 +02005109But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111Just make sure your machine specific header file (for instance
5112include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005113Information structure as we define in include/asm-<arch>/u-boot.h,
5114and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005115as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005116
Simon Glassd097e592014-06-11 23:29:46 -06005117Note that U-Boot now has a driver model, a unified model for drivers.
5118If you are adding a new driver, plumb it into driver model. If there
5119is no uclass available, you are encouraged to create one. See
5120doc/driver-model.
5121
wdenkc6097192002-11-03 00:24:07 +00005122
wdenk6c59edc2004-05-03 20:45:30 +00005123Configuring the Linux kernel:
5124-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005125
wdenk6c59edc2004-05-03 20:45:30 +00005126No specific requirements for U-Boot. Make sure you have some root
5127device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005128
wdenkc6097192002-11-03 00:24:07 +00005129
wdenk6c59edc2004-05-03 20:45:30 +00005130Building a Linux Image:
5131-----------------------
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk6c59edc2004-05-03 20:45:30 +00005133With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5134not used. If you use recent kernel source, a new build target
5135"uImage" will exist which automatically builds an image usable by
5136U-Boot. Most older kernels also have support for a "pImage" target,
5137which was introduced for our predecessor project PPCBoot and uses a
5138100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk6c59edc2004-05-03 20:45:30 +00005140Example:
wdenkc6097192002-11-03 00:24:07 +00005141
Holger Freyther7ba4e572014-08-04 09:26:05 +02005142 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005143 make oldconfig
5144 make dep
5145 make uImage
wdenkc6097192002-11-03 00:24:07 +00005146
wdenk6c59edc2004-05-03 20:45:30 +00005147The "uImage" build target uses a special tool (in 'tools/mkimage') to
5148encapsulate a compressed Linux kernel image with header information,
5149CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk6c59edc2004-05-03 20:45:30 +00005151* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005152
wdenk6c59edc2004-05-03 20:45:30 +00005153* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005154
wdenk6c59edc2004-05-03 20:45:30 +00005155 ${CROSS_COMPILE}-objcopy -O binary \
5156 -R .note -R .comment \
5157 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005158
wdenk6c59edc2004-05-03 20:45:30 +00005159* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005160
wdenk6c59edc2004-05-03 20:45:30 +00005161 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005162
wdenk6c59edc2004-05-03 20:45:30 +00005163* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005164
wdenk6c59edc2004-05-03 20:45:30 +00005165 mkimage -A ppc -O linux -T kernel -C gzip \
5166 -a 0 -e 0 -n "Linux Kernel Image" \
5167 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005168
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk6c59edc2004-05-03 20:45:30 +00005170The "mkimage" tool can also be used to create ramdisk images for use
5171with U-Boot, either separated from the Linux kernel image, or
5172combined into one file. "mkimage" encapsulates the images with a 64
5173byte header containing information about target architecture,
5174operating system, image type, compression method, entry points, time
5175stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005176
wdenk6c59edc2004-05-03 20:45:30 +00005177"mkimage" can be called in two ways: to verify existing images and
5178print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005179
wdenk6c59edc2004-05-03 20:45:30 +00005180In the first form (with "-l" option) mkimage lists the information
5181contained in the header of an existing U-Boot image; this includes
5182checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184 tools/mkimage -l image
5185 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005186
wdenk6c59edc2004-05-03 20:45:30 +00005187The second form (with "-d" option) is used to build a U-Boot image
5188from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005189
wdenk6c59edc2004-05-03 20:45:30 +00005190 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5191 -n name -d data_file image
5192 -A ==> set architecture to 'arch'
5193 -O ==> set operating system to 'os'
5194 -T ==> set image type to 'type'
5195 -C ==> set compression type 'comp'
5196 -a ==> set load address to 'addr' (hex)
5197 -e ==> set entry point to 'ep' (hex)
5198 -n ==> set image name to 'name'
5199 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005200
wdenkcd914452004-05-29 16:53:29 +00005201Right now, all Linux kernels for PowerPC systems use the same load
5202address (0x00000000), but the entry point address depends on the
5203kernel version:
wdenkc6097192002-11-03 00:24:07 +00005204
wdenk6c59edc2004-05-03 20:45:30 +00005205- 2.2.x kernels have the entry point at 0x0000000C,
5206- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005207
wdenk6c59edc2004-05-03 20:45:30 +00005208So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005209
wdenk6c59edc2004-05-03 20:45:30 +00005210 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5211 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005212 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005213 > examples/uImage.TQM850L
5214 Image Name: 2.4.4 kernel for TQM850L
5215 Created: Wed Jul 19 02:34:59 2000
5216 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5217 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5218 Load Address: 0x00000000
5219 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005220
wdenk6c59edc2004-05-03 20:45:30 +00005221To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223 -> tools/mkimage -l examples/uImage.TQM850L
5224 Image Name: 2.4.4 kernel for TQM850L
5225 Created: Wed Jul 19 02:34:59 2000
5226 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5227 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5228 Load Address: 0x00000000
5229 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk6c59edc2004-05-03 20:45:30 +00005231NOTE: for embedded systems where boot time is critical you can trade
5232speed for memory and install an UNCOMPRESSED image instead: this
5233needs more space in Flash, but boots much faster since it does not
5234need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005235
Stefan Roese88fbf932010-04-15 16:07:28 +02005236 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005237 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5238 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005239 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005240 > examples/uImage.TQM850L-uncompressed
5241 Image Name: 2.4.4 kernel for TQM850L
5242 Created: Wed Jul 19 02:34:59 2000
5243 Image Type: PowerPC Linux Kernel Image (uncompressed)
5244 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5245 Load Address: 0x00000000
5246 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005247
wdenkc6097192002-11-03 00:24:07 +00005248
wdenk6c59edc2004-05-03 20:45:30 +00005249Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5250when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005251
wdenk6c59edc2004-05-03 20:45:30 +00005252 -> tools/mkimage -n 'Simple Ramdisk Image' \
5253 > -A ppc -O linux -T ramdisk -C gzip \
5254 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5255 Image Name: Simple Ramdisk Image
5256 Created: Wed Jan 12 14:01:50 2000
5257 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5258 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5259 Load Address: 0x00000000
5260 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005261
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005262The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5263option performs the converse operation of the mkimage's second form (the "-d"
5264option). Given an image built by mkimage, the dumpimage extracts a "data file"
5265from the image:
5266
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005267 tools/dumpimage -i image -T type -p position data_file
5268 -i ==> extract from the 'image' a specific 'data_file'
5269 -T ==> set image type to 'type'
5270 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005271
wdenkc6097192002-11-03 00:24:07 +00005272
wdenk6c59edc2004-05-03 20:45:30 +00005273Installing a Linux Image:
5274-------------------------
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276To downloading a U-Boot image over the serial (console) interface,
5277you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk6c59edc2004-05-03 20:45:30 +00005279 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005280
wdenk6c59edc2004-05-03 20:45:30 +00005281The 'objcopy' does not understand the information in the U-Boot
5282image header, so the resulting S-Record file will be relative to
5283address 0x00000000. To load it to a given address, you need to
5284specify the target address as 'offset' parameter with the 'loads'
5285command.
wdenkc6097192002-11-03 00:24:07 +00005286
wdenk6c59edc2004-05-03 20:45:30 +00005287Example: install the image to address 0x40100000 (which on the
5288TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005289
wdenk6c59edc2004-05-03 20:45:30 +00005290 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005291
wdenk6c59edc2004-05-03 20:45:30 +00005292 .......... done
5293 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295 => loads 40100000
5296 ## Ready for S-Record download ...
5297 ~>examples/image.srec
5298 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5299 ...
5300 15989 15990 15991 15992
5301 [file transfer complete]
5302 [connected]
5303 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005304
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk6c59edc2004-05-03 20:45:30 +00005306You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005307this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005308corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk6c59edc2004-05-03 20:45:30 +00005310 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005311
wdenk6c59edc2004-05-03 20:45:30 +00005312 ## Checking Image at 40100000 ...
5313 Image Name: 2.2.13 for initrd on TQM850L
5314 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5315 Data Size: 335725 Bytes = 327 kB = 0 MB
5316 Load Address: 00000000
5317 Entry Point: 0000000c
5318 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005319
5320
wdenk6c59edc2004-05-03 20:45:30 +00005321Boot Linux:
5322-----------
wdenkc6097192002-11-03 00:24:07 +00005323
wdenk6c59edc2004-05-03 20:45:30 +00005324The "bootm" command is used to boot an application that is stored in
5325memory (RAM or Flash). In case of a Linux kernel image, the contents
5326of the "bootargs" environment variable is passed to the kernel as
5327parameters. You can check and modify this variable using the
5328"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005329
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331 => printenv bootargs
5332 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005333
wdenk6c59edc2004-05-03 20:45:30 +00005334 => 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 +00005335
wdenk6c59edc2004-05-03 20:45:30 +00005336 => printenv bootargs
5337 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 +00005338
wdenk6c59edc2004-05-03 20:45:30 +00005339 => bootm 40020000
5340 ## Booting Linux kernel at 40020000 ...
5341 Image Name: 2.2.13 for NFS on TQM850L
5342 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5343 Data Size: 381681 Bytes = 372 kB = 0 MB
5344 Load Address: 00000000
5345 Entry Point: 0000000c
5346 Verifying Checksum ... OK
5347 Uncompressing Kernel Image ... OK
5348 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
5349 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5350 time_init: decrementer frequency = 187500000/60
5351 Calibrating delay loop... 49.77 BogoMIPS
5352 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5353 ...
wdenkc6097192002-11-03 00:24:07 +00005354
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005355If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005356the memory addresses of both the kernel and the initrd image (PPBCOOT
5357format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005358
wdenk6c59edc2004-05-03 20:45:30 +00005359 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005360
wdenk6c59edc2004-05-03 20:45:30 +00005361 ## Checking Image at 40100000 ...
5362 Image Name: 2.2.13 for initrd on TQM850L
5363 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5364 Data Size: 335725 Bytes = 327 kB = 0 MB
5365 Load Address: 00000000
5366 Entry Point: 0000000c
5367 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005368
wdenk6c59edc2004-05-03 20:45:30 +00005369 ## Checking Image at 40200000 ...
5370 Image Name: Simple Ramdisk Image
5371 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5372 Data Size: 566530 Bytes = 553 kB = 0 MB
5373 Load Address: 00000000
5374 Entry Point: 00000000
5375 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005376
wdenk6c59edc2004-05-03 20:45:30 +00005377 => bootm 40100000 40200000
5378 ## Booting Linux kernel at 40100000 ...
5379 Image Name: 2.2.13 for initrd on TQM850L
5380 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5381 Data Size: 335725 Bytes = 327 kB = 0 MB
5382 Load Address: 00000000
5383 Entry Point: 0000000c
5384 Verifying Checksum ... OK
5385 Uncompressing Kernel Image ... OK
5386 ## Loading RAMDisk Image at 40200000 ...
5387 Image Name: Simple Ramdisk Image
5388 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5389 Data Size: 566530 Bytes = 553 kB = 0 MB
5390 Load Address: 00000000
5391 Entry Point: 00000000
5392 Verifying Checksum ... OK
5393 Loading Ramdisk ... OK
5394 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
5395 Boot arguments: root=/dev/ram
5396 time_init: decrementer frequency = 187500000/60
5397 Calibrating delay loop... 49.77 BogoMIPS
5398 ...
5399 RAMDISK: Compressed image found at block 0
5400 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005401
wdenk6c59edc2004-05-03 20:45:30 +00005402 bash#
wdenkc6097192002-11-03 00:24:07 +00005403
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005404Boot Linux and pass a flat device tree:
5405-----------
5406
5407First, U-Boot must be compiled with the appropriate defines. See the section
5408titled "Linux Kernel Interface" above for a more in depth explanation. The
5409following is an example of how to start a kernel and pass an updated
5410flat device tree:
5411
5412=> print oftaddr
5413oftaddr=0x300000
5414=> print oft
5415oft=oftrees/mpc8540ads.dtb
5416=> tftp $oftaddr $oft
5417Speed: 1000, full duplex
5418Using TSEC0 device
5419TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5420Filename 'oftrees/mpc8540ads.dtb'.
5421Load address: 0x300000
5422Loading: #
5423done
5424Bytes transferred = 4106 (100a hex)
5425=> tftp $loadaddr $bootfile
5426Speed: 1000, full duplex
5427Using TSEC0 device
5428TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5429Filename 'uImage'.
5430Load address: 0x200000
5431Loading:############
5432done
5433Bytes transferred = 1029407 (fb51f hex)
5434=> print loadaddr
5435loadaddr=200000
5436=> print oftaddr
5437oftaddr=0x300000
5438=> bootm $loadaddr - $oftaddr
5439## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005440 Image Name: Linux-2.6.17-dirty
5441 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5442 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005443 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005444 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005445 Verifying Checksum ... OK
5446 Uncompressing Kernel Image ... OK
5447Booting using flat device tree at 0x300000
5448Using MPC85xx ADS machine description
5449Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5450[snip]
5451
5452
wdenk6c59edc2004-05-03 20:45:30 +00005453More About U-Boot Image Types:
5454------------------------------
wdenkc6097192002-11-03 00:24:07 +00005455
wdenk6c59edc2004-05-03 20:45:30 +00005456U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005457
wdenk6c59edc2004-05-03 20:45:30 +00005458 "Standalone Programs" are directly runnable in the environment
5459 provided by U-Boot; it is expected that (if they behave
5460 well) you can continue to work in U-Boot after return from
5461 the Standalone Program.
5462 "OS Kernel Images" are usually images of some Embedded OS which
5463 will take over control completely. Usually these programs
5464 will install their own set of exception handlers, device
5465 drivers, set up the MMU, etc. - this means, that you cannot
5466 expect to re-enter U-Boot except by resetting the CPU.
5467 "RAMDisk Images" are more or less just data blocks, and their
5468 parameters (address, size) are passed to an OS kernel that is
5469 being started.
5470 "Multi-File Images" contain several images, typically an OS
5471 (Linux) kernel image and one or more data images like
5472 RAMDisks. This construct is useful for instance when you want
5473 to boot over the network using BOOTP etc., where the boot
5474 server provides just a single image file, but you want to get
5475 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005476
wdenk6c59edc2004-05-03 20:45:30 +00005477 "Multi-File Images" start with a list of image sizes, each
5478 image size (in bytes) specified by an "uint32_t" in network
5479 byte order. This list is terminated by an "(uint32_t)0".
5480 Immediately after the terminating 0 follow the images, one by
5481 one, all aligned on "uint32_t" boundaries (size rounded up to
5482 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005483
wdenk6c59edc2004-05-03 20:45:30 +00005484 "Firmware Images" are binary images containing firmware (like
5485 U-Boot or FPGA images) which usually will be programmed to
5486 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005487
wdenk6c59edc2004-05-03 20:45:30 +00005488 "Script files" are command sequences that will be executed by
5489 U-Boot's command interpreter; this feature is especially
5490 useful when you configure U-Boot to use a real shell (hush)
5491 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005492
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005493Booting the Linux zImage:
5494-------------------------
5495
5496On some platforms, it's possible to boot Linux zImage. This is done
5497using the "bootz" command. The syntax of "bootz" command is the same
5498as the syntax of "bootm" command.
5499
Tom Rini45f46d12013-05-16 11:40:11 -04005500Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005501kernel with raw initrd images. The syntax is slightly different, the
5502address of the initrd must be augmented by it's size, in the following
5503format: "<initrd addres>:<initrd size>".
5504
stroeseb9c17c52003-04-04 15:53:41 +00005505
wdenk6c59edc2004-05-03 20:45:30 +00005506Standalone HOWTO:
5507=================
stroeseb9c17c52003-04-04 15:53:41 +00005508
wdenk6c59edc2004-05-03 20:45:30 +00005509One of the features of U-Boot is that you can dynamically load and
5510run "standalone" applications, which can use some resources of
5511U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005512
wdenk6c59edc2004-05-03 20:45:30 +00005513Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005514
wdenk6c59edc2004-05-03 20:45:30 +00005515"Hello World" Demo:
5516-------------------
wdenkc6097192002-11-03 00:24:07 +00005517
wdenk6c59edc2004-05-03 20:45:30 +00005518'examples/hello_world.c' contains a small "Hello World" Demo
5519application; it is automatically compiled when you build U-Boot.
5520It's configured to run at address 0x00040004, so you can play with it
5521like that:
wdenkc6097192002-11-03 00:24:07 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523 => loads
5524 ## Ready for S-Record download ...
5525 ~>examples/hello_world.srec
5526 1 2 3 4 5 6 7 8 9 10 11 ...
5527 [file transfer complete]
5528 [connected]
5529 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk6c59edc2004-05-03 20:45:30 +00005531 => go 40004 Hello World! This is a test.
5532 ## Starting application at 0x00040004 ...
5533 Hello World
5534 argc = 7
5535 argv[0] = "40004"
5536 argv[1] = "Hello"
5537 argv[2] = "World!"
5538 argv[3] = "This"
5539 argv[4] = "is"
5540 argv[5] = "a"
5541 argv[6] = "test."
5542 argv[7] = "<NULL>"
5543 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005544
wdenk6c59edc2004-05-03 20:45:30 +00005545 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005546
wdenk6c59edc2004-05-03 20:45:30 +00005547Another example, which demonstrates how to register a CPM interrupt
5548handler with the U-Boot code, can be found in 'examples/timer.c'.
5549Here, a CPM timer is set up to generate an interrupt every second.
5550The interrupt service routine is trivial, just printing a '.'
5551character, but this is just a demo program. The application can be
5552controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005553
wdenk6c59edc2004-05-03 20:45:30 +00005554 ? - print current values og the CPM Timer registers
5555 b - enable interrupts and start timer
5556 e - stop timer and disable interrupts
5557 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005558
wdenk6c59edc2004-05-03 20:45:30 +00005559 => loads
5560 ## Ready for S-Record download ...
5561 ~>examples/timer.srec
5562 1 2 3 4 5 6 7 8 9 10 11 ...
5563 [file transfer complete]
5564 [connected]
5565 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005566
wdenk6c59edc2004-05-03 20:45:30 +00005567 => go 40004
5568 ## Starting application at 0x00040004 ...
5569 TIMERS=0xfff00980
5570 Using timer 1
5571 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005572
wdenk6c59edc2004-05-03 20:45:30 +00005573Hit 'b':
5574 [q, b, e, ?] Set interval 1000000 us
5575 Enabling timer
5576Hit '?':
5577 [q, b, e, ?] ........
5578 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5579Hit '?':
5580 [q, b, e, ?] .
5581 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5582Hit '?':
5583 [q, b, e, ?] .
5584 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5585Hit '?':
5586 [q, b, e, ?] .
5587 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5588Hit 'e':
5589 [q, b, e, ?] ...Stopping timer
5590Hit 'q':
5591 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005592
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk6c59edc2004-05-03 20:45:30 +00005594Minicom warning:
5595================
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk6c59edc2004-05-03 20:45:30 +00005597Over time, many people have reported problems when trying to use the
5598"minicom" terminal emulation program for serial download. I (wd)
5599consider minicom to be broken, and recommend not to use it. Under
5600Unix, I recommend to use C-Kermit for general purpose use (and
5601especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005602use "cu" for S-Record download ("loads" command). See
5603http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5604for help with kermit.
5605
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk6c59edc2004-05-03 20:45:30 +00005607Nevertheless, if you absolutely want to use it try adding this
5608configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005609
wdenk6c59edc2004-05-03 20:45:30 +00005610 Name Program Name U/D FullScr IO-Red. Multi
5611 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5612 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005613
wdenk8dba0502003-03-31 16:34:49 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615NetBSD Notes:
5616=============
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618Starting at version 0.9.2, U-Boot supports NetBSD both as host
5619(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005620
wdenk6c59edc2004-05-03 20:45:30 +00005621Building requires a cross environment; it is known to work on
5622NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5623need gmake since the Makefiles are not compatible with BSD make).
5624Note that the cross-powerpc package does not install include files;
5625attempting to build U-Boot will fail because <machine/ansi.h> is
5626missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005627
wdenk6c59edc2004-05-03 20:45:30 +00005628 # cd /usr/pkg/cross/powerpc-netbsd/include
5629 # mkdir powerpc
5630 # ln -s powerpc machine
5631 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5632 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005633
wdenk6c59edc2004-05-03 20:45:30 +00005634Native builds *don't* work due to incompatibilities between native
5635and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005636
wdenk6c59edc2004-05-03 20:45:30 +00005637Booting assumes that (the first part of) the image booted is a
5638stage-2 loader which in turn loads and then invokes the kernel
5639proper. Loader sources will eventually appear in the NetBSD source
5640tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005641meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005642
wdenkc6097192002-11-03 00:24:07 +00005643
wdenk6c59edc2004-05-03 20:45:30 +00005644Implementation Internals:
5645=========================
wdenkc6097192002-11-03 00:24:07 +00005646
wdenk6c59edc2004-05-03 20:45:30 +00005647The following is not intended to be a complete description of every
5648implementation detail. However, it should help to understand the
5649inner workings of U-Boot and make it easier to port it to custom
5650hardware.
wdenkc6097192002-11-03 00:24:07 +00005651
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk6c59edc2004-05-03 20:45:30 +00005653Initial Stack, Global Data:
5654---------------------------
wdenkc6097192002-11-03 00:24:07 +00005655
wdenk6c59edc2004-05-03 20:45:30 +00005656The implementation of U-Boot is complicated by the fact that U-Boot
5657starts running out of ROM (flash memory), usually without access to
5658system RAM (because the memory controller is not initialized yet).
5659This means that we don't have writable Data or BSS segments, and BSS
5660is not initialized as zero. To be able to get a C environment working
5661at all, we have to allocate at least a minimal stack. Implementation
5662options for this are defined and restricted by the CPU used: Some CPU
5663models provide on-chip memory (like the IMMR area on MPC8xx and
5664MPC826x processors), on others (parts of) the data cache can be
5665locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005666
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005667 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005668 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005669
wdenk6c59edc2004-05-03 20:45:30 +00005670 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5671 From: "Chris Hallinan" <clh@net1plus.com>
5672 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5673 ...
wdenkc6097192002-11-03 00:24:07 +00005674
wdenk6c59edc2004-05-03 20:45:30 +00005675 Correct me if I'm wrong, folks, but the way I understand it
5676 is this: Using DCACHE as initial RAM for Stack, etc, does not
5677 require any physical RAM backing up the cache. The cleverness
5678 is that the cache is being used as a temporary supply of
5679 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005680 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005681 can see how this works by studying the cache architecture and
5682 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005683
wdenk6c59edc2004-05-03 20:45:30 +00005684 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5685 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005686 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005687 option should work for you. Using CS 4 should be fine if your
5688 board designers haven't used it for something that would
5689 cause you grief during the initial boot! It is frequently not
5690 used.
wdenkc6097192002-11-03 00:24:07 +00005691
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005692 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005693 with your processor/board/system design. The default value
5694 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005695 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005696 than your SDRAM module. If you have a 64MB SDRAM module, set
5697 it above 400_0000. Just make sure your board has no resources
5698 that are supposed to respond to that address! That code in
5699 start.S has been around a while and should work as is when
5700 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005701
wdenk6c59edc2004-05-03 20:45:30 +00005702 -Chris Hallinan
5703 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005704
wdenk6c59edc2004-05-03 20:45:30 +00005705It is essential to remember this, since it has some impact on the C
5706code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005707
wdenk6c59edc2004-05-03 20:45:30 +00005708* Initialized global data (data segment) is read-only. Do not attempt
5709 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005710
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005711* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005712 as zero data - BSS segment) at all - this is undefined, initiali-
5713 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005714
wdenk6c59edc2004-05-03 20:45:30 +00005715* Stack space is very limited. Avoid big data buffers or things like
5716 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005717
wdenk6c59edc2004-05-03 20:45:30 +00005718Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005719normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005720turned out that the implementation of U-Boot can be greatly
5721simplified by making a global data structure (gd_t) available to all
5722functions. We could pass a pointer to this data as argument to _all_
5723functions, but this would bloat the code. Instead we use a feature of
5724the GCC compiler (Global Register Variables) to share the data: we
5725place a pointer (gd) to the global data into a register which we
5726reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk6c59edc2004-05-03 20:45:30 +00005728When choosing a register for such a purpose we are restricted by the
5729relevant (E)ABI specifications for the current architecture, and by
5730GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk6c59edc2004-05-03 20:45:30 +00005732For PowerPC, the following registers have specific use:
5733 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005734 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005735 R3-R4: parameter passing and return values
5736 R5-R10: parameter passing
5737 R13: small data area pointer
5738 R30: GOT pointer
5739 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005740
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005741 (U-Boot also uses R12 as internal GOT pointer. r12
5742 is a volatile register so r12 needs to be reset when
5743 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005744
Wolfgang Denk69c09642008-02-14 22:43:22 +01005745 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005746
wdenk6c59edc2004-05-03 20:45:30 +00005747 Note: on PPC, we could use a static initializer (since the
5748 address of the global data structure is known at compile time),
5749 but it turned out that reserving a register results in somewhat
5750 smaller code - although the code savings are not that big (on
5751 average for all boards 752 bytes for the whole U-Boot image,
5752 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005753
wdenk6c59edc2004-05-03 20:45:30 +00005754On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756 R0: function argument word/integer result
5757 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005758 R9: platform specific
5759 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005760 R11: argument (frame) pointer
5761 R12: temporary workspace
5762 R13: stack pointer
5763 R14: link register
5764 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005765
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005766 ==> U-Boot will use R9 to hold a pointer to the global data
5767
5768 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005769
Thomas Chou8fa38582010-05-21 11:08:03 +08005770On Nios II, the ABI is documented here:
5771 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5772
5773 ==> U-Boot will use gp to hold a pointer to the global data
5774
5775 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5776 to access small data sections, so gp is free.
5777
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005778On NDS32, the following registers are used:
5779
5780 R0-R1: argument/return
5781 R2-R5: argument
5782 R15: temporary register for assembler
5783 R16: trampoline register
5784 R28: frame pointer (FP)
5785 R29: global pointer (GP)
5786 R30: link register (LP)
5787 R31: stack pointer (SP)
5788 PC: program counter (PC)
5789
5790 ==> U-Boot will use R10 to hold a pointer to the global data
5791
Wolfgang Denk6405a152006-03-31 18:32:53 +02005792NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5793or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005794
wdenk6c59edc2004-05-03 20:45:30 +00005795Memory Management:
5796------------------
wdenkc6097192002-11-03 00:24:07 +00005797
wdenk6c59edc2004-05-03 20:45:30 +00005798U-Boot runs in system state and uses physical addresses, i.e. the
5799MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005800
wdenk6c59edc2004-05-03 20:45:30 +00005801The available memory is mapped to fixed addresses using the memory
5802controller. In this process, a contiguous block is formed for each
5803memory type (Flash, SDRAM, SRAM), even when it consists of several
5804physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk6c59edc2004-05-03 20:45:30 +00005806U-Boot is installed in the first 128 kB of the first Flash bank (on
5807TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5808booting and sizing and initializing DRAM, the code relocates itself
5809to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005810memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005811configuration setting]. Below that, a structure with global Board
5812Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814Additionally, some exception handler code is copied to the low 8 kB
5815of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005816
wdenk6c59edc2004-05-03 20:45:30 +00005817So a typical memory configuration with 16 MB of DRAM could look like
5818this:
wdenkc6097192002-11-03 00:24:07 +00005819
wdenk6c59edc2004-05-03 20:45:30 +00005820 0x0000 0000 Exception Vector code
5821 :
5822 0x0000 1FFF
5823 0x0000 2000 Free for Application Use
5824 :
5825 :
wdenkc6097192002-11-03 00:24:07 +00005826
wdenk6c59edc2004-05-03 20:45:30 +00005827 :
5828 :
5829 0x00FB FF20 Monitor Stack (Growing downward)
5830 0x00FB FFAC Board Info Data and permanent copy of global data
5831 0x00FC 0000 Malloc Arena
5832 :
5833 0x00FD FFFF
5834 0x00FE 0000 RAM Copy of Monitor Code
5835 ... eventually: LCD or video framebuffer
5836 ... eventually: pRAM (Protected RAM - unchanged by reset)
5837 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005838
wdenkc6097192002-11-03 00:24:07 +00005839
wdenk6c59edc2004-05-03 20:45:30 +00005840System Initialization:
5841----------------------
wdenkc6097192002-11-03 00:24:07 +00005842
wdenk6c59edc2004-05-03 20:45:30 +00005843In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005844(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005845configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005846To be able to re-map memory U-Boot then jumps to its link address.
5847To be able to implement the initialization code in C, a (small!)
5848initial stack is set up in the internal Dual Ported RAM (in case CPUs
5849which provide such a feature like MPC8xx or MPC8260), or in a locked
5850part of the data cache. After that, U-Boot initializes the CPU core,
5851the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk6c59edc2004-05-03 20:45:30 +00005853Next, all (potentially) available memory banks are mapped using a
5854preliminary mapping. For example, we put them on 512 MB boundaries
5855(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5856on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5857programmed for SDRAM access. Using the temporary configuration, a
5858simple memory test is run that determines the size of the SDRAM
5859banks.
wdenkc6097192002-11-03 00:24:07 +00005860
wdenk6c59edc2004-05-03 20:45:30 +00005861When there is more than one SDRAM bank, and the banks are of
5862different size, the largest is mapped first. For equal size, the first
5863bank (CS2#) is mapped first. The first mapping is always for address
58640x00000000, with any additional banks following immediately to create
5865contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005866
wdenk6c59edc2004-05-03 20:45:30 +00005867Then, the monitor installs itself at the upper end of the SDRAM area
5868and allocates memory for use by malloc() and for the global Board
5869Info data; also, the exception vector code is copied to the low RAM
5870pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005871
wdenk6c59edc2004-05-03 20:45:30 +00005872Only after this relocation will you have a "normal" C environment;
5873until that you are restricted in several ways, mostly because you are
5874running from ROM, and because the code will have to be relocated to a
5875new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005876
wdenkc6097192002-11-03 00:24:07 +00005877
wdenk6c59edc2004-05-03 20:45:30 +00005878U-Boot Porting Guide:
5879----------------------
wdenkc6097192002-11-03 00:24:07 +00005880
wdenk6c59edc2004-05-03 20:45:30 +00005881[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5882list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005883
wdenkc6097192002-11-03 00:24:07 +00005884
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005885int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005886{
5887 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005888
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005889 signal(SIGALRM, no_more_time);
5890 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005891
wdenk6c59edc2004-05-03 20:45:30 +00005892 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005893 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005894 return 0;
5895 }
wdenkc6097192002-11-03 00:24:07 +00005896
wdenk6c59edc2004-05-03 20:45:30 +00005897 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005898
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005899 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005900
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005901 if (clueless)
5902 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005903
wdenk6c59edc2004-05-03 20:45:30 +00005904 while (learning) {
5905 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005906 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5907 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005908 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005909 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005910 }
wdenkc6097192002-11-03 00:24:07 +00005911
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005912 if (available_money > toLocalCurrency ($2500))
5913 Buy a BDI3000;
5914 else
wdenk6c59edc2004-05-03 20:45:30 +00005915 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005916
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005917 if (a similar board exists) { /* hopefully... */
5918 cp -a board/<similar> board/<myboard>
5919 cp include/configs/<similar>.h include/configs/<myboard>.h
5920 } else {
5921 Create your own board support subdirectory;
5922 Create your own board include/configs/<myboard>.h file;
5923 }
5924 Edit new board/<myboard> files
5925 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005926
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005927 while (!accepted) {
5928 while (!running) {
5929 do {
5930 Add / modify source code;
5931 } until (compiles);
5932 Debug;
5933 if (clueless)
5934 email("Hi, I am having problems...");
5935 }
5936 Send patch file to the U-Boot email list;
5937 if (reasonable critiques)
5938 Incorporate improvements from email list code review;
5939 else
5940 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005941 }
wdenkc6097192002-11-03 00:24:07 +00005942
wdenk6c59edc2004-05-03 20:45:30 +00005943 return 0;
5944}
wdenkc6097192002-11-03 00:24:07 +00005945
wdenk6c59edc2004-05-03 20:45:30 +00005946void no_more_time (int sig)
5947{
5948 hire_a_guru();
5949}
wdenkc6097192002-11-03 00:24:07 +00005950
wdenkc6097192002-11-03 00:24:07 +00005951
wdenk6c59edc2004-05-03 20:45:30 +00005952Coding Standards:
5953-----------------
wdenkc6097192002-11-03 00:24:07 +00005954
wdenk6c59edc2004-05-03 20:45:30 +00005955All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005956coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005957"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005958
5959Source files originating from a different project (for example the
5960MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005961reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005962sources.
wdenkc6097192002-11-03 00:24:07 +00005963
Detlev Zundelaa63d482006-09-01 15:39:02 +02005964Please note that U-Boot is implemented in C (and to some small parts in
5965Assembler); no C++ is used, so please do not use C++ style comments (//)
5966in your code.
wdenkad276f22004-01-04 16:28:35 +00005967
wdenk6c59edc2004-05-03 20:45:30 +00005968Please also stick to the following formatting rules:
5969- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005970- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005971- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005972- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005973- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005974
wdenk6c59edc2004-05-03 20:45:30 +00005975Submissions which do not conform to the standards may be returned
5976with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005977
wdenkc6097192002-11-03 00:24:07 +00005978
wdenk6c59edc2004-05-03 20:45:30 +00005979Submitting Patches:
5980-------------------
wdenkc6097192002-11-03 00:24:07 +00005981
wdenk6c59edc2004-05-03 20:45:30 +00005982Since the number of patches for U-Boot is growing, we need to
5983establish some rules. Submissions which do not conform to these rules
5984may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005985
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005986Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005987
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005988Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5989see http://lists.denx.de/mailman/listinfo/u-boot
5990
wdenk6c59edc2004-05-03 20:45:30 +00005991When you send a patch, please include the following information with
5992it:
wdenkc6097192002-11-03 00:24:07 +00005993
wdenk6c59edc2004-05-03 20:45:30 +00005994* For bug fixes: a description of the bug and how your patch fixes
5995 this bug. Please try to include a way of demonstrating that the
5996 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005997
wdenk6c59edc2004-05-03 20:45:30 +00005998* For new features: a description of the feature and your
5999 implementation.
wdenkc6097192002-11-03 00:24:07 +00006000
wdenk6c59edc2004-05-03 20:45:30 +00006001* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006002
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006003* For major contributions, add a MAINTAINERS file with your
6004 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006005
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006006* When you add support for a new board, don't forget to add a
6007 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006008
wdenk6c59edc2004-05-03 20:45:30 +00006009* If your patch adds new configuration options, don't forget to
6010 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006011
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006012* The patch itself. If you are using git (which is *strongly*
6013 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006014 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006015 the U-Boot mailing list, you will avoid most of the common problems
6016 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006017
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006018 If you cannot use git, use "diff -purN OLD NEW". If your version of
6019 diff does not support these options, then get the latest version of
6020 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006021
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006022 The current directory when running this command shall be the parent
6023 directory of the U-Boot source tree (i. e. please make sure that
6024 your patch includes sufficient directory information for the
6025 affected files).
6026
6027 We prefer patches as plain text. MIME attachments are discouraged,
6028 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006029
wdenk6c59edc2004-05-03 20:45:30 +00006030* If one logical set of modifications affects or creates several
6031 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006032
wdenk6c59edc2004-05-03 20:45:30 +00006033* Changesets that contain different, unrelated modifications shall be
6034 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006035
wdenkc6097192002-11-03 00:24:07 +00006036
wdenk6c59edc2004-05-03 20:45:30 +00006037Notes:
wdenkc6097192002-11-03 00:24:07 +00006038
Simon Glassdc27def2016-07-27 20:33:08 -06006039* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00006040 source tree and make sure that no errors or warnings are reported
6041 for any of the boards.
6042
6043* Keep your modifications to the necessary minimum: A patch
6044 containing several unrelated changes or arbitrary reformats will be
6045 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006046
wdenk6c59edc2004-05-03 20:45:30 +00006047* If you modify existing code, make sure that your new code does not
6048 add to the memory footprint of the code ;-) Small is beautiful!
6049 When adding new features, these should compile conditionally only
6050 (using #ifdef), and the resulting code with the new feature
6051 disabled must not need more memory than the old code without your
6052 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006053
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006054* Remember that there is a size limit of 100 kB per message on the
6055 u-boot mailing list. Bigger patches will be moderated. If they are
6056 reasonable and not too big, they will be acknowledged. But patches
6057 bigger than the size limit should be avoided.