blob: 075d919df3fee00e6c486e65344b1c1d61338422 [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
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500830 CONFIG_CMD_DHCP * DHCP support
831 CONFIG_CMD_DIAG * Diagnostics
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500832 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -0500833 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500834 CONFIG_CMD_ELF * bootelf, bootvx
Andrew Ruder94463402013-10-22 19:07:34 -0500835 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500836 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +0000837 CONFIG_CMD_EXT2 * ext2 command support
838 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -0700839 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
840 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +0100841 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -0500842 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500843 CONFIG_CMD_FLASH flinfo, erase, protect
844 CONFIG_CMD_FPGA FPGA device initialization support
Mike Frysinger2ed02412010-12-26 23:32:22 -0500845 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +0000846 CONFIG_CMD_GREPENV * search environment
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500847 CONFIG_CMD_I2C * I2C serial bus support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500848 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +0000849 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200850 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Mike Frysingerf3ddf202010-12-26 23:09:45 -0500851 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +0000852 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500853 CONFIG_CMD_ITEST Integer/string test of 2 values
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200854 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +0000855 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
856 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500857 CONFIG_CMD_LOADB loadb
858 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200859 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -0400860 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +0000861 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500862 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +0000863 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200864 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500865 CONFIG_CMD_MISC Misc functions like sleep etc
866 CONFIG_CMD_MMC * MMC memory mapped support
867 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +0100868 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500869 CONFIG_CMD_NAND * NAND support
870 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200871 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -0600872 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +0000873 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500874 CONFIG_CMD_PCI * pciinfo
875 CONFIG_CMD_PCMCIA * PCMCIA support
876 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
877 host
878 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +0000879 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500880 CONFIG_CMD_REGINFO * Register dump
881 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +0000882 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500883 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -0600884 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500885 CONFIG_CMD_SDRAM * print SDRAM configuration information
886 (requires CONFIG_CMD_I2C)
887 CONFIG_CMD_SETGETDCR Support for DCR Register access
888 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -0700889 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Bob Liua671b702013-02-05 19:05:41 +0800890 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +0200891 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500892 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +0000893 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +0000894 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +0000895 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
896 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500897 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500898 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +0000899 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +0200900 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +0200901 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +0000902
903 EXAMPLE: If you want all functions except of network
904 support you can write:
905
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500906 #include "config_cmd_all.h"
907 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +0000908
Gerald Van Barend6abef42007-03-31 12:23:51 -0400909 Other Commands:
910 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +0000911
912 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500913 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +0000914 what you (and your U-Boot users) are doing. Data
915 cache cannot be enabled on systems like the 8xx or
916 8260 (where accesses to the IMMR region must be
917 uncached), and it cannot be disabled on all other
918 systems where we (mis-) use the data cache to hold an
919 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +0000920
921
922 XXX - this list needs to get updated!
923
Simon Glassaa34ef22016-03-13 19:07:28 -0600924- Removal of commands
925 If no commands are needed to boot, you can disable
926 CONFIG_CMDLINE to remove them. In this case, the command line
927 will not be available, and when U-Boot wants to execute the
928 boot command (on start-up) it will call board_run_command()
929 instead. This can reduce image size significantly for very
930 simple boot procedures.
931
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000932- Regular expression support:
933 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +0200934 If this variable is defined, U-Boot is linked against
935 the SLRE (Super Light Regular Expression) library,
936 which adds regex support to some commands, as for
937 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +0000938
Simon Glass3d686442011-10-15 05:48:20 +0000939- Device tree:
940 CONFIG_OF_CONTROL
941 If this variable is defined, U-Boot will use a device tree
942 to configure its devices, instead of relying on statically
943 compiled #defines in the board file. This option is
944 experimental and only available on a few boards. The device
945 tree is available in the global data as gd->fdt_blob.
946
Simon Glass5cb34db2011-10-24 19:15:31 +0000947 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo5b661ec2017-04-02 01:25:20 -0700948 be done using one of the three options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +0000949
950 CONFIG_OF_EMBED
951 If this variable is defined, U-Boot will embed a device tree
952 binary in its image. This device tree file should be in the
953 board directory and called <soc>-<board>.dts. The binary file
954 is then picked up in board_init_f() and made available through
955 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +0000956
Simon Glass5cb34db2011-10-24 19:15:31 +0000957 CONFIG_OF_SEPARATE
958 If this variable is defined, U-Boot will build a device tree
959 binary. It will be called u-boot.dtb. Architecture-specific
960 code will locate it at run-time. Generally this works by:
961
962 cat u-boot.bin u-boot.dtb >image.bin
963
964 and in fact, U-Boot does this for you, creating a file called
965 u-boot-dtb.bin which is useful in the common case. You can
966 still use the individual files if you need something more
967 exotic.
968
Alex Deymo5b661ec2017-04-02 01:25:20 -0700969 CONFIG_OF_BOARD
970 If this variable is defined, U-Boot will use the device tree
971 provided by the board at runtime instead of embedding one with
972 the image. Only boards defining board_fdt_blob_setup() support
973 this option (see include/fdtdec.h file).
974
wdenkc6097192002-11-03 00:24:07 +0000975- Watchdog:
976 CONFIG_WATCHDOG
977 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +0000978 support for the SoC. There must be support in the SoC
979 specific code for a watchdog. For the 8xx and 8260
980 CPUs, the SIU Watchdog feature is enabled in the SYPCR
981 register. When supported for a specific SoC is
982 available, then no further board specific code should
983 be needed to use it.
984
985 CONFIG_HW_WATCHDOG
986 When using a watchdog circuitry external to the used
987 SoC, then define this variable and provide board
988 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000989
Heiko Schocher735326c2015-01-21 08:38:22 +0100990 CONFIG_AT91_HW_WDT_TIMEOUT
991 specify the timeout in seconds. default 2 seconds.
992
stroeseb9c17c52003-04-04 15:53:41 +0000993- U-Boot Version:
994 CONFIG_VERSION_VARIABLE
995 If this variable is defined, an environment variable
996 named "ver" is created by U-Boot showing the U-Boot
997 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +0200998 Any change to this variable will be reverted at the
999 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001000
wdenkc6097192002-11-03 00:24:07 +00001001- Real-Time Clock:
1002
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001003 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001004 has to be selected, too. Define exactly one of the
1005 following options:
1006
1007 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1008 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001009 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001010 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001011 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001012 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001013 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001014 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001015 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001016 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001017 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001018 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001019 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1020 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001021
wdenkb9bbd242003-06-30 16:24:52 +00001022 Note that if the RTC uses I2C, then the I2C interface
1023 must also be configured. See I2C Support, below.
1024
Peter Tyser9902e422008-12-17 16:36:21 -06001025- GPIO Support:
1026 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001027
Chris Packham9b383202010-12-19 10:12:13 +00001028 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1029 chip-ngpio pairs that tell the PCA953X driver the number of
1030 pins supported by a particular chip.
1031
Peter Tyser9902e422008-12-17 16:36:21 -06001032 Note that if the GPIO device uses I2C, then the I2C interface
1033 must also be configured. See I2C Support, below.
1034
Simon Glass4dc47ca2014-06-11 23:29:41 -06001035- I/O tracing:
1036 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1037 accesses and can checksum them or write a list of them out
1038 to memory. See the 'iotrace' command for details. This is
1039 useful for testing device drivers since it can confirm that
1040 the driver behaves the same way before and after a code
1041 change. Currently this is supported on sandbox and arm. To
1042 add support for your architecture, add '#include <iotrace.h>'
1043 to the bottom of arch/<arch>/include/asm/io.h and test.
1044
1045 Example output from the 'iotrace stats' command is below.
1046 Note that if the trace buffer is exhausted, the checksum will
1047 still continue to operate.
1048
1049 iotrace is enabled
1050 Start: 10000000 (buffer start address)
1051 Size: 00010000 (buffer size)
1052 Offset: 00000120 (current buffer offset)
1053 Output: 10000120 (start + offset)
1054 Count: 00000018 (number of trace records)
1055 CRC32: 9526fb66 (CRC32 of all trace records)
1056
wdenkc6097192002-11-03 00:24:07 +00001057- Timestamp Support:
1058
wdenk4a5c8a72003-03-06 00:02:04 +00001059 When CONFIG_TIMESTAMP is selected, the timestamp
1060 (date and time) of an image is printed by image
1061 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001062 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001063
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001064- Partition Labels (disklabels) Supported:
1065 Zero or more of the following:
1066 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001067 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1068 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1069 bootloader. Note 2TB partition limit; see
1070 disk/part_efi.c
1071 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001072
Simon Glassb569a012017-05-17 03:25:30 -06001073 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001074 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001075 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001076
1077- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001078 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1079 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001080
wdenk369d43d2004-03-14 14:09:05 +00001081 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1082 be performed by calling the function
1083 ide_set_reset(int reset)
1084 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001085
1086- ATAPI Support:
1087 CONFIG_ATAPI
1088
1089 Set this to enable ATAPI support.
1090
wdenkf602aa02004-03-13 23:29:43 +00001091- LBA48 Support
1092 CONFIG_LBA48
1093
1094 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001095 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001096 Whithout these , LBA48 support uses 32bit variables and will 'only'
1097 support disks up to 2.1TB.
1098
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001099 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001100 When enabled, makes the IDE subsystem use 64bit sector addresses.
1101 Default is 32bit.
1102
wdenkc6097192002-11-03 00:24:07 +00001103- SCSI Support:
1104 At the moment only there is only support for the
1105 SYM53C8XX SCSI controller; define
1106 CONFIG_SCSI_SYM53C8XX to enable it.
1107
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001108 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1109 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1110 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001111 maximum numbers of LUNs, SCSI ID's and target
1112 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001113 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001114
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001115 The environment variable 'scsidevs' is set to the number of
1116 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001117
wdenkc6097192002-11-03 00:24:07 +00001118- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001119 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001120 Support for Intel 8254x/8257x gigabit chips.
1121
1122 CONFIG_E1000_SPI
1123 Utility code for direct access to the SPI bus on Intel 8257x.
1124 This does not do anything useful unless you set at least one
1125 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1126
1127 CONFIG_E1000_SPI_GENERIC
1128 Allow generic access to the SPI bus on the Intel 8257x, for
1129 example with the "sspi" command.
1130
1131 CONFIG_CMD_E1000
1132 Management command for E1000 devices. When used on devices
1133 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001134
wdenkc6097192002-11-03 00:24:07 +00001135 CONFIG_EEPRO100
1136 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001137 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001138 write routine for first time initialisation.
1139
1140 CONFIG_TULIP
1141 Support for Digital 2114x chips.
1142 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1143 modem chip initialisation (KS8761/QS6611).
1144
1145 CONFIG_NATSEMI
1146 Support for National dp83815 chips.
1147
1148 CONFIG_NS8382X
1149 Support for National dp8382[01] gigabit chips.
1150
wdenkaa603362003-05-12 21:50:16 +00001151- NETWORK Support (other):
1152
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001153 CONFIG_DRIVER_AT91EMAC
1154 Support for AT91RM9200 EMAC.
1155
1156 CONFIG_RMII
1157 Define this to use reduced MII inteface
1158
1159 CONFIG_DRIVER_AT91EMAC_QUIET
1160 If this defined, the driver is quiet.
1161 The driver doen't show link status messages.
1162
Rob Herringc9830dc2011-12-15 11:15:49 +00001163 CONFIG_CALXEDA_XGMAC
1164 Support for the Calxeda XGMAC device
1165
Ashok93fb8722012-10-15 06:20:47 +00001166 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001167 Support for SMSC's LAN91C96 chips.
1168
wdenkaa603362003-05-12 21:50:16 +00001169 CONFIG_LAN91C96_USE_32_BIT
1170 Define this to enable 32 bit addressing
1171
Ashok93fb8722012-10-15 06:20:47 +00001172 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001173 Support for SMSC's LAN91C111 chip
1174
1175 CONFIG_SMC91111_BASE
1176 Define this to hold the physical address
1177 of the device (I/O space)
1178
1179 CONFIG_SMC_USE_32_BIT
1180 Define this if data bus is 32 bits
1181
1182 CONFIG_SMC_USE_IOFUNCS
1183 Define this to use i/o functions instead of macros
1184 (some hardware wont work with macros)
1185
Heiko Schocher7d037f72011-11-15 10:00:04 -05001186 CONFIG_DRIVER_TI_EMAC
1187 Support for davinci emac
1188
1189 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1190 Define this if you have more then 3 PHYs.
1191
Macpaul Lin199c6252010-12-21 16:59:46 +08001192 CONFIG_FTGMAC100
1193 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1194
1195 CONFIG_FTGMAC100_EGIGA
1196 Define this to use GE link update with gigabit PHY.
1197 Define this if FTGMAC100 is connected to gigabit PHY.
1198 If your system has 10/100 PHY only, it might not occur
1199 wrong behavior. Because PHY usually return timeout or
1200 useless data when polling gigabit status and gigabit
1201 control registers. This behavior won't affect the
1202 correctnessof 10/100 link speed update.
1203
Mike Rapoportf4761af2009-11-11 10:03:03 +02001204 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001205 Support for SMSC's LAN911x and LAN921x chips
1206
Mike Rapoportf4761af2009-11-11 10:03:03 +02001207 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001208 Define this to hold the physical address
1209 of the device (I/O space)
1210
Mike Rapoportf4761af2009-11-11 10:03:03 +02001211 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001212 Define this if data bus is 32 bits
1213
Mike Rapoportf4761af2009-11-11 10:03:03 +02001214 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001215 Define this if data bus is 16 bits. If your processor
1216 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001217 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001218
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001219 CONFIG_SH_ETHER
1220 Support for Renesas on-chip Ethernet controller
1221
1222 CONFIG_SH_ETHER_USE_PORT
1223 Define the number of ports to be used
1224
1225 CONFIG_SH_ETHER_PHY_ADDR
1226 Define the ETH PHY's address
1227
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001228 CONFIG_SH_ETHER_CACHE_WRITEBACK
1229 If this option is set, the driver enables cache flush.
1230
Heiko Schocher2b387762014-07-18 06:07:19 +02001231- PWM Support:
1232 CONFIG_PWM_IMX
Robert P. J. Day1f8378a2016-09-13 08:35:18 -04001233 Support for PWM module on the imx6.
Heiko Schocher2b387762014-07-18 06:07:19 +02001234
Vadim Bendeburydac69642011-10-17 08:36:14 +00001235- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001236 CONFIG_TPM
1237 Support TPM devices.
1238
Christophe Ricard8759ff82015-10-06 22:54:41 +02001239 CONFIG_TPM_TIS_INFINEON
1240 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001241 per system is supported at this time.
1242
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001243 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1244 Define the burst count bytes upper limit
1245
Christophe Ricard88249232016-01-21 23:27:13 +01001246 CONFIG_TPM_ST33ZP24
1247 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1248
1249 CONFIG_TPM_ST33ZP24_I2C
1250 Support for STMicroelectronics ST33ZP24 I2C devices.
1251 Requires TPM_ST33ZP24 and I2C.
1252
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001253 CONFIG_TPM_ST33ZP24_SPI
1254 Support for STMicroelectronics ST33ZP24 SPI devices.
1255 Requires TPM_ST33ZP24 and SPI.
1256
Dirk Eibach20489092013-06-26 15:55:15 +02001257 CONFIG_TPM_ATMEL_TWI
1258 Support for Atmel TWI TPM device. Requires I2C support.
1259
Che-liang Chiouacea5702013-04-12 11:04:34 +00001260 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001261 Support for generic parallel port TPM devices. Only one device
1262 per system is supported at this time.
1263
1264 CONFIG_TPM_TIS_BASE_ADDRESS
1265 Base address where the generic TPM device is mapped
1266 to. Contemporary x86 systems usually map it at
1267 0xfed40000.
1268
Reinhard Pfau4fece432013-06-26 15:55:13 +02001269 CONFIG_CMD_TPM
1270 Add tpm monitor functions.
1271 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1272 provides monitor access to authorized functions.
1273
1274 CONFIG_TPM
1275 Define this to enable the TPM support library which provides
1276 functional interfaces to some TPM commands.
1277 Requires support for a TPM device.
1278
1279 CONFIG_TPM_AUTH_SESSIONS
1280 Define this to enable authorized functions in the TPM library.
1281 Requires CONFIG_TPM and CONFIG_SHA1.
1282
wdenkc6097192002-11-03 00:24:07 +00001283- USB Support:
1284 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001285 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001286 CONFIG_USB_UHCI to enable it.
1287 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001288 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001289 storage devices.
1290 Note:
1291 Supported are USB Keyboards and USB Floppy drives
1292 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001293 MPC5200 USB requires additional defines:
1294 CONFIG_USB_CLOCK
1295 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001296 CONFIG_PSC3_USB
1297 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001298 CONFIG_USB_CONFIG
1299 for differential drivers: 0x00001000
1300 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001301 for differential drivers on PSC3: 0x00000100
1302 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001303 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001304 May be defined to allow interrupt polling
1305 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001306
Simon Glass5978cdb2012-02-27 10:52:47 +00001307 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1308 txfilltuning field in the EHCI controller on reset.
1309
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001310 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1311 HW module registers.
1312
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001313- USB Device:
1314 Define the below if you wish to use the USB console.
1315 Once firmware is rebuilt from a serial console issue the
1316 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001317 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001318 it has found a new device. The environment variable usbtty
1319 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001320 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001321 Common Device Class Abstract Control Model serial device.
1322 If you select usbtty = gserial you should be able to enumerate
1323 a Linux host by
1324 # modprobe usbserial vendor=0xVendorID product=0xProductID
1325 else if using cdc_acm, simply setting the environment
1326 variable usbtty to be cdc_acm should suffice. The following
1327 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001328
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001329 CONFIG_USB_DEVICE
1330 Define this to build a UDC device
1331
1332 CONFIG_USB_TTY
1333 Define this to have a tty type of device available to
1334 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001335
Vipin KUMARbdb17702012-03-26 15:38:06 +05301336 CONFIG_USBD_HS
1337 Define this to enable the high speed support for usb
1338 device and usbtty. If this feature is enabled, a routine
1339 int is_usbd_high_speed(void)
1340 also needs to be defined by the driver to dynamically poll
1341 whether the enumeration has succeded at high speed or full
1342 speed.
1343
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001344 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001345 Define this if you want stdin, stdout &/or stderr to
1346 be set to usbtty.
1347
1348 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001349 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001350 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001351 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001352
Wolfgang Denke2601822006-06-14 18:14:56 +02001353 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001354 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001355 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001356 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1357 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1358 should pretend to be a Linux device to it's target host.
1359
1360 CONFIG_USBD_MANUFACTURER
1361 Define this string as the name of your company for
1362 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001363
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001364 CONFIG_USBD_PRODUCT_NAME
1365 Define this string as the name of your product
1366 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001367
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001368 CONFIG_USBD_VENDORID
1369 Define this as your assigned Vendor ID from the USB
1370 Implementors Forum. This *must* be a genuine Vendor ID
1371 to avoid polluting the USB namespace.
1372 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001373
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001374 CONFIG_USBD_PRODUCTID
1375 Define this as the unique Product ID
1376 for your device
1377 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001378
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001379- ULPI Layer Support:
1380 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1381 the generic ULPI layer. The generic layer accesses the ULPI PHY
1382 via the platform viewport, so you need both the genric layer and
1383 the viewport enabled. Currently only Chipidea/ARC based
1384 viewport is supported.
1385 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1386 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001387 If your ULPI phy needs a different reference clock than the
1388 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1389 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001390
wdenk7a428cc2003-06-15 22:40:42 +00001391- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001392 The MMC controller on the Intel PXA is supported. To
1393 enable this define CONFIG_MMC. The MMC can be
1394 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001395 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001396 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1397 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001398
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001399 CONFIG_SH_MMCIF
1400 Support for Renesas on-chip MMCIF controller
1401
1402 CONFIG_SH_MMCIF_ADDR
1403 Define the base address of MMCIF registers
1404
1405 CONFIG_SH_MMCIF_CLK
1406 Define the clock frequency for MMCIF
1407
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001408 CONFIG_SUPPORT_EMMC_BOOT
1409 Enable some additional features of the eMMC boot partitions.
1410
1411 CONFIG_SUPPORT_EMMC_RPMB
1412 Enable the commands for reading, writing and programming the
1413 key for the Replay Protection Memory Block partition in eMMC.
1414
Tom Rini58a8d322013-03-14 05:32:47 +00001415- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001416 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001417 This enables the USB portion of the DFU USB class
1418
1419 CONFIG_CMD_DFU
1420 This enables the command "dfu" which is used to have
1421 U-Boot create a DFU class device via USB. This command
1422 requires that the "dfu_alt_info" environment variable be
1423 set and define the alt settings to expose to the host.
1424
1425 CONFIG_DFU_MMC
1426 This enables support for exposing (e)MMC devices via DFU.
1427
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001428 CONFIG_DFU_NAND
1429 This enables support for exposing NAND devices via DFU.
1430
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301431 CONFIG_DFU_RAM
1432 This enables support for exposing RAM via DFU.
1433 Note: DFU spec refer to non-volatile memory usage, but
1434 allow usages beyond the scope of spec - here RAM usage,
1435 one that would help mostly the developer.
1436
Heiko Schochera2f831e2013-06-12 06:05:51 +02001437 CONFIG_SYS_DFU_DATA_BUF_SIZE
1438 Dfu transfer uses a buffer before writing data to the
1439 raw storage device. Make the size (in bytes) of this buffer
1440 configurable. The size of this buffer is also configurable
1441 through the "dfu_bufsiz" environment variable.
1442
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001443 CONFIG_SYS_DFU_MAX_FILE_SIZE
1444 When updating files rather than the raw storage device,
1445 we use a static buffer to copy the file into and then write
1446 the buffer once we've been given the whole file. Define
1447 this to the maximum filesize (in bytes) for the buffer.
1448 Default is 4 MiB if undefined.
1449
Heiko Schochere1ba1512014-03-18 08:09:56 +01001450 DFU_DEFAULT_POLL_TIMEOUT
1451 Poll timeout [ms], is the timeout a device can send to the
1452 host. The host must wait for this timeout before sending
1453 a subsequent DFU_GET_STATUS request to the device.
1454
1455 DFU_MANIFEST_POLL_TIMEOUT
1456 Poll timeout [ms], which the device sends to the host when
1457 entering dfuMANIFEST state. Host waits this timeout, before
1458 sending again an USB request to the device.
1459
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001460- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001461 CONFIG_USB_FUNCTION_FASTBOOT
1462 This enables the USB part of the fastboot gadget
1463
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001464 CONFIG_CMD_FASTBOOT
1465 This enables the command "fastboot" which enables the Android
1466 fastboot mode for the platform's USB device. Fastboot is a USB
1467 protocol for downloading images, flashing and device control
1468 used on Android devices.
1469 See doc/README.android-fastboot for more information.
1470
1471 CONFIG_ANDROID_BOOT_IMAGE
1472 This enables support for booting images which use the Android
1473 image format header.
1474
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001475 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001476 The fastboot protocol requires a large memory buffer for
1477 downloads. Define this to the starting RAM address to use for
1478 downloaded images.
1479
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001480 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001481 The fastboot protocol requires a large memory buffer for
1482 downloads. This buffer should be as large as possible for a
1483 platform. Define this to the size available RAM for fastboot.
1484
Steve Raebfb9ba42014-08-26 11:47:28 -07001485 CONFIG_FASTBOOT_FLASH
1486 The fastboot protocol includes a "flash" command for writing
1487 the downloaded image to a non-volatile storage device. Define
1488 this to enable the "fastboot flash" command.
1489
1490 CONFIG_FASTBOOT_FLASH_MMC_DEV
1491 The fastboot "flash" command requires additional information
1492 regarding the non-volatile storage device. Define this to
1493 the eMMC device that fastboot should use to store the image.
1494
Steve Rae7d059342014-12-12 15:51:54 -08001495 CONFIG_FASTBOOT_GPT_NAME
1496 The fastboot "flash" command supports writing the downloaded
1497 image to the Protective MBR and the Primary GUID Partition
1498 Table. (Additionally, this downloaded image is post-processed
1499 to generate and write the Backup GUID Partition Table.)
1500 This occurs when the specified "partition name" on the
1501 "fastboot flash" command line matches this value.
Petr Kulhavy4ed1eca2016-09-09 10:27:18 +02001502 The default is "gpt" if undefined.
Steve Rae7d059342014-12-12 15:51:54 -08001503
Petr Kulhavy9f174c92016-09-09 10:27:16 +02001504 CONFIG_FASTBOOT_MBR_NAME
1505 The fastboot "flash" command supports writing the downloaded
1506 image to DOS MBR.
1507 This occurs when the "partition name" specified on the
1508 "fastboot flash" command line matches this value.
1509 If not defined the default value "mbr" is used.
1510
wdenkda04a8b2004-08-02 23:22:59 +00001511- Journaling Flash filesystem support:
Simon Glassfa8527b2016-10-02 18:00:59 -06001512 CONFIG_JFFS2_NAND
wdenkda04a8b2004-08-02 23:22:59 +00001513 Define these for a default partition on a NAND device
1514
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001515 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1516 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001517 Define these for a default partition on a NOR device
1518
wdenkc6097192002-11-03 00:24:07 +00001519- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001520 See Kconfig help for available keyboard drivers.
1521
1522 CONFIG_KEYBOARD
1523
1524 Define this to enable a custom keyboard support.
1525 This simply calls drv_keyboard_init() which must be
1526 defined in your board-specific files. This option is deprecated
1527 and is only used by novena. For new boards, use driver model
1528 instead.
wdenkc6097192002-11-03 00:24:07 +00001529
1530- Video support:
Timur Tabi020edd22011-02-15 17:09:19 -06001531 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001532 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001533 SOCs that have a DIU should define this macro to enable DIU
1534 support, and should also define these other macros:
1535
1536 CONFIG_SYS_DIU_ADDR
1537 CONFIG_VIDEO
Timur Tabi020edd22011-02-15 17:09:19 -06001538 CONFIG_CFB_CONSOLE
1539 CONFIG_VIDEO_SW_CURSOR
1540 CONFIG_VGA_AS_SINGLE_DEVICE
1541 CONFIG_VIDEO_LOGO
1542 CONFIG_VIDEO_BMP_LOGO
1543
Timur Tabi32f709e2011-04-11 14:18:22 -05001544 The DIU driver will look for the 'video-mode' environment
1545 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001546 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001547 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001548
wdenkc6097192002-11-03 00:24:07 +00001549- LCD Support: CONFIG_LCD
1550
1551 Define this to enable LCD support (for output to LCD
1552 display); also select one of the supported displays
1553 by defining one of these:
1554
Stelian Popf6f86652008-05-09 21:57:18 +02001555 CONFIG_ATMEL_LCD:
1556
1557 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1558
wdenkc0d54ae2003-11-25 16:55:19 +00001559 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001560
wdenkc0d54ae2003-11-25 16:55:19 +00001561 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001562
wdenkc0d54ae2003-11-25 16:55:19 +00001563 CONFIG_NEC_NL6448BC20
1564
1565 NEC NL6448BC20-08. 6.5", 640x480.
1566 Active, color, single scan.
1567
1568 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001569
wdenkc0d54ae2003-11-25 16:55:19 +00001570 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001571 Active, color, single scan.
1572
1573 CONFIG_SHARP_16x9
1574
1575 Sharp 320x240. Active, color, single scan.
1576 It isn't 16x9, and I am not sure what it is.
1577
1578 CONFIG_SHARP_LQ64D341
1579
1580 Sharp LQ64D341 display, 640x480.
1581 Active, color, single scan.
1582
1583 CONFIG_HLD1045
1584
1585 HLD1045 display, 640x480.
1586 Active, color, single scan.
1587
1588 CONFIG_OPTREX_BW
1589
1590 Optrex CBL50840-2 NF-FW 99 22 M5
1591 or
1592 Hitachi LMG6912RPFC-00T
1593 or
1594 Hitachi SP14Q002
1595
1596 320x240. Black & white.
1597
Simon Glass599a4df2012-10-17 13:24:54 +00001598 CONFIG_LCD_ALIGNMENT
1599
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001600 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001601 defined then the LCD will be aligned to this value instead.
1602 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1603 here, since it is cheaper to change data cache settings on
1604 a per-section basis.
1605
1606
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001607 CONFIG_LCD_ROTATION
1608
1609 Sometimes, for example if the display is mounted in portrait
1610 mode or even if it's mounted landscape but rotated by 180degree,
1611 we need to rotate our content of the display relative to the
1612 framebuffer, so that user can read the messages which are
1613 printed out.
1614 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1615 initialized with a given rotation from "vl_rot" out of
1616 "vidinfo_t" which is provided by the board specific code.
1617 The value for vl_rot is coded as following (matching to
1618 fbcon=rotate:<n> linux-kernel commandline):
1619 0 = no rotation respectively 0 degree
1620 1 = 90 degree rotation
1621 2 = 180 degree rotation
1622 3 = 270 degree rotation
1623
1624 If CONFIG_LCD_ROTATION is not defined, the console will be
1625 initialized with 0degree rotation.
1626
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001627 CONFIG_LCD_BMP_RLE8
1628
1629 Support drawing of RLE8-compressed bitmaps on the LCD.
1630
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001631 CONFIG_I2C_EDID
1632
1633 Enables an 'i2c edid' command which can read EDID
1634 information over I2C from an attached LCD display.
1635
wdenkeb20ad32003-09-05 23:19:14 +00001636- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001637
wdenk57b2d802003-06-27 21:31:46 +00001638 If this option is set, the environment is checked for
1639 a variable "splashimage". If found, the usual display
1640 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001641 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001642 specified in "splashimage" is loaded instead. The
1643 console is redirected to the "nulldev", too. This
1644 allows for a "silent" boot where a splash screen is
1645 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001646
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001647 CONFIG_SPLASHIMAGE_GUARD
1648
1649 If this option is set, then U-Boot will prevent the environment
1650 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001651 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001652 This option is useful for targets where, due to alignment
1653 restrictions, an improperly aligned BMP image will cause a data
1654 abort. If you think you will not have problems with unaligned
1655 accesses (for example because your toolchain prevents them)
1656 there is no need to set this option.
1657
Matthias Weisser53884182009-07-09 16:07:30 +02001658 CONFIG_SPLASH_SCREEN_ALIGN
1659
1660 If this option is set the splash image can be freely positioned
1661 on the screen. Environment variable "splashpos" specifies the
1662 position as "x,y". If a positive number is given it is used as
1663 number of pixel from left/top. If a negative number is given it
1664 is used as number of pixel from right/bottom. You can also
1665 specify 'm' for centering the image.
1666
1667 Example:
1668 setenv splashpos m,m
1669 => image at center of screen
1670
1671 setenv splashpos 30,20
1672 => image at x = 30 and y = 20
1673
1674 setenv splashpos -10,m
1675 => vertically centered image
1676 at x = dspWidth - bmpWidth - 9
1677
Stefan Roesed9d97742005-09-22 09:04:17 +02001678- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1679
1680 If this option is set, additionally to standard BMP
1681 images, gzipped BMP images can be displayed via the
1682 splashscreen support or the bmp command.
1683
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001684- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1685
1686 If this option is set, 8-bit RLE compressed BMP images
1687 can be displayed via the splashscreen support or the
1688 bmp command.
1689
wdenk710e3502003-08-29 20:57:53 +00001690- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001691 CONFIG_GZIP
1692
1693 Enabled by default to support gzip compressed images.
1694
wdenk710e3502003-08-29 20:57:53 +00001695 CONFIG_BZIP2
1696
1697 If this option is set, support for bzip2 compressed
1698 images is included. If not, only uncompressed and gzip
1699 compressed images are supported.
1700
wdenk9c53f402003-10-15 23:53:47 +00001701 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001702 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001703 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001704
Kees Cook5b06e642013-08-16 07:59:12 -07001705 CONFIG_LZO
1706
1707 If this option is set, support for LZO compressed images
1708 is included.
1709
wdenk0e2bd9c2004-06-06 21:51:03 +00001710- MII/PHY support:
1711 CONFIG_PHY_ADDR
1712
1713 The address of PHY on MII bus.
1714
1715 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1716
1717 The clock frequency of the MII bus
1718
1719 CONFIG_PHY_GIGE
1720
1721 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001722 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00001723
1724 CONFIG_PHY_RESET_DELAY
1725
1726 Some PHY like Intel LXT971A need extra delay after
1727 reset before any MII register access is possible.
1728 For such PHY, set this option to the usec delay
1729 required. (minimum 300usec for LXT971A)
1730
1731 CONFIG_PHY_CMD_DELAY (ppc4xx)
1732
1733 Some PHY like Intel LXT971A need extra delay after
1734 command issued before MII status register can be read
1735
wdenkc6097192002-11-03 00:24:07 +00001736- IP address:
1737 CONFIG_IPADDR
1738
1739 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001740 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001741 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001742 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001743
1744- Server IP address:
1745 CONFIG_SERVERIP
1746
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001747 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001748 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00001749 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001750
Robin Getz470a6d42009-07-21 12:15:28 -04001751 CONFIG_KEEP_SERVERADDR
1752
1753 Keeps the server's MAC address, in the env 'serveraddr'
1754 for passing to bootargs (like Linux's netconsole option)
1755
Wolfgang Denk26da2992011-10-26 10:21:22 +00001756- Gateway IP address:
1757 CONFIG_GATEWAYIP
1758
1759 Defines a default value for the IP address of the
1760 default router where packets to other networks are
1761 sent to.
1762 (Environment variable "gatewayip")
1763
1764- Subnet mask:
1765 CONFIG_NETMASK
1766
1767 Defines a default value for the subnet mask (or
1768 routing prefix) which is used to determine if an IP
1769 address belongs to the local subnet or needs to be
1770 forwarded through a router.
1771 (Environment variable "netmask")
1772
David Updegraff7280da72007-06-11 10:41:07 -05001773- Multicast TFTP Mode:
1774 CONFIG_MCAST_TFTP
1775
1776 Defines whether you want to support multicast TFTP as per
1777 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001778 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05001779 driver in use must provide a function: mcast() to join/leave a
1780 multicast group.
1781
wdenkc6097192002-11-03 00:24:07 +00001782- BOOTP Recovery Mode:
1783 CONFIG_BOOTP_RANDOM_DELAY
1784
1785 If you have many targets in a network that try to
1786 boot using BOOTP, you may want to avoid that all
1787 systems send out BOOTP requests at precisely the same
1788 moment (which would happen for instance at recovery
1789 from a power failure, when all systems will try to
1790 boot, thus flooding the BOOTP server. Defining
1791 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1792 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02001793 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001794
1795 1st BOOTP request: delay 0 ... 1 sec
1796 2nd BOOTP request: delay 0 ... 2 sec
1797 3rd BOOTP request: delay 0 ... 4 sec
1798 4th and following
1799 BOOTP requests: delay 0 ... 8 sec
1800
Thierry Reding8977cda2014-08-19 10:21:24 +02001801 CONFIG_BOOTP_ID_CACHE_SIZE
1802
1803 BOOTP packets are uniquely identified using a 32-bit ID. The
1804 server will copy the ID from client requests to responses and
1805 U-Boot will use this to determine if it is the destination of
1806 an incoming response. Some servers will check that addresses
1807 aren't in use before handing them out (usually using an ARP
1808 ping) and therefore take up to a few hundred milliseconds to
1809 respond. Network congestion may also influence the time it
1810 takes for a response to make it back to the client. If that
1811 time is too long, U-Boot will retransmit requests. In order
1812 to allow earlier responses to still be accepted after these
1813 retransmissions, U-Boot's BOOTP client keeps a small cache of
1814 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1815 cache. The default is to keep IDs for up to four outstanding
1816 requests. Increasing this will allow U-Boot to accept offers
1817 from a BOOTP client in networks with unusually high latency.
1818
stroesee0aadfb2003-08-28 14:17:32 +00001819- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05001820 You can fine tune the DHCP functionality by defining
1821 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00001822
Jon Loeliger5336a762007-07-09 22:08:34 -05001823 CONFIG_BOOTP_SUBNETMASK
1824 CONFIG_BOOTP_GATEWAY
1825 CONFIG_BOOTP_HOSTNAME
1826 CONFIG_BOOTP_NISDOMAIN
1827 CONFIG_BOOTP_BOOTPATH
1828 CONFIG_BOOTP_BOOTFILESIZE
1829 CONFIG_BOOTP_DNS
1830 CONFIG_BOOTP_DNS2
1831 CONFIG_BOOTP_SEND_HOSTNAME
1832 CONFIG_BOOTP_NTPSERVER
1833 CONFIG_BOOTP_TIMEOFFSET
1834 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001835 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00001836
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001837 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1838 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00001839
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00001840 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1841 after the configured retry count, the call will fail
1842 instead of starting over. This can be used to fail over
1843 to Link-local IP address configuration if the DHCP server
1844 is not available.
1845
stroesee0aadfb2003-08-28 14:17:32 +00001846 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1847 serverip from a DHCP server, it is possible that more
1848 than one DNS serverip is offered to the client.
1849 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1850 serverip will be stored in the additional environment
1851 variable "dnsip2". The first DNS serverip is always
1852 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05001853 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00001854
1855 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1856 to do a dynamic update of a DNS server. To do this, they
1857 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04001858 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05001859 of the "hostname" environment variable is passed as
1860 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00001861
Aras Vaichas72aa3f32008-03-26 09:43:57 +11001862 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1863
1864 A 32bit value in microseconds for a delay between
1865 receiving a "DHCP Offer" and sending the "DHCP Request".
1866 This fixes a problem with certain DHCP servers that don't
1867 respond 100% of the time to a "DHCP request". E.g. On an
1868 AT91RM9200 processor running at 180MHz, this delay needed
1869 to be *at least* 15,000 usec before a Windows Server 2003
1870 DHCP server would reply 100% of the time. I recommend at
1871 least 50,000 usec to be safe. The alternative is to hope
1872 that one of the retries will be successful but note that
1873 the DHCP timeout and retry process takes a longer than
1874 this delay.
1875
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001876 - Link-local IP address negotiation:
1877 Negotiate with other link-local clients on the local network
1878 for an address that doesn't require explicit configuration.
1879 This is especially useful if a DHCP server cannot be guaranteed
1880 to exist in all environments that the device must operate.
1881
1882 See doc/README.link-local for more information.
1883
wdenk145d2c12004-04-15 21:48:45 +00001884 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00001885 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00001886
1887 The device id used in CDP trigger frames.
1888
1889 CONFIG_CDP_DEVICE_ID_PREFIX
1890
1891 A two character string which is prefixed to the MAC address
1892 of the device.
1893
1894 CONFIG_CDP_PORT_ID
1895
1896 A printf format string which contains the ascii name of
1897 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001898 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00001899
1900 CONFIG_CDP_CAPABILITIES
1901
1902 A 32bit integer which indicates the device capabilities;
1903 0x00000010 for a normal host which does not forwards.
1904
1905 CONFIG_CDP_VERSION
1906
1907 An ascii string containing the version of the software.
1908
1909 CONFIG_CDP_PLATFORM
1910
1911 An ascii string containing the name of the platform.
1912
1913 CONFIG_CDP_TRIGGER
1914
1915 A 32bit integer sent on the trigger.
1916
1917 CONFIG_CDP_POWER_CONSUMPTION
1918
1919 A 16bit integer containing the power consumption of the
1920 device in .1 of milliwatts.
1921
1922 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1923
1924 A byte containing the id of the VLAN.
1925
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001926- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001927
1928 Several configurations allow to display the current
1929 status using a LED. For instance, the LED will blink
1930 fast while running U-Boot code, stop blinking as
1931 soon as a reply to a BOOTP request was received, and
1932 start blinking slow once the Linux kernel is running
1933 (supported by a status LED driver in the Linux
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001934 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001935 feature in U-Boot.
1936
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001937 Additional options:
1938
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001939 CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001940 The status LED can be connected to a GPIO pin.
1941 In such cases, the gpio_led driver can be used as a
Uri Mashiach3dc6f652017-01-19 10:51:05 +02001942 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg4997a9e2013-11-08 01:03:50 +02001943 to include the gpio_led driver in the U-Boot binary.
1944
Igor Grinberg203bd9f2013-11-08 01:03:52 +02001945 CONFIG_GPIO_LED_INVERTED_TABLE
1946 Some GPIO connected LEDs may have inverted polarity in which
1947 case the GPIO high value corresponds to LED off state and
1948 GPIO low value corresponds to LED on state.
1949 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1950 with a list of GPIO LEDs that have inverted polarity.
1951
wdenkc6097192002-11-03 00:24:07 +00001952- CAN Support: CONFIG_CAN_DRIVER
1953
1954 Defining CONFIG_CAN_DRIVER enables CAN driver support
1955 on those systems that support this (optional)
1956 feature, like the TQM8xxL modules.
1957
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001958- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001959
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001960 This enable the NEW i2c subsystem, and will allow you to use
1961 i2c commands at the u-boot command line (as long as you set
1962 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1963 based realtime clock chips or other i2c devices. See
1964 common/cmd_i2c.c for a description of the command line
1965 interface.
1966
1967 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01001968 - drivers/i2c/soft_i2c.c:
1969 - activate first bus with CONFIG_SYS_I2C_SOFT define
1970 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1971 for defining speed and slave address
1972 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1973 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1974 for defining speed and slave address
1975 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1976 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1977 for defining speed and slave address
1978 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1979 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1980 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00001981
Heiko Schocherf2850742012-10-24 13:48:22 +02001982 - drivers/i2c/fsl_i2c.c:
1983 - activate i2c driver with CONFIG_SYS_I2C_FSL
1984 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1985 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1986 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1987 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001988 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02001989 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1990 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1991 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1992 second bus.
1993
Simon Glass026fefb2012-10-30 07:28:53 +00001994 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09001995 - activate this driver with CONFIG_SYS_I2C_TEGRA
1996 - This driver adds 4 i2c buses with a fix speed from
1997 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00001998
Dirk Eibach42b204f2013-04-25 02:40:01 +00001999 - drivers/i2c/ppc4xx_i2c.c
2000 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2001 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2002 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2003
trema49f40a2013-09-21 18:13:35 +02002004 - drivers/i2c/i2c_mxc.c
2005 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002006 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2007 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2008 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2009 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002010 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2011 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2012 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2013 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2014 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2015 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002016 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2017 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002018 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002019 for speed, and 0 for slave.
2020
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002021 - drivers/i2c/rcar_i2c.c:
2022 - activate this driver with CONFIG_SYS_I2C_RCAR
2023 - This driver adds 4 i2c buses
2024
2025 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2026 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2027 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2028 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2029 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2030 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2031 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2032 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2033 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2034
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002035 - drivers/i2c/sh_i2c.c:
2036 - activate this driver with CONFIG_SYS_I2C_SH
2037 - This driver adds from 2 to 5 i2c buses
2038
2039 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2040 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2041 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2042 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2043 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2044 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2045 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2046 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2047 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2048 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002049 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002050
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002051 - drivers/i2c/omap24xx_i2c.c
2052 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2053 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2054 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2055 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2056 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2057 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2058 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2059 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2060 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2061 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2062 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2063
Heiko Schocher465819a2013-11-08 07:30:53 +01002064 - drivers/i2c/zynq_i2c.c
2065 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2066 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2067 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2068
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302069 - drivers/i2c/s3c24x0_i2c.c:
2070 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2071 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2072 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2073 with a fix speed from 100000 and the slave addr 0!
2074
Dirk Eibachb9577432014-07-03 09:28:18 +02002075 - drivers/i2c/ihs_i2c.c
2076 - activate this driver with CONFIG_SYS_I2C_IHS
2077 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2078 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2079 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2080 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2081 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2082 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2083 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2084 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2085 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2086 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2087 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2088 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002089 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2090 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2091 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2092 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2093 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2094 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2095 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2096 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2097 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002098
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002099 additional defines:
2100
2101 CONFIG_SYS_NUM_I2C_BUSES
Simon Glassb05e2b32016-10-02 18:01:05 -06002102 Hold the number of i2c buses you want to use.
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002103
2104 CONFIG_SYS_I2C_DIRECT_BUS
2105 define this, if you don't use i2c muxes on your hardware.
2106 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2107 omit this define.
2108
2109 CONFIG_SYS_I2C_MAX_HOPS
2110 define how many muxes are maximal consecutively connected
2111 on one i2c bus. If you not use i2c muxes, omit this
2112 define.
2113
2114 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002115 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002116 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2117 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2118 CONFIG_SYS_NUM_I2C_BUSES = 9:
2119
2120 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2121 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2122 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2123 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2124 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2125 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2126 {1, {I2C_NULL_HOP}}, \
2127 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2128 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2129 }
2130
2131 which defines
2132 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002133 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2134 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2135 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2136 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2137 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002138 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002139 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2140 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002141
2142 If you do not have i2c muxes on your board, omit this define.
2143
Simon Glass3efce392017-05-12 21:10:00 -06002144- Legacy I2C Support:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002145 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002146 then the following macros need to be defined (examples are
2147 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002148
2149 I2C_INIT
2150
wdenkb9bbd242003-06-30 16:24:52 +00002151 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002152 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002153
wdenk544e9732004-02-06 23:19:44 +00002154 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002155
wdenkc6097192002-11-03 00:24:07 +00002156 I2C_PORT
2157
wdenk4a5c8a72003-03-06 00:02:04 +00002158 (Only for MPC8260 CPU). The I/O port to use (the code
2159 assumes both bits are on the same port). Valid values
2160 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002161
2162 I2C_ACTIVE
2163
2164 The code necessary to make the I2C data line active
2165 (driven). If the data line is open collector, this
2166 define can be null.
2167
wdenkb9bbd242003-06-30 16:24:52 +00002168 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2169
wdenkc6097192002-11-03 00:24:07 +00002170 I2C_TRISTATE
2171
2172 The code necessary to make the I2C data line tri-stated
2173 (inactive). If the data line is open collector, this
2174 define can be null.
2175
wdenkb9bbd242003-06-30 16:24:52 +00002176 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2177
wdenkc6097192002-11-03 00:24:07 +00002178 I2C_READ
2179
York Sun4a598092013-04-01 11:29:11 -07002180 Code that returns true if the I2C data line is high,
2181 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002182
wdenkb9bbd242003-06-30 16:24:52 +00002183 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2184
wdenkc6097192002-11-03 00:24:07 +00002185 I2C_SDA(bit)
2186
York Sun4a598092013-04-01 11:29:11 -07002187 If <bit> is true, sets the I2C data line high. If it
2188 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002189
wdenkb9bbd242003-06-30 16:24:52 +00002190 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002191 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002192 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002193
wdenkc6097192002-11-03 00:24:07 +00002194 I2C_SCL(bit)
2195
York Sun4a598092013-04-01 11:29:11 -07002196 If <bit> is true, sets the I2C clock line high. If it
2197 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002198
wdenkb9bbd242003-06-30 16:24:52 +00002199 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002200 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002201 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002202
wdenkc6097192002-11-03 00:24:07 +00002203 I2C_DELAY
2204
2205 This delay is invoked four times per clock cycle so this
2206 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002207 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002208 like:
2209
wdenkb9bbd242003-06-30 16:24:52 +00002210 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002211
Mike Frysingeree12d542010-07-21 13:38:02 -04002212 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2213
2214 If your arch supports the generic GPIO framework (asm/gpio.h),
2215 then you may alternatively define the two GPIOs that are to be
2216 used as SCL / SDA. Any of the previous I2C_xxx macros will
2217 have GPIO-based defaults assigned to them as appropriate.
2218
2219 You should define these to the GPIO value as given directly to
2220 the generic GPIO functions.
2221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002222 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002223
wdenk57b2d802003-06-27 21:31:46 +00002224 When a board is reset during an i2c bus transfer
2225 chips might think that the current transfer is still
2226 in progress. On some boards it is possible to access
2227 the i2c SCLK line directly, either by using the
2228 processor pin as a GPIO or by having a second pin
2229 connected to the bus. If this option is defined a
2230 custom i2c_init_board() routine in boards/xxx/board.c
2231 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002232
Ben Warren45657152006-09-07 16:50:54 -04002233 CONFIG_I2C_MULTI_BUS
2234
2235 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002236 must have a controller. At any point in time, only one bus is
2237 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002238 Note that bus numbering is zero-based.
2239
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002240 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002241
2242 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002243 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002244 is set, specify a list of bus-device pairs. Otherwise, specify
2245 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002246
2247 e.g.
2248 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002249 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002250
2251 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2252
Wolfgang Denk092ae952011-10-26 10:21:21 +00002253 #define CONFIG_I2C_MULTI_BUS
Simon Glassb05e2b32016-10-02 18:01:05 -06002254 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002255
2256 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2257
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002258 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002259
2260 If defined, then this indicates the I2C bus number for DDR SPD.
2261 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2262
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002263 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002264
2265 If defined, then this indicates the I2C bus number for the RTC.
2266 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2267
Andrew Dyer58c41f92008-12-29 17:36:01 -06002268 CONFIG_SOFT_I2C_READ_REPEATED_START
2269
2270 defining this will force the i2c_read() function in
2271 the soft_i2c driver to perform an I2C repeated start
2272 between writing the address pointer and reading the
2273 data. If this define is omitted the default behaviour
2274 of doing a stop-start sequence will be used. Most I2C
2275 devices can use either method, but some require one or
2276 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002277
wdenkc6097192002-11-03 00:24:07 +00002278- SPI Support: CONFIG_SPI
2279
2280 Enables SPI driver (so far only tested with
2281 SPI EEPROM, also an instance works with Crystal A/D and
2282 D/As on the SACSng board)
2283
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002284 CONFIG_SH_SPI
2285
2286 Enables the driver for SPI controller on SuperH. Currently
2287 only SH7757 is supported.
2288
wdenkc6097192002-11-03 00:24:07 +00002289 CONFIG_SOFT_SPI
2290
wdenk4a5c8a72003-03-06 00:02:04 +00002291 Enables a software (bit-bang) SPI driver rather than
2292 using hardware support. This is a general purpose
2293 driver that only requires three general I/O port pins
2294 (two outputs, one input) to function. If this is
2295 defined, the board configuration must define several
2296 SPI configuration items (port pins to use, etc). For
2297 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002298
Ben Warren7efe9272008-01-16 22:37:35 -05002299 CONFIG_HARD_SPI
2300
2301 Enables a hardware SPI driver for general-purpose reads
2302 and writes. As with CONFIG_SOFT_SPI, the board configuration
2303 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002304 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002305 example, see include/configs/mpc8349emds.h.
2306
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002307 CONFIG_MXC_SPI
2308
2309 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002310 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002311
Heiko Schocherb77c8882014-07-14 10:22:11 +02002312 CONFIG_SYS_SPI_MXC_WAIT
2313 Timeout for waiting until spi transfer completed.
2314 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2315
Matthias Fuchsa4400872007-12-27 17:12:34 +01002316- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002317
Matthias Fuchsa4400872007-12-27 17:12:34 +01002318 Enables FPGA subsystem.
2319
2320 CONFIG_FPGA_<vendor>
2321
2322 Enables support for specific chip vendors.
2323 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002324
Matthias Fuchsa4400872007-12-27 17:12:34 +01002325 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002326
Matthias Fuchsa4400872007-12-27 17:12:34 +01002327 Enables support for FPGA family.
2328 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2329
2330 CONFIG_FPGA_COUNT
2331
2332 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002333
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002334 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002335
wdenk57b2d802003-06-27 21:31:46 +00002336 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002337
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002338 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002339
wdenk4a5c8a72003-03-06 00:02:04 +00002340 Enable checks on FPGA configuration interface busy
2341 status by the configuration function. This option
2342 will require a board or device specific function to
2343 be written.
wdenkc6097192002-11-03 00:24:07 +00002344
2345 CONFIG_FPGA_DELAY
2346
2347 If defined, a function that provides delays in the FPGA
2348 configuration driver.
2349
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002350 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002351 Allow Control-C to interrupt FPGA configuration
2352
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002353 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002354
wdenk4a5c8a72003-03-06 00:02:04 +00002355 Check for configuration errors during FPGA bitfile
2356 loading. For example, abort during Virtex II
2357 configuration if the INIT_B line goes low (which
2358 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002359
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002360 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002361
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002362 Maximum time to wait for the INIT_B line to de-assert
2363 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002364 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002365 ms.
wdenkc6097192002-11-03 00:24:07 +00002366
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002367 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002368
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002369 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002370 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002371
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002372 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002373
wdenk4a5c8a72003-03-06 00:02:04 +00002374 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002375 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002376
2377- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002378 CONFIG_BUILD_TARGET
2379
2380 Some SoCs need special image types (e.g. U-Boot binary
2381 with a special header) as build targets. By defining
2382 CONFIG_BUILD_TARGET in the SoC / board header, this
2383 special image will be automatically built upon calling
Simon Glassdc27def2016-07-27 20:33:08 -06002384 make / buildman.
Stefan Roese141ed202014-10-22 12:13:24 +02002385
wdenkc6097192002-11-03 00:24:07 +00002386 CONFIG_IDENT_STRING
2387
wdenk4a5c8a72003-03-06 00:02:04 +00002388 If defined, this string will be added to the U-Boot
2389 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002390
2391- Vendor Parameter Protection:
2392
wdenk4a5c8a72003-03-06 00:02:04 +00002393 U-Boot considers the values of the environment
2394 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002395 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002396 are set once by the board vendor / manufacturer, and
2397 protects these variables from casual modification by
2398 the user. Once set, these variables are read-only,
2399 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002400 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002401
2402 If CONFIG_ENV_OVERWRITE is #defined in your config
2403 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002404 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002405 these parameters.
2406
Joe Hershberger76f353e2015-05-04 14:55:14 -05002407 Alternatively, if you define _both_ an ethaddr in the
2408 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002409 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002410 which can be changed exactly ONCE by the user. [The
2411 serial# is unaffected by this, i. e. it remains
2412 read-only.]
2413
Joe Hershberger71497d02012-12-11 22:16:31 -06002414 The same can be accomplished in a more flexible way
2415 for any variable by configuring the type of access
2416 to allow for those variables in the ".flags" variable
2417 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2418
wdenkc6097192002-11-03 00:24:07 +00002419- Protected RAM:
2420 CONFIG_PRAM
2421
2422 Define this variable to enable the reservation of
2423 "protected RAM", i. e. RAM which is not overwritten
2424 by U-Boot. Define CONFIG_PRAM to hold the number of
2425 kB you want to reserve for pRAM. You can overwrite
2426 this default value by defining an environment
2427 variable "pram" to the number of kB you want to
2428 reserve. Note that the board info structure will
2429 still show the full amount of RAM. If pRAM is
2430 reserved, a new environment variable "mem" will
2431 automatically be defined to hold the amount of
2432 remaining RAM in a form that can be passed as boot
2433 argument to Linux, for instance like that:
2434
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002435 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002436 saveenv
2437
2438 This way you can tell Linux not to use this memory,
2439 either, which results in a memory region that will
2440 not be affected by reboots.
2441
2442 *WARNING* If your board configuration uses automatic
2443 detection of the RAM size, you must make sure that
2444 this memory test is non-destructive. So far, the
2445 following board configurations are known to be
2446 "pRAM-clean":
2447
Wolfgang Denk90326762012-10-24 02:36:15 +00002448 IVMS8, IVML24, SPD8xx, TQM8xxL,
2449 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002450 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002451
Gabe Blacka2f3a932012-12-02 04:55:18 +00002452- Access to physical memory region (> 4GB)
2453 Some basic support is provided for operations on memory not
2454 normally accessible to U-Boot - e.g. some architectures
2455 support access to more than 4GB of memory on 32-bit
2456 machines using physical address extension or similar.
2457 Define CONFIG_PHYSMEM to access this basic support, which
2458 currently only supports clearing the memory.
2459
wdenkc6097192002-11-03 00:24:07 +00002460- Error Recovery:
2461 CONFIG_PANIC_HANG
2462
2463 Define this variable to stop the system in case of a
2464 fatal error, so that you have to reset it manually.
2465 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002466 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002467 automatically as fast as possible, but it may be
2468 useful during development since you can try to debug
2469 the conditions that lead to the situation.
2470
2471 CONFIG_NET_RETRY_COUNT
2472
wdenk4a5c8a72003-03-06 00:02:04 +00002473 This variable defines the number of retries for
2474 network operations like ARP, RARP, TFTP, or BOOTP
2475 before giving up the operation. If not defined, a
2476 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002477
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002478 CONFIG_ARP_TIMEOUT
2479
2480 Timeout waiting for an ARP reply in milliseconds.
2481
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002482 CONFIG_NFS_TIMEOUT
2483
2484 Timeout in milliseconds used in NFS protocol.
2485 If you encounter "ERROR: Cannot umount" in nfs command,
2486 try longer timeout such as
2487 #define CONFIG_NFS_TIMEOUT 10000UL
2488
wdenkc6097192002-11-03 00:24:07 +00002489- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002490 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002491
2492 Enable auto completion of commands using TAB.
2493
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002494 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002495
2496 This defines the secondary prompt string, which is
2497 printed when the command interpreter needs more input
2498 to complete a command. Usually "> ".
2499
2500 Note:
2501
wdenk57b2d802003-06-27 21:31:46 +00002502 In the current implementation, the local variables
2503 space and global environment variables space are
2504 separated. Local variables are those you define by
2505 simply typing `name=value'. To access a local
2506 variable later on, you have write `$name' or
2507 `${name}'; to execute the contents of a variable
2508 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002509
wdenk4a5c8a72003-03-06 00:02:04 +00002510 Global environment variables are those you use
2511 setenv/printenv to work with. To run a command stored
2512 in such a variable, you need to use the run command,
2513 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002514
2515 To store commands and special characters in a
2516 variable, please use double quotation marks
2517 surrounding the whole text of the variable, instead
2518 of the backslashes before semicolons and special
2519 symbols.
2520
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002521- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002522 CONFIG_CMDLINE_EDITING
2523
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002524 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002525 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002526
Marek Vasut734fb042016-01-27 04:47:55 +01002527- Command Line PS1/PS2 support:
2528 CONFIG_CMDLINE_PS_SUPPORT
2529
2530 Enable support for changing the command prompt string
2531 at run-time. Only static string is supported so far.
2532 The string is obtained from environment variables PS1
2533 and PS2.
2534
wdenkc0aa5c52003-12-06 19:49:23 +00002535- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002536 CONFIG_EXTRA_ENV_SETTINGS
2537
wdenk4a5c8a72003-03-06 00:02:04 +00002538 Define this to contain any number of null terminated
2539 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002540 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002541
wdenk4a5c8a72003-03-06 00:02:04 +00002542 For example, place something like this in your
2543 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002544
2545 #define CONFIG_EXTRA_ENV_SETTINGS \
2546 "myvar1=value1\0" \
2547 "myvar2=value2\0"
2548
wdenk4a5c8a72003-03-06 00:02:04 +00002549 Warning: This method is based on knowledge about the
2550 internal format how the environment is stored by the
2551 U-Boot code. This is NOT an official, exported
2552 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002553 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002554 You better know what you are doing here.
2555
wdenk4a5c8a72003-03-06 00:02:04 +00002556 Note: overly (ab)use of the default environment is
2557 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002558 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002559 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002560
Stephen Warren1465d5f2012-05-22 09:21:54 +00002561 CONFIG_ENV_VARS_UBOOT_CONFIG
2562
2563 Define this in order to add variables describing the
2564 U-Boot build configuration to the default environment.
2565 These will be named arch, cpu, board, vendor, and soc.
2566
2567 Enabling this option will cause the following to be defined:
2568
2569 - CONFIG_SYS_ARCH
2570 - CONFIG_SYS_CPU
2571 - CONFIG_SYS_BOARD
2572 - CONFIG_SYS_VENDOR
2573 - CONFIG_SYS_SOC
2574
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002575 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2576
2577 Define this in order to add variables describing certain
2578 run-time determined information about the hardware to the
2579 environment. These will be named board_name, board_rev.
2580
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002581 CONFIG_DELAY_ENVIRONMENT
2582
2583 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002584 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002585 that so that the environment is not available until
2586 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2587 this is instead controlled by the value of
2588 /config/load-environment.
2589
wdenkc0aa5c52003-12-06 19:49:23 +00002590- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002591 CONFIG_HAS_DATAFLASH
2592
wdenk57b2d802003-06-27 21:31:46 +00002593 Defining this option enables DataFlash features and
2594 allows to read/write in Dataflash via the standard
2595 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002596
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002597- Serial Flash support
2598 CONFIG_CMD_SF
2599
2600 Defining this option enables SPI flash commands
2601 'sf probe/read/write/erase/update'.
2602
2603 Usage requires an initial 'probe' to define the serial
2604 flash parameters, followed by read/write/erase/update
2605 commands.
2606
2607 The following defaults may be provided by the platform
2608 to handle the common case when only a single serial
2609 flash is present on the system.
2610
2611 CONFIG_SF_DEFAULT_BUS Bus identifier
2612 CONFIG_SF_DEFAULT_CS Chip-select
2613 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2614 CONFIG_SF_DEFAULT_SPEED in Hz
2615
Simon Glass4b5545e2012-10-08 13:16:02 +00002616 CONFIG_CMD_SF_TEST
2617
2618 Define this option to include a destructive SPI flash
2619 test ('sf test').
2620
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302621 CONFIG_SF_DUAL_FLASH Dual flash memories
2622
2623 Define this option to use dual flash support where two flash
2624 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002625 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302626
wdenkef893942004-02-23 16:11:30 +00002627- SystemACE Support:
2628 CONFIG_SYSTEMACE
2629
2630 Adding this option adds support for Xilinx SystemACE
2631 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002632 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002633 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00002634
2635 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002636 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00002637
2638 When SystemACE support is added, the "ace" device type
2639 becomes available to the fat commands, i.e. fatls.
2640
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002641- TFTP Fixed UDP Port:
2642 CONFIG_TFTP_PORT
2643
Wolfgang Denk227b5192005-09-24 23:25:46 +02002644 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002645 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02002646 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002647 number generator is used.
2648
Wolfgang Denk227b5192005-09-24 23:25:46 +02002649 Also, the environment variable tftpdstp is used to supply
2650 the TFTP UDP destination port value. If tftpdstp isn't
2651 defined, the normal port 69 is used.
2652
2653 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02002654 blindly start the TFTP transfer using the pre-configured
2655 target IP address and UDP port. This has the effect of
2656 "punching through" the (Windows XP) firewall, allowing
2657 the remainder of the TFTP transfer to proceed normally.
2658 A better solution is to properly configure the firewall,
2659 but sometimes that is not allowed.
2660
Heiko Schocher443ca402014-01-25 07:27:13 +01002661- bootcount support:
2662 CONFIG_BOOTCOUNT_LIMIT
2663
2664 This enables the bootcounter support, see:
2665 http://www.denx.de/wiki/DULG/UBootBootCountLimit
2666
2667 CONFIG_AT91SAM9XE
2668 enable special bootcounter support on at91sam9xe based boards.
Heiko Schocher443ca402014-01-25 07:27:13 +01002669 CONFIG_SOC_DA8XX
2670 enable special bootcounter support on da850 based boards.
2671 CONFIG_BOOTCOUNT_RAM
2672 enable support for the bootcounter in RAM
2673 CONFIG_BOOTCOUNT_I2C
2674 enable support for the bootcounter on an i2c (like RTC) device.
2675 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
2676 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
2677 the bootcounter.
2678 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07002679
wdenkc0aa5c52003-12-06 19:49:23 +00002680- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002681 CONFIG_SHOW_BOOT_PROGRESS
2682
wdenk4a5c8a72003-03-06 00:02:04 +00002683 Defining this option allows to add some board-
2684 specific code (calling a user-provided function
2685 "show_boot_progress(int)") that enables you to show
2686 the system's boot progress on some display (for
2687 example, some LED's) on your board. At the moment,
2688 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002689
Simon Glass0fa36a42012-09-28 08:56:37 +00002690
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002691Legacy uImage format:
2692
wdenkc6097192002-11-03 00:24:07 +00002693 Arg Where When
2694 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00002695 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002696 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00002697 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002698 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00002699 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002700 4 common/cmd_bootm.c Image data has correct checksum
2701 -4 common/cmd_bootm.c Image is for unsupported architecture
2702 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002703 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002704 6 common/cmd_bootm.c Image Type check OK
2705 -6 common/cmd_bootm.c gunzip uncompression error
2706 -7 common/cmd_bootm.c Unimplemented compression type
2707 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002708 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002709 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002710
2711 9 common/image.c Start initial ramdisk verification
2712 -10 common/image.c Ramdisk header has bad magic number
2713 -11 common/image.c Ramdisk header has bad checksum
2714 10 common/image.c Ramdisk header is OK
2715 -12 common/image.c Ramdisk data has bad checksum
2716 11 common/image.c Ramdisk data has correct checksum
2717 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002718 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002719 13 common/image.c Start multifile image verification
2720 14 common/image.c No initial ramdisk, no multifile, continue.
2721
Wolfgang Denk092ae952011-10-26 10:21:21 +00002722 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002723
Stefan Roese88fbf932010-04-15 16:07:28 +02002724 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00002725 -31 post/post.c POST test failed, detected by post_output_backlog()
2726 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00002727
Heiko Schocher633e03a2007-06-22 19:11:54 +02002728 34 common/cmd_doc.c before loading a Image from a DOC device
2729 -35 common/cmd_doc.c Bad usage of "doc" command
2730 35 common/cmd_doc.c correct usage of "doc" command
2731 -36 common/cmd_doc.c No boot device
2732 36 common/cmd_doc.c correct boot device
2733 -37 common/cmd_doc.c Unknown Chip ID on boot device
2734 37 common/cmd_doc.c correct chip ID found, device available
2735 -38 common/cmd_doc.c Read Error on boot device
2736 38 common/cmd_doc.c reading Image header from DOC device OK
2737 -39 common/cmd_doc.c Image header has bad magic number
2738 39 common/cmd_doc.c Image header has correct magic number
2739 -40 common/cmd_doc.c Error reading Image from DOC device
2740 40 common/cmd_doc.c Image header has correct magic number
2741 41 common/cmd_ide.c before loading a Image from a IDE device
2742 -42 common/cmd_ide.c Bad usage of "ide" command
2743 42 common/cmd_ide.c correct usage of "ide" command
2744 -43 common/cmd_ide.c No boot device
2745 43 common/cmd_ide.c boot device found
2746 -44 common/cmd_ide.c Device not available
2747 44 common/cmd_ide.c Device available
2748 -45 common/cmd_ide.c wrong partition selected
2749 45 common/cmd_ide.c partition selected
2750 -46 common/cmd_ide.c Unknown partition table
2751 46 common/cmd_ide.c valid partition table found
2752 -47 common/cmd_ide.c Invalid partition type
2753 47 common/cmd_ide.c correct partition type
2754 -48 common/cmd_ide.c Error reading Image Header on boot device
2755 48 common/cmd_ide.c reading Image Header from IDE device OK
2756 -49 common/cmd_ide.c Image header has bad magic number
2757 49 common/cmd_ide.c Image header has correct magic number
2758 -50 common/cmd_ide.c Image header has bad checksum
2759 50 common/cmd_ide.c Image header has correct checksum
2760 -51 common/cmd_ide.c Error reading Image from IDE device
2761 51 common/cmd_ide.c reading Image from IDE device OK
2762 52 common/cmd_nand.c before loading a Image from a NAND device
2763 -53 common/cmd_nand.c Bad usage of "nand" command
2764 53 common/cmd_nand.c correct usage of "nand" command
2765 -54 common/cmd_nand.c No boot device
2766 54 common/cmd_nand.c boot device found
2767 -55 common/cmd_nand.c Unknown Chip ID on boot device
2768 55 common/cmd_nand.c correct chip ID found, device available
2769 -56 common/cmd_nand.c Error reading Image Header on boot device
2770 56 common/cmd_nand.c reading Image Header from NAND device OK
2771 -57 common/cmd_nand.c Image header has bad magic number
2772 57 common/cmd_nand.c Image header has correct magic number
2773 -58 common/cmd_nand.c Error reading Image from NAND device
2774 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002775
Heiko Schocher633e03a2007-06-22 19:11:54 +02002776 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002777
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002778 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02002779 -64 net/eth.c no Ethernet found.
2780 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00002781
Heiko Schocher633e03a2007-06-22 19:11:54 +02002782 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05002783 80 common/cmd_net.c before calling net_loop()
2784 -81 common/cmd_net.c some error in net_loop() occurred
2785 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02002786 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2787 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002788 83 common/cmd_net.c running "source" command
2789 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02002790 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002791
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002792FIT uImage format:
2793
2794 Arg Where When
2795 100 common/cmd_bootm.c Kernel FIT Image has correct format
2796 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2797 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2798 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2799 102 common/cmd_bootm.c Kernel unit name specified
2800 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01002801 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002802 104 common/cmd_bootm.c Got kernel subimage node offset
2803 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2804 105 common/cmd_bootm.c Kernel subimage hash verification OK
2805 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2806 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002807 -106 common/cmd_bootm.c Kernel subimage has wrong type
2808 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002809 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2810 108 common/cmd_bootm.c Got kernel subimage data/size
2811 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2812 -109 common/cmd_bootm.c Can't get kernel subimage type
2813 -110 common/cmd_bootm.c Can't get kernel subimage comp
2814 -111 common/cmd_bootm.c Can't get kernel subimage os
2815 -112 common/cmd_bootm.c Can't get kernel subimage load address
2816 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2817
2818 120 common/image.c Start initial ramdisk verification
2819 -120 common/image.c Ramdisk FIT image has incorrect format
2820 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002821 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002822 -122 common/image.c Can't get configuration for ramdisk subimage
2823 123 common/image.c Ramdisk unit name specified
2824 -124 common/image.c Can't get ramdisk subimage node offset
2825 125 common/image.c Got ramdisk subimage node offset
2826 -125 common/image.c Ramdisk subimage hash verification failed
2827 126 common/image.c Ramdisk subimage hash verification OK
2828 -126 common/image.c Ramdisk subimage for unsupported architecture
2829 127 common/image.c Architecture check OK
2830 -127 common/image.c Can't get ramdisk subimage data/size
2831 128 common/image.c Got ramdisk subimage data/size
2832 129 common/image.c Can't get ramdisk load address
2833 -129 common/image.c Got ramdisk load address
2834
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002835 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002836 131 common/cmd_doc.c FIT image format OK
2837
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002838 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002839 141 common/cmd_ide.c FIT image format OK
2840
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002841 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01002842 151 common/cmd_nand.c FIT image format OK
2843
Heiko Schocher515eb122014-05-28 11:33:33 +02002844- legacy image format:
2845 CONFIG_IMAGE_FORMAT_LEGACY
2846 enables the legacy image format support in U-Boot.
2847
2848 Default:
2849 enabled if CONFIG_FIT_SIGNATURE is not defined.
2850
2851 CONFIG_DISABLE_IMAGE_LEGACY
2852 disable the legacy image format
2853
2854 This define is introduced, as the legacy image format is
2855 enabled per default for backward compatibility.
2856
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002857- Standalone program support:
2858 CONFIG_STANDALONE_LOAD_ADDR
2859
Wolfgang Denk23f78482011-10-09 21:06:34 +02002860 This option defines a board specific value for the
2861 address where standalone program gets loaded, thus
2862 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002863 settings.
2864
2865- Frame Buffer Address:
2866 CONFIG_FB_ADDR
2867
2868 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00002869 address for frame buffer. This is typically the case
2870 when using a graphics controller has separate video
2871 memory. U-Boot will then place the frame buffer at
2872 the given address instead of dynamically reserving it
2873 in system RAM by calling lcd_setmem(), which grabs
2874 the memory for the frame buffer depending on the
2875 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02002876
2877 Please see board_init_f function.
2878
Detlev Zundel0ecb6112009-12-01 17:16:19 +01002879- Automatic software updates via TFTP server
2880 CONFIG_UPDATE_TFTP
2881 CONFIG_UPDATE_TFTP_CNT_MAX
2882 CONFIG_UPDATE_TFTP_MSEC_MAX
2883
2884 These options enable and control the auto-update feature;
2885 for a more detailed description refer to doc/README.update.
2886
2887- MTD Support (mtdparts command, UBI support)
2888 CONFIG_MTD_DEVICE
2889
2890 Adds the MTD device infrastructure from the Linux kernel.
2891 Needed for mtdparts command support.
2892
2893 CONFIG_MTD_PARTITIONS
2894
2895 Adds the MTD partitioning infrastructure from the Linux
2896 kernel. Needed for UBI support.
2897
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002898- UBI support
2899 CONFIG_CMD_UBI
2900
2901 Adds commands for interacting with MTD partitions formatted
2902 with the UBI flash translation layer
2903
2904 Requires also defining CONFIG_RBTREE
2905
Joe Hershberger47550fc2013-04-08 10:32:49 +00002906 CONFIG_UBI_SILENCE_MSG
2907
2908 Make the verbose messages from UBI stop printing. This leaves
2909 warnings and errors enabled.
2910
Heiko Schocherf5895d12014-06-24 10:10:04 +02002911
2912 CONFIG_MTD_UBI_WL_THRESHOLD
2913 This parameter defines the maximum difference between the highest
2914 erase counter value and the lowest erase counter value of eraseblocks
2915 of UBI devices. When this threshold is exceeded, UBI starts performing
2916 wear leveling by means of moving data from eraseblock with low erase
2917 counter to eraseblocks with high erase counter.
2918
2919 The default value should be OK for SLC NAND flashes, NOR flashes and
2920 other flashes which have eraseblock life-cycle 100000 or more.
2921 However, in case of MLC NAND flashes which typically have eraseblock
2922 life-cycle less than 10000, the threshold should be lessened (e.g.,
2923 to 128 or 256, although it does not have to be power of 2).
2924
2925 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06002926
Heiko Schocherf5895d12014-06-24 10:10:04 +02002927 CONFIG_MTD_UBI_BEB_LIMIT
2928 This option specifies the maximum bad physical eraseblocks UBI
2929 expects on the MTD device (per 1024 eraseblocks). If the
2930 underlying flash does not admit of bad eraseblocks (e.g. NOR
2931 flash), this value is ignored.
2932
2933 NAND datasheets often specify the minimum and maximum NVM
2934 (Number of Valid Blocks) for the flashes' endurance lifetime.
2935 The maximum expected bad eraseblocks per 1024 eraseblocks
2936 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2937 which gives 20 for most NANDs (MaxNVB is basically the total
2938 count of eraseblocks on the chip).
2939
2940 To put it differently, if this value is 20, UBI will try to
2941 reserve about 1.9% of physical eraseblocks for bad blocks
2942 handling. And that will be 1.9% of eraseblocks on the entire
2943 NAND chip, not just the MTD partition UBI attaches. This means
2944 that if you have, say, a NAND flash chip admits maximum 40 bad
2945 eraseblocks, and it is split on two MTD partitions of the same
2946 size, UBI will reserve 40 eraseblocks when attaching a
2947 partition.
2948
2949 default: 20
2950
2951 CONFIG_MTD_UBI_FASTMAP
2952 Fastmap is a mechanism which allows attaching an UBI device
2953 in nearly constant time. Instead of scanning the whole MTD device it
2954 only has to locate a checkpoint (called fastmap) on the device.
2955 The on-flash fastmap contains all information needed to attach
2956 the device. Using fastmap makes only sense on large devices where
2957 attaching by scanning takes long. UBI will not automatically install
2958 a fastmap on old images, but you can set the UBI parameter
2959 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2960 that fastmap-enabled images are still usable with UBI implementations
2961 without fastmap support. On typical flash devices the whole fastmap
2962 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2963
2964 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2965 Set this parameter to enable fastmap automatically on images
2966 without a fastmap.
2967 default: 0
2968
Heiko Schocher94b66de2015-10-22 06:19:21 +02002969 CONFIG_MTD_UBI_FM_DEBUG
2970 Enable UBI fastmap debug
2971 default: 0
2972
Joe Hershberger7d80fc12013-04-08 10:32:48 +00002973- UBIFS support
2974 CONFIG_CMD_UBIFS
2975
2976 Adds commands for interacting with UBI volumes formatted as
2977 UBIFS. UBIFS is read-only in u-boot.
2978
2979 Requires UBI support as well as CONFIG_LZO
2980
Joe Hershberger47550fc2013-04-08 10:32:49 +00002981 CONFIG_UBIFS_SILENCE_MSG
2982
2983 Make the verbose messages from UBIFS stop printing. This leaves
2984 warnings and errors enabled.
2985
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002986- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02002987 CONFIG_SPL
2988 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00002989
Tom Rini36853852012-02-14 07:29:40 +00002990 CONFIG_SPL_LDSCRIPT
2991 LDSCRIPT for linking the SPL binary.
2992
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002993 CONFIG_SPL_MAX_FOOTPRINT
2994 Maximum size in memory allocated to the SPL, BSS included.
2995 When defined, the linker checks that the actual memory
2996 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00002997 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00002998 must not be both defined at the same time.
2999
Tom Rini36853852012-02-14 07:29:40 +00003000 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003001 Maximum size of the SPL image (text, data, rodata, and
3002 linker lists sections), BSS excluded.
3003 When defined, the linker checks that the actual size does
3004 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003005
Wolfgang Denk825223d2011-09-11 21:24:09 +02003006 CONFIG_SPL_TEXT_BASE
3007 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003008
Scott Woodc4f0d002012-09-20 19:05:12 -05003009 CONFIG_SPL_RELOC_TEXT_BASE
3010 Address to relocate to. If unspecified, this is equal to
3011 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3012
Tom Rini36853852012-02-14 07:29:40 +00003013 CONFIG_SPL_BSS_START_ADDR
3014 Link address for the BSS within the SPL binary.
3015
3016 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003017 Maximum size in memory allocated to the SPL BSS.
3018 When defined, the linker checks that the actual memory used
3019 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003020 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003021 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003022
3023 CONFIG_SPL_STACK
3024 Adress of the start of the stack SPL will use
3025
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003026 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3027 When defined, SPL will panic() if the image it has
3028 loaded does not have a signature.
3029 Defining this is useful when code which loads images
3030 in SPL cannot guarantee that absolutely all read errors
3031 will be caught.
3032 An example is the LPC32XX MLC NAND driver, which will
3033 consider that a completely unreadable NAND block is bad,
3034 and thus should be skipped silently.
3035
Scott Woodc4f0d002012-09-20 19:05:12 -05003036 CONFIG_SPL_RELOC_STACK
3037 Adress of the start of the stack SPL will use after
3038 relocation. If unspecified, this is equal to
3039 CONFIG_SPL_STACK.
3040
Tom Rini36853852012-02-14 07:29:40 +00003041 CONFIG_SYS_SPL_MALLOC_START
3042 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003043 When this option is set the full malloc is used in SPL and
3044 it is set up by spl_init() and before that, the simple malloc()
3045 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003046
3047 CONFIG_SYS_SPL_MALLOC_SIZE
3048 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003049
Tom Rini28591df2012-08-13 12:03:19 -07003050 CONFIG_SPL_FRAMEWORK
3051 Enable the SPL framework under common/. This framework
3052 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3053 NAND loading of the Linux Kernel.
3054
Tom Rinic2b76002014-03-28 12:03:39 -04003055 CONFIG_SPL_OS_BOOT
3056 Enable booting directly to an OS from SPL.
3057 See also: doc/README.falcon
3058
Tom Rinife3b0c72012-08-13 11:37:56 -07003059 CONFIG_SPL_DISPLAY_PRINT
3060 For ARM, enable an optional function to print more information
3061 about the running system.
3062
Scott Wood7c810902012-09-20 16:35:21 -05003063 CONFIG_SPL_INIT_MINIMAL
3064 Arch init code should be built for a very small image
3065
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003066 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3067 Partition on the MMC to load U-Boot from when the MMC is being
3068 used in raw mode
3069
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003070 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3071 Sector to load kernel uImage from when MMC is being
3072 used in raw mode (for Falcon mode)
3073
3074 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3075 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3076 Sector and number of sectors to load kernel argument
3077 parameters from when MMC is being used in raw mode
3078 (for falcon mode)
3079
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003080 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3081 Partition on the MMC to load U-Boot from when the MMC is being
3082 used in fs mode
3083
Guillaume GARDET5065b712014-10-15 17:53:13 +02003084 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3085 Filename to read to load U-Boot when reading from filesystem
3086
3087 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003088 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003089 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003090
Guillaume GARDET5065b712014-10-15 17:53:13 +02003091 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003092 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003093 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003094
Scott Wood2b36fbb2012-12-06 13:33:17 +00003095 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3096 Set this for NAND SPL on PPC mpc83xx targets, so that
3097 start.S waits for the rest of the SPL to load before
3098 continuing (the hardware starts execution after just
3099 loading the first page rather than the full 4K).
3100
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303101 CONFIG_SPL_SKIP_RELOCATE
3102 Avoid SPL relocation
3103
Scott Woodc352a0c2012-09-20 19:09:07 -05003104 CONFIG_SPL_NAND_BASE
3105 Include nand_base.c in the SPL. Requires
3106 CONFIG_SPL_NAND_DRIVERS.
3107
3108 CONFIG_SPL_NAND_DRIVERS
3109 SPL uses normal NAND drivers, not minimal drivers.
3110
3111 CONFIG_SPL_NAND_ECC
3112 Include standard software ECC in the SPL
3113
Tom Rini36853852012-02-14 07:29:40 +00003114 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003115 Support for NAND boot using simple NAND drivers that
3116 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003117
Thomas Gleixner820d24d2016-07-12 20:28:12 +02003118 CONFIG_SPL_UBI
3119 Support for a lightweight UBI (fastmap) scanner and
3120 loader
3121
Heiko Schochercf000272014-10-31 08:31:00 +01003122 CONFIG_SPL_NAND_RAW_ONLY
3123 Support to boot only raw u-boot.bin images. Use this only
3124 if you need to save space.
3125
Ying Zhangdfb2b152013-08-16 15:16:12 +08003126 CONFIG_SPL_COMMON_INIT_DDR
3127 Set for common ddr init with serial presence detect in
3128 SPL binary.
3129
Tom Rini36853852012-02-14 07:29:40 +00003130 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3131 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3132 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3133 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3134 CONFIG_SYS_NAND_ECCBYTES
3135 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003136 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003137
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303138 CONFIG_SPL_NAND_BOOT
3139 Add support NAND boot
3140
Tom Rini36853852012-02-14 07:29:40 +00003141 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003142 Location in NAND to read U-Boot from
3143
3144 CONFIG_SYS_NAND_U_BOOT_DST
3145 Location in memory to load U-Boot to
3146
3147 CONFIG_SYS_NAND_U_BOOT_SIZE
3148 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003149
3150 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003151 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003152
3153 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3154 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003155 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003156
3157 CONFIG_SPL_OMAP3_ID_NAND
3158 Support for an OMAP3-specific set of functions to return the
3159 ID and MFR of the first attached NAND chip, if present.
3160
Pavel Machekde997252012-08-30 22:42:11 +02003161 CONFIG_SPL_RAM_DEVICE
3162 Support for running image already present in ram, in SPL binary
3163
Scott Woodeb7bd972012-12-06 13:33:16 +00003164 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003165 Image offset to which the SPL should be padded before appending
3166 the SPL payload. By default, this is defined as
3167 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3168 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3169 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003170
Scott Woodf147eb72012-09-21 16:27:32 -05003171 CONFIG_SPL_TARGET
3172 Final target image containing SPL and payload. Some SPLs
3173 use an arch-specific makefile fragment instead, for
3174 example if more than one image needs to be produced.
3175
Simon Glass82d94532013-05-08 08:05:59 +00003176 CONFIG_FIT_SPL_PRINT
3177 Printing information about a FIT image adds quite a bit of
3178 code to SPL. So this is normally disabled in SPL. Use this
3179 option to re-enable it. This will affect the output of the
3180 bootm command when booting a FIT image.
3181
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003182- TPL framework
3183 CONFIG_TPL
3184 Enable building of TPL globally.
3185
3186 CONFIG_TPL_PAD_TO
3187 Image offset to which the TPL should be padded before appending
3188 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003189 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3190 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3191 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003192
wdenkc0aa5c52003-12-06 19:49:23 +00003193- Interrupt support (PPC):
3194
wdenk1ebf41e2004-01-02 14:00:00 +00003195 There are common interrupt_init() and timer_interrupt()
3196 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003197 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003198 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003199 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003200 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003201 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003202 specific handling. If board has watchdog / status_led
3203 / other_activity_monitor it works automatically from
3204 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003205
wdenkc6097192002-11-03 00:24:07 +00003206
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003207Board initialization settings:
3208------------------------------
3209
3210During Initialization u-boot calls a number of board specific functions
3211to allow the preparation of board specific prerequisites, e.g. pin setup
3212before drivers are initialized. To enable these callbacks the
3213following configuration macros have to be defined. Currently this is
3214architecture specific, so please check arch/your_architecture/lib/board.c
3215typically in board_init_f() and board_init_r().
3216
3217- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3218- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3219- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3220- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003221
wdenkc6097192002-11-03 00:24:07 +00003222Configuration Settings:
3223-----------------------
3224
York Sun6c480012014-02-26 17:03:19 -08003225- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3226 Optionally it can be defined to support 64-bit memory commands.
3227
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003228- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003229 undefine this when you're short of memory.
3230
Peter Tyserdfb72b82009-01-27 18:03:12 -06003231- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3232 width of the commands listed in the 'help' command output.
3233
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003234- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003235 prompt for user input.
3236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003237- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003238
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003239- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003240
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003241- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003242
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003243- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003244 the application (usually a Linux kernel) when it is
3245 booted
3246
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003247- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003248 List of legal baudrate settings for this board.
3249
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003250- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003251 Begin and End addresses of the area used by the
3252 simple memory test.
3253
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003254- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003255 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003256
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003257- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003258 Scratch address used by the alternate memory test
3259 You only need to set this if address zero isn't writeable
3260
York Sun5d286cd2015-12-04 11:57:07 -08003261- CONFIG_SYS_MEM_RESERVE_SECURE
York Sun1ef95cc2016-06-24 16:46:18 -07003262 Only implemented for ARMv8 for now.
York Sun5d286cd2015-12-04 11:57:07 -08003263 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3264 is substracted from total RAM and won't be reported to OS.
3265 This memory can be used as secure memory. A variable
York Sun1ef95cc2016-06-24 16:46:18 -07003266 gd->arch.secure_ram is used to track the location. In systems
York Sun5d286cd2015-12-04 11:57:07 -08003267 the RAM base is not zero, or RAM is divided into banks,
3268 this variable needs to be recalcuated to get the address.
3269
York Sun50739372015-12-07 11:05:29 -08003270- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003271 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003272 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003273 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003274 fixing up gd->ram_size the Linux kernel should gets passed
3275 the now "corrected" memory size and won't touch it either.
3276 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003277 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003278 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003279 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003280
3281 This option can be used as a workaround for the 440EPx/GRx
3282 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3283 be touched.
3284
3285 WARNING: Please make sure that this value is a multiple of
3286 the Linux page size (normally 4k). If this is not the case,
3287 then the end address of the Linux memory will be located at a
3288 non page size aligned address and this could cause major
3289 problems.
3290
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003291- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003292 Enable temporary baudrate change while serial download
3293
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003294- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003295 Physical start address of SDRAM. _Must_ be 0 here.
3296
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003297- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003298 Physical start address of Flash memory.
3299
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003300- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003301 Physical start address of boot monitor code (set by
3302 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003303 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003304 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003305
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003306- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003307 Size of memory reserved for monitor code, used to
3308 determine _at_compile_time_ (!) if the environment is
3309 embedded within the U-Boot image, or in a separate
3310 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003311
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003312- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003313 Size of DRAM reserved for malloc() use.
3314
Simon Glass863e4042014-07-10 22:23:28 -06003315- CONFIG_SYS_MALLOC_F_LEN
3316 Size of the malloc() pool for use before relocation. If
3317 this is defined, then a very simple malloc() implementation
3318 will become available before relocation. The address is just
3319 below the global data, and the stack is moved down to make
3320 space.
3321
3322 This feature allocates regions with increasing addresses
3323 within the region. calloc() is supported, but realloc()
3324 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003325 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003326 U-Boot relocates itself.
3327
Simon Glass9fa901b2014-11-10 17:16:54 -07003328- CONFIG_SYS_MALLOC_SIMPLE
3329 Provides a simple and small malloc() and calloc() for those
3330 boards which do not use the full malloc in SPL (which is
3331 enabled with CONFIG_SYS_SPL_MALLOC_START).
3332
Thierry Redingc97d9742014-12-09 22:25:22 -07003333- CONFIG_SYS_NONCACHED_MEMORY:
3334 Size of non-cached memory area. This area of memory will be
3335 typically located right below the malloc() area and mapped
3336 uncached in the MMU. This is useful for drivers that would
3337 otherwise require a lot of explicit cache maintenance. For
3338 some drivers it's also impossible to properly maintain the
3339 cache. For example if the regions that need to be flushed
3340 are not a multiple of the cache-line size, *and* padding
3341 cannot be allocated between the regions to align them (i.e.
3342 if the HW requires a contiguous array of regions, and the
3343 size of each region is not cache-aligned), then a flush of
3344 one region may result in overwriting data that hardware has
3345 written to another region in the same cache-line. This can
3346 happen for example in network drivers where descriptors for
3347 buffers are typically smaller than the CPU cache-line (e.g.
3348 16 bytes vs. 32 or 64 bytes).
3349
3350 Non-cached memory is only supported on 32-bit ARM at present.
3351
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003352- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003353 Normally compressed uImages are limited to an
3354 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003355 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003356 to adjust this setting to your needs.
3357
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003358- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003359 Maximum size of memory mapped by the startup code of
3360 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003361 the Linux kernel (bd_info, boot arguments, FDT blob if
3362 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003363 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003364 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003365 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003366 variable "bootm_mapsize" will override the value of
3367 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3368 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003369
John Rigbyeea8e692010-10-13 13:57:35 -06003370- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3371 Enable initrd_high functionality. If defined then the
3372 initrd_high feature is enabled and the bootm ramdisk subcommand
3373 is enabled.
3374
3375- CONFIG_SYS_BOOT_GET_CMDLINE:
3376 Enables allocating and saving kernel cmdline in space between
3377 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3378
3379- CONFIG_SYS_BOOT_GET_KBD:
3380 Enables allocating and saving a kernel copy of the bd_info in
3381 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3382
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003383- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003384 Max number of Flash memory banks
3385
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003386- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003387 Max number of sectors on a Flash chip
3388
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003389- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003390 Timeout for Flash erase operations (in ms)
3391
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003392- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003393 Timeout for Flash write operations (in ms)
3394
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003395- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003396 Timeout for Flash set sector lock bit operation (in ms)
3397
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003398- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003399 Timeout for Flash clear lock bits operation (in ms)
3400
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003401- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003402 If defined, hardware flash sectors protection is used
3403 instead of U-Boot software protection.
3404
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003405- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003406
3407 Enable TFTP transfers directly to flash memory;
3408 without this option such a download has to be
3409 performed in two steps: (1) download to RAM, and (2)
3410 copy from RAM to flash.
3411
3412 The two-step approach is usually more reliable, since
3413 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003414 the flash, but in some situations (when system RAM is
3415 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003416 downloaded image) this option may be very useful.
3417
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003418- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003419 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003420 common flash structure for storing flash geometry.
3421
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003422- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003423 This option also enables the building of the cfi_flash driver
3424 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003425
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003426- CONFIG_FLASH_CFI_MTD
3427 This option enables the building of the cfi_mtd driver
3428 in the drivers directory. The driver exports CFI flash
3429 to the MTD layer.
3430
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003431- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003432 Use buffered writes to flash.
3433
3434- CONFIG_FLASH_SPANSION_S29WS_N
3435 s29ws-n MirrorBit flash has non-standard addresses for buffered
3436 write commands.
3437
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003438- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003439 If this option is defined, the common CFI flash doesn't
3440 print it's warning upon not recognized FLASH banks. This
3441 is useful, if some of the configured banks are only
3442 optionally available.
3443
Jerry Van Barenaae73572008-03-08 13:48:01 -05003444- CONFIG_FLASH_SHOW_PROGRESS
3445 If defined (must be an integer), print out countdown
3446 digits and dots. Recommended value: 45 (9..1) for 80
3447 column displays, 15 (3..1) for 40 column displays.
3448
Stefan Roesed20cba52013-04-04 15:53:14 +02003449- CONFIG_FLASH_VERIFY
3450 If defined, the content of the flash (destination) is compared
3451 against the source after the write operation. An error message
3452 will be printed when the contents are not identical.
3453 Please note that this option is useless in nearly all cases,
3454 since such flash programming errors usually are detected earlier
3455 while unprotecting/erasing/programming. Please only enable
3456 this option if you really know what you are doing.
3457
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003458- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003459 Defines the number of Ethernet receive buffers. On some
3460 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003461 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3462 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003463 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003464 Defaults to 4 if not defined.
3465
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003466- CONFIG_ENV_MAX_ENTRIES
3467
Wolfgang Denk1136f692010-10-27 22:48:30 +02003468 Maximum number of entries in the hash table that is used
3469 internally to store the environment settings. The default
3470 setting is supposed to be generous and should work in most
3471 cases. This setting can be used to tune behaviour; see
3472 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003473
Joe Hershberger71497d02012-12-11 22:16:31 -06003474- CONFIG_ENV_FLAGS_LIST_DEFAULT
3475- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003476 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06003477 calling env set. Variables can be restricted to only decimal,
3478 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3479 the variables can also be restricted to IP address or MAC address.
3480
3481 The format of the list is:
3482 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003483 access_attribute = [a|r|o|c]
3484 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06003485 entry = variable_name[:attributes]
3486 list = entry[,list]
3487
3488 The type attributes are:
3489 s - String (default)
3490 d - Decimal
3491 x - Hexadecimal
3492 b - Boolean ([1yYtT|0nNfF])
3493 i - IP address
3494 m - MAC address
3495
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003496 The access attributes are:
3497 a - Any (default)
3498 r - Read-only
3499 o - Write-once
3500 c - Change-default
3501
Joe Hershberger71497d02012-12-11 22:16:31 -06003502 - CONFIG_ENV_FLAGS_LIST_DEFAULT
3503 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003504 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06003505
3506 - CONFIG_ENV_FLAGS_LIST_STATIC
3507 Define this to a list (string) to define validation that
3508 should be done if an entry is not found in the ".flags"
3509 environment variable. To override a setting in the static
3510 list, simply add an entry for the same variable name to the
3511 ".flags" variable.
3512
Joe Hershberger6db9fd42015-05-20 14:27:20 -05003513 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3514 regular expression. This allows multiple variables to define the same
3515 flags without explicitly listing them for each variable.
3516
Joe Hershberger6fe26c92012-12-11 22:16:34 -06003517- CONFIG_ENV_ACCESS_IGNORE_FORCE
3518 If defined, don't allow the -f switch to env set override variable
3519 access flags.
3520
Gabe Black3687fe42014-10-15 04:38:30 -06003521- CONFIG_USE_STDINT
3522 If stdint.h is available with your toolchain you can define this
3523 option to enable it. You can provide option 'USE_STDINT=1' when
3524 building U-Boot to enable this.
3525
wdenkc6097192002-11-03 00:24:07 +00003526The following definitions that deal with the placement and management
3527of environment data (variable area); in general, we support the
3528following configurations:
3529
Mike Frysinger63b8f122011-07-08 10:44:25 +00003530- CONFIG_BUILD_ENVCRC:
3531
3532 Builds up envcrc with the target environment so that external utils
3533 may easily extract it and embed it in final U-Boot images.
3534
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003535- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00003536
3537 Define this if the environment is in flash memory.
3538
3539 a) The environment occupies one whole flash sector, which is
3540 "embedded" in the text segment with the U-Boot code. This
3541 happens usually with "bottom boot sector" or "top boot
3542 sector" type flash chips, which have several smaller
3543 sectors at the start or the end. For instance, such a
3544 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3545 such a case you would place the environment in one of the
3546 4 kB sectors - with U-Boot code before and after it. With
3547 "top boot sector" type flash chips, you would put the
3548 environment in one of the last sectors, leaving a gap
3549 between U-Boot and the environment.
3550
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003551 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00003552
3553 Offset of environment data (variable area) to the
3554 beginning of flash memory; for instance, with bottom boot
3555 type flash chips the second sector can be used: the offset
3556 for this sector is given here.
3557
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003558 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00003559
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003560 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003561
3562 This is just another way to specify the start address of
3563 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003564 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00003565
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003566 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003567
3568 Size of the sector containing the environment.
3569
3570
3571 b) Sometimes flash chips have few, equal sized, BIG sectors.
3572 In such a case you don't want to spend a whole sector for
3573 the environment.
3574
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003575 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003576
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02003577 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003578 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00003579 of this flash sector for the environment. This saves
3580 memory for the RAM copy of the environment.
3581
3582 It may also save flash memory if you decide to use this
3583 when your environment is "embedded" within U-Boot code,
3584 since then the remainder of the flash sector could be used
3585 for U-Boot code. It should be pointed out that this is
3586 STRONGLY DISCOURAGED from a robustness point of view:
3587 updating the environment in flash makes it always
3588 necessary to erase the WHOLE sector. If something goes
3589 wrong before the contents has been restored from a copy in
3590 RAM, your target system will be dead.
3591
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003592 - CONFIG_ENV_ADDR_REDUND
3593 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00003594
wdenk4a5c8a72003-03-06 00:02:04 +00003595 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003596 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00003597 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00003598 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00003599
3600BE CAREFUL! Any changes to the flash layout, and some changes to the
3601source code will make it necessary to adapt <board>/u-boot.lds*
3602accordingly!
3603
3604
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02003605- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00003606
3607 Define this if you have some non-volatile memory device
3608 (NVRAM, battery buffered SRAM) which you want to use for the
3609 environment.
3610
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003611 - CONFIG_ENV_ADDR:
3612 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003613
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003614 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00003615 want to use for environment. It is assumed that this memory
3616 can just be read and written to, without any special
3617 provision.
3618
3619BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003620in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003621console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00003622U-Boot will hang.
3623
3624Please note that even with NVRAM we still use a copy of the
3625environment in RAM: we could work on NVRAM directly, but we want to
3626keep settings there always unmodified except somebody uses "saveenv"
3627to save the current settings.
3628
3629
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02003630- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00003631
3632 Use this if you have an EEPROM or similar serial access
3633 device and a driver for it.
3634
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003635 - CONFIG_ENV_OFFSET:
3636 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003637
3638 These two #defines specify the offset and size of the
3639 environment area within the total memory of your EEPROM.
3640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003641 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00003642 If defined, specified the chip address of the EEPROM device.
3643 The default address is zero.
3644
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01003645 - CONFIG_SYS_I2C_EEPROM_BUS:
3646 If defined, specified the i2c bus of the EEPROM device.
3647
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003648 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00003649 If defined, the number of bits used to address bytes in a
3650 single page in the EEPROM device. A 64 byte page, for example
3651 would require six bits.
3652
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003653 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00003654 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00003655 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00003656
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003657 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00003658 The length in bytes of the EEPROM memory array address. Note
3659 that this is NOT the chip address length!
3660
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003661 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00003662 EEPROM chips that implement "address overflow" are ones
3663 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
3664 address and the extra bits end up in the "chip address" bit
3665 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
3666 byte chips.
3667
3668 Note that we consider the length of the address field to
3669 still be one byte because the extra address bits are hidden
3670 in the chip address.
3671
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003672 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003673 The size in bytes of the EEPROM device.
3674
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003675 - CONFIG_ENV_EEPROM_IS_ON_I2C
3676 define this, if you have I2C and SPI activated, and your
3677 EEPROM, which holds the environment, is on the I2C bus.
3678
3679 - CONFIG_I2C_ENV_EEPROM_BUS
3680 if you have an Environment on an EEPROM reached over
3681 I2C muxes, you can define here, how to reach this
3682 EEPROM. For example:
3683
Heiko Schocher479a4cf2013-01-29 08:53:15 +01003684 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01003685
3686 EEPROM which holds the environment, is reached over
3687 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00003688
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02003689- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00003690
wdenk1ebf41e2004-01-02 14:00:00 +00003691 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00003692 want to use for the environment.
3693
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003694 - CONFIG_ENV_OFFSET:
3695 - CONFIG_ENV_ADDR:
3696 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00003697
3698 These three #defines specify the offset and size of the
3699 environment area within the total memory of your DataFlash placed
3700 at the specified address.
3701
Wu, Josh76db7bf2014-07-01 19:30:13 +08003702- CONFIG_ENV_IS_IN_SPI_FLASH:
3703
3704 Define this if you have a SPI Flash memory device which you
3705 want to use for the environment.
3706
3707 - CONFIG_ENV_OFFSET:
3708 - CONFIG_ENV_SIZE:
3709
3710 These two #defines specify the offset and size of the
3711 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3712 aligned to an erase sector boundary.
3713
3714 - CONFIG_ENV_SECT_SIZE:
3715
3716 Define the SPI flash's sector size.
3717
3718 - CONFIG_ENV_OFFSET_REDUND (optional):
3719
3720 This setting describes a second storage area of CONFIG_ENV_SIZE
3721 size used to hold a redundant copy of the environment data, so
3722 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003723 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Wu, Josh76db7bf2014-07-01 19:30:13 +08003724 aligned to an erase sector boundary.
3725
3726 - CONFIG_ENV_SPI_BUS (optional):
3727 - CONFIG_ENV_SPI_CS (optional):
3728
3729 Define the SPI bus and chip select. If not defined they will be 0.
3730
3731 - CONFIG_ENV_SPI_MAX_HZ (optional):
3732
3733 Define the SPI max work clock. If not defined then use 1MHz.
3734
3735 - CONFIG_ENV_SPI_MODE (optional):
3736
3737 Define the SPI work mode. If not defined then use SPI_MODE_3.
3738
Liu Gang85bcd732012-03-08 00:33:20 +00003739- CONFIG_ENV_IS_IN_REMOTE:
3740
3741 Define this if you have a remote memory space which you
3742 want to use for the local device's environment.
3743
3744 - CONFIG_ENV_ADDR:
3745 - CONFIG_ENV_SIZE:
3746
3747 These two #defines specify the address and size of the
3748 environment area within the remote memory space. The
3749 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00003750 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00003751
3752BE CAREFUL! For some special cases, the local device can not use
3753"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00003754environment stored in a remote NOR flash by SRIO or PCIE link,
3755but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00003756
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02003757- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00003758
3759 Define this if you have a NAND device which you want to use
3760 for the environment.
3761
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003762 - CONFIG_ENV_OFFSET:
3763 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00003764
3765 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05003766 area within the first NAND device. CONFIG_ENV_OFFSET must be
3767 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00003768
Scott Wood08239322010-09-17 14:38:37 -05003769 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003770
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02003771 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05003772 size used to hold a redundant copy of the environment data, so
3773 that there is a valid backup copy in case there is a power failure
Simon Glass5b9a5172016-10-02 18:00:58 -06003774 during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
Scott Wood08239322010-09-17 14:38:37 -05003775 aligned to an erase block boundary.
3776
3777 - CONFIG_ENV_RANGE (optional):
3778
3779 Specifies the length of the region in which the environment
3780 can be written. This should be a multiple of the NAND device's
3781 block size. Specifying a range with more erase blocks than
3782 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3783 the range to be avoided.
3784
3785 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003786
Scott Wood08239322010-09-17 14:38:37 -05003787 Enables support for dynamically retrieving the offset of the
3788 environment from block zero's out-of-band data. The
3789 "nand env.oob" command can be used to record this offset.
3790 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3791 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01003792
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02003793- CONFIG_NAND_ENV_DST
3794
3795 Defines address in RAM to which the nand_spl code should copy the
3796 environment. If redundant environment is used, it will be copied to
3797 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3798
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003799- CONFIG_ENV_IS_IN_UBI:
3800
3801 Define this if you have an UBI volume that you want to use for the
3802 environment. This has the benefit of wear-leveling the environment
3803 accesses, which is important on NAND.
3804
3805 - CONFIG_ENV_UBI_PART:
3806
3807 Define this to a string that is the mtd partition containing the UBI.
3808
3809 - CONFIG_ENV_UBI_VOLUME:
3810
3811 Define this to the name of the volume that you want to store the
3812 environment in.
3813
Joe Hershbergerdb14e862013-04-08 10:32:52 +00003814 - CONFIG_ENV_UBI_VOLUME_REDUND:
3815
3816 Define this to the name of another volume to store a second copy of
3817 the environment in. This will enable redundant environments in UBI.
3818 It is assumed that both volumes are in the same MTD partition.
3819
Joe Hershberger0c5faa82013-04-08 10:32:51 +00003820 - CONFIG_UBI_SILENCE_MSG
3821 - CONFIG_UBIFS_SILENCE_MSG
3822
3823 You will probably want to define these to avoid a really noisy system
3824 when storing the env in UBI.
3825
Wu, Josha7d0c872014-06-24 17:31:03 +08003826- CONFIG_ENV_IS_IN_FAT:
3827 Define this if you want to use the FAT file system for the environment.
3828
3829 - FAT_ENV_INTERFACE:
3830
3831 Define this to a string that is the name of the block device.
3832
Nicolae Rosia86811f22016-11-21 17:33:58 +02003833 - FAT_ENV_DEVICE_AND_PART:
Wu, Josha7d0c872014-06-24 17:31:03 +08003834
3835 Define this to a string to specify the partition of the device. It can
3836 be as following:
3837
3838 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3839 - "D:P": device D partition P. Error occurs if device D has no
3840 partition table.
3841 - "D:0": device D.
3842 - "D" or "D:": device D partition 1 if device D has partition
3843 table, or the whole device D if has no partition
3844 table.
3845 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003846 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08003847 partition table then means device D.
3848
3849 - FAT_ENV_FILE:
3850
3851 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003852 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08003853
3854 - CONFIG_FAT_WRITE:
Tom Rinid8532af2017-06-02 11:03:50 -04003855 This must be enabled. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08003856
Stephen Warreneedcacd2013-06-11 15:14:00 -06003857- CONFIG_ENV_IS_IN_MMC:
3858
3859 Define this if you have an MMC device which you want to use for the
3860 environment.
3861
3862 - CONFIG_SYS_MMC_ENV_DEV:
3863
3864 Specifies which MMC device the environment is stored in.
3865
3866 - CONFIG_SYS_MMC_ENV_PART (optional):
3867
3868 Specifies which MMC partition the environment is stored in. If not
3869 set, defaults to partition 0, the user area. Common values might be
3870 1 (first MMC boot partition), 2 (second MMC boot partition).
3871
3872 - CONFIG_ENV_OFFSET:
3873 - CONFIG_ENV_SIZE:
3874
3875 These two #defines specify the offset and size of the environment
3876 area within the specified MMC device.
3877
Stephen Warren24dc2032013-06-11 15:14:02 -06003878 If offset is positive (the usual case), it is treated as relative to
3879 the start of the MMC partition. If offset is negative, it is treated
3880 as relative to the end of the MMC partition. This can be useful if
3881 your board may be fitted with different MMC devices, which have
3882 different sizes for the MMC partitions, and you always want the
3883 environment placed at the very end of the partition, to leave the
3884 maximum possible space before it, to store other data.
3885
Stephen Warreneedcacd2013-06-11 15:14:00 -06003886 These two values are in units of bytes, but must be aligned to an
3887 MMC sector boundary.
3888
3889 - CONFIG_ENV_OFFSET_REDUND (optional):
3890
3891 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
3892 hold a redundant copy of the environment data. This provides a
3893 valid backup copy in case the other copy is corrupted, e.g. due
3894 to a power failure during a "saveenv" operation.
3895
Stephen Warren24dc2032013-06-11 15:14:02 -06003896 This value may also be positive or negative; this is handled in the
3897 same way as CONFIG_ENV_OFFSET.
3898
Stephen Warreneedcacd2013-06-11 15:14:00 -06003899 This value is also in units of bytes, but must also be aligned to
3900 an MMC sector boundary.
3901
3902 - CONFIG_ENV_SIZE_REDUND (optional):
3903
3904 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
3905 set. If this value is set, it must be set to the same value as
3906 CONFIG_ENV_SIZE.
3907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003908- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00003909
3910 Defines offset to the initial SPI buffer area in DPRAM. The
3911 area is used at an early stage (ROM part) if the environment
3912 is configured to reside in the SPI EEPROM: We need a 520 byte
3913 scratch DPRAM area. It is used between the two initialization
3914 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3915 to be a good choice since it makes it far enough from the
3916 start of the data area as well as from the stack pointer.
3917
Bruce Adleredecc942007-11-02 13:15:42 -07003918Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00003919has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02003920created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00003921until then to read environment variables.
3922
wdenk8dba0502003-03-31 16:34:49 +00003923The environment is protected by a CRC32 checksum. Before the monitor
3924is relocated into RAM, as a result of a bad CRC you will be working
3925with the compiled-in default environment - *silently*!!! [This is
3926necessary, because the first environment variable we need is the
3927"baudrate" setting for the console - if we have a bad CRC, we don't
3928have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00003929
3930Note: once the monitor has been relocated, then it will complain if
3931the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00003932use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00003933
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003934- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00003935 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00003936
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003937 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00003938 also needs to be defined.
3939
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003940- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00003941 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00003942
Ron Madriddfa028a2009-02-18 14:30:44 -08003943- CONFIG_NS16550_MIN_FUNCTIONS:
3944 Define this if you desire to only have use of the NS16550_init
3945 and NS16550_putc functions for the serial driver located at
3946 drivers/serial/ns16550.c. This option is useful for saving
3947 space for already greatly restricted images, including but not
3948 limited to NAND_SPL configurations.
3949
Simon Glass28a9e332012-11-30 13:01:18 +00003950- CONFIG_DISPLAY_BOARDINFO
3951 Display information about the board that U-Boot is running on
3952 when U-Boot starts up. The board function checkboard() is called
3953 to do this.
3954
Simon Glasse8822012012-11-30 13:01:19 +00003955- CONFIG_DISPLAY_BOARDINFO_LATE
3956 Similar to the previous option, but display this information
3957 later, once stdio is running and output goes to the LCD, if
3958 present.
3959
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02003960- CONFIG_BOARD_SIZE_LIMIT:
3961 Maximum size of the U-Boot image. When defined, the
3962 build system checks that the actual size does not
3963 exceed it.
3964
wdenkc6097192002-11-03 00:24:07 +00003965Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00003966---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00003967
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003968- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00003969 Cache Line Size of the CPU.
3970
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003971- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00003972 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00003973
wdenk9c53f402003-10-15 23:53:47 +00003974 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
3975 and RPXsuper) to be able to adjust the position of
3976 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00003977
Timur Tabid8f341c2011-08-04 18:03:41 -05003978- CONFIG_SYS_CCSRBAR_DEFAULT:
3979 Default (power-on reset) physical address of CCSR on Freescale
3980 PowerPC SOCs.
3981
3982- CONFIG_SYS_CCSRBAR:
3983 Virtual address of CCSR. On a 32-bit build, this is typically
3984 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3985
3986 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3987 for cross-platform code that uses that macro instead.
3988
3989- CONFIG_SYS_CCSRBAR_PHYS:
3990 Physical address of CCSR. CCSR can be relocated to a new
3991 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00003992 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05003993 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
3994 is typically relocated on 36-bit builds. It is recommended
3995 that this macro be defined via the _HIGH and _LOW macros:
3996
3997 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3998 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3999
4000- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004001 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4002 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004003 used in assembly code, so it must not contain typecasts or
4004 integer size suffixes (e.g. "ULL").
4005
4006- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4007 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4008 used in assembly code, so it must not contain typecasts or
4009 integer size suffixes (e.g. "ULL").
4010
4011- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4012 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4013 forced to a value that ensures that CCSR is not relocated.
4014
wdenk1272e232002-11-10 22:06:23 +00004015- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004016 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004017
4018 the default drive number (default value 0)
4019
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004020 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004021
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004022 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004023 (default value 1)
4024
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004025 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004026
wdenk4a5c8a72003-03-06 00:02:04 +00004027 defines the offset of register from address. It
4028 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004029 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004030
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004031 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4032 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004033 default value.
wdenk1272e232002-11-10 22:06:23 +00004034
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004035 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004036 fdc_hw_init() is called at the beginning of the FDC
4037 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004038 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004039 initializations.
wdenk1272e232002-11-10 22:06:23 +00004040
Macpaul Lind1e49942011-04-11 20:45:32 +00004041- CONFIG_IDE_AHB:
4042 Most IDE controllers were designed to be connected with PCI
4043 interface. Only few of them were designed for AHB interface.
4044 When software is doing ATA command and data transfer to
4045 IDE devices through IDE-AHB controller, some additional
4046 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004047 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004048
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004049- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004050 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004051 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004052
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004053- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004054
wdenkeb20ad32003-09-05 23:19:14 +00004055 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004056 initial data and stack; please note that this must be
4057 writable memory that is working WITHOUT special
4058 initialization, i. e. you CANNOT use normal RAM which
4059 will become available only after programming the
4060 memory controller and running certain initialization
4061 sequences.
4062
4063 U-Boot uses the following memory types:
4064 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4065 - MPC824X: data cache
4066 - PPC4xx: data cache
4067
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004068- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004069
4070 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004071 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4072 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004073 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004074 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Simon Glass9a6ac8b2016-10-02 18:01:06 -06004075 GENERATED_GBL_DATA_SIZE), and the initial stack is just
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004076 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4077 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004078
4079 Note:
4080 On the MPC824X (or other systems that use the data
4081 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004082 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004083 point to an otherwise UNUSED address space between
4084 the top of RAM and the start of the PCI space.
4085
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004086- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004087
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004088- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004089
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004090- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004091
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004092- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004093
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004094- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004095
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004096- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004097
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004098- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004099 SDRAM timing
4100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004101- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004102 periodic timer for refresh
4103
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004104- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004105
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004106- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4107 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4108 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4109 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004110 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4111
4112- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004113 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4114 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004115 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4116
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004117- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4118 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004119 Machine Mode Register and Memory Periodic Timer
4120 Prescaler definitions (SDRAM timing)
4121
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004122- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004123 enable I2C microcode relocation patch (MPC8xx);
4124 define relocation offset in DPRAM [DSP2]
4125
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004126- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004127 enable SMC microcode relocation patch (MPC8xx);
4128 define relocation offset in DPRAM [SMC1]
4129
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004130- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004131 enable SPI microcode relocation patch (MPC8xx);
4132 define relocation offset in DPRAM [SCC4]
4133
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004134- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004135 Offset of the bootmode word in DPRAM used by post
4136 (Power On Self Tests). This definition overrides
4137 #define'd default value in commproc.h resp.
4138 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004139
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004140- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4141 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4142 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4143 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4144 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4145 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4146 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4147 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004148 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004149
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004150- CONFIG_PCI_DISABLE_PCIE:
4151 Disable PCI-Express on systems where it is supported but not
4152 required.
4153
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004154- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004155 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004156 Don't do any setup work, presumably because someone or
4157 something has already done it, and we don't need to do it
4158 a second time. Useful for platforms that are pre-booted
4159 by coreboot or similar.
4160
Gabor Juhosb4458732013-05-30 07:06:12 +00004161- CONFIG_PCI_INDIRECT_BRIDGE:
4162 Enable support for indirect PCI bridges.
4163
Kumar Gala8975d7a2010-12-30 12:09:53 -06004164- CONFIG_SYS_SRIO:
4165 Chip has SRIO or not
4166
4167- CONFIG_SRIO1:
4168 Board has SRIO 1 port available
4169
4170- CONFIG_SRIO2:
4171 Board has SRIO 2 port available
4172
Liu Gang27afb9c2013-05-07 16:30:46 +08004173- CONFIG_SRIO_PCIE_BOOT_MASTER
4174 Board can support master function for Boot from SRIO and PCIE
4175
Kumar Gala8975d7a2010-12-30 12:09:53 -06004176- CONFIG_SYS_SRIOn_MEM_VIRT:
4177 Virtual Address of SRIO port 'n' memory region
4178
4179- CONFIG_SYS_SRIOn_MEM_PHYS:
4180 Physical Address of SRIO port 'n' memory region
4181
4182- CONFIG_SYS_SRIOn_MEM_SIZE:
4183 Size of SRIO port 'n' memory region
4184
Fabio Estevamf17e8782013-04-11 09:35:34 +00004185- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4186 Defined to tell the NAND controller that the NAND chip is using
4187 a 16 bit bus.
4188 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004189 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004190 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004191 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004192
4193- CONFIG_SYS_NDFC_EBC0_CFG
4194 Sets the EBC0_CFG register for the NDFC. If not defined
4195 a default value will be used.
4196
Ben Warren45657152006-09-07 16:50:54 -04004197- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004198 Get DDR timing information from an I2C EEPROM. Common
4199 with pluggable memory modules such as SODIMMs
4200
Ben Warren45657152006-09-07 16:50:54 -04004201 SPD_EEPROM_ADDRESS
4202 I2C address of the SPD EEPROM
4203
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004204- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004205 If SPD EEPROM is on an I2C bus other than the first
4206 one, specify here. Note that the value must resolve
4207 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004208
York Sune73cc042011-06-07 09:42:16 +08004209- CONFIG_SYS_DDR_RAW_TIMING
4210 Get DDR timing information from other than SPD. Common with
4211 soldered DDR chips onboard without SPD. DDR raw timing
4212 parameters are extracted from datasheet and hard-coded into
4213 header files or board specific files.
4214
York Sunbd495cf2011-09-16 13:21:35 -07004215- CONFIG_FSL_DDR_INTERACTIVE
4216 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4217
York Sun8ced0502015-01-06 13:18:55 -08004218- CONFIG_FSL_DDR_SYNC_REFRESH
4219 Enable sync of refresh for multiple controllers.
4220
York Sunb6a35f82015-03-19 09:30:28 -07004221- CONFIG_FSL_DDR_BIST
4222 Enable built-in memory test for Freescale DDR controllers.
4223
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004224- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004225 Only for 83xx systems. If specified, then DDR should
4226 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004227
wdenk6203e402004-04-18 10:13:26 +00004228- CONFIG_ETHER_ON_FEC[12]
4229 Define to enable FEC[12] on a 8xx series processor.
4230
4231- CONFIG_FEC[12]_PHY
4232 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004233 to the given FEC; i. e.
4234 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004235 means that the PHY with address 4 is connected to FEC1
4236
4237 When set to -1, means to probe for first available.
4238
4239- CONFIG_FEC[12]_PHY_NORXERR
4240 The PHY does not have a RXERR line (RMII only).
4241 (so program the FEC to ignore it).
4242
4243- CONFIG_RMII
4244 Enable RMII mode for all FECs.
4245 Note that this is a global option, we can't
4246 have one FEC in standard MII mode and another in RMII mode.
4247
wdenk20c98a62004-04-23 20:32:05 +00004248- CONFIG_CRC32_VERIFY
4249 Add a verify option to the crc32 command.
4250 The syntax is:
4251
4252 => crc32 -v <address> <count> <crc32>
4253
4254 Where address/count indicate a memory area
4255 and crc32 is the correct crc32 which the
4256 area should have.
4257
wdenk64519362004-07-11 17:40:54 +00004258- CONFIG_LOOPW
4259 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004260 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004261
stroesecc3af832004-12-16 18:46:55 +00004262- CONFIG_MX_CYCLIC
4263 Add the "mdc" and "mwc" memory commands. These are cyclic
4264 "md/mw" commands.
4265 Examples:
4266
wdenk07d7e6b2004-12-16 21:44:03 +00004267 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004268 This command will print 4 bytes (10,11,12,13) each 500 ms.
4269
wdenk07d7e6b2004-12-16 21:44:03 +00004270 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004271 This command will write 12345678 to address 100 all 10 ms.
4272
wdenk07d7e6b2004-12-16 21:44:03 +00004273 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004274 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004275
wdenk3d3d99f2005-04-04 12:44:11 +00004276- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004277 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004278 low level initializations (like setting up the memory
4279 controller) are omitted and/or U-Boot does not
4280 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004281
Wolfgang Denk302141d2010-11-27 23:30:56 +01004282 Normally this variable MUST NOT be defined. The only
4283 exception is when U-Boot is loaded (to RAM) by some
4284 other boot loader or by a debugger which performs
4285 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004286
Simon Glass90844072016-05-05 07:28:06 -06004287- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4288 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim7a203682016-07-20 22:56:12 +09004289 to be skipped. The normal CP15 init (such as enabling the
Simon Glass90844072016-05-05 07:28:06 -06004290 instruction cache) is still performed.
4291
Aneesh V552a3192011-07-13 05:11:07 +00004292- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004293 Modifies the behaviour of start.S when compiling a loader
4294 that is executed before the actual U-Boot. E.g. when
4295 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004296
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004297- CONFIG_TPL_BUILD
4298 Modifies the behaviour of start.S when compiling a loader
4299 that is executed after the SPL and before the actual U-Boot.
4300 It is loaded by the SPL.
4301
Ying Zhang0d4f5442013-05-20 14:07:23 +08004302- CONFIG_SYS_MPC85XX_NO_RESETVEC
4303 Only for 85xx systems. If this variable is specified, the section
4304 .resetvec is not kept and the section .bootpg is placed in the
4305 previous 4k of the .text section.
4306
Simon Glass17dabf02013-02-24 17:33:14 +00004307- CONFIG_ARCH_MAP_SYSMEM
4308 Generally U-Boot (and in particular the md command) uses
4309 effective address. It is therefore not necessary to regard
4310 U-Boot address as virtual addresses that need to be translated
4311 to physical addresses. However, sandbox requires this, since
4312 it maintains its own little RAM buffer which contains all
4313 addressable memory. This option causes some memory accesses
4314 to be mapped through map_sysmem() / unmap_sysmem().
4315
Simon Glassbfb59802013-02-14 04:18:54 +00004316- CONFIG_X86_RESET_VECTOR
4317 If defined, the x86 reset vector code is included. This is not
4318 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004319
Heiko Schocher2233e462013-11-04 14:05:00 +01004320- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4321 Enables the RTC32K OSC on AM33xx based plattforms
4322
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004323- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4324 Option to disable subpage write in NAND driver
4325 driver that uses this:
4326 drivers/mtd/nand/davinci_nand.c
4327
Timur Tabi275f4bb2011-11-22 09:21:25 -06004328Freescale QE/FMAN Firmware Support:
4329-----------------------------------
4330
4331The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4332loading of "firmware", which is encoded in the QE firmware binary format.
4333This firmware often needs to be loaded during U-Boot booting, so macros
4334are used to identify the storage device (NOR flash, SPI, etc) and the address
4335within that device.
4336
Zhao Qiang83a90842014-03-21 16:21:44 +08004337- CONFIG_SYS_FMAN_FW_ADDR
4338 The address in the storage device where the FMAN microcode is located. The
4339 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4340 is also specified.
4341
4342- CONFIG_SYS_QE_FW_ADDR
4343 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004344 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4345 is also specified.
4346
4347- CONFIG_SYS_QE_FMAN_FW_LENGTH
4348 The maximum possible size of the firmware. The firmware binary format
4349 has a field that specifies the actual size of the firmware, but it
4350 might not be possible to read any part of the firmware unless some
4351 local storage is allocated to hold the entire firmware first.
4352
4353- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4354 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4355 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4356 virtual address in NOR flash.
4357
4358- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4359 Specifies that QE/FMAN firmware is located in NAND flash.
4360 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4361
4362- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4363 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4364 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4365
Liu Gang1e084582012-03-08 00:33:18 +00004366- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4367 Specifies that QE/FMAN firmware is located in the remote (master)
4368 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004369 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4370 window->master inbound window->master LAW->the ucode address in
4371 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004372
J. German Rivera8ff14b72014-06-23 15:15:55 -07004373Freescale Layerscape Management Complex Firmware Support:
4374---------------------------------------------------------
4375The Freescale Layerscape Management Complex (MC) supports the loading of
4376"firmware".
4377This firmware often needs to be loaded during U-Boot booting, so macros
4378are used to identify the storage device (NOR flash, SPI, etc) and the address
4379within that device.
4380
4381- CONFIG_FSL_MC_ENET
4382 Enable the MC driver for Layerscape SoCs.
4383
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304384Freescale Layerscape Debug Server Support:
4385-------------------------------------------
4386The Freescale Layerscape Debug Server Support supports the loading of
4387"Debug Server firmware" and triggering SP boot-rom.
4388This firmware often needs to be loaded during U-Boot booting.
4389
York Sun928b6812015-12-07 11:08:58 -08004390- CONFIG_SYS_MC_RSV_MEM_ALIGN
4391 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304392
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004393Reproducible builds
4394-------------------
4395
4396In order to achieve reproducible builds, timestamps used in the U-Boot build
4397process have to be set to a fixed value.
4398
4399This is done using the SOURCE_DATE_EPOCH environment variable.
4400SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4401option for U-Boot or an environment variable in U-Boot.
4402
4403SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4404
wdenkc6097192002-11-03 00:24:07 +00004405Building the Software:
4406======================
4407
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004408Building U-Boot has been tested in several native build environments
4409and in many different cross environments. Of course we cannot support
4410all possibly existing versions of cross development tools in all
4411(potentially obsolete) versions. In case of tool chain problems we
4412recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4413which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004414
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004415If you are not using a native environment, it is assumed that you
4416have GNU cross compiling tools available in your path. In this case,
4417you must set the environment variable CROSS_COMPILE in your shell.
4418Note that no changes to the Makefile or any other source files are
4419necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004420
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004421 $ CROSS_COMPILE=ppc_4xx-
4422 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004423
Peter Tyserb06976d2009-03-13 18:54:51 -05004424Note: If you wish to generate Windows versions of the utilities in
4425 the tools directory you can use the MinGW toolchain
4426 (http://www.mingw.org). Set your HOST tools to the MinGW
4427 toolchain and execute 'make tools'. For example:
4428
4429 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4430
4431 Binaries such as tools/mkimage.exe will be created which can
4432 be executed on computers running Windows.
4433
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004434U-Boot is intended to be simple to build. After installing the
4435sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004436is done by typing:
4437
Holger Freyther7ba4e572014-08-04 09:26:05 +02004438 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004439
Holger Freyther7ba4e572014-08-04 09:26:05 +02004440where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00004441rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00004442
wdenk6c59edc2004-05-03 20:45:30 +00004443Note: for some board special configuration names may exist; check if
4444 additional information is available from the board vendor; for
4445 instance, the TQM823L systems are available without (standard)
4446 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004447 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00004448
Holger Freyther7ba4e572014-08-04 09:26:05 +02004449 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004450 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00004451
Holger Freyther7ba4e572014-08-04 09:26:05 +02004452 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00004453 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00004454
wdenk6c59edc2004-05-03 20:45:30 +00004455 etc.
wdenkc6097192002-11-03 00:24:07 +00004456
wdenkc6097192002-11-03 00:24:07 +00004457
wdenk6c59edc2004-05-03 20:45:30 +00004458Finally, type "make all", and you should get some working U-Boot
4459images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00004460
wdenk6c59edc2004-05-03 20:45:30 +00004461- "u-boot.bin" is a raw binary image
4462- "u-boot" is an image in ELF binary format
4463- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00004464
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004465By default the build is performed locally and the objects are saved
4466in the source directory. One of the two methods can be used to change
4467this behavior and build U-Boot to some external directory:
4468
44691. Add O= to the make command line invocations:
4470
4471 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004472 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004473 make O=/tmp/build all
4474
Timo Ketolac8c67602014-11-06 14:39:05 +020044752. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004476
Timo Ketolac8c67602014-11-06 14:39:05 +02004477 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004478 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02004479 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004480 make all
4481
Timo Ketolac8c67602014-11-06 14:39:05 +02004482Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004483variable.
4484
wdenkc6097192002-11-03 00:24:07 +00004485
wdenk6c59edc2004-05-03 20:45:30 +00004486Please be aware that the Makefiles assume you are using GNU make, so
4487for instance on NetBSD you might need to use "gmake" instead of
4488native "make".
wdenkc6097192002-11-03 00:24:07 +00004489
wdenkc6097192002-11-03 00:24:07 +00004490
wdenk6c59edc2004-05-03 20:45:30 +00004491If the system board that you have is not listed, then you will need
4492to port U-Boot to your hardware platform. To do this, follow these
4493steps:
wdenkc6097192002-11-03 00:24:07 +00004494
Phil Sutterc77b4882015-12-25 14:41:18 +010044951. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00004496 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01004497 the "Makefile" and a "<board>.c".
44982. Create a new configuration file "include/configs/<board>.h" for
4499 your board.
wdenk6c59edc2004-05-03 20:45:30 +000045003. If you're porting U-Boot to a new CPU, then also create a new
4501 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020045024. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000045035. Type "make", and you should get a working "u-boot.srec" file
4504 to be installed on your target system.
45056. Debug and solve any problems that might arise.
4506 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00004507
wdenkc6097192002-11-03 00:24:07 +00004508
wdenk6c59edc2004-05-03 20:45:30 +00004509Testing of U-Boot Modifications, Ports to New Hardware, etc.:
4510==============================================================
wdenkc6097192002-11-03 00:24:07 +00004511
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004512If you have modified U-Boot sources (for instance added a new board
4513or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00004514provide feedback to the other developers. The feedback normally takes
4515the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004516official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00004517
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004518But before you submit such a patch, please verify that your modifi-
4519cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00004520the supported boards compile WITHOUT ANY compiler warnings. To do so,
Simon Glassdc27def2016-07-27 20:33:08 -06004521just run the buildman script (tools/buildman/buildman), which will
4522configure and build U-Boot for ALL supported system. Be warned, this
4523will take a while. Please see the buildman README, or run 'buildman -H'
4524for documentation.
wdenkc6097192002-11-03 00:24:07 +00004525
Marian Balakowiczefe063f2006-09-07 17:25:40 +02004526
wdenk6c59edc2004-05-03 20:45:30 +00004527See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00004528
wdenkc6097192002-11-03 00:24:07 +00004529
wdenk6c59edc2004-05-03 20:45:30 +00004530Monitor Commands - Overview:
4531============================
wdenkc6097192002-11-03 00:24:07 +00004532
wdenk6c59edc2004-05-03 20:45:30 +00004533go - start application at address 'addr'
4534run - run commands in an environment variable
4535bootm - boot application image from memory
4536bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00004537bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00004538tftpboot- boot image via network using TFTP protocol
4539 and env variables "ipaddr" and "serverip"
4540 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00004541tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00004542rarpboot- boot image via network using RARP/TFTP protocol
4543diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
4544loads - load S-Record file over serial line
4545loadb - load binary file over serial line (kermit mode)
4546md - memory display
4547mm - memory modify (auto-incrementing)
4548nm - memory modify (constant address)
4549mw - memory write (fill)
4550cp - memory copy
4551cmp - memory compare
4552crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05004553i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00004554sspi - SPI utility commands
4555base - print or set address offset
4556printenv- print environment variables
4557setenv - set environment variables
4558saveenv - save environment variables to persistent storage
4559protect - enable or disable FLASH write protection
4560erase - erase FLASH memory
4561flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00004562nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00004563bdinfo - print Board Info structure
4564iminfo - print header information for application image
4565coninfo - print console devices and informations
4566ide - IDE sub-system
4567loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00004568loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00004569mtest - simple RAM test
4570icache - enable or disable instruction cache
4571dcache - enable or disable data cache
4572reset - Perform RESET of the CPU
4573echo - echo args to console
4574version - print monitor version
4575help - print online help
4576? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00004577
wdenkc6097192002-11-03 00:24:07 +00004578
wdenk6c59edc2004-05-03 20:45:30 +00004579Monitor Commands - Detailed Description:
4580========================================
wdenkc6097192002-11-03 00:24:07 +00004581
wdenk6c59edc2004-05-03 20:45:30 +00004582TODO.
wdenkc6097192002-11-03 00:24:07 +00004583
wdenk6c59edc2004-05-03 20:45:30 +00004584For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00004585
4586
wdenk6c59edc2004-05-03 20:45:30 +00004587Environment Variables:
4588======================
wdenkc6097192002-11-03 00:24:07 +00004589
wdenk6c59edc2004-05-03 20:45:30 +00004590U-Boot supports user configuration using Environment Variables which
4591can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00004592
wdenk6c59edc2004-05-03 20:45:30 +00004593Environment Variables are set using "setenv", printed using
4594"printenv", and saved to Flash using "saveenv". Using "setenv"
4595without a value can be used to delete a variable from the
4596environment. As long as you don't save the environment you are
4597working with an in-memory copy. In case the Flash area containing the
4598environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00004599
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004600Some configuration options can be set using Environment Variables.
4601
4602List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00004603
wdenk6c59edc2004-05-03 20:45:30 +00004604 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00004605
wdenk6c59edc2004-05-03 20:45:30 +00004606 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00004607
wdenk6c59edc2004-05-03 20:45:30 +00004608 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00004609
wdenk6c59edc2004-05-03 20:45:30 +00004610 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00004611
wdenk6c59edc2004-05-03 20:45:30 +00004612 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00004613
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004614 bootm_low - Memory range available for image processing in the bootm
4615 command can be restricted. This variable is given as
4616 a hexadecimal number and defines lowest address allowed
4617 for use by the bootm command. See also "bootm_size"
4618 environment variable. Address defined by "bootm_low" is
4619 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00004620 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4621 bootm_mapsize.
4622
Wolfgang Denk092ae952011-10-26 10:21:21 +00004623 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00004624 This variable is given as a hexadecimal number and it
4625 defines the size of the memory region starting at base
4626 address bootm_low that is accessible by the Linux kernel
4627 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
4628 as the default value if it is defined, and bootm_size is
4629 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02004630
4631 bootm_size - Memory range available for image processing in the bootm
4632 command can be restricted. This variable is given as
4633 a hexadecimal number and defines the size of the region
4634 allowed for use by the bootm command. See also "bootm_low"
4635 environment variable.
4636
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02004637 updatefile - Location of the software update file on a TFTP server, used
4638 by the automatic software update feature. Please refer to
4639 documentation in doc/README.update for more details.
4640
wdenk6c59edc2004-05-03 20:45:30 +00004641 autoload - if set to "no" (any string beginning with 'n'),
4642 "bootp" will just load perform a lookup of the
4643 configuration from the BOOTP server, but not try to
4644 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00004645
wdenk6c59edc2004-05-03 20:45:30 +00004646 autostart - if set to "yes", an image loaded using the "bootp",
4647 "rarpboot", "tftpboot" or "diskboot" commands will
4648 be automatically started (by internally calling
4649 "bootm")
wdenkc6097192002-11-03 00:24:07 +00004650
wdenk6c59edc2004-05-03 20:45:30 +00004651 If set to "no", a standalone image passed to the
4652 "bootm" command will be copied to the load address
4653 (and eventually uncompressed), but NOT be started.
4654 This can be used to load and uncompress arbitrary
4655 data.
wdenkc6097192002-11-03 00:24:07 +00004656
David A. Longd558a4e2011-07-09 16:40:19 -04004657 fdt_high - if set this restricts the maximum address that the
4658 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00004659 For example, if you have a system with 1 GB memory
4660 at physical address 0x10000000, while Linux kernel
4661 only recognizes the first 704 MB as low memory, you
4662 may need to set fdt_high as 0x3C000000 to have the
4663 device tree blob be copied to the maximum address
4664 of the 704 MB low memory, so that Linux kernel can
4665 access it during the boot procedure.
4666
David A. Longd558a4e2011-07-09 16:40:19 -04004667 If this is set to the special value 0xFFFFFFFF then
4668 the fdt will not be copied at all on boot. For this
4669 to work it must reside in writable memory, have
4670 sufficient padding on the end of it for u-boot to
4671 add the information it needs into it, and the memory
4672 must be accessible by the kernel.
4673
Simon Glassdc6fa642011-10-24 19:15:34 +00004674 fdtcontroladdr- if set this is the address of the control flattened
4675 device tree used by U-Boot when CONFIG_OF_CONTROL is
4676 defined.
4677
wdenk0e2bd9c2004-06-06 21:51:03 +00004678 i2cfast - (PPC405GP|PPC405EP only)
4679 if set to 'y' configures Linux I2C driver for fast
4680 mode (400kHZ). This environment variable is used in
4681 initialization code. So, for changes to be effective
4682 it must be saved and board must be reset.
4683
wdenk6c59edc2004-05-03 20:45:30 +00004684 initrd_high - restrict positioning of initrd images:
4685 If this variable is not set, initrd images will be
4686 copied to the highest possible address in RAM; this
4687 is usually what you want since it allows for
4688 maximum initrd size. If for some reason you want to
4689 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004690 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00004691 variable to a value of "no" or "off" or "0".
4692 Alternatively, you can set it to a maximum upper
4693 address to use (U-Boot will still check that it
4694 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00004695
wdenk6c59edc2004-05-03 20:45:30 +00004696 For instance, when you have a system with 16 MB
4697 RAM, and want to reserve 4 MB from use by Linux,
4698 you can do this by adding "mem=12M" to the value of
4699 the "bootargs" variable. However, now you must make
4700 sure that the initrd image is placed in the first
4701 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00004702
wdenk6c59edc2004-05-03 20:45:30 +00004703 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00004704
wdenk6c59edc2004-05-03 20:45:30 +00004705 If you set initrd_high to 0xFFFFFFFF, this is an
4706 indication to U-Boot that all addresses are legal
4707 for the Linux kernel, including addresses in flash
4708 memory. In this case U-Boot will NOT COPY the
4709 ramdisk at all. This may be useful to reduce the
4710 boot time on your system, but requires that this
4711 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00004712
wdenk6c59edc2004-05-03 20:45:30 +00004713 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00004714
wdenk6c59edc2004-05-03 20:45:30 +00004715 loadaddr - Default load address for commands like "bootp",
4716 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00004717
wdenk6c59edc2004-05-03 20:45:30 +00004718 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00004719
wdenk6c59edc2004-05-03 20:45:30 +00004720 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00004721
wdenk6c59edc2004-05-03 20:45:30 +00004722 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00004723
wdenk6c59edc2004-05-03 20:45:30 +00004724 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00004725
wdenk6c59edc2004-05-03 20:45:30 +00004726 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00004727
Mike Frysingera23230c2011-10-02 10:01:27 +00004728 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00004729
Mike Frysingera23230c2011-10-02 10:01:27 +00004730 ethact - controls which interface is currently active.
4731 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00004732
Heiko Schocherc5e84052010-07-20 17:45:02 +02004733 => setenv ethact FEC
4734 => ping 192.168.0.1 # traffic sent on FEC
4735 => setenv ethact SCC
4736 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00004737
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01004738 ethrotate - When set to "no" U-Boot does not go through all
4739 available network interfaces.
4740 It just stays at the currently selected interface.
4741
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004742 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00004743 either succeed or fail without retrying.
4744 When set to "once" the network operation will
4745 fail when all the available network interfaces
4746 are tried once without success.
4747 Useful on scripts which control the retry operation
4748 themselves.
wdenkc6097192002-11-03 00:24:07 +00004749
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01004750 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01004751
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004752 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07004753 changing the console to be empty. If "yes" it will be
4754 made silent. If "no" it will not be made silent. If
4755 unset, then it will be made silent if the U-Boot console
4756 is silent.
4757
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004758 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02004759 UDP source port.
4760
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004761 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02004762 destination port instead of the Well Know Port 69.
4763
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004764 tftpblocksize - Block size to use for TFTP transfers; if not set,
4765 we use the TFTP server's default block size
4766
4767 tftptimeout - Retransmission timeout for TFTP packets (in milli-
4768 seconds, minimum value is 1000 = 1 second). Defines
4769 when a packet is considered to be lost so it has to
4770 be retransmitted. The default is 5000 = 5 seconds.
4771 Lowering this value may make downloads succeed
4772 faster in networks with high packet loss rates or
4773 with unreliable TFTP servers.
4774
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02004775 tftptimeoutcountmax - maximum count of TFTP timeouts (no
4776 unit, minimum value = 0). Defines how many timeouts
4777 can happen during a single file transfer before that
4778 transfer is aborted. The default is 10, and 0 means
4779 'no timeouts allowed'. Increasing this value may help
4780 downloads succeed with high packet loss rates, or with
4781 unreliable TFTP servers or client hardware.
4782
Wolfgang Denkb233bd72010-01-17 23:55:53 +01004783 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004784 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00004785 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00004786
Alexandre Messier15971322016-02-01 17:08:57 -05004787 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
4788 Unsigned value, in milliseconds. If not set, the period will
4789 be either the default (28000), or a value based on
4790 CONFIG_NET_RETRY_COUNT, if defined. This value has
4791 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
4792
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004793The following image location variables contain the location of images
4794used in booting. The "Image" column gives the role of the image and is
4795not an environment variable name. The other columns are environment
4796variable names. "File Name" gives the name of the file on a TFTP
4797server, "RAM Address" gives the location in RAM the image will be
4798loaded to, and "Flash Location" gives the image's address in NOR
4799flash or offset in NAND flash.
4800
4801*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03004802boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004803boards use these variables for other purposes.
4804
Wolfgang Denk092ae952011-10-26 10:21:21 +00004805Image File Name RAM Address Flash Location
4806----- --------- ----------- --------------
4807u-boot u-boot u-boot_addr_r u-boot_addr
4808Linux kernel bootfile kernel_addr_r kernel_addr
4809device tree blob fdtfile fdt_addr_r fdt_addr
4810ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00004811
wdenk6c59edc2004-05-03 20:45:30 +00004812The following environment variables may be used and automatically
4813updated by the network boot commands ("bootp" and "rarpboot"),
4814depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00004815
wdenk6c59edc2004-05-03 20:45:30 +00004816 bootfile - see above
4817 dnsip - IP address of your Domain Name Server
4818 dnsip2 - IP address of your secondary Domain Name Server
4819 gatewayip - IP address of the Gateway (Router) to use
4820 hostname - Target hostname
4821 ipaddr - see above
4822 netmask - Subnet Mask
4823 rootpath - Pathname of the root filesystem on the NFS server
4824 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00004825
wdenk145d2c12004-04-15 21:48:45 +00004826
wdenk6c59edc2004-05-03 20:45:30 +00004827There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004828
wdenk6c59edc2004-05-03 20:45:30 +00004829 serial# - contains hardware identification information such
4830 as type string and/or serial number
4831 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00004832
wdenk6c59edc2004-05-03 20:45:30 +00004833These variables can be set only once (usually during manufacturing of
4834the board). U-Boot refuses to delete or overwrite these variables
4835once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00004836
4837
wdenk6c59edc2004-05-03 20:45:30 +00004838Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00004839
wdenk6c59edc2004-05-03 20:45:30 +00004840 ver - Contains the U-Boot version string as printed
4841 with the "version" command. This variable is
4842 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00004843
wdenkc6097192002-11-03 00:24:07 +00004844
wdenk6c59edc2004-05-03 20:45:30 +00004845Please note that changes to some configuration parameters may take
4846only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00004847
stroeseb9c17c52003-04-04 15:53:41 +00004848
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004849Callback functions for environment variables:
4850---------------------------------------------
4851
4852For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004853when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004854be associated with arbitrary variables. On creation, overwrite, or
4855deletion, the callback will provide the opportunity for some side
4856effect to happen or for the change to be rejected.
4857
4858The callbacks are named and associated with a function using the
4859U_BOOT_ENV_CALLBACK macro in your board or driver code.
4860
4861These callbacks are associated with variables in one of two ways. The
4862static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4863in the board configuration to a string that defines a list of
4864associations. The list must be in the following format:
4865
4866 entry = variable_name[:callback_name]
4867 list = entry[,list]
4868
4869If the callback name is not specified, then the callback is deleted.
4870Spaces are also allowed anywhere in the list.
4871
4872Callbacks can also be associated by defining the ".callbacks" variable
4873with the same list format above. Any association in ".callbacks" will
4874override any association in the static list. You can define
4875CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004876".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004877
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004878If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4879regular expression. This allows multiple variables to be connected to
4880the same callback without explicitly listing them all out.
4881
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06004882
wdenk6c59edc2004-05-03 20:45:30 +00004883Command Line Parsing:
4884=====================
stroeseb9c17c52003-04-04 15:53:41 +00004885
wdenk6c59edc2004-05-03 20:45:30 +00004886There are two different command line parsers available with U-Boot:
4887the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00004888
wdenk6c59edc2004-05-03 20:45:30 +00004889Old, simple command line parser:
4890--------------------------------
wdenkc6097192002-11-03 00:24:07 +00004891
wdenk6c59edc2004-05-03 20:45:30 +00004892- supports environment variables (through setenv / saveenv commands)
4893- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004894- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00004895- special characters ('$', ';') can be escaped by prefixing with '\',
4896 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01004897 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00004898- You can also escape text by enclosing in single apostrophes, for example:
4899 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00004900
wdenk6c59edc2004-05-03 20:45:30 +00004901Hush shell:
4902-----------
wdenkf4688a22003-05-28 08:06:31 +00004903
wdenk6c59edc2004-05-03 20:45:30 +00004904- similar to Bourne shell, with control structures like
4905 if...then...else...fi, for...do...done; while...do...done,
4906 until...do...done, ...
4907- supports environment ("global") variables (through setenv / saveenv
4908 commands) and local shell variables (through standard shell syntax
4909 "name=value"); only environment variables can be used with "run"
4910 command
wdenkf4688a22003-05-28 08:06:31 +00004911
wdenk6c59edc2004-05-03 20:45:30 +00004912General rules:
4913--------------
wdenkf4688a22003-05-28 08:06:31 +00004914
wdenk6c59edc2004-05-03 20:45:30 +00004915(1) If a command line (or an environment variable executed by a "run"
4916 command) contains several commands separated by semicolon, and
4917 one of these commands fails, then the remaining commands will be
4918 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00004919
wdenk6c59edc2004-05-03 20:45:30 +00004920(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004921 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00004922 command will cause "run" to terminate, i. e. the remaining
4923 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00004924
wdenk6c59edc2004-05-03 20:45:30 +00004925Note for Redundant Ethernet Interfaces:
4926=======================================
wdenkf4688a22003-05-28 08:06:31 +00004927
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004928Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00004929such configurations and is capable of automatic selection of a
4930"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00004931
wdenk6c59edc2004-05-03 20:45:30 +00004932Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
4933MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4934"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00004935
wdenk6c59edc2004-05-03 20:45:30 +00004936If the network interface stores some valid MAC address (for instance
4937in SROM), this is used as default address if there is NO correspon-
4938ding setting in the environment; if the corresponding environment
4939variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00004940
wdenk6c59edc2004-05-03 20:45:30 +00004941o If the SROM has a valid MAC address, and there is no address in the
4942 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00004943
wdenk6c59edc2004-05-03 20:45:30 +00004944o If there is no valid address in the SROM, and a definition in the
4945 environment exists, then the value from the environment variable is
4946 used.
wdenkc6097192002-11-03 00:24:07 +00004947
wdenk6c59edc2004-05-03 20:45:30 +00004948o If both the SROM and the environment contain a MAC address, and
4949 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00004950
wdenk6c59edc2004-05-03 20:45:30 +00004951o If both the SROM and the environment contain a MAC address, and the
4952 addresses differ, the value from the environment is used and a
4953 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00004954
wdenk6c59edc2004-05-03 20:45:30 +00004955o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05004956 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4957 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00004958
Ben Warren6db991a2010-04-26 11:11:46 -07004959If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00004960will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07004961may be skipped by setting the appropriate 'ethmacskip' environment variable.
4962The naming convention is as follows:
4963"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00004964
wdenk6c59edc2004-05-03 20:45:30 +00004965Image Formats:
4966==============
wdenkc6097192002-11-03 00:24:07 +00004967
Marian Balakowicz18710b82008-03-12 12:13:13 +01004968U-Boot is capable of booting (and performing other auxiliary operations on)
4969images in two formats:
4970
4971New uImage format (FIT)
4972-----------------------
4973
4974Flexible and powerful format based on Flattened Image Tree -- FIT (similar
4975to Flattened Device Tree). It allows the use of images with multiple
4976components (several kernels, ramdisks, etc.), with contents protected by
4977SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
4978
4979
4980Old uImage format
4981-----------------
4982
4983Old image format is based on binary files which can be basically anything,
4984preceded by a special header; see the definitions in include/image.h for
4985details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00004986
wdenk6c59edc2004-05-03 20:45:30 +00004987* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4988 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05004989 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4990 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4991 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02004992* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004993 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4994 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00004995* Compression Type (uncompressed, gzip, bzip2)
4996* Load Address
4997* Entry Point
4998* Image Name
4999* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005000
wdenk6c59edc2004-05-03 20:45:30 +00005001The header is marked by a special Magic Number, and both the header
5002and the data portions of the image are secured against corruption by
5003CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005004
wdenkc6097192002-11-03 00:24:07 +00005005
wdenk6c59edc2004-05-03 20:45:30 +00005006Linux Support:
5007==============
wdenkc6097192002-11-03 00:24:07 +00005008
wdenk6c59edc2004-05-03 20:45:30 +00005009Although U-Boot should support any OS or standalone application
5010easily, the main focus has always been on Linux during the design of
5011U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005012
wdenk6c59edc2004-05-03 20:45:30 +00005013U-Boot includes many features that so far have been part of some
5014special "boot loader" code within the Linux kernel. Also, any
5015"initrd" images to be used are no longer part of one big Linux image;
5016instead, kernel and "initrd" are separate images. This implementation
5017serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005018
wdenk6c59edc2004-05-03 20:45:30 +00005019- the same features can be used for other OS or standalone
5020 applications (for instance: using compressed images to reduce the
5021 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005022
wdenk6c59edc2004-05-03 20:45:30 +00005023- it becomes much easier to port new Linux kernel versions because
5024 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk6c59edc2004-05-03 20:45:30 +00005026- the same Linux kernel image can now be used with different "initrd"
5027 images; of course this also means that different kernel images can
5028 be run with the same "initrd". This makes testing easier (you don't
5029 have to build a new "zImage.initrd" Linux image when you just
5030 change a file in your "initrd"). Also, a field-upgrade of the
5031 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005032
wdenkc6097192002-11-03 00:24:07 +00005033
wdenk6c59edc2004-05-03 20:45:30 +00005034Linux HOWTO:
5035============
wdenkc6097192002-11-03 00:24:07 +00005036
wdenk6c59edc2004-05-03 20:45:30 +00005037Porting Linux to U-Boot based systems:
5038---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk6c59edc2004-05-03 20:45:30 +00005040U-Boot cannot save you from doing all the necessary modifications to
5041configure the Linux device drivers for use with your target hardware
5042(no, we don't intend to provide a full virtual machine interface to
5043Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005044
Stefan Roese88fbf932010-04-15 16:07:28 +02005045But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005046
wdenk6c59edc2004-05-03 20:45:30 +00005047Just make sure your machine specific header file (for instance
5048include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005049Information structure as we define in include/asm-<arch>/u-boot.h,
5050and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005051as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005052
Simon Glassd097e592014-06-11 23:29:46 -06005053Note that U-Boot now has a driver model, a unified model for drivers.
5054If you are adding a new driver, plumb it into driver model. If there
5055is no uclass available, you are encouraged to create one. See
5056doc/driver-model.
5057
wdenkc6097192002-11-03 00:24:07 +00005058
wdenk6c59edc2004-05-03 20:45:30 +00005059Configuring the Linux kernel:
5060-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005061
wdenk6c59edc2004-05-03 20:45:30 +00005062No specific requirements for U-Boot. Make sure you have some root
5063device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005064
wdenkc6097192002-11-03 00:24:07 +00005065
wdenk6c59edc2004-05-03 20:45:30 +00005066Building a Linux Image:
5067-----------------------
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5070not used. If you use recent kernel source, a new build target
5071"uImage" will exist which automatically builds an image usable by
5072U-Boot. Most older kernels also have support for a "pImage" target,
5073which was introduced for our predecessor project PPCBoot and uses a
5074100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005075
wdenk6c59edc2004-05-03 20:45:30 +00005076Example:
wdenkc6097192002-11-03 00:24:07 +00005077
Holger Freyther7ba4e572014-08-04 09:26:05 +02005078 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005079 make oldconfig
5080 make dep
5081 make uImage
wdenkc6097192002-11-03 00:24:07 +00005082
wdenk6c59edc2004-05-03 20:45:30 +00005083The "uImage" build target uses a special tool (in 'tools/mkimage') to
5084encapsulate a compressed Linux kernel image with header information,
5085CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005086
wdenk6c59edc2004-05-03 20:45:30 +00005087* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005088
wdenk6c59edc2004-05-03 20:45:30 +00005089* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005090
wdenk6c59edc2004-05-03 20:45:30 +00005091 ${CROSS_COMPILE}-objcopy -O binary \
5092 -R .note -R .comment \
5093 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005094
wdenk6c59edc2004-05-03 20:45:30 +00005095* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005096
wdenk6c59edc2004-05-03 20:45:30 +00005097 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005098
wdenk6c59edc2004-05-03 20:45:30 +00005099* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005100
wdenk6c59edc2004-05-03 20:45:30 +00005101 mkimage -A ppc -O linux -T kernel -C gzip \
5102 -a 0 -e 0 -n "Linux Kernel Image" \
5103 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005104
wdenkc6097192002-11-03 00:24:07 +00005105
wdenk6c59edc2004-05-03 20:45:30 +00005106The "mkimage" tool can also be used to create ramdisk images for use
5107with U-Boot, either separated from the Linux kernel image, or
5108combined into one file. "mkimage" encapsulates the images with a 64
5109byte header containing information about target architecture,
5110operating system, image type, compression method, entry points, time
5111stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk6c59edc2004-05-03 20:45:30 +00005113"mkimage" can be called in two ways: to verify existing images and
5114print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005115
wdenk6c59edc2004-05-03 20:45:30 +00005116In the first form (with "-l" option) mkimage lists the information
5117contained in the header of an existing U-Boot image; this includes
5118checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005119
wdenk6c59edc2004-05-03 20:45:30 +00005120 tools/mkimage -l image
5121 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005122
wdenk6c59edc2004-05-03 20:45:30 +00005123The second form (with "-d" option) is used to build a U-Boot image
5124from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005125
wdenk6c59edc2004-05-03 20:45:30 +00005126 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5127 -n name -d data_file image
5128 -A ==> set architecture to 'arch'
5129 -O ==> set operating system to 'os'
5130 -T ==> set image type to 'type'
5131 -C ==> set compression type 'comp'
5132 -a ==> set load address to 'addr' (hex)
5133 -e ==> set entry point to 'ep' (hex)
5134 -n ==> set image name to 'name'
5135 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005136
wdenkcd914452004-05-29 16:53:29 +00005137Right now, all Linux kernels for PowerPC systems use the same load
5138address (0x00000000), but the entry point address depends on the
5139kernel version:
wdenkc6097192002-11-03 00:24:07 +00005140
wdenk6c59edc2004-05-03 20:45:30 +00005141- 2.2.x kernels have the entry point at 0x0000000C,
5142- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005143
wdenk6c59edc2004-05-03 20:45:30 +00005144So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005145
wdenk6c59edc2004-05-03 20:45:30 +00005146 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5147 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005148 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005149 > examples/uImage.TQM850L
5150 Image Name: 2.4.4 kernel for TQM850L
5151 Created: Wed Jul 19 02:34:59 2000
5152 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5153 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5154 Load Address: 0x00000000
5155 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005156
wdenk6c59edc2004-05-03 20:45:30 +00005157To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005158
wdenk6c59edc2004-05-03 20:45:30 +00005159 -> tools/mkimage -l examples/uImage.TQM850L
5160 Image Name: 2.4.4 kernel for TQM850L
5161 Created: Wed Jul 19 02:34:59 2000
5162 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5163 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5164 Load Address: 0x00000000
5165 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk6c59edc2004-05-03 20:45:30 +00005167NOTE: for embedded systems where boot time is critical you can trade
5168speed for memory and install an UNCOMPRESSED image instead: this
5169needs more space in Flash, but boots much faster since it does not
5170need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005171
Stefan Roese88fbf932010-04-15 16:07:28 +02005172 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005173 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5174 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005175 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005176 > examples/uImage.TQM850L-uncompressed
5177 Image Name: 2.4.4 kernel for TQM850L
5178 Created: Wed Jul 19 02:34:59 2000
5179 Image Type: PowerPC Linux Kernel Image (uncompressed)
5180 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5181 Load Address: 0x00000000
5182 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005183
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk6c59edc2004-05-03 20:45:30 +00005185Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5186when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005187
wdenk6c59edc2004-05-03 20:45:30 +00005188 -> tools/mkimage -n 'Simple Ramdisk Image' \
5189 > -A ppc -O linux -T ramdisk -C gzip \
5190 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5191 Image Name: Simple Ramdisk Image
5192 Created: Wed Jan 12 14:01:50 2000
5193 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5194 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5195 Load Address: 0x00000000
5196 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005197
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005198The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5199option performs the converse operation of the mkimage's second form (the "-d"
5200option). Given an image built by mkimage, the dumpimage extracts a "data file"
5201from the image:
5202
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005203 tools/dumpimage -i image -T type -p position data_file
5204 -i ==> extract from the 'image' a specific 'data_file'
5205 -T ==> set image type to 'type'
5206 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005207
wdenkc6097192002-11-03 00:24:07 +00005208
wdenk6c59edc2004-05-03 20:45:30 +00005209Installing a Linux Image:
5210-------------------------
wdenkc6097192002-11-03 00:24:07 +00005211
wdenk6c59edc2004-05-03 20:45:30 +00005212To downloading a U-Boot image over the serial (console) interface,
5213you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005216
wdenk6c59edc2004-05-03 20:45:30 +00005217The 'objcopy' does not understand the information in the U-Boot
5218image header, so the resulting S-Record file will be relative to
5219address 0x00000000. To load it to a given address, you need to
5220specify the target address as 'offset' parameter with the 'loads'
5221command.
wdenkc6097192002-11-03 00:24:07 +00005222
wdenk6c59edc2004-05-03 20:45:30 +00005223Example: install the image to address 0x40100000 (which on the
5224TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005225
wdenk6c59edc2004-05-03 20:45:30 +00005226 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005227
wdenk6c59edc2004-05-03 20:45:30 +00005228 .......... done
5229 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk6c59edc2004-05-03 20:45:30 +00005231 => loads 40100000
5232 ## Ready for S-Record download ...
5233 ~>examples/image.srec
5234 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5235 ...
5236 15989 15990 15991 15992
5237 [file transfer complete]
5238 [connected]
5239 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005240
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk6c59edc2004-05-03 20:45:30 +00005242You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005243this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005244corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005245
wdenk6c59edc2004-05-03 20:45:30 +00005246 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005247
wdenk6c59edc2004-05-03 20:45:30 +00005248 ## Checking Image at 40100000 ...
5249 Image Name: 2.2.13 for initrd on TQM850L
5250 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5251 Data Size: 335725 Bytes = 327 kB = 0 MB
5252 Load Address: 00000000
5253 Entry Point: 0000000c
5254 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005255
5256
wdenk6c59edc2004-05-03 20:45:30 +00005257Boot Linux:
5258-----------
wdenkc6097192002-11-03 00:24:07 +00005259
wdenk6c59edc2004-05-03 20:45:30 +00005260The "bootm" command is used to boot an application that is stored in
5261memory (RAM or Flash). In case of a Linux kernel image, the contents
5262of the "bootargs" environment variable is passed to the kernel as
5263parameters. You can check and modify this variable using the
5264"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005265
wdenkc6097192002-11-03 00:24:07 +00005266
wdenk6c59edc2004-05-03 20:45:30 +00005267 => printenv bootargs
5268 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005269
wdenk6c59edc2004-05-03 20:45:30 +00005270 => 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 +00005271
wdenk6c59edc2004-05-03 20:45:30 +00005272 => printenv bootargs
5273 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 +00005274
wdenk6c59edc2004-05-03 20:45:30 +00005275 => bootm 40020000
5276 ## Booting Linux kernel at 40020000 ...
5277 Image Name: 2.2.13 for NFS on TQM850L
5278 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5279 Data Size: 381681 Bytes = 372 kB = 0 MB
5280 Load Address: 00000000
5281 Entry Point: 0000000c
5282 Verifying Checksum ... OK
5283 Uncompressing Kernel Image ... OK
5284 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
5285 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5286 time_init: decrementer frequency = 187500000/60
5287 Calibrating delay loop... 49.77 BogoMIPS
5288 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5289 ...
wdenkc6097192002-11-03 00:24:07 +00005290
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005291If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005292the memory addresses of both the kernel and the initrd image (PPBCOOT
5293format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005294
wdenk6c59edc2004-05-03 20:45:30 +00005295 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005296
wdenk6c59edc2004-05-03 20:45:30 +00005297 ## Checking Image at 40100000 ...
5298 Image Name: 2.2.13 for initrd on TQM850L
5299 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5300 Data Size: 335725 Bytes = 327 kB = 0 MB
5301 Load Address: 00000000
5302 Entry Point: 0000000c
5303 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005304
wdenk6c59edc2004-05-03 20:45:30 +00005305 ## Checking Image at 40200000 ...
5306 Image Name: Simple Ramdisk Image
5307 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5308 Data Size: 566530 Bytes = 553 kB = 0 MB
5309 Load Address: 00000000
5310 Entry Point: 00000000
5311 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005312
wdenk6c59edc2004-05-03 20:45:30 +00005313 => bootm 40100000 40200000
5314 ## Booting Linux kernel at 40100000 ...
5315 Image Name: 2.2.13 for initrd on TQM850L
5316 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5317 Data Size: 335725 Bytes = 327 kB = 0 MB
5318 Load Address: 00000000
5319 Entry Point: 0000000c
5320 Verifying Checksum ... OK
5321 Uncompressing Kernel Image ... OK
5322 ## Loading RAMDisk Image at 40200000 ...
5323 Image Name: Simple Ramdisk Image
5324 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5325 Data Size: 566530 Bytes = 553 kB = 0 MB
5326 Load Address: 00000000
5327 Entry Point: 00000000
5328 Verifying Checksum ... OK
5329 Loading Ramdisk ... OK
5330 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
5331 Boot arguments: root=/dev/ram
5332 time_init: decrementer frequency = 187500000/60
5333 Calibrating delay loop... 49.77 BogoMIPS
5334 ...
5335 RAMDISK: Compressed image found at block 0
5336 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005337
wdenk6c59edc2004-05-03 20:45:30 +00005338 bash#
wdenkc6097192002-11-03 00:24:07 +00005339
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005340Boot Linux and pass a flat device tree:
5341-----------
5342
5343First, U-Boot must be compiled with the appropriate defines. See the section
5344titled "Linux Kernel Interface" above for a more in depth explanation. The
5345following is an example of how to start a kernel and pass an updated
5346flat device tree:
5347
5348=> print oftaddr
5349oftaddr=0x300000
5350=> print oft
5351oft=oftrees/mpc8540ads.dtb
5352=> tftp $oftaddr $oft
5353Speed: 1000, full duplex
5354Using TSEC0 device
5355TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5356Filename 'oftrees/mpc8540ads.dtb'.
5357Load address: 0x300000
5358Loading: #
5359done
5360Bytes transferred = 4106 (100a hex)
5361=> tftp $loadaddr $bootfile
5362Speed: 1000, full duplex
5363Using TSEC0 device
5364TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5365Filename 'uImage'.
5366Load address: 0x200000
5367Loading:############
5368done
5369Bytes transferred = 1029407 (fb51f hex)
5370=> print loadaddr
5371loadaddr=200000
5372=> print oftaddr
5373oftaddr=0x300000
5374=> bootm $loadaddr - $oftaddr
5375## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005376 Image Name: Linux-2.6.17-dirty
5377 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5378 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005379 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005380 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005381 Verifying Checksum ... OK
5382 Uncompressing Kernel Image ... OK
5383Booting using flat device tree at 0x300000
5384Using MPC85xx ADS machine description
5385Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5386[snip]
5387
5388
wdenk6c59edc2004-05-03 20:45:30 +00005389More About U-Boot Image Types:
5390------------------------------
wdenkc6097192002-11-03 00:24:07 +00005391
wdenk6c59edc2004-05-03 20:45:30 +00005392U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005393
wdenk6c59edc2004-05-03 20:45:30 +00005394 "Standalone Programs" are directly runnable in the environment
5395 provided by U-Boot; it is expected that (if they behave
5396 well) you can continue to work in U-Boot after return from
5397 the Standalone Program.
5398 "OS Kernel Images" are usually images of some Embedded OS which
5399 will take over control completely. Usually these programs
5400 will install their own set of exception handlers, device
5401 drivers, set up the MMU, etc. - this means, that you cannot
5402 expect to re-enter U-Boot except by resetting the CPU.
5403 "RAMDisk Images" are more or less just data blocks, and their
5404 parameters (address, size) are passed to an OS kernel that is
5405 being started.
5406 "Multi-File Images" contain several images, typically an OS
5407 (Linux) kernel image and one or more data images like
5408 RAMDisks. This construct is useful for instance when you want
5409 to boot over the network using BOOTP etc., where the boot
5410 server provides just a single image file, but you want to get
5411 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00005412
wdenk6c59edc2004-05-03 20:45:30 +00005413 "Multi-File Images" start with a list of image sizes, each
5414 image size (in bytes) specified by an "uint32_t" in network
5415 byte order. This list is terminated by an "(uint32_t)0".
5416 Immediately after the terminating 0 follow the images, one by
5417 one, all aligned on "uint32_t" boundaries (size rounded up to
5418 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00005419
wdenk6c59edc2004-05-03 20:45:30 +00005420 "Firmware Images" are binary images containing firmware (like
5421 U-Boot or FPGA images) which usually will be programmed to
5422 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00005423
wdenk6c59edc2004-05-03 20:45:30 +00005424 "Script files" are command sequences that will be executed by
5425 U-Boot's command interpreter; this feature is especially
5426 useful when you configure U-Boot to use a real shell (hush)
5427 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00005428
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005429Booting the Linux zImage:
5430-------------------------
5431
5432On some platforms, it's possible to boot Linux zImage. This is done
5433using the "bootz" command. The syntax of "bootz" command is the same
5434as the syntax of "bootm" command.
5435
Tom Rini45f46d12013-05-16 11:40:11 -04005436Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00005437kernel with raw initrd images. The syntax is slightly different, the
5438address of the initrd must be augmented by it's size, in the following
5439format: "<initrd addres>:<initrd size>".
5440
stroeseb9c17c52003-04-04 15:53:41 +00005441
wdenk6c59edc2004-05-03 20:45:30 +00005442Standalone HOWTO:
5443=================
stroeseb9c17c52003-04-04 15:53:41 +00005444
wdenk6c59edc2004-05-03 20:45:30 +00005445One of the features of U-Boot is that you can dynamically load and
5446run "standalone" applications, which can use some resources of
5447U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00005448
wdenk6c59edc2004-05-03 20:45:30 +00005449Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00005450
wdenk6c59edc2004-05-03 20:45:30 +00005451"Hello World" Demo:
5452-------------------
wdenkc6097192002-11-03 00:24:07 +00005453
wdenk6c59edc2004-05-03 20:45:30 +00005454'examples/hello_world.c' contains a small "Hello World" Demo
5455application; it is automatically compiled when you build U-Boot.
5456It's configured to run at address 0x00040004, so you can play with it
5457like that:
wdenkc6097192002-11-03 00:24:07 +00005458
wdenk6c59edc2004-05-03 20:45:30 +00005459 => loads
5460 ## Ready for S-Record download ...
5461 ~>examples/hello_world.srec
5462 1 2 3 4 5 6 7 8 9 10 11 ...
5463 [file transfer complete]
5464 [connected]
5465 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005466
wdenk6c59edc2004-05-03 20:45:30 +00005467 => go 40004 Hello World! This is a test.
5468 ## Starting application at 0x00040004 ...
5469 Hello World
5470 argc = 7
5471 argv[0] = "40004"
5472 argv[1] = "Hello"
5473 argv[2] = "World!"
5474 argv[3] = "This"
5475 argv[4] = "is"
5476 argv[5] = "a"
5477 argv[6] = "test."
5478 argv[7] = "<NULL>"
5479 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00005480
wdenk6c59edc2004-05-03 20:45:30 +00005481 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005482
wdenk6c59edc2004-05-03 20:45:30 +00005483Another example, which demonstrates how to register a CPM interrupt
5484handler with the U-Boot code, can be found in 'examples/timer.c'.
5485Here, a CPM timer is set up to generate an interrupt every second.
5486The interrupt service routine is trivial, just printing a '.'
5487character, but this is just a demo program. The application can be
5488controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00005489
wdenk6c59edc2004-05-03 20:45:30 +00005490 ? - print current values og the CPM Timer registers
5491 b - enable interrupts and start timer
5492 e - stop timer and disable interrupts
5493 q - quit application
wdenkc6097192002-11-03 00:24:07 +00005494
wdenk6c59edc2004-05-03 20:45:30 +00005495 => loads
5496 ## Ready for S-Record download ...
5497 ~>examples/timer.srec
5498 1 2 3 4 5 6 7 8 9 10 11 ...
5499 [file transfer complete]
5500 [connected]
5501 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00005502
wdenk6c59edc2004-05-03 20:45:30 +00005503 => go 40004
5504 ## Starting application at 0x00040004 ...
5505 TIMERS=0xfff00980
5506 Using timer 1
5507 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00005508
wdenk6c59edc2004-05-03 20:45:30 +00005509Hit 'b':
5510 [q, b, e, ?] Set interval 1000000 us
5511 Enabling timer
5512Hit '?':
5513 [q, b, e, ?] ........
5514 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5515Hit '?':
5516 [q, b, e, ?] .
5517 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5518Hit '?':
5519 [q, b, e, ?] .
5520 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5521Hit '?':
5522 [q, b, e, ?] .
5523 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5524Hit 'e':
5525 [q, b, e, ?] ...Stopping timer
5526Hit 'q':
5527 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00005528
wdenkc6097192002-11-03 00:24:07 +00005529
wdenk6c59edc2004-05-03 20:45:30 +00005530Minicom warning:
5531================
wdenkc6097192002-11-03 00:24:07 +00005532
wdenk6c59edc2004-05-03 20:45:30 +00005533Over time, many people have reported problems when trying to use the
5534"minicom" terminal emulation program for serial download. I (wd)
5535consider minicom to be broken, and recommend not to use it. Under
5536Unix, I recommend to use C-Kermit for general purpose use (and
5537especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00005538use "cu" for S-Record download ("loads" command). See
5539http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5540for help with kermit.
5541
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543Nevertheless, if you absolutely want to use it try adding this
5544configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00005545
wdenk6c59edc2004-05-03 20:45:30 +00005546 Name Program Name U/D FullScr IO-Red. Multi
5547 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
5548 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00005549
wdenk8dba0502003-03-31 16:34:49 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551NetBSD Notes:
5552=============
wdenkc6097192002-11-03 00:24:07 +00005553
wdenk6c59edc2004-05-03 20:45:30 +00005554Starting at version 0.9.2, U-Boot supports NetBSD both as host
5555(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00005556
wdenk6c59edc2004-05-03 20:45:30 +00005557Building requires a cross environment; it is known to work on
5558NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5559need gmake since the Makefiles are not compatible with BSD make).
5560Note that the cross-powerpc package does not install include files;
5561attempting to build U-Boot will fail because <machine/ansi.h> is
5562missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00005563
wdenk6c59edc2004-05-03 20:45:30 +00005564 # cd /usr/pkg/cross/powerpc-netbsd/include
5565 # mkdir powerpc
5566 # ln -s powerpc machine
5567 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5568 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00005569
wdenk6c59edc2004-05-03 20:45:30 +00005570Native builds *don't* work due to incompatibilities between native
5571and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00005572
wdenk6c59edc2004-05-03 20:45:30 +00005573Booting assumes that (the first part of) the image booted is a
5574stage-2 loader which in turn loads and then invokes the kernel
5575proper. Loader sources will eventually appear in the NetBSD source
5576tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00005577meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00005578
wdenkc6097192002-11-03 00:24:07 +00005579
wdenk6c59edc2004-05-03 20:45:30 +00005580Implementation Internals:
5581=========================
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk6c59edc2004-05-03 20:45:30 +00005583The following is not intended to be a complete description of every
5584implementation detail. However, it should help to understand the
5585inner workings of U-Boot and make it easier to port it to custom
5586hardware.
wdenkc6097192002-11-03 00:24:07 +00005587
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk6c59edc2004-05-03 20:45:30 +00005589Initial Stack, Global Data:
5590---------------------------
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk6c59edc2004-05-03 20:45:30 +00005592The implementation of U-Boot is complicated by the fact that U-Boot
5593starts running out of ROM (flash memory), usually without access to
5594system RAM (because the memory controller is not initialized yet).
5595This means that we don't have writable Data or BSS segments, and BSS
5596is not initialized as zero. To be able to get a C environment working
5597at all, we have to allocate at least a minimal stack. Implementation
5598options for this are defined and restricted by the CPU used: Some CPU
5599models provide on-chip memory (like the IMMR area on MPC8xx and
5600MPC826x processors), on others (parts of) the data cache can be
5601locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00005602
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005603 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005604 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk6c59edc2004-05-03 20:45:30 +00005606 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
5607 From: "Chris Hallinan" <clh@net1plus.com>
5608 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
5609 ...
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611 Correct me if I'm wrong, folks, but the way I understand it
5612 is this: Using DCACHE as initial RAM for Stack, etc, does not
5613 require any physical RAM backing up the cache. The cleverness
5614 is that the cache is being used as a temporary supply of
5615 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005616 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00005617 can see how this works by studying the cache architecture and
5618 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00005619
wdenk6c59edc2004-05-03 20:45:30 +00005620 OCM is On Chip Memory, which I believe the 405GP has 4K. It
5621 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005622 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00005623 option should work for you. Using CS 4 should be fine if your
5624 board designers haven't used it for something that would
5625 cause you grief during the initial boot! It is frequently not
5626 used.
wdenkc6097192002-11-03 00:24:07 +00005627
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005628 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00005629 with your processor/board/system design. The default value
5630 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02005631 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00005632 than your SDRAM module. If you have a 64MB SDRAM module, set
5633 it above 400_0000. Just make sure your board has no resources
5634 that are supposed to respond to that address! That code in
5635 start.S has been around a while and should work as is when
5636 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00005637
wdenk6c59edc2004-05-03 20:45:30 +00005638 -Chris Hallinan
5639 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00005640
wdenk6c59edc2004-05-03 20:45:30 +00005641It is essential to remember this, since it has some impact on the C
5642code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00005643
wdenk6c59edc2004-05-03 20:45:30 +00005644* Initialized global data (data segment) is read-only. Do not attempt
5645 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00005646
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005647* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00005648 as zero data - BSS segment) at all - this is undefined, initiali-
5649 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00005650
wdenk6c59edc2004-05-03 20:45:30 +00005651* Stack space is very limited. Avoid big data buffers or things like
5652 that.
wdenk4a5c8a72003-03-06 00:02:04 +00005653
wdenk6c59edc2004-05-03 20:45:30 +00005654Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005655normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00005656turned out that the implementation of U-Boot can be greatly
5657simplified by making a global data structure (gd_t) available to all
5658functions. We could pass a pointer to this data as argument to _all_
5659functions, but this would bloat the code. Instead we use a feature of
5660the GCC compiler (Global Register Variables) to share the data: we
5661place a pointer (gd) to the global data into a register which we
5662reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk6c59edc2004-05-03 20:45:30 +00005664When choosing a register for such a purpose we are restricted by the
5665relevant (E)ABI specifications for the current architecture, and by
5666GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00005667
wdenk6c59edc2004-05-03 20:45:30 +00005668For PowerPC, the following registers have specific use:
5669 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01005670 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00005671 R3-R4: parameter passing and return values
5672 R5-R10: parameter passing
5673 R13: small data area pointer
5674 R30: GOT pointer
5675 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00005676
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01005677 (U-Boot also uses R12 as internal GOT pointer. r12
5678 is a volatile register so r12 needs to be reset when
5679 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00005680
Wolfgang Denk69c09642008-02-14 22:43:22 +01005681 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk6c59edc2004-05-03 20:45:30 +00005683 Note: on PPC, we could use a static initializer (since the
5684 address of the global data structure is known at compile time),
5685 but it turned out that reserving a register results in somewhat
5686 smaller code - although the code savings are not that big (on
5687 average for all boards 752 bytes for the whole U-Boot image,
5688 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00005689
wdenk6c59edc2004-05-03 20:45:30 +00005690On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk6c59edc2004-05-03 20:45:30 +00005692 R0: function argument word/integer result
5693 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005694 R9: platform specific
5695 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00005696 R11: argument (frame) pointer
5697 R12: temporary workspace
5698 R13: stack pointer
5699 R14: link register
5700 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00005701
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02005702 ==> U-Boot will use R9 to hold a pointer to the global data
5703
5704 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00005705
Thomas Chou8fa38582010-05-21 11:08:03 +08005706On Nios II, the ABI is documented here:
5707 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
5708
5709 ==> U-Boot will use gp to hold a pointer to the global data
5710
5711 Note: on Nios II, we give "-G0" option to gcc and don't use gp
5712 to access small data sections, so gp is free.
5713
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005714On NDS32, the following registers are used:
5715
5716 R0-R1: argument/return
5717 R2-R5: argument
5718 R15: temporary register for assembler
5719 R16: trampoline register
5720 R28: frame pointer (FP)
5721 R29: global pointer (GP)
5722 R30: link register (LP)
5723 R31: stack pointer (SP)
5724 PC: program counter (PC)
5725
5726 ==> U-Boot will use R10 to hold a pointer to the global data
5727
Wolfgang Denk6405a152006-03-31 18:32:53 +02005728NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5729or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00005730
wdenk6c59edc2004-05-03 20:45:30 +00005731Memory Management:
5732------------------
wdenkc6097192002-11-03 00:24:07 +00005733
wdenk6c59edc2004-05-03 20:45:30 +00005734U-Boot runs in system state and uses physical addresses, i.e. the
5735MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00005736
wdenk6c59edc2004-05-03 20:45:30 +00005737The available memory is mapped to fixed addresses using the memory
5738controller. In this process, a contiguous block is formed for each
5739memory type (Flash, SDRAM, SRAM), even when it consists of several
5740physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00005741
wdenk6c59edc2004-05-03 20:45:30 +00005742U-Boot is installed in the first 128 kB of the first Flash bank (on
5743TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5744booting and sizing and initializing DRAM, the code relocates itself
5745to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005746memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00005747configuration setting]. Below that, a structure with global Board
5748Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk6c59edc2004-05-03 20:45:30 +00005750Additionally, some exception handler code is copied to the low 8 kB
5751of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00005752
wdenk6c59edc2004-05-03 20:45:30 +00005753So a typical memory configuration with 16 MB of DRAM could look like
5754this:
wdenkc6097192002-11-03 00:24:07 +00005755
wdenk6c59edc2004-05-03 20:45:30 +00005756 0x0000 0000 Exception Vector code
5757 :
5758 0x0000 1FFF
5759 0x0000 2000 Free for Application Use
5760 :
5761 :
wdenkc6097192002-11-03 00:24:07 +00005762
wdenk6c59edc2004-05-03 20:45:30 +00005763 :
5764 :
5765 0x00FB FF20 Monitor Stack (Growing downward)
5766 0x00FB FFAC Board Info Data and permanent copy of global data
5767 0x00FC 0000 Malloc Arena
5768 :
5769 0x00FD FFFF
5770 0x00FE 0000 RAM Copy of Monitor Code
5771 ... eventually: LCD or video framebuffer
5772 ... eventually: pRAM (Protected RAM - unchanged by reset)
5773 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00005774
wdenkc6097192002-11-03 00:24:07 +00005775
wdenk6c59edc2004-05-03 20:45:30 +00005776System Initialization:
5777----------------------
wdenkc6097192002-11-03 00:24:07 +00005778
wdenk6c59edc2004-05-03 20:45:30 +00005779In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005780(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005781configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00005782To be able to re-map memory U-Boot then jumps to its link address.
5783To be able to implement the initialization code in C, a (small!)
5784initial stack is set up in the internal Dual Ported RAM (in case CPUs
5785which provide such a feature like MPC8xx or MPC8260), or in a locked
5786part of the data cache. After that, U-Boot initializes the CPU core,
5787the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00005788
wdenk6c59edc2004-05-03 20:45:30 +00005789Next, all (potentially) available memory banks are mapped using a
5790preliminary mapping. For example, we put them on 512 MB boundaries
5791(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5792on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5793programmed for SDRAM access. Using the temporary configuration, a
5794simple memory test is run that determines the size of the SDRAM
5795banks.
wdenkc6097192002-11-03 00:24:07 +00005796
wdenk6c59edc2004-05-03 20:45:30 +00005797When there is more than one SDRAM bank, and the banks are of
5798different size, the largest is mapped first. For equal size, the first
5799bank (CS2#) is mapped first. The first mapping is always for address
58000x00000000, with any additional banks following immediately to create
5801contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00005802
wdenk6c59edc2004-05-03 20:45:30 +00005803Then, the monitor installs itself at the upper end of the SDRAM area
5804and allocates memory for use by malloc() and for the global Board
5805Info data; also, the exception vector code is copied to the low RAM
5806pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00005807
wdenk6c59edc2004-05-03 20:45:30 +00005808Only after this relocation will you have a "normal" C environment;
5809until that you are restricted in several ways, mostly because you are
5810running from ROM, and because the code will have to be relocated to a
5811new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00005812
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814U-Boot Porting Guide:
5815----------------------
wdenkc6097192002-11-03 00:24:07 +00005816
wdenk6c59edc2004-05-03 20:45:30 +00005817[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
5818list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00005819
wdenkc6097192002-11-03 00:24:07 +00005820
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005821int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00005822{
5823 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00005824
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005825 signal(SIGALRM, no_more_time);
5826 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00005827
wdenk6c59edc2004-05-03 20:45:30 +00005828 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005829 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00005830 return 0;
5831 }
wdenkc6097192002-11-03 00:24:07 +00005832
wdenk6c59edc2004-05-03 20:45:30 +00005833 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00005834
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005835 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00005836
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005837 if (clueless)
5838 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00005839
wdenk6c59edc2004-05-03 20:45:30 +00005840 while (learning) {
5841 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005842 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
5843 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00005844 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005845 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00005846 }
wdenkc6097192002-11-03 00:24:07 +00005847
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005848 if (available_money > toLocalCurrency ($2500))
5849 Buy a BDI3000;
5850 else
wdenk6c59edc2004-05-03 20:45:30 +00005851 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00005852
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005853 if (a similar board exists) { /* hopefully... */
5854 cp -a board/<similar> board/<myboard>
5855 cp include/configs/<similar>.h include/configs/<myboard>.h
5856 } else {
5857 Create your own board support subdirectory;
5858 Create your own board include/configs/<myboard>.h file;
5859 }
5860 Edit new board/<myboard> files
5861 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00005862
Jerry Van Barenba0687c2009-07-15 20:42:59 -04005863 while (!accepted) {
5864 while (!running) {
5865 do {
5866 Add / modify source code;
5867 } until (compiles);
5868 Debug;
5869 if (clueless)
5870 email("Hi, I am having problems...");
5871 }
5872 Send patch file to the U-Boot email list;
5873 if (reasonable critiques)
5874 Incorporate improvements from email list code review;
5875 else
5876 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00005877 }
wdenkc6097192002-11-03 00:24:07 +00005878
wdenk6c59edc2004-05-03 20:45:30 +00005879 return 0;
5880}
wdenkc6097192002-11-03 00:24:07 +00005881
wdenk6c59edc2004-05-03 20:45:30 +00005882void no_more_time (int sig)
5883{
5884 hire_a_guru();
5885}
wdenkc6097192002-11-03 00:24:07 +00005886
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk6c59edc2004-05-03 20:45:30 +00005888Coding Standards:
5889-----------------
wdenkc6097192002-11-03 00:24:07 +00005890
wdenk6c59edc2004-05-03 20:45:30 +00005891All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02005892coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005893"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02005894
5895Source files originating from a different project (for example the
5896MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005897reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02005898sources.
wdenkc6097192002-11-03 00:24:07 +00005899
Detlev Zundelaa63d482006-09-01 15:39:02 +02005900Please note that U-Boot is implemented in C (and to some small parts in
5901Assembler); no C++ is used, so please do not use C++ style comments (//)
5902in your code.
wdenkad276f22004-01-04 16:28:35 +00005903
wdenk6c59edc2004-05-03 20:45:30 +00005904Please also stick to the following formatting rules:
5905- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005906- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00005907- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005908- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00005909- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00005910
wdenk6c59edc2004-05-03 20:45:30 +00005911Submissions which do not conform to the standards may be returned
5912with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00005913
wdenkc6097192002-11-03 00:24:07 +00005914
wdenk6c59edc2004-05-03 20:45:30 +00005915Submitting Patches:
5916-------------------
wdenkc6097192002-11-03 00:24:07 +00005917
wdenk6c59edc2004-05-03 20:45:30 +00005918Since the number of patches for U-Boot is growing, we need to
5919establish some rules. Submissions which do not conform to these rules
5920may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00005921
Magnus Liljaf3b287b2008-08-06 19:32:33 +02005922Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005923
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005924Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
5925see http://lists.denx.de/mailman/listinfo/u-boot
5926
wdenk6c59edc2004-05-03 20:45:30 +00005927When you send a patch, please include the following information with
5928it:
wdenkc6097192002-11-03 00:24:07 +00005929
wdenk6c59edc2004-05-03 20:45:30 +00005930* For bug fixes: a description of the bug and how your patch fixes
5931 this bug. Please try to include a way of demonstrating that the
5932 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00005933
wdenk6c59edc2004-05-03 20:45:30 +00005934* For new features: a description of the feature and your
5935 implementation.
wdenkc6097192002-11-03 00:24:07 +00005936
wdenk6c59edc2004-05-03 20:45:30 +00005937* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00005938
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05005939* For major contributions, add a MAINTAINERS file with your
5940 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00005941
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02005942* When you add support for a new board, don't forget to add a
5943 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00005944
wdenk6c59edc2004-05-03 20:45:30 +00005945* If your patch adds new configuration options, don't forget to
5946 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00005947
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005948* The patch itself. If you are using git (which is *strongly*
5949 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00005950 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005951 the U-Boot mailing list, you will avoid most of the common problems
5952 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00005953
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005954 If you cannot use git, use "diff -purN OLD NEW". If your version of
5955 diff does not support these options, then get the latest version of
5956 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00005957
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005958 The current directory when running this command shall be the parent
5959 directory of the U-Boot source tree (i. e. please make sure that
5960 your patch includes sufficient directory information for the
5961 affected files).
5962
5963 We prefer patches as plain text. MIME attachments are discouraged,
5964 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00005965
wdenk6c59edc2004-05-03 20:45:30 +00005966* If one logical set of modifications affects or creates several
5967 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00005968
wdenk6c59edc2004-05-03 20:45:30 +00005969* Changesets that contain different, unrelated modifications shall be
5970 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00005971
wdenkc6097192002-11-03 00:24:07 +00005972
wdenk6c59edc2004-05-03 20:45:30 +00005973Notes:
wdenkc6097192002-11-03 00:24:07 +00005974
Simon Glassdc27def2016-07-27 20:33:08 -06005975* Before sending the patch, run the buildman script on your patched
wdenk6c59edc2004-05-03 20:45:30 +00005976 source tree and make sure that no errors or warnings are reported
5977 for any of the boards.
5978
5979* Keep your modifications to the necessary minimum: A patch
5980 containing several unrelated changes or arbitrary reformats will be
5981 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00005982
wdenk6c59edc2004-05-03 20:45:30 +00005983* If you modify existing code, make sure that your new code does not
5984 add to the memory footprint of the code ;-) Small is beautiful!
5985 When adding new features, these should compile conditionally only
5986 (using #ifdef), and the resulting code with the new feature
5987 disabled must not need more memory than the old code without your
5988 modification.
wdenkcbc49a52005-05-03 14:12:25 +00005989
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01005990* Remember that there is a size limit of 100 kB per message on the
5991 u-boot mailing list. Bigger patches will be moderated. If they are
5992 reasonable and not too big, they will be acknowledged. But patches
5993 bigger than the size limit should be avoided.