blob: 864c7cccc3b7a7182612680eba3316889460008b [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
130 U-Boot v2010.09-rc1 - Release candiate 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 /blackfin Files generic to Analog Devices Blackfin architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500141 /m68k Files generic to m68k architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500142 /microblaze Files generic to microblaze architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500143 /mips Files generic to MIPS architecture
Macpaul Lin1cac36e2011-10-19 20:41:11 +0000144 /nds32 Files generic to NDS32 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500145 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400146 /openrisc Files generic to OpenRISC architecture
Stefan Roese88fbf932010-04-15 16:07:28 +0200147 /powerpc Files generic to PowerPC architecture
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500148 /sandbox Files generic to HW-independent "sandbox"
Peter Tysere4d1abc2010-04-12 22:28:21 -0500149 /sh Files generic to SH architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500150 /sparc Files generic to SPARC architecture
Robert P. J. Daya269c932013-09-15 18:34:15 -0400151 /x86 Files generic to x86 architecture
Peter Tysere4d1abc2010-04-12 22:28:21 -0500152/api Machine/arch independent API for external apps
153/board Board dependent files
154/common Misc architecture independent functions
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500155/configs Board default configuration files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500156/disk Code for disk drive partition handling
157/doc Documentation (don't expect too much)
158/drivers Commonly used device drivers
Robert P. J. Daya269c932013-09-15 18:34:15 -0400159/dts Contains Makefile for building internal U-Boot fdt.
Peter Tysere4d1abc2010-04-12 22:28:21 -0500160/examples Example code for standalone applications, etc.
161/fs Filesystem code (cramfs, ext2, jffs2, etc.)
162/include Header Files
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500163/lib Library routines generic to all architectures
164/Licenses Various license files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500165/net Networking code
166/post Power On Self Test
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500167/scripts Various build scripts and Makefiles
168/test Various unit test files
Peter Tysere4d1abc2010-04-12 22:28:21 -0500169/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000170
wdenkc6097192002-11-03 00:24:07 +0000171Software Configuration:
172=======================
173
174Configuration is usually done using C preprocessor defines; the
175rationale behind that is to avoid dead code whenever possible.
176
177There are two classes of configuration variables:
178
179* Configuration _OPTIONS_:
180 These are selectable by the user and have names beginning with
181 "CONFIG_".
182
183* Configuration _SETTINGS_:
184 These depend on the hardware etc. and should not be meddled with if
185 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200186 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000187
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500188Previously, all configuration was done by hand, which involved creating
189symbolic links and editing configuration files manually. More recently,
190U-Boot has added the Kbuild infrastructure used by the Linux kernel,
191allowing you to use the "make menuconfig" command to configure your
192build.
wdenkc6097192002-11-03 00:24:07 +0000193
194
195Selection of Processor Architecture and Board Type:
196---------------------------------------------------
197
198For all supported boards there are ready-to-use default
Holger Freyther7ba4e572014-08-04 09:26:05 +0200199configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000200
201Example: For a TQM823L module type:
202
203 cd u-boot
Holger Freyther7ba4e572014-08-04 09:26:05 +0200204 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000205
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500206Note: If you're looking for the default configuration file for a board
207you're sure used to be there but is now missing, check the file
208doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000209
Simon Glass53552c92014-03-22 17:12:59 -0600210Sandbox Environment:
211--------------------
212
213U-Boot can be built natively to run on a Linux host using the 'sandbox'
214board. This allows feature development which is not board- or architecture-
215specific to be undertaken on a native platform. The sandbox is also used to
216run some of U-Boot's tests.
217
Jagannadha Sutradharudu Teki287314f2014-08-31 21:19:43 +0530218See board/sandbox/README.sandbox for more details.
Simon Glass53552c92014-03-22 17:12:59 -0600219
220
Simon Glassd8711af2015-03-03 08:03:00 -0700221Board Initialisation Flow:
222--------------------------
223
224This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500225SPL and U-Boot proper (i.e. they both follow the same rules).
226
227Note: "SPL" stands for "Secondary Program Loader," which is explained in
228more detail later in this file.
229
230At present, SPL mostly uses a separate code path, but the function names
231and roles of each function are the same. Some boards or architectures
232may not conform to this. At least most ARM boards which use
233CONFIG_SPL_FRAMEWORK conform to this.
Simon Glassd8711af2015-03-03 08:03:00 -0700234
Robert P. J. Day076ed9b2015-12-19 07:16:10 -0500235Execution typically starts with an architecture-specific (and possibly
236CPU-specific) start.S file, such as:
237
238 - arch/arm/cpu/armv7/start.S
239 - arch/powerpc/cpu/mpc83xx/start.S
240 - arch/mips/cpu/start.S
241
242and so on. From there, three functions are called; the purpose and
243limitations of each of these functions are described below.
Simon Glassd8711af2015-03-03 08:03:00 -0700244
245lowlevel_init():
246 - purpose: essential init to permit execution to reach board_init_f()
247 - no global_data or BSS
248 - there is no stack (ARMv7 may have one but it will soon be removed)
249 - must not set up SDRAM or use console
250 - must only do the bare minimum to allow execution to continue to
251 board_init_f()
252 - this is almost never needed
253 - return normally from this function
254
255board_init_f():
256 - purpose: set up the machine ready for running board_init_r():
257 i.e. SDRAM and serial UART
258 - global_data is available
259 - stack is in SRAM
260 - BSS is not available, so you cannot use global/static variables,
261 only stack variables and global_data
262
263 Non-SPL-specific notes:
264 - dram_init() is called to set up DRAM. If already done in SPL this
265 can do nothing
266
267 SPL-specific notes:
268 - you can override the entire board_init_f() function with your own
269 version as needed.
270 - preloader_console_init() can be called here in extremis
271 - should set up SDRAM, and anything needed to make the UART work
272 - these is no need to clear BSS, it will be done by crt0.S
273 - must return normally from this function (don't call board_init_r()
274 directly)
275
276Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
277this point the stack and global_data are relocated to below
278CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
279memory.
280
281board_init_r():
282 - purpose: main execution, common code
283 - global_data is available
284 - SDRAM is available
285 - BSS is available, all static/global variables can be used
286 - execution eventually continues to main_loop()
287
288 Non-SPL-specific notes:
289 - U-Boot is relocated to the top of memory and is now running from
290 there.
291
292 SPL-specific notes:
293 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
294 CONFIG_SPL_STACK_R_ADDR points into SDRAM
295 - preloader_console_init() can be called here - typically this is
296 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
297 spl_board_init() function containing this call
298 - loads U-Boot or (in falcon mode) Linux
299
300
301
wdenkc6097192002-11-03 00:24:07 +0000302Configuration Options:
303----------------------
304
305Configuration depends on the combination of board and CPU type; all
306such information is kept in a configuration file
307"include/configs/<board_name>.h".
308
309Example: For a TQM823L module, all configuration settings are in
310"include/configs/TQM823L.h".
311
312
wdenk1272e232002-11-10 22:06:23 +0000313Many of the options are named exactly as the corresponding Linux
314kernel configuration options. The intention is to make it easier to
315build a config tool - later.
316
317
wdenkc6097192002-11-03 00:24:07 +0000318The following options need to be configured:
319
Kim Phillips203fee32007-08-10 13:28:25 -0500320- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000321
Kim Phillips203fee32007-08-10 13:28:25 -0500322- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk994ad962006-10-24 14:42:37 +0200323
324- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen9d5a43f2007-11-01 12:44:20 +0100325 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000326
327- CPU Module Type: (if CONFIG_COGENT is defined)
328 Define exactly one of
329 CONFIG_CMA286_60_OLD
330--- FIXME --- not tested yet:
331 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
332 CONFIG_CMA287_23, CONFIG_CMA287_50
333
334- Motherboard Type: (if CONFIG_COGENT is defined)
335 Define exactly one of
336 CONFIG_CMA101, CONFIG_CMA102
337
338- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
339 Define one or more of
340 CONFIG_CMA302
341
342- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
343 Define one or more of
344 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200345 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000346 a "rotator" |\-/|\-/
347
Lei Wen20014762011-02-09 18:06:58 +0530348- Marvell Family Member
349 CONFIG_SYS_MVFS - define it if you want to enable
350 multiple fs option at one time
351 for marvell soc family
352
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200353- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk20bddb32004-09-28 17:59:53 +0000354 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
355 get_gclk_freq() cannot work
wdenk9b7f3842003-10-09 20:09:04 +0000356 e.g. if there is no 32KHz
357 reference PIT/RTC clock
wdenk20bddb32004-09-28 17:59:53 +0000358 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
359 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000360
wdenk20bddb32004-09-28 17:59:53 +0000361- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200362 CONFIG_SYS_8xx_CPUCLK_MIN
363 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk20bddb32004-09-28 17:59:53 +0000364 CONFIG_8xx_CPUCLK_DEFAULT
wdenkfde37042004-01-31 20:06:54 +0000365 See doc/README.MPC866
366
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200367 CONFIG_SYS_MEASURE_CPUCLK
wdenkfde37042004-01-31 20:06:54 +0000368
wdenk544e9732004-02-06 23:19:44 +0000369 Define this to measure the actual CPU clock instead
370 of relying on the correctness of the configured
371 values. Mostly useful for board bringup to make sure
372 the PLL is locked at the intended frequency. Note
373 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200374 RTC clock or CONFIG_SYS_8XX_XIN)
wdenkfde37042004-01-31 20:06:54 +0000375
Heiko Schocher734f0272009-03-12 07:37:15 +0100376 CONFIG_SYS_DELAYED_ICACHE
377
378 Define this option if you want to enable the
379 ICache only when Code runs from RAM.
380
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600381- 85xx CPU Options:
York Sun2394a0f2012-10-08 07:44:30 +0000382 CONFIG_SYS_PPC64
383
384 Specifies that the core is a 64-bit PowerPC implementation (implements
385 the "64" category of the Power ISA). This is necessary for ePAPR
386 compliance, among other possible reasons.
387
Kumar Galaf4fb90f2011-02-18 05:40:54 -0600388 CONFIG_SYS_FSL_TBCLK_DIV
389
390 Defines the core time base clock divider ratio compared to the
391 system clock. On most PQ3 devices this is 8, on newer QorIQ
392 devices it can be 16 or 32. The ratio varies from SoC to Soc.
393
Kumar Gala179b1b22011-05-20 00:39:21 -0500394 CONFIG_SYS_FSL_PCIE_COMPAT
395
396 Defines the string to utilize when trying to match PCIe device
397 tree nodes for the given platform.
398
Prabhakar Kushwahaa6a30622012-04-29 23:56:13 +0000399 CONFIG_SYS_PPC_E500_DEBUG_TLB
400
401 Enables a temporary TLB entry to be used during boot to work
402 around limitations in e500v1 and e500v2 external debugger
403 support. This reduces the portions of the boot code where
404 breakpoints and single stepping do not work. The value of this
405 symbol should be set to the TLB1 entry to be used for this
406 purpose.
407
Scott Wood80806962012-08-14 10:14:53 +0000408 CONFIG_SYS_FSL_ERRATUM_A004510
409
410 Enables a workaround for erratum A004510. If set,
411 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
413
414 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
415 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
416
417 Defines one or two SoC revisions (low 8 bits of SVR)
418 for which the A004510 workaround should be applied.
419
420 The rest of SVR is either not relevant to the decision
421 of whether the erratum is present (e.g. p2040 versus
422 p2041) or is implied by the build target, which controls
423 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
424
425 See Freescale App Note 4493 for more information about
426 this erratum.
427
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530428 CONFIG_A003399_NOR_WORKAROUND
429 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800430 required during NOR boot.
Prabhakar Kushwahad324f472013-04-16 13:27:44 +0530431
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530432 CONFIG_A008044_WORKAROUND
433 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800434 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwahac4c10d12014-10-29 22:33:09 +0530435
Scott Wood80806962012-08-14 10:14:53 +0000436 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
437
438 This is the value to write into CCSR offset 0x18600
439 according to the A004510 workaround.
440
Priyanka Jainc73b9032013-07-02 09:21:04 +0530441 CONFIG_SYS_FSL_DSP_DDR_ADDR
442 This value denotes start offset of DDR memory which is
443 connected exclusively to the DSP cores.
444
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530445 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
446 This value denotes start offset of M2 memory
447 which is directly connected to the DSP core.
448
Priyanka Jainc73b9032013-07-02 09:21:04 +0530449 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
450 This value denotes start offset of M3 memory which is directly
451 connected to the DSP core.
452
Priyanka Jainf81e8b22013-04-04 09:31:54 +0530453 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
454 This value denotes start offset of DSP CCSR space.
455
Priyanka Jaine9dcaa82013-12-17 14:25:52 +0530456 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
457 Single Source Clock is clocking mode present in some of FSL SoC's.
458 In this mode, a single differential clock is used to supply
459 clocks to the sysclock, ddrclock and usbclock.
460
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530461 CONFIG_SYS_CPC_REINIT_F
462 This CONFIG is defined when the CPC is configured as SRAM at the
463 time of U-boot entry and is required to be re-initialized.
464
Tang Yuantiana7364af2014-04-17 15:33:46 +0800465 CONFIG_DEEP_SLEEP
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800466 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantiana7364af2014-04-17 15:33:46 +0800467 supported, core will start to execute uboot when wakes up.
468
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000469- Generic CPU options:
York Sun021d2022014-05-02 17:28:04 -0700470 CONFIG_SYS_GENERIC_GLOBAL_DATA
471 Defines global data is initialized in generic board board_init_f().
472 If this macro is defined, global data is created and cleared in
473 generic board board_init_f(). Without this macro, architecture/board
474 should initialize global data before calling board_init_f().
475
Daniel Schwierzeckd8a49ca2012-04-02 02:57:56 +0000476 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
477
478 Defines the endianess of the CPU. Implementation of those
479 values is arch specific.
480
York Sunf0626592013-09-30 09:22:09 -0700481 CONFIG_SYS_FSL_DDR
482 Freescale DDR driver in use. This type of DDR controller is
483 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
484 SoCs.
485
486 CONFIG_SYS_FSL_DDR_ADDR
487 Freescale DDR memory-mapped register base.
488
489 CONFIG_SYS_FSL_DDR_EMU
490 Specify emulator support for DDR. Some DDR features such as
491 deskew training are not available.
492
493 CONFIG_SYS_FSL_DDRC_GEN1
494 Freescale DDR1 controller.
495
496 CONFIG_SYS_FSL_DDRC_GEN2
497 Freescale DDR2 controller.
498
499 CONFIG_SYS_FSL_DDRC_GEN3
500 Freescale DDR3 controller.
501
York Sun2896cb72014-03-27 17:54:47 -0700502 CONFIG_SYS_FSL_DDRC_GEN4
503 Freescale DDR4 controller.
504
York Sun461c9392013-09-30 14:20:51 -0700505 CONFIG_SYS_FSL_DDRC_ARM_GEN3
506 Freescale DDR3 controller for ARM-based SoCs.
507
York Sunf0626592013-09-30 09:22:09 -0700508 CONFIG_SYS_FSL_DDR1
509 Board config to use DDR1. It can be enabled for SoCs with
510 Freescale DDR1 or DDR2 controllers, depending on the board
511 implemetation.
512
513 CONFIG_SYS_FSL_DDR2
514 Board config to use DDR2. It can be eanbeld for SoCs with
515 Freescale DDR2 or DDR3 controllers, depending on the board
516 implementation.
517
518 CONFIG_SYS_FSL_DDR3
519 Board config to use DDR3. It can be enabled for SoCs with
York Sun2896cb72014-03-27 17:54:47 -0700520 Freescale DDR3 or DDR3L controllers.
521
522 CONFIG_SYS_FSL_DDR3L
523 Board config to use DDR3L. It can be enabled for SoCs with
524 DDR3L controllers.
525
526 CONFIG_SYS_FSL_DDR4
527 Board config to use DDR4. It can be enabled for SoCs with
528 DDR4 controllers.
York Sunf0626592013-09-30 09:22:09 -0700529
Prabhakar Kushwaha62908c22014-01-18 12:28:30 +0530530 CONFIG_SYS_FSL_IFC_BE
531 Defines the IFC controller register space as Big Endian
532
533 CONFIG_SYS_FSL_IFC_LE
534 Defines the IFC controller register space as Little Endian
535
Prabhakar Kushwaha950f2f72014-01-13 11:28:04 +0530536 CONFIG_SYS_FSL_PBL_PBI
537 It enables addition of RCW (Power on reset configuration) in built image.
538 Please refer doc/README.pblimage for more details
539
540 CONFIG_SYS_FSL_PBL_RCW
541 It adds PBI(pre-boot instructions) commands in u-boot build image.
542 PBI commands can be used to configure SoC before it starts the execution.
543 Please refer doc/README.pblimage for more details
544
Prabhakar Kushwaha2c27f122014-04-08 19:13:34 +0530545 CONFIG_SPL_FSL_PBL
546 It adds a target to create boot binary having SPL binary in PBI format
547 concatenated with u-boot binary.
548
York Sun29647ab2014-02-10 13:59:42 -0800549 CONFIG_SYS_FSL_DDR_BE
550 Defines the DDR controller register space as Big Endian
551
552 CONFIG_SYS_FSL_DDR_LE
553 Defines the DDR controller register space as Little Endian
554
York Sun3a0916d2014-02-10 13:59:43 -0800555 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
556 Physical address from the view of DDR controllers. It is the
557 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
558 it could be different for ARM SoCs.
559
York Sunc459ae62014-02-10 13:59:44 -0800560 CONFIG_SYS_FSL_DDR_INTLV_256B
561 DDR controller interleaving on 256-byte. This is a special
562 interleaving mode, handled by Dickens for Freescale layerscape
563 SoCs with ARM core.
564
York Sun79a779b2014-08-01 15:51:00 -0700565 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
566 Number of controllers used as main memory.
567
568 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
569 Number of controllers used for other than main memory.
570
Prabhakar Kushwaha122bcfd2015-11-09 16:42:07 +0530571 CONFIG_SYS_FSL_HAS_DP_DDR
572 Defines the SoC has DP-DDR used for DPAA.
573
Ruchika Guptabb7143b2014-09-09 11:50:31 +0530574 CONFIG_SYS_FSL_SEC_BE
575 Defines the SEC controller register space as Big Endian
576
577 CONFIG_SYS_FSL_SEC_LE
578 Defines the SEC controller register space as Little Endian
579
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100580- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200581 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100582
583 Defines the Monahans run mode to oscillator
584 ratio. Valid values are 8, 16, 24, 31. The core
585 frequency is this value multiplied by 13 MHz.
586
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200587 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200588
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100589 Defines the Monahans turbo mode to oscillator
590 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200591 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher6e5c19a2006-03-24 15:28:02 +0100592 by this value.
Wolfgang Denkebd3deb2006-04-16 10:51:58 +0200593
Daniel Schwierzeckd52a6232011-07-27 13:22:39 +0200594- MIPS CPU options:
595 CONFIG_SYS_INIT_SP_OFFSET
596
597 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
598 pointer. This is needed for the temporary stack before
599 relocation.
600
601 CONFIG_SYS_MIPS_CACHE_MODE
602
603 Cache operation mode for the MIPS CPU.
604 See also arch/mips/include/asm/mipsregs.h.
605 Possible values are:
606 CONF_CM_CACHABLE_NO_WA
607 CONF_CM_CACHABLE_WA
608 CONF_CM_UNCACHED
609 CONF_CM_CACHABLE_NONCOHERENT
610 CONF_CM_CACHABLE_CE
611 CONF_CM_CACHABLE_COW
612 CONF_CM_CACHABLE_CUW
613 CONF_CM_CACHABLE_ACCELERATED
614
615 CONFIG_SYS_XWAY_EBU_BOOTCFG
616
617 Special option for Lantiq XWAY SoCs for booting from NOR flash.
618 See also arch/mips/cpu/mips32/start.S.
619
620 CONFIG_XWAY_SWAP_BYTES
621
622 Enable compilation of tools/xway-swap-bytes needed for Lantiq
623 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
624 be swapped if a flash programmer is used.
625
Christian Riesch48c2d6d2012-02-02 00:44:39 +0000626- ARM options:
627 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
628
629 Select high exception vectors of the ARM core, e.g., do not
630 clear the V bit of the c1 register of CP15.
631
Aneesh Vb8e40802012-03-08 07:20:19 +0000632 CONFIG_SYS_THUMB_BUILD
633
634 Use this flag to build U-Boot using the Thumb instruction
635 set for ARM architectures. Thumb instruction set provides
636 better code density. For ARM architectures that support
637 Thumb2 this flag will result in Thumb2 code generated by
638 GCC.
639
Stephen Warrenc63c3502013-03-04 13:29:40 +0000640 CONFIG_ARM_ERRATA_716044
Stephen Warrene9d59c92013-02-26 12:28:27 +0000641 CONFIG_ARM_ERRATA_742230
642 CONFIG_ARM_ERRATA_743622
643 CONFIG_ARM_ERRATA_751472
Nitin Garg245defa2014-04-02 08:55:02 -0500644 CONFIG_ARM_ERRATA_761320
Ian Campbell363e4242015-09-29 10:27:09 +0100645 CONFIG_ARM_ERRATA_773022
646 CONFIG_ARM_ERRATA_774769
647 CONFIG_ARM_ERRATA_794072
Stephen Warrene9d59c92013-02-26 12:28:27 +0000648
649 If set, the workarounds for these ARM errata are applied early
650 during U-Boot startup. Note that these options force the
651 workarounds to be applied; no CPU-type/version detection
652 exists, unlike the similar options in the Linux kernel. Do not
653 set these options unless they apply!
654
York Sun77a10972015-03-20 19:28:08 -0700655 COUNTER_FREQUENCY
656 Generic timer clock source frequency.
657
658 COUNTER_FREQUENCY_REAL
659 Generic timer clock source frequency if the real clock is
660 different from COUNTER_FREQUENCY, and can only be determined
661 at run time.
662
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500663 NOTE: The following can be machine specific errata. These
664 do have ability to provide rudimentary version and machine
665 specific checks, but expect no product checks.
Nishanth Menon3f445112015-03-09 17:12:01 -0500666 CONFIG_ARM_ERRATA_430973
Nishanth Menon071d6ce2015-03-09 17:12:00 -0500667 CONFIG_ARM_ERRATA_454179
Nishanth Menon49db62d2015-03-09 17:12:02 -0500668 CONFIG_ARM_ERRATA_621766
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500669 CONFIG_ARM_ERRATA_798870
Nishanth Menon6e2bd2e2015-07-27 16:26:05 -0500670 CONFIG_ARM_ERRATA_801819
Nishanth Menonaa0294e2015-03-09 17:11:59 -0500671
Stephen Warren8d1fb312015-01-19 16:25:52 -0700672- Tegra SoC options:
673 CONFIG_TEGRA_SUPPORT_NON_SECURE
674
675 Support executing U-Boot in non-secure (NS) mode. Certain
676 impossible actions will be skipped if the CPU is in NS mode,
677 such as ARM architectural timer initialization.
678
wdenk9b7f3842003-10-09 20:09:04 +0000679- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000680 CONFIG_CLOCKS_IN_MHZ
681
682 U-Boot stores all clock information in Hz
683 internally. For binary compatibility with older Linux
684 kernels (which expect the clocks passed in the
685 bd_info data to be in MHz) the environment variable
686 "clocks_in_mhz" can be defined so that U-Boot
687 converts clock data to MHZ before passing it to the
688 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000689 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denkb240aef2008-03-26 10:40:12 +0100690 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000691 default environment.
692
wdenk9b7f3842003-10-09 20:09:04 +0000693 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
694
Jeremiah Mahler03f930c2015-01-04 18:56:50 -0800695 When transferring memsize parameter to Linux, some versions
wdenk9b7f3842003-10-09 20:09:04 +0000696 expect it to be in bytes, others in MB.
697 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
698
Gerald Van Barenfcd91bb2008-06-03 20:34:45 -0400699 CONFIG_OF_LIBFDT
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200700
701 New kernel versions are expecting firmware settings to be
Gerald Van Barend6abef42007-03-31 12:23:51 -0400702 passed using flattened device trees (based on open firmware
703 concepts).
704
705 CONFIG_OF_LIBFDT
706 * New libfdt-based support
707 * Adds the "fdt" command
Kim Phillips9b46eb62007-08-10 14:34:14 -0500708 * The bootm command automatically updates the fdt
Gerald Van Barend6abef42007-03-31 12:23:51 -0400709
Marcel Ziswilerb29bc712009-09-09 21:18:41 +0200710 OF_CPU - The proper name of the cpus node (only required for
711 MPC512X and MPC5xxx based boards).
712 OF_SOC - The proper name of the soc node (only required for
713 MPC512X and MPC5xxx based boards).
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200714 OF_TBCLK - The timebase frequency.
Kumar Galae40c2b52006-01-11 13:59:02 -0600715 OF_STDOUT_PATH - The path to the console device
Wolfgang Denk27a5b0b2005-10-13 01:45:54 +0200716
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200717 boards with QUICC Engines require OF_QE to set UCC MAC
718 addresses
Kim Phillips9b46eb62007-08-10 14:34:14 -0500719
Kumar Gala1e26aa52006-01-11 13:54:17 -0600720 CONFIG_OF_BOARD_SETUP
721
722 Board code has addition modification that it wants to make
723 to the flat device tree before handing it off to the kernel
wdenkda04a8b2004-08-02 23:22:59 +0000724
Simon Glass6c0be912014-10-23 18:58:54 -0600725 CONFIG_OF_SYSTEM_SETUP
726
727 Other code has addition modification that it wants to make
728 to the flat device tree before handing it off to the kernel.
729 This causes ft_system_setup() to be called before booting
730 the kernel.
731
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500732 CONFIG_OF_BOOT_CPU
733
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200734 This define fills in the correct boot CPU in the boot
Matthew McClintockefae4ca2006-06-28 10:41:37 -0500735 param header, the default value is zero if undefined.
736
Heiko Schocherffb293a2009-09-23 07:56:08 +0200737 CONFIG_OF_IDE_FIXUP
738
739 U-Boot can detect if an IDE device is present or not.
740 If not, and this new config option is activated, U-Boot
741 removes the ATA node from the DTS before booting Linux,
742 so the Linux IDE driver does not probe the device and
743 crash. This is needed for buggy hardware (uc101) where
744 no pull down resistor is connected to the signal IDE5V_DD7.
745
Igor Grinberg06890672011-07-14 05:45:07 +0000746 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
747
748 This setting is mandatory for all boards that have only one
749 machine type and must be used to specify the machine type
750 number as it appears in the ARM machine registry
751 (see http://www.arm.linux.org.uk/developer/machines/).
752 Only boards that have multiple machine types supported
753 in a single configuration file and the machine type is
754 runtime discoverable, do not have to use this setting.
755
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100756- vxWorks boot parameters:
757
758 bootvx constructs a valid bootline using the following
Bin Mengfb694b92015-10-07 20:19:17 -0700759 environments variables: bootdev, bootfile, ipaddr, netmask,
760 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100761 It loads the vxWorks image pointed bootfile.
762
Niklaus Giger0ab978d2008-11-03 22:13:47 +0100763 Note: If a "bootargs" environment is defined, it will overwride
764 the defaults discussed just above.
765
Aneesh V960f5c02011-06-16 23:30:47 +0000766- Cache Configuration:
767 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
768 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
769 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
770
Aneesh V686a0752011-06-16 23:30:51 +0000771- Cache Configuration for ARM:
772 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
773 controller
774 CONFIG_SYS_PL310_BASE - Physical base address of PL310
775 controller register space
776
wdenkda04a8b2004-08-02 23:22:59 +0000777- Serial Ports:
Andreas Engel0813b122008-09-08 14:30:53 +0200778 CONFIG_PL010_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000779
780 Define this if you want support for Amba PrimeCell PL010 UARTs.
781
Andreas Engel0813b122008-09-08 14:30:53 +0200782 CONFIG_PL011_SERIAL
wdenkda04a8b2004-08-02 23:22:59 +0000783
784 Define this if you want support for Amba PrimeCell PL011 UARTs.
785
786 CONFIG_PL011_CLOCK
787
788 If you have Amba PrimeCell PL011 UARTs, set this variable to
789 the clock speed of the UARTs.
790
791 CONFIG_PL01x_PORTS
792
793 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
794 define this to a list of base addresses for each (supported)
795 port. See e.g. include/configs/versatile.h
796
Karicheri, Muralidharancbc08882014-04-09 15:38:46 -0400797 CONFIG_SERIAL_HW_FLOW_CONTROL
798
799 Define this variable to enable hw flow control in serial driver.
800 Current user of this option is drivers/serial/nsl16550.c driver
wdenkda04a8b2004-08-02 23:22:59 +0000801
wdenkc6097192002-11-03 00:24:07 +0000802- Console Interface:
wdenk4a5c8a72003-03-06 00:02:04 +0000803 Depending on board, define exactly one serial port
804 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
805 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
806 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000807
808 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
809 port routines must be defined elsewhere
810 (i.e. serial_init(), serial_getc(), ...)
811
812 CONFIG_CFB_CONSOLE
813 Enables console device for a color framebuffer. Needs following
Wolfgang Denkf6e50a42011-12-07 12:19:20 +0000814 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000815 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
816 (default big endian)
817 VIDEO_HW_RECTFILL graphic chip supports
818 rectangle fill
819 (cf. smiLynxEM)
820 VIDEO_HW_BITBLT graphic chip supports
821 bit-blit (cf. smiLynxEM)
822 VIDEO_VISIBLE_COLS visible pixel columns
823 (cols=pitch)
wdenk544e9732004-02-06 23:19:44 +0000824 VIDEO_VISIBLE_ROWS visible pixel rows
825 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000826 VIDEO_DATA_FORMAT graphic data format
827 (0-5, cf. cfb_console.c)
wdenk544e9732004-02-06 23:19:44 +0000828 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000829 VIDEO_KBD_INIT_FCT keyboard int fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700830 (i.e. rx51_kp_init())
wdenkc6097192002-11-03 00:24:07 +0000831 VIDEO_TSTC_FCT test char fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700832 (i.e. rx51_kp_tstc)
wdenkc6097192002-11-03 00:24:07 +0000833 VIDEO_GETC_FCT get char fct
Simon Glasseaba37e2015-11-11 10:05:47 -0700834 (i.e. rx51_kp_getc)
wdenkc6097192002-11-03 00:24:07 +0000835 CONFIG_VIDEO_LOGO display Linux logo in
836 upper left corner
wdenk9dd2b882002-12-03 21:28:10 +0000837 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
838 linux_logo.h for logo.
839 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000840 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200841 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000842 the logo
843
Pali Rohár4a57da32012-10-19 13:30:09 +0000844 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
845 a limited number of ANSI escape sequences (cursor control,
846 erase functions and limited graphics rendition control).
847
wdenk4a5c8a72003-03-06 00:02:04 +0000848 When CONFIG_CFB_CONSOLE is defined, video console is
849 default i/o. Serial console can be forced with
850 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000851
wdenk1ebf41e2004-01-02 14:00:00 +0000852 When CONFIG_SILENT_CONSOLE is defined, all console
853 messages (by U-Boot and Linux!) can be silenced with
854 the "silent" environment variable. See
855 doc/README.silent for more information.
wdenk3da587e2003-10-19 23:22:11 +0000856
Heiko Schocher62759562013-10-22 11:06:06 +0200857 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
858 is 0x00.
859 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
860 is 0xa0.
861
wdenkc6097192002-11-03 00:24:07 +0000862- Console Baudrate:
863 CONFIG_BAUDRATE - in bps
864 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200865 CONFIG_SYS_BAUDRATE_TABLE, see below.
866 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000867
Heiko Schocher327480a2009-01-30 12:55:38 +0100868- Console Rx buffer length
869 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
870 the maximum receive buffer length for the SMC.
Heiko Schocher362447f2009-02-10 09:31:47 +0100871 This option is actual only for 82xx and 8xx possible.
Heiko Schocher327480a2009-01-30 12:55:38 +0100872 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
873 must be defined, to setup the maximum idle timeout for
874 the SMC.
875
Graeme Russ3c28f482011-09-01 00:48:27 +0000876- Pre-Console Buffer:
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200877 Prior to the console being initialised (i.e. serial UART
878 initialised etc) all console output is silently discarded.
879 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
880 buffer any console messages prior to the console being
881 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
882 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
883 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk23f78482011-10-09 21:06:34 +0200884 bytes are output before the console is initialised, the
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200885 earlier bytes are discarded.
Graeme Russ3c28f482011-09-01 00:48:27 +0000886
Hans de Goedee355da02015-05-05 13:13:36 +0200887 Note that when printing the buffer a copy is made on the
888 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
889
Wolfgang Denkd590fb12011-10-07 09:58:21 +0200890 'Sane' compilers will generate smaller code if
891 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ3c28f482011-09-01 00:48:27 +0000892
wdenkc6097192002-11-03 00:24:07 +0000893- Boot Delay: CONFIG_BOOTDELAY - in seconds
894 Delay before automatically booting the default image;
895 set to -1 to disable autoboot.
Joe Hershberger96ccaf32012-08-17 10:53:12 +0000896 set to -2 to autoboot with no delay and not check for abort
897 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000898
899 See doc/README.autoboot for these options that
900 work with CONFIG_BOOTDELAY. None are required.
901 CONFIG_BOOT_RETRY_TIME
902 CONFIG_BOOT_RETRY_MIN
903 CONFIG_AUTOBOOT_KEYED
904 CONFIG_AUTOBOOT_PROMPT
905 CONFIG_AUTOBOOT_DELAY_STR
906 CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +0000907 CONFIG_ZERO_BOOTDELAY_CHECK
908 CONFIG_RESET_TO_RETRY
909
910- Autoboot Command:
911 CONFIG_BOOTCOMMAND
912 Only needed when CONFIG_BOOTDELAY is enabled;
913 define a command string that is automatically executed
914 when no character is read on the console interface
915 within "Boot Delay" after reset.
916
917 CONFIG_BOOTARGS
wdenk4a5c8a72003-03-06 00:02:04 +0000918 This can be used to pass arguments to the bootm
919 command. The value of CONFIG_BOOTARGS goes into the
920 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000921
922 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk4a5c8a72003-03-06 00:02:04 +0000923 The value of these goes into the environment as
924 "ramboot" and "nfsboot" respectively, and can be used
925 as a convenience, when switching between booting from
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +0200926 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000927
Heiko Schocher040c5c32013-11-04 14:04:59 +0100928- Bootcount:
929 CONFIG_BOOTCOUNT_LIMIT
930 Implements a mechanism for detecting a repeating reboot
931 cycle, see:
932 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
933
934 CONFIG_BOOTCOUNT_ENV
935 If no softreset save registers are found on the hardware
936 "bootcount" is stored in the environment. To prevent a
937 saveenv on all reboots, the environment variable
938 "upgrade_available" is used. If "upgrade_available" is
939 0, "bootcount" is always 0, if "upgrade_available" is
940 1 "bootcount" is incremented in the environment.
941 So the Userspace Applikation must set the "upgrade_available"
942 and "bootcount" variable to 0, if a boot was successfully.
943
wdenkc6097192002-11-03 00:24:07 +0000944- Pre-Boot Commands:
945 CONFIG_PREBOOT
946
947 When this option is #defined, the existence of the
948 environment variable "preboot" will be checked
949 immediately before starting the CONFIG_BOOTDELAY
950 countdown and/or running the auto-boot command resp.
951 entering interactive mode.
952
953 This feature is especially useful when "preboot" is
954 automatically generated or modified. For an example
955 see the LWMON board specific code: here "preboot" is
956 modified when the user holds down a certain
957 combination of keys on the (special) keyboard when
958 booting the systems
959
960- Serial Download Echo Mode:
961 CONFIG_LOADS_ECHO
962 If defined to 1, all characters received during a
963 serial download (using the "loads" command) are
964 echoed back. This might be needed by some terminal
965 emulations (like "cu"), but may as well just take
966 time on others. This setting #define's the initial
967 value of the "loads_echo" environment variable.
968
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500969- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000970 CONFIG_KGDB_BAUDRATE
971 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +0200972 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000973
974- Monitor Functions:
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500975 Monitor commands can be included or excluded
976 from the build by using the #include files
Stephen Warren963a7cf2012-08-05 16:07:19 +0000977 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershberger5a9d7f12015-06-22 16:15:30 -0500978 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000979
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500980 The default command configuration includes all commands
981 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000982
Marek Vasutc4d8a1b2014-03-05 19:58:39 +0100983 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500984 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500985 CONFIG_CMD_BDI bdinfo
986 CONFIG_CMD_BEDBUG * Include BedBug Debugger
987 CONFIG_CMD_BMP * BMP support
988 CONFIG_CMD_BSP * Board specific commands
989 CONFIG_CMD_BOOTD bootd
Tom Rini5ce62cd2014-08-14 06:42:36 -0400990 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500991 CONFIG_CMD_CACHE * icache, dcache
Michal Simeka0d28022013-11-21 13:39:02 -0800992 CONFIG_CMD_CLK * clock command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500993 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger321ab9e2010-12-21 14:19:51 -0500994 CONFIG_CMD_CRC32 * crc32
Jon Loeligerc1da5c92007-06-11 19:03:39 -0500995 CONFIG_CMD_DATE * support for RTC, date/time...
996 CONFIG_CMD_DHCP * DHCP support
997 CONFIG_CMD_DIAG * Diagnostics
Peter Tyser15258042008-12-17 16:36:22 -0600998 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
999 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1000 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1001 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001002 CONFIG_CMD_DTT * Digital Therm and Thermostat
1003 CONFIG_CMD_ECHO echo arguments
Peter Tyser0deafa22009-10-25 15:12:56 -05001004 CONFIG_CMD_EDITENV edit env variable
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001005 CONFIG_CMD_EEPROM * EEPROM read/write support
1006 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001007 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001008 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001009 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001010 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001011 CONFIG_CMD_EXT2 * ext2 command support
1012 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001013 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1014 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001015 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001016 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001017 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001018 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001019 CONFIG_CMD_FLASH flinfo, erase, protect
1020 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001021 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001022 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001023 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001024 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001025 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001026 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1027 CONFIG_CMD_I2C * I2C serial bus support
1028 CONFIG_CMD_IDE * IDE harddisk support
1029 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001030 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001031 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001032 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001033 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001034 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001035 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001036 CONFIG_CMD_IRQ * irqinfo
1037 CONFIG_CMD_ITEST Integer/string test of 2 values
1038 CONFIG_CMD_JFFS2 * JFFS2 Support
1039 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001040 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001041 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1042 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001043 CONFIG_CMD_LOADB loadb
1044 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001045 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001046 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001047 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001048 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001049 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001050 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001051 CONFIG_CMD_MISC Misc functions like sleep etc
1052 CONFIG_CMD_MMC * MMC memory mapped support
1053 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001054 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001055 CONFIG_CMD_NAND * NAND support
1056 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001057 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001058 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001059 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001060 CONFIG_CMD_PCI * pciinfo
1061 CONFIG_CMD_PCMCIA * PCMCIA support
1062 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1063 host
1064 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001065 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001066 CONFIG_CMD_REGINFO * Register dump
1067 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001068 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001069 CONFIG_CMD_SAVES * save S record dump
1070 CONFIG_CMD_SCSI * SCSI Support
1071 CONFIG_CMD_SDRAM * print SDRAM configuration information
1072 (requires CONFIG_CMD_I2C)
1073 CONFIG_CMD_SETGETDCR Support for DCR Register access
1074 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001075 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001076 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001077 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001078 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001079 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001080 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001081 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001082 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001083 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1084 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001085 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001086 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001087 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001088 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001089 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001090
1091 EXAMPLE: If you want all functions except of network
1092 support you can write:
1093
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001094 #include "config_cmd_all.h"
1095 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001096
Gerald Van Barend6abef42007-03-31 12:23:51 -04001097 Other Commands:
1098 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001099
1100 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001101 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001102 what you (and your U-Boot users) are doing. Data
1103 cache cannot be enabled on systems like the 8xx or
1104 8260 (where accesses to the IMMR region must be
1105 uncached), and it cannot be disabled on all other
1106 systems where we (mis-) use the data cache to hold an
1107 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001108
1109
1110 XXX - this list needs to get updated!
1111
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001112- Regular expression support:
1113 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001114 If this variable is defined, U-Boot is linked against
1115 the SLRE (Super Light Regular Expression) library,
1116 which adds regex support to some commands, as for
1117 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001118
Simon Glass3d686442011-10-15 05:48:20 +00001119- Device tree:
1120 CONFIG_OF_CONTROL
1121 If this variable is defined, U-Boot will use a device tree
1122 to configure its devices, instead of relying on statically
1123 compiled #defines in the board file. This option is
1124 experimental and only available on a few boards. The device
1125 tree is available in the global data as gd->fdt_blob.
1126
Simon Glass5cb34db2011-10-24 19:15:31 +00001127 U-Boot needs to get its device tree from somewhere. This can
1128 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001129
1130 CONFIG_OF_EMBED
1131 If this variable is defined, U-Boot will embed a device tree
1132 binary in its image. This device tree file should be in the
1133 board directory and called <soc>-<board>.dts. The binary file
1134 is then picked up in board_init_f() and made available through
1135 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001136
Simon Glass5cb34db2011-10-24 19:15:31 +00001137 CONFIG_OF_SEPARATE
1138 If this variable is defined, U-Boot will build a device tree
1139 binary. It will be called u-boot.dtb. Architecture-specific
1140 code will locate it at run-time. Generally this works by:
1141
1142 cat u-boot.bin u-boot.dtb >image.bin
1143
1144 and in fact, U-Boot does this for you, creating a file called
1145 u-boot-dtb.bin which is useful in the common case. You can
1146 still use the individual files if you need something more
1147 exotic.
1148
wdenkc6097192002-11-03 00:24:07 +00001149- Watchdog:
1150 CONFIG_WATCHDOG
1151 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001152 support for the SoC. There must be support in the SoC
1153 specific code for a watchdog. For the 8xx and 8260
1154 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1155 register. When supported for a specific SoC is
1156 available, then no further board specific code should
1157 be needed to use it.
1158
1159 CONFIG_HW_WATCHDOG
1160 When using a watchdog circuitry external to the used
1161 SoC, then define this variable and provide board
1162 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001163
Heiko Schocher735326c2015-01-21 08:38:22 +01001164 CONFIG_AT91_HW_WDT_TIMEOUT
1165 specify the timeout in seconds. default 2 seconds.
1166
stroeseb9c17c52003-04-04 15:53:41 +00001167- U-Boot Version:
1168 CONFIG_VERSION_VARIABLE
1169 If this variable is defined, an environment variable
1170 named "ver" is created by U-Boot showing the U-Boot
1171 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001172 Any change to this variable will be reverted at the
1173 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001174
wdenkc6097192002-11-03 00:24:07 +00001175- Real-Time Clock:
1176
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001177 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001178 has to be selected, too. Define exactly one of the
1179 following options:
1180
1181 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1182 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001183 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001184 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001185 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001186 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001187 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001188 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001189 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001190 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001191 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001192 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001193 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1194 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001195
wdenkb9bbd242003-06-30 16:24:52 +00001196 Note that if the RTC uses I2C, then the I2C interface
1197 must also be configured. See I2C Support, below.
1198
Peter Tyser9902e422008-12-17 16:36:21 -06001199- GPIO Support:
1200 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001201
Chris Packham9b383202010-12-19 10:12:13 +00001202 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1203 chip-ngpio pairs that tell the PCA953X driver the number of
1204 pins supported by a particular chip.
1205
Peter Tyser9902e422008-12-17 16:36:21 -06001206 Note that if the GPIO device uses I2C, then the I2C interface
1207 must also be configured. See I2C Support, below.
1208
Simon Glass4dc47ca2014-06-11 23:29:41 -06001209- I/O tracing:
1210 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1211 accesses and can checksum them or write a list of them out
1212 to memory. See the 'iotrace' command for details. This is
1213 useful for testing device drivers since it can confirm that
1214 the driver behaves the same way before and after a code
1215 change. Currently this is supported on sandbox and arm. To
1216 add support for your architecture, add '#include <iotrace.h>'
1217 to the bottom of arch/<arch>/include/asm/io.h and test.
1218
1219 Example output from the 'iotrace stats' command is below.
1220 Note that if the trace buffer is exhausted, the checksum will
1221 still continue to operate.
1222
1223 iotrace is enabled
1224 Start: 10000000 (buffer start address)
1225 Size: 00010000 (buffer size)
1226 Offset: 00000120 (current buffer offset)
1227 Output: 10000120 (start + offset)
1228 Count: 00000018 (number of trace records)
1229 CRC32: 9526fb66 (CRC32 of all trace records)
1230
wdenkc6097192002-11-03 00:24:07 +00001231- Timestamp Support:
1232
wdenk4a5c8a72003-03-06 00:02:04 +00001233 When CONFIG_TIMESTAMP is selected, the timestamp
1234 (date and time) of an image is printed by image
1235 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001236 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001237
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001238- Partition Labels (disklabels) Supported:
1239 Zero or more of the following:
1240 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1241 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1242 Intel architecture, USB sticks, etc.
1243 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1244 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1245 bootloader. Note 2TB partition limit; see
1246 disk/part_efi.c
1247 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001248
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001249 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1250 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001251 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001252
1253- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001254 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1255 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001256
wdenk369d43d2004-03-14 14:09:05 +00001257 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1258 be performed by calling the function
1259 ide_set_reset(int reset)
1260 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001261
1262- ATAPI Support:
1263 CONFIG_ATAPI
1264
1265 Set this to enable ATAPI support.
1266
wdenkf602aa02004-03-13 23:29:43 +00001267- LBA48 Support
1268 CONFIG_LBA48
1269
1270 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001271 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001272 Whithout these , LBA48 support uses 32bit variables and will 'only'
1273 support disks up to 2.1TB.
1274
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001275 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001276 When enabled, makes the IDE subsystem use 64bit sector addresses.
1277 Default is 32bit.
1278
wdenkc6097192002-11-03 00:24:07 +00001279- SCSI Support:
1280 At the moment only there is only support for the
1281 SYM53C8XX SCSI controller; define
1282 CONFIG_SCSI_SYM53C8XX to enable it.
1283
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001284 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1285 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1286 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001287 maximum numbers of LUNs, SCSI ID's and target
1288 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001289 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001290
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001291 The environment variable 'scsidevs' is set to the number of
1292 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001293
wdenkc6097192002-11-03 00:24:07 +00001294- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001295 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001296 Support for Intel 8254x/8257x gigabit chips.
1297
1298 CONFIG_E1000_SPI
1299 Utility code for direct access to the SPI bus on Intel 8257x.
1300 This does not do anything useful unless you set at least one
1301 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1302
1303 CONFIG_E1000_SPI_GENERIC
1304 Allow generic access to the SPI bus on the Intel 8257x, for
1305 example with the "sspi" command.
1306
1307 CONFIG_CMD_E1000
1308 Management command for E1000 devices. When used on devices
1309 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001310
wdenkc6097192002-11-03 00:24:07 +00001311 CONFIG_EEPRO100
1312 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001313 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001314 write routine for first time initialisation.
1315
1316 CONFIG_TULIP
1317 Support for Digital 2114x chips.
1318 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1319 modem chip initialisation (KS8761/QS6611).
1320
1321 CONFIG_NATSEMI
1322 Support for National dp83815 chips.
1323
1324 CONFIG_NS8382X
1325 Support for National dp8382[01] gigabit chips.
1326
wdenkaa603362003-05-12 21:50:16 +00001327- NETWORK Support (other):
1328
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001329 CONFIG_DRIVER_AT91EMAC
1330 Support for AT91RM9200 EMAC.
1331
1332 CONFIG_RMII
1333 Define this to use reduced MII inteface
1334
1335 CONFIG_DRIVER_AT91EMAC_QUIET
1336 If this defined, the driver is quiet.
1337 The driver doen't show link status messages.
1338
Rob Herringc9830dc2011-12-15 11:15:49 +00001339 CONFIG_CALXEDA_XGMAC
1340 Support for the Calxeda XGMAC device
1341
Ashok93fb8722012-10-15 06:20:47 +00001342 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001343 Support for SMSC's LAN91C96 chips.
1344
1345 CONFIG_LAN91C96_BASE
1346 Define this to hold the physical address
1347 of the LAN91C96's I/O space
1348
1349 CONFIG_LAN91C96_USE_32_BIT
1350 Define this to enable 32 bit addressing
1351
Ashok93fb8722012-10-15 06:20:47 +00001352 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001353 Support for SMSC's LAN91C111 chip
1354
1355 CONFIG_SMC91111_BASE
1356 Define this to hold the physical address
1357 of the device (I/O space)
1358
1359 CONFIG_SMC_USE_32_BIT
1360 Define this if data bus is 32 bits
1361
1362 CONFIG_SMC_USE_IOFUNCS
1363 Define this to use i/o functions instead of macros
1364 (some hardware wont work with macros)
1365
Heiko Schocher7d037f72011-11-15 10:00:04 -05001366 CONFIG_DRIVER_TI_EMAC
1367 Support for davinci emac
1368
1369 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1370 Define this if you have more then 3 PHYs.
1371
Macpaul Lin199c6252010-12-21 16:59:46 +08001372 CONFIG_FTGMAC100
1373 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1374
1375 CONFIG_FTGMAC100_EGIGA
1376 Define this to use GE link update with gigabit PHY.
1377 Define this if FTGMAC100 is connected to gigabit PHY.
1378 If your system has 10/100 PHY only, it might not occur
1379 wrong behavior. Because PHY usually return timeout or
1380 useless data when polling gigabit status and gigabit
1381 control registers. This behavior won't affect the
1382 correctnessof 10/100 link speed update.
1383
Mike Rapoportf4761af2009-11-11 10:03:03 +02001384 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001385 Support for SMSC's LAN911x and LAN921x chips
1386
Mike Rapoportf4761af2009-11-11 10:03:03 +02001387 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001388 Define this to hold the physical address
1389 of the device (I/O space)
1390
Mike Rapoportf4761af2009-11-11 10:03:03 +02001391 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001392 Define this if data bus is 32 bits
1393
Mike Rapoportf4761af2009-11-11 10:03:03 +02001394 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001395 Define this if data bus is 16 bits. If your processor
1396 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001397 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001398
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001399 CONFIG_SH_ETHER
1400 Support for Renesas on-chip Ethernet controller
1401
1402 CONFIG_SH_ETHER_USE_PORT
1403 Define the number of ports to be used
1404
1405 CONFIG_SH_ETHER_PHY_ADDR
1406 Define the ETH PHY's address
1407
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001408 CONFIG_SH_ETHER_CACHE_WRITEBACK
1409 If this option is set, the driver enables cache flush.
1410
Heiko Schocher2b387762014-07-18 06:07:19 +02001411- PWM Support:
1412 CONFIG_PWM_IMX
1413 Support for PWM modul on the imx6.
1414
Vadim Bendeburydac69642011-10-17 08:36:14 +00001415- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001416 CONFIG_TPM
1417 Support TPM devices.
1418
Christophe Ricard8759ff82015-10-06 22:54:41 +02001419 CONFIG_TPM_TIS_INFINEON
1420 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001421 per system is supported at this time.
1422
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001423 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1424 Define the burst count bytes upper limit
1425
Dirk Eibach20489092013-06-26 15:55:15 +02001426 CONFIG_TPM_ATMEL_TWI
1427 Support for Atmel TWI TPM device. Requires I2C support.
1428
Che-liang Chiouacea5702013-04-12 11:04:34 +00001429 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001430 Support for generic parallel port TPM devices. Only one device
1431 per system is supported at this time.
1432
1433 CONFIG_TPM_TIS_BASE_ADDRESS
1434 Base address where the generic TPM device is mapped
1435 to. Contemporary x86 systems usually map it at
1436 0xfed40000.
1437
Reinhard Pfau4fece432013-06-26 15:55:13 +02001438 CONFIG_CMD_TPM
1439 Add tpm monitor functions.
1440 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1441 provides monitor access to authorized functions.
1442
1443 CONFIG_TPM
1444 Define this to enable the TPM support library which provides
1445 functional interfaces to some TPM commands.
1446 Requires support for a TPM device.
1447
1448 CONFIG_TPM_AUTH_SESSIONS
1449 Define this to enable authorized functions in the TPM library.
1450 Requires CONFIG_TPM and CONFIG_SHA1.
1451
wdenkc6097192002-11-03 00:24:07 +00001452- USB Support:
1453 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001454 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001455 CONFIG_USB_UHCI to enable it.
1456 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001457 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001458 storage devices.
1459 Note:
1460 Supported are USB Keyboards and USB Floppy drives
1461 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001462 MPC5200 USB requires additional defines:
1463 CONFIG_USB_CLOCK
1464 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001465 CONFIG_PSC3_USB
1466 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001467 CONFIG_USB_CONFIG
1468 for differential drivers: 0x00001000
1469 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001470 for differential drivers on PSC3: 0x00000100
1471 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001472 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001473 May be defined to allow interrupt polling
1474 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001475
Simon Glass5978cdb2012-02-27 10:52:47 +00001476 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1477 txfilltuning field in the EHCI controller on reset.
1478
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001479 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1480 HW module registers.
1481
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001482- USB Device:
1483 Define the below if you wish to use the USB console.
1484 Once firmware is rebuilt from a serial console issue the
1485 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001486 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001487 it has found a new device. The environment variable usbtty
1488 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001489 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001490 Common Device Class Abstract Control Model serial device.
1491 If you select usbtty = gserial you should be able to enumerate
1492 a Linux host by
1493 # modprobe usbserial vendor=0xVendorID product=0xProductID
1494 else if using cdc_acm, simply setting the environment
1495 variable usbtty to be cdc_acm should suffice. The following
1496 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001497
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001498 CONFIG_USB_DEVICE
1499 Define this to build a UDC device
1500
1501 CONFIG_USB_TTY
1502 Define this to have a tty type of device available to
1503 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001504
Vipin KUMARbdb17702012-03-26 15:38:06 +05301505 CONFIG_USBD_HS
1506 Define this to enable the high speed support for usb
1507 device and usbtty. If this feature is enabled, a routine
1508 int is_usbd_high_speed(void)
1509 also needs to be defined by the driver to dynamically poll
1510 whether the enumeration has succeded at high speed or full
1511 speed.
1512
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001513 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001514 Define this if you want stdin, stdout &/or stderr to
1515 be set to usbtty.
1516
1517 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001518 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001519 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001520 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001521
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001522 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001523 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001524 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001525
Wolfgang Denke2601822006-06-14 18:14:56 +02001526 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001527 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001528 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001529 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1530 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1531 should pretend to be a Linux device to it's target host.
1532
1533 CONFIG_USBD_MANUFACTURER
1534 Define this string as the name of your company for
1535 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001536
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001537 CONFIG_USBD_PRODUCT_NAME
1538 Define this string as the name of your product
1539 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001540
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001541 CONFIG_USBD_VENDORID
1542 Define this as your assigned Vendor ID from the USB
1543 Implementors Forum. This *must* be a genuine Vendor ID
1544 to avoid polluting the USB namespace.
1545 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001546
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001547 CONFIG_USBD_PRODUCTID
1548 Define this as the unique Product ID
1549 for your device
1550 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001551
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001552- ULPI Layer Support:
1553 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1554 the generic ULPI layer. The generic layer accesses the ULPI PHY
1555 via the platform viewport, so you need both the genric layer and
1556 the viewport enabled. Currently only Chipidea/ARC based
1557 viewport is supported.
1558 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1559 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001560 If your ULPI phy needs a different reference clock than the
1561 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1562 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001563
wdenk7a428cc2003-06-15 22:40:42 +00001564- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001565 The MMC controller on the Intel PXA is supported. To
1566 enable this define CONFIG_MMC. The MMC can be
1567 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001568 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001569 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1570 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001571
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001572 CONFIG_SH_MMCIF
1573 Support for Renesas on-chip MMCIF controller
1574
1575 CONFIG_SH_MMCIF_ADDR
1576 Define the base address of MMCIF registers
1577
1578 CONFIG_SH_MMCIF_CLK
1579 Define the clock frequency for MMCIF
1580
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001581 CONFIG_GENERIC_MMC
1582 Enable the generic MMC driver
1583
1584 CONFIG_SUPPORT_EMMC_BOOT
1585 Enable some additional features of the eMMC boot partitions.
1586
1587 CONFIG_SUPPORT_EMMC_RPMB
1588 Enable the commands for reading, writing and programming the
1589 key for the Replay Protection Memory Block partition in eMMC.
1590
Tom Rini58a8d322013-03-14 05:32:47 +00001591- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001592 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001593 This enables the USB portion of the DFU USB class
1594
1595 CONFIG_CMD_DFU
1596 This enables the command "dfu" which is used to have
1597 U-Boot create a DFU class device via USB. This command
1598 requires that the "dfu_alt_info" environment variable be
1599 set and define the alt settings to expose to the host.
1600
1601 CONFIG_DFU_MMC
1602 This enables support for exposing (e)MMC devices via DFU.
1603
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001604 CONFIG_DFU_NAND
1605 This enables support for exposing NAND devices via DFU.
1606
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301607 CONFIG_DFU_RAM
1608 This enables support for exposing RAM via DFU.
1609 Note: DFU spec refer to non-volatile memory usage, but
1610 allow usages beyond the scope of spec - here RAM usage,
1611 one that would help mostly the developer.
1612
Heiko Schochera2f831e2013-06-12 06:05:51 +02001613 CONFIG_SYS_DFU_DATA_BUF_SIZE
1614 Dfu transfer uses a buffer before writing data to the
1615 raw storage device. Make the size (in bytes) of this buffer
1616 configurable. The size of this buffer is also configurable
1617 through the "dfu_bufsiz" environment variable.
1618
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001619 CONFIG_SYS_DFU_MAX_FILE_SIZE
1620 When updating files rather than the raw storage device,
1621 we use a static buffer to copy the file into and then write
1622 the buffer once we've been given the whole file. Define
1623 this to the maximum filesize (in bytes) for the buffer.
1624 Default is 4 MiB if undefined.
1625
Heiko Schochere1ba1512014-03-18 08:09:56 +01001626 DFU_DEFAULT_POLL_TIMEOUT
1627 Poll timeout [ms], is the timeout a device can send to the
1628 host. The host must wait for this timeout before sending
1629 a subsequent DFU_GET_STATUS request to the device.
1630
1631 DFU_MANIFEST_POLL_TIMEOUT
1632 Poll timeout [ms], which the device sends to the host when
1633 entering dfuMANIFEST state. Host waits this timeout, before
1634 sending again an USB request to the device.
1635
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001636- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001637 CONFIG_USB_FUNCTION_FASTBOOT
1638 This enables the USB part of the fastboot gadget
1639
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001640 CONFIG_CMD_FASTBOOT
1641 This enables the command "fastboot" which enables the Android
1642 fastboot mode for the platform's USB device. Fastboot is a USB
1643 protocol for downloading images, flashing and device control
1644 used on Android devices.
1645 See doc/README.android-fastboot for more information.
1646
1647 CONFIG_ANDROID_BOOT_IMAGE
1648 This enables support for booting images which use the Android
1649 image format header.
1650
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001651 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001652 The fastboot protocol requires a large memory buffer for
1653 downloads. Define this to the starting RAM address to use for
1654 downloaded images.
1655
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001656 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001657 The fastboot protocol requires a large memory buffer for
1658 downloads. This buffer should be as large as possible for a
1659 platform. Define this to the size available RAM for fastboot.
1660
Steve Raebfb9ba42014-08-26 11:47:28 -07001661 CONFIG_FASTBOOT_FLASH
1662 The fastboot protocol includes a "flash" command for writing
1663 the downloaded image to a non-volatile storage device. Define
1664 this to enable the "fastboot flash" command.
1665
1666 CONFIG_FASTBOOT_FLASH_MMC_DEV
1667 The fastboot "flash" command requires additional information
1668 regarding the non-volatile storage device. Define this to
1669 the eMMC device that fastboot should use to store the image.
1670
Steve Rae7d059342014-12-12 15:51:54 -08001671 CONFIG_FASTBOOT_GPT_NAME
1672 The fastboot "flash" command supports writing the downloaded
1673 image to the Protective MBR and the Primary GUID Partition
1674 Table. (Additionally, this downloaded image is post-processed
1675 to generate and write the Backup GUID Partition Table.)
1676 This occurs when the specified "partition name" on the
1677 "fastboot flash" command line matches this value.
1678 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1679
wdenkda04a8b2004-08-02 23:22:59 +00001680- Journaling Flash filesystem support:
1681 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1682 CONFIG_JFFS2_NAND_DEV
1683 Define these for a default partition on a NAND device
1684
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001685 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1686 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001687 Define these for a default partition on a NOR device
1688
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001689 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001690 Define this to create an own partition. You have to provide a
1691 function struct part_info* jffs2_part_info(int part_num)
1692
1693 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001694 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001695 to disable the command chpart. This is the default when you
1696 have not defined a custom partition
1697
Donggeun Kim8f814002011-10-24 21:15:28 +00001698- FAT(File Allocation Table) filesystem write function support:
1699 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001700
1701 Define this to enable support for saving memory data as a
1702 file in FAT formatted partition.
1703
1704 This will also enable the command "fatwrite" enabling the
1705 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001706
Gabe Black7f8574c2012-10-12 14:26:11 +00001707CBFS (Coreboot Filesystem) support
1708 CONFIG_CMD_CBFS
1709
1710 Define this to enable support for reading from a Coreboot
1711 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1712 and cbfsload.
1713
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301714- FAT(File Allocation Table) filesystem cluster size:
1715 CONFIG_FS_FAT_MAX_CLUSTSIZE
1716
1717 Define the max cluster size for fat operations else
1718 a default value of 65536 will be defined.
1719
wdenkc6097192002-11-03 00:24:07 +00001720- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001721 See Kconfig help for available keyboard drivers.
1722
1723 CONFIG_KEYBOARD
1724
1725 Define this to enable a custom keyboard support.
1726 This simply calls drv_keyboard_init() which must be
1727 defined in your board-specific files. This option is deprecated
1728 and is only used by novena. For new boards, use driver model
1729 instead.
wdenkc6097192002-11-03 00:24:07 +00001730
1731- Video support:
1732 CONFIG_VIDEO
1733
1734 Define this to enable video support (for output to
1735 video).
1736
1737 CONFIG_VIDEO_CT69000
1738
1739 Enable Chips & Technologies 69000 Video chip
1740
1741 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001742 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001743 video output is selected via environment 'videoout'
1744 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1745 assumed.
wdenkc6097192002-11-03 00:24:07 +00001746
wdenkd3602132004-03-25 15:14:43 +00001747 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001748 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001749 are possible:
1750 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001751 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001752
1753 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1754 -------------+---------------------------------------------
1755 8 bits | 0x301* 0x303 0x305 0x161 0x307
1756 15 bits | 0x310 0x313 0x316 0x162 0x319
1757 16 bits | 0x311 0x314 0x317 0x163 0x31A
1758 24 bits | 0x312 0x315 0x318 ? 0x31B
1759 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001760 (i.e. setenv videomode 317; saveenv; reset;)
1761
wdenkd3602132004-03-25 15:14:43 +00001762 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001763 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001764
1765
stroeseb9c17c52003-04-04 15:53:41 +00001766 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001767 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001768 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1769 or CONFIG_VIDEO_SED13806_16BPP
1770
Timur Tabi020edd22011-02-15 17:09:19 -06001771 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001772 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001773 SOCs that have a DIU should define this macro to enable DIU
1774 support, and should also define these other macros:
1775
1776 CONFIG_SYS_DIU_ADDR
1777 CONFIG_VIDEO
1778 CONFIG_CMD_BMP
1779 CONFIG_CFB_CONSOLE
1780 CONFIG_VIDEO_SW_CURSOR
1781 CONFIG_VGA_AS_SINGLE_DEVICE
1782 CONFIG_VIDEO_LOGO
1783 CONFIG_VIDEO_BMP_LOGO
1784
Timur Tabi32f709e2011-04-11 14:18:22 -05001785 The DIU driver will look for the 'video-mode' environment
1786 variable, and if defined, enable the DIU as a console during
1787 boot. See the documentation file README.video for a
1788 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001789
wdenkc6097192002-11-03 00:24:07 +00001790- LCD Support: CONFIG_LCD
1791
1792 Define this to enable LCD support (for output to LCD
1793 display); also select one of the supported displays
1794 by defining one of these:
1795
Stelian Popf6f86652008-05-09 21:57:18 +02001796 CONFIG_ATMEL_LCD:
1797
1798 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1799
wdenkc0d54ae2003-11-25 16:55:19 +00001800 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001801
wdenkc0d54ae2003-11-25 16:55:19 +00001802 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001803
wdenkc0d54ae2003-11-25 16:55:19 +00001804 CONFIG_NEC_NL6448BC20
1805
1806 NEC NL6448BC20-08. 6.5", 640x480.
1807 Active, color, single scan.
1808
1809 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001810
wdenkc0d54ae2003-11-25 16:55:19 +00001811 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001812 Active, color, single scan.
1813
1814 CONFIG_SHARP_16x9
1815
1816 Sharp 320x240. Active, color, single scan.
1817 It isn't 16x9, and I am not sure what it is.
1818
1819 CONFIG_SHARP_LQ64D341
1820
1821 Sharp LQ64D341 display, 640x480.
1822 Active, color, single scan.
1823
1824 CONFIG_HLD1045
1825
1826 HLD1045 display, 640x480.
1827 Active, color, single scan.
1828
1829 CONFIG_OPTREX_BW
1830
1831 Optrex CBL50840-2 NF-FW 99 22 M5
1832 or
1833 Hitachi LMG6912RPFC-00T
1834 or
1835 Hitachi SP14Q002
1836
1837 320x240. Black & white.
1838
1839 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001840 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001841
Simon Glass599a4df2012-10-17 13:24:54 +00001842 CONFIG_LCD_ALIGNMENT
1843
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001844 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001845 defined then the LCD will be aligned to this value instead.
1846 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1847 here, since it is cheaper to change data cache settings on
1848 a per-section basis.
1849
Simon Glassaf3e2802012-10-17 13:24:59 +00001850 CONFIG_CONSOLE_SCROLL_LINES
1851
1852 When the console need to be scrolled, this is the number of
1853 lines to scroll by. It defaults to 1. Increasing this makes
1854 the console jump but can help speed up operation when scrolling
1855 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001856
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001857 CONFIG_LCD_ROTATION
1858
1859 Sometimes, for example if the display is mounted in portrait
1860 mode or even if it's mounted landscape but rotated by 180degree,
1861 we need to rotate our content of the display relative to the
1862 framebuffer, so that user can read the messages which are
1863 printed out.
1864 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1865 initialized with a given rotation from "vl_rot" out of
1866 "vidinfo_t" which is provided by the board specific code.
1867 The value for vl_rot is coded as following (matching to
1868 fbcon=rotate:<n> linux-kernel commandline):
1869 0 = no rotation respectively 0 degree
1870 1 = 90 degree rotation
1871 2 = 180 degree rotation
1872 3 = 270 degree rotation
1873
1874 If CONFIG_LCD_ROTATION is not defined, the console will be
1875 initialized with 0degree rotation.
1876
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001877 CONFIG_LCD_BMP_RLE8
1878
1879 Support drawing of RLE8-compressed bitmaps on the LCD.
1880
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001881 CONFIG_I2C_EDID
1882
1883 Enables an 'i2c edid' command which can read EDID
1884 information over I2C from an attached LCD display.
1885
wdenkeb20ad32003-09-05 23:19:14 +00001886- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001887
wdenk57b2d802003-06-27 21:31:46 +00001888 If this option is set, the environment is checked for
1889 a variable "splashimage". If found, the usual display
1890 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001891 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001892 specified in "splashimage" is loaded instead. The
1893 console is redirected to the "nulldev", too. This
1894 allows for a "silent" boot where a splash screen is
1895 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001896
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001897 CONFIG_SPLASHIMAGE_GUARD
1898
1899 If this option is set, then U-Boot will prevent the environment
1900 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001901 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001902 This option is useful for targets where, due to alignment
1903 restrictions, an improperly aligned BMP image will cause a data
1904 abort. If you think you will not have problems with unaligned
1905 accesses (for example because your toolchain prevents them)
1906 there is no need to set this option.
1907
Matthias Weisser53884182009-07-09 16:07:30 +02001908 CONFIG_SPLASH_SCREEN_ALIGN
1909
1910 If this option is set the splash image can be freely positioned
1911 on the screen. Environment variable "splashpos" specifies the
1912 position as "x,y". If a positive number is given it is used as
1913 number of pixel from left/top. If a negative number is given it
1914 is used as number of pixel from right/bottom. You can also
1915 specify 'm' for centering the image.
1916
1917 Example:
1918 setenv splashpos m,m
1919 => image at center of screen
1920
1921 setenv splashpos 30,20
1922 => image at x = 30 and y = 20
1923
1924 setenv splashpos -10,m
1925 => vertically centered image
1926 at x = dspWidth - bmpWidth - 9
1927
Stefan Roesed9d97742005-09-22 09:04:17 +02001928- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1929
1930 If this option is set, additionally to standard BMP
1931 images, gzipped BMP images can be displayed via the
1932 splashscreen support or the bmp command.
1933
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001934- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1935
1936 If this option is set, 8-bit RLE compressed BMP images
1937 can be displayed via the splashscreen support or the
1938 bmp command.
1939
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001940- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001941 CONFIG_CMD_ZIP
1942
1943 If this option is set, it would use zlib deflate method
1944 to compress the specified memory at its best effort.
1945
wdenk710e3502003-08-29 20:57:53 +00001946- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001947 CONFIG_GZIP
1948
1949 Enabled by default to support gzip compressed images.
1950
wdenk710e3502003-08-29 20:57:53 +00001951 CONFIG_BZIP2
1952
1953 If this option is set, support for bzip2 compressed
1954 images is included. If not, only uncompressed and gzip
1955 compressed images are supported.
1956
wdenk9c53f402003-10-15 23:53:47 +00001957 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001958 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001959 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001960
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001961 CONFIG_LZMA
1962
1963 If this option is set, support for lzma compressed
1964 images is included.
1965
1966 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1967 requires an amount of dynamic memory that is given by the
1968 formula:
1969
1970 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1971
1972 Where lc and lp stand for, respectively, Literal context bits
1973 and Literal pos bits.
1974
1975 This value is upper-bounded by 14MB in the worst case. Anyway,
1976 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1977 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1978 a very small buffer.
1979
1980 Use the lzmainfo tool to determinate the lc and lp values and
1981 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001982 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001983
Kees Cook5b06e642013-08-16 07:59:12 -07001984 CONFIG_LZO
1985
1986 If this option is set, support for LZO compressed images
1987 is included.
1988
wdenk0e2bd9c2004-06-06 21:51:03 +00001989- MII/PHY support:
1990 CONFIG_PHY_ADDR
1991
1992 The address of PHY on MII bus.
1993
1994 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1995
1996 The clock frequency of the MII bus
1997
1998 CONFIG_PHY_GIGE
1999
2000 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002001 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002002
2003 CONFIG_PHY_RESET_DELAY
2004
2005 Some PHY like Intel LXT971A need extra delay after
2006 reset before any MII register access is possible.
2007 For such PHY, set this option to the usec delay
2008 required. (minimum 300usec for LXT971A)
2009
2010 CONFIG_PHY_CMD_DELAY (ppc4xx)
2011
2012 Some PHY like Intel LXT971A need extra delay after
2013 command issued before MII status register can be read
2014
wdenkc6097192002-11-03 00:24:07 +00002015- IP address:
2016 CONFIG_IPADDR
2017
2018 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002019 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002020 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002021 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002022
2023- Server IP address:
2024 CONFIG_SERVERIP
2025
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002026 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002027 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002028 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002029
Robin Getz470a6d42009-07-21 12:15:28 -04002030 CONFIG_KEEP_SERVERADDR
2031
2032 Keeps the server's MAC address, in the env 'serveraddr'
2033 for passing to bootargs (like Linux's netconsole option)
2034
Wolfgang Denk26da2992011-10-26 10:21:22 +00002035- Gateway IP address:
2036 CONFIG_GATEWAYIP
2037
2038 Defines a default value for the IP address of the
2039 default router where packets to other networks are
2040 sent to.
2041 (Environment variable "gatewayip")
2042
2043- Subnet mask:
2044 CONFIG_NETMASK
2045
2046 Defines a default value for the subnet mask (or
2047 routing prefix) which is used to determine if an IP
2048 address belongs to the local subnet or needs to be
2049 forwarded through a router.
2050 (Environment variable "netmask")
2051
David Updegraff7280da72007-06-11 10:41:07 -05002052- Multicast TFTP Mode:
2053 CONFIG_MCAST_TFTP
2054
2055 Defines whether you want to support multicast TFTP as per
2056 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002057 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002058 driver in use must provide a function: mcast() to join/leave a
2059 multicast group.
2060
wdenkc6097192002-11-03 00:24:07 +00002061- BOOTP Recovery Mode:
2062 CONFIG_BOOTP_RANDOM_DELAY
2063
2064 If you have many targets in a network that try to
2065 boot using BOOTP, you may want to avoid that all
2066 systems send out BOOTP requests at precisely the same
2067 moment (which would happen for instance at recovery
2068 from a power failure, when all systems will try to
2069 boot, thus flooding the BOOTP server. Defining
2070 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2071 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002072 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002073
2074 1st BOOTP request: delay 0 ... 1 sec
2075 2nd BOOTP request: delay 0 ... 2 sec
2076 3rd BOOTP request: delay 0 ... 4 sec
2077 4th and following
2078 BOOTP requests: delay 0 ... 8 sec
2079
Thierry Reding8977cda2014-08-19 10:21:24 +02002080 CONFIG_BOOTP_ID_CACHE_SIZE
2081
2082 BOOTP packets are uniquely identified using a 32-bit ID. The
2083 server will copy the ID from client requests to responses and
2084 U-Boot will use this to determine if it is the destination of
2085 an incoming response. Some servers will check that addresses
2086 aren't in use before handing them out (usually using an ARP
2087 ping) and therefore take up to a few hundred milliseconds to
2088 respond. Network congestion may also influence the time it
2089 takes for a response to make it back to the client. If that
2090 time is too long, U-Boot will retransmit requests. In order
2091 to allow earlier responses to still be accepted after these
2092 retransmissions, U-Boot's BOOTP client keeps a small cache of
2093 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2094 cache. The default is to keep IDs for up to four outstanding
2095 requests. Increasing this will allow U-Boot to accept offers
2096 from a BOOTP client in networks with unusually high latency.
2097
stroesee0aadfb2003-08-28 14:17:32 +00002098- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002099 You can fine tune the DHCP functionality by defining
2100 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002101
Jon Loeliger5336a762007-07-09 22:08:34 -05002102 CONFIG_BOOTP_SUBNETMASK
2103 CONFIG_BOOTP_GATEWAY
2104 CONFIG_BOOTP_HOSTNAME
2105 CONFIG_BOOTP_NISDOMAIN
2106 CONFIG_BOOTP_BOOTPATH
2107 CONFIG_BOOTP_BOOTFILESIZE
2108 CONFIG_BOOTP_DNS
2109 CONFIG_BOOTP_DNS2
2110 CONFIG_BOOTP_SEND_HOSTNAME
2111 CONFIG_BOOTP_NTPSERVER
2112 CONFIG_BOOTP_TIMEOFFSET
2113 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002114 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002115
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002116 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2117 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002118
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002119 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2120 after the configured retry count, the call will fail
2121 instead of starting over. This can be used to fail over
2122 to Link-local IP address configuration if the DHCP server
2123 is not available.
2124
stroesee0aadfb2003-08-28 14:17:32 +00002125 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2126 serverip from a DHCP server, it is possible that more
2127 than one DNS serverip is offered to the client.
2128 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2129 serverip will be stored in the additional environment
2130 variable "dnsip2". The first DNS serverip is always
2131 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002132 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002133
2134 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2135 to do a dynamic update of a DNS server. To do this, they
2136 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002137 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002138 of the "hostname" environment variable is passed as
2139 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002140
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002141 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2142
2143 A 32bit value in microseconds for a delay between
2144 receiving a "DHCP Offer" and sending the "DHCP Request".
2145 This fixes a problem with certain DHCP servers that don't
2146 respond 100% of the time to a "DHCP request". E.g. On an
2147 AT91RM9200 processor running at 180MHz, this delay needed
2148 to be *at least* 15,000 usec before a Windows Server 2003
2149 DHCP server would reply 100% of the time. I recommend at
2150 least 50,000 usec to be safe. The alternative is to hope
2151 that one of the retries will be successful but note that
2152 the DHCP timeout and retry process takes a longer than
2153 this delay.
2154
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002155 - Link-local IP address negotiation:
2156 Negotiate with other link-local clients on the local network
2157 for an address that doesn't require explicit configuration.
2158 This is especially useful if a DHCP server cannot be guaranteed
2159 to exist in all environments that the device must operate.
2160
2161 See doc/README.link-local for more information.
2162
wdenk145d2c12004-04-15 21:48:45 +00002163 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002164 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002165
2166 The device id used in CDP trigger frames.
2167
2168 CONFIG_CDP_DEVICE_ID_PREFIX
2169
2170 A two character string which is prefixed to the MAC address
2171 of the device.
2172
2173 CONFIG_CDP_PORT_ID
2174
2175 A printf format string which contains the ascii name of
2176 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002177 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002178
2179 CONFIG_CDP_CAPABILITIES
2180
2181 A 32bit integer which indicates the device capabilities;
2182 0x00000010 for a normal host which does not forwards.
2183
2184 CONFIG_CDP_VERSION
2185
2186 An ascii string containing the version of the software.
2187
2188 CONFIG_CDP_PLATFORM
2189
2190 An ascii string containing the name of the platform.
2191
2192 CONFIG_CDP_TRIGGER
2193
2194 A 32bit integer sent on the trigger.
2195
2196 CONFIG_CDP_POWER_CONSUMPTION
2197
2198 A 16bit integer containing the power consumption of the
2199 device in .1 of milliwatts.
2200
2201 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2202
2203 A byte containing the id of the VLAN.
2204
wdenkc6097192002-11-03 00:24:07 +00002205- Status LED: CONFIG_STATUS_LED
2206
2207 Several configurations allow to display the current
2208 status using a LED. For instance, the LED will blink
2209 fast while running U-Boot code, stop blinking as
2210 soon as a reply to a BOOTP request was received, and
2211 start blinking slow once the Linux kernel is running
2212 (supported by a status LED driver in the Linux
2213 kernel). Defining CONFIG_STATUS_LED enables this
2214 feature in U-Boot.
2215
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002216 Additional options:
2217
2218 CONFIG_GPIO_LED
2219 The status LED can be connected to a GPIO pin.
2220 In such cases, the gpio_led driver can be used as a
2221 status LED backend implementation. Define CONFIG_GPIO_LED
2222 to include the gpio_led driver in the U-Boot binary.
2223
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002224 CONFIG_GPIO_LED_INVERTED_TABLE
2225 Some GPIO connected LEDs may have inverted polarity in which
2226 case the GPIO high value corresponds to LED off state and
2227 GPIO low value corresponds to LED on state.
2228 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2229 with a list of GPIO LEDs that have inverted polarity.
2230
wdenkc6097192002-11-03 00:24:07 +00002231- CAN Support: CONFIG_CAN_DRIVER
2232
2233 Defining CONFIG_CAN_DRIVER enables CAN driver support
2234 on those systems that support this (optional)
2235 feature, like the TQM8xxL modules.
2236
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002237- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002238
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002239 This enable the NEW i2c subsystem, and will allow you to use
2240 i2c commands at the u-boot command line (as long as you set
2241 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2242 based realtime clock chips or other i2c devices. See
2243 common/cmd_i2c.c for a description of the command line
2244 interface.
2245
2246 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002247 - drivers/i2c/soft_i2c.c:
2248 - activate first bus with CONFIG_SYS_I2C_SOFT define
2249 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2250 for defining speed and slave address
2251 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2252 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2253 for defining speed and slave address
2254 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2255 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2256 for defining speed and slave address
2257 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2258 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2259 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002260
Heiko Schocherf2850742012-10-24 13:48:22 +02002261 - drivers/i2c/fsl_i2c.c:
2262 - activate i2c driver with CONFIG_SYS_I2C_FSL
2263 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2264 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2265 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2266 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002267 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002268 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2269 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2270 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2271 second bus.
2272
Simon Glass026fefb2012-10-30 07:28:53 +00002273 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002274 - activate this driver with CONFIG_SYS_I2C_TEGRA
2275 - This driver adds 4 i2c buses with a fix speed from
2276 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002277
Dirk Eibach42b204f2013-04-25 02:40:01 +00002278 - drivers/i2c/ppc4xx_i2c.c
2279 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2280 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2281 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2282
trema49f40a2013-09-21 18:13:35 +02002283 - drivers/i2c/i2c_mxc.c
2284 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002285 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2286 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2287 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2288 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002289 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2290 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2291 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2292 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2293 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2294 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002295 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2296 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002297 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002298 for speed, and 0 for slave.
2299
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002300 - drivers/i2c/rcar_i2c.c:
2301 - activate this driver with CONFIG_SYS_I2C_RCAR
2302 - This driver adds 4 i2c buses
2303
2304 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2305 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2306 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2307 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2308 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2309 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2310 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2311 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2312 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2313
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002314 - drivers/i2c/sh_i2c.c:
2315 - activate this driver with CONFIG_SYS_I2C_SH
2316 - This driver adds from 2 to 5 i2c buses
2317
2318 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2319 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2320 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2321 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2322 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2323 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2324 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2325 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2326 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2327 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2328 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2329 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002330 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002331
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002332 - drivers/i2c/omap24xx_i2c.c
2333 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2334 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2335 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2336 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2337 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2338 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2339 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2340 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2341 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2342 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2343 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2344
Heiko Schocher465819a2013-11-08 07:30:53 +01002345 - drivers/i2c/zynq_i2c.c
2346 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2347 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2348 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2349
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302350 - drivers/i2c/s3c24x0_i2c.c:
2351 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2352 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2353 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2354 with a fix speed from 100000 and the slave addr 0!
2355
Dirk Eibachb9577432014-07-03 09:28:18 +02002356 - drivers/i2c/ihs_i2c.c
2357 - activate this driver with CONFIG_SYS_I2C_IHS
2358 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2359 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2360 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2361 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2362 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2363 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2364 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2365 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2366 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2367 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2368 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2369 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002370 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2371 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2372 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2373 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2374 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2375 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2376 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2377 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2378 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002379
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002380 additional defines:
2381
2382 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002383 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002384 don't use/have i2c muxes on your i2c bus, this
2385 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2386 omit this define.
2387
2388 CONFIG_SYS_I2C_DIRECT_BUS
2389 define this, if you don't use i2c muxes on your hardware.
2390 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2391 omit this define.
2392
2393 CONFIG_SYS_I2C_MAX_HOPS
2394 define how many muxes are maximal consecutively connected
2395 on one i2c bus. If you not use i2c muxes, omit this
2396 define.
2397
2398 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002399 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002400 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2401 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2402 CONFIG_SYS_NUM_I2C_BUSES = 9:
2403
2404 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2405 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2406 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2407 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2408 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2409 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2410 {1, {I2C_NULL_HOP}}, \
2411 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2412 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2413 }
2414
2415 which defines
2416 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002417 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2418 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2419 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2420 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2421 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002422 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002423 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2424 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002425
2426 If you do not have i2c muxes on your board, omit this define.
2427
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002428- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002429
2430 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2431 provides the following compelling advantages:
2432
2433 - more than one i2c adapter is usable
2434 - approved multibus support
2435 - better i2c mux support
2436
2437 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002438
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002439 These enable legacy I2C serial bus commands. Defining
2440 CONFIG_HARD_I2C will include the appropriate I2C driver
2441 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002442
wdenk21136db2003-07-16 21:53:01 +00002443 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002444 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002445 CONFIG_COMMANDS) and communicate with i2c based realtime
2446 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002447 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002448
Ben Warren45657152006-09-07 16:50:54 -04002449 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002450
wdenk21136db2003-07-16 21:53:01 +00002451 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002452 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002453
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002454 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002455 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002456 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002457 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002458
Peter Tysere4d1abc2010-04-12 22:28:21 -05002459 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002460 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002461 and so its address should therefore be cleared to 0 (See,
2462 eg, MPC823e User's Manual p.16-473). So, set
2463 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002464
Eric Millbrandt12990a42009-09-03 08:09:44 -05002465 CONFIG_SYS_I2C_INIT_MPC5XXX
2466
2467 When a board is reset during an i2c bus transfer
2468 chips might think that the current transfer is still
2469 in progress. Reset the slave devices by sending start
2470 commands until the slave device responds.
2471
wdenk21136db2003-07-16 21:53:01 +00002472 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002473
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002474 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002475 then the following macros need to be defined (examples are
2476 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002477
2478 I2C_INIT
2479
wdenkb9bbd242003-06-30 16:24:52 +00002480 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002481 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002482
wdenk544e9732004-02-06 23:19:44 +00002483 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002484
wdenkc6097192002-11-03 00:24:07 +00002485 I2C_PORT
2486
wdenk4a5c8a72003-03-06 00:02:04 +00002487 (Only for MPC8260 CPU). The I/O port to use (the code
2488 assumes both bits are on the same port). Valid values
2489 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002490
2491 I2C_ACTIVE
2492
2493 The code necessary to make the I2C data line active
2494 (driven). If the data line is open collector, this
2495 define can be null.
2496
wdenkb9bbd242003-06-30 16:24:52 +00002497 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2498
wdenkc6097192002-11-03 00:24:07 +00002499 I2C_TRISTATE
2500
2501 The code necessary to make the I2C data line tri-stated
2502 (inactive). If the data line is open collector, this
2503 define can be null.
2504
wdenkb9bbd242003-06-30 16:24:52 +00002505 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2506
wdenkc6097192002-11-03 00:24:07 +00002507 I2C_READ
2508
York Sun4a598092013-04-01 11:29:11 -07002509 Code that returns true if the I2C data line is high,
2510 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002511
wdenkb9bbd242003-06-30 16:24:52 +00002512 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2513
wdenkc6097192002-11-03 00:24:07 +00002514 I2C_SDA(bit)
2515
York Sun4a598092013-04-01 11:29:11 -07002516 If <bit> is true, sets the I2C data line high. If it
2517 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002518
wdenkb9bbd242003-06-30 16:24:52 +00002519 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002520 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002521 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002522
wdenkc6097192002-11-03 00:24:07 +00002523 I2C_SCL(bit)
2524
York Sun4a598092013-04-01 11:29:11 -07002525 If <bit> is true, sets the I2C clock line high. If it
2526 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002527
wdenkb9bbd242003-06-30 16:24:52 +00002528 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002529 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002530 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002531
wdenkc6097192002-11-03 00:24:07 +00002532 I2C_DELAY
2533
2534 This delay is invoked four times per clock cycle so this
2535 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002536 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002537 like:
2538
wdenkb9bbd242003-06-30 16:24:52 +00002539 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002540
Mike Frysingeree12d542010-07-21 13:38:02 -04002541 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2542
2543 If your arch supports the generic GPIO framework (asm/gpio.h),
2544 then you may alternatively define the two GPIOs that are to be
2545 used as SCL / SDA. Any of the previous I2C_xxx macros will
2546 have GPIO-based defaults assigned to them as appropriate.
2547
2548 You should define these to the GPIO value as given directly to
2549 the generic GPIO functions.
2550
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002551 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002552
wdenk57b2d802003-06-27 21:31:46 +00002553 When a board is reset during an i2c bus transfer
2554 chips might think that the current transfer is still
2555 in progress. On some boards it is possible to access
2556 the i2c SCLK line directly, either by using the
2557 processor pin as a GPIO or by having a second pin
2558 connected to the bus. If this option is defined a
2559 custom i2c_init_board() routine in boards/xxx/board.c
2560 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002561
Richard Retanubundf0149c2010-04-12 15:08:17 -04002562 CONFIG_SYS_I2C_BOARD_LATE_INIT
2563
2564 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2565 defined a custom i2c_board_late_init() routine in
2566 boards/xxx/board.c is run AFTER the operations in i2c_init()
2567 is completed. This callpoint can be used to unreset i2c bus
2568 using CPU i2c controller register accesses for CPUs whose i2c
2569 controller provide such a method. It is called at the end of
2570 i2c_init() to allow i2c_init operations to setup the i2c bus
2571 controller on the CPU (e.g. setting bus speed & slave address).
2572
wdenk0e2bd9c2004-06-06 21:51:03 +00002573 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2574
2575 This option enables configuration of bi_iic_fast[] flags
2576 in u-boot bd_info structure based on u-boot environment
2577 variable "i2cfast". (see also i2cfast)
2578
Ben Warren45657152006-09-07 16:50:54 -04002579 CONFIG_I2C_MULTI_BUS
2580
2581 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002582 must have a controller. At any point in time, only one bus is
2583 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002584 Note that bus numbering is zero-based.
2585
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002586 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002587
2588 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002589 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002590 is set, specify a list of bus-device pairs. Otherwise, specify
2591 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002592
2593 e.g.
2594 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002595 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002596
2597 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2598
Wolfgang Denk092ae952011-10-26 10:21:21 +00002599 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002600 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002601
2602 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2603
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002604 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002605
2606 If defined, then this indicates the I2C bus number for DDR SPD.
2607 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2608
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002609 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002610
2611 If defined, then this indicates the I2C bus number for the RTC.
2612 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2613
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002614 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002615
2616 If defined, then this indicates the I2C bus number for the DTT.
2617 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2618
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002619 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002620
2621 If defined, specifies the I2C address of the DTT device.
2622 If not defined, then U-Boot uses predefined value for
2623 specified DTT device.
2624
Andrew Dyer58c41f92008-12-29 17:36:01 -06002625 CONFIG_SOFT_I2C_READ_REPEATED_START
2626
2627 defining this will force the i2c_read() function in
2628 the soft_i2c driver to perform an I2C repeated start
2629 between writing the address pointer and reading the
2630 data. If this define is omitted the default behaviour
2631 of doing a stop-start sequence will be used. Most I2C
2632 devices can use either method, but some require one or
2633 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002634
wdenkc6097192002-11-03 00:24:07 +00002635- SPI Support: CONFIG_SPI
2636
2637 Enables SPI driver (so far only tested with
2638 SPI EEPROM, also an instance works with Crystal A/D and
2639 D/As on the SACSng board)
2640
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002641 CONFIG_SH_SPI
2642
2643 Enables the driver for SPI controller on SuperH. Currently
2644 only SH7757 is supported.
2645
wdenkc6097192002-11-03 00:24:07 +00002646 CONFIG_SOFT_SPI
2647
wdenk4a5c8a72003-03-06 00:02:04 +00002648 Enables a software (bit-bang) SPI driver rather than
2649 using hardware support. This is a general purpose
2650 driver that only requires three general I/O port pins
2651 (two outputs, one input) to function. If this is
2652 defined, the board configuration must define several
2653 SPI configuration items (port pins to use, etc). For
2654 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002655
Ben Warren7efe9272008-01-16 22:37:35 -05002656 CONFIG_HARD_SPI
2657
2658 Enables a hardware SPI driver for general-purpose reads
2659 and writes. As with CONFIG_SOFT_SPI, the board configuration
2660 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002661 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002662 example, see include/configs/mpc8349emds.h.
2663
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002664 CONFIG_MXC_SPI
2665
2666 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002667 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002668
Heiko Schocherb77c8882014-07-14 10:22:11 +02002669 CONFIG_SYS_SPI_MXC_WAIT
2670 Timeout for waiting until spi transfer completed.
2671 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2672
Matthias Fuchsa4400872007-12-27 17:12:34 +01002673- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002674
Matthias Fuchsa4400872007-12-27 17:12:34 +01002675 Enables FPGA subsystem.
2676
2677 CONFIG_FPGA_<vendor>
2678
2679 Enables support for specific chip vendors.
2680 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002681
Matthias Fuchsa4400872007-12-27 17:12:34 +01002682 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002683
Matthias Fuchsa4400872007-12-27 17:12:34 +01002684 Enables support for FPGA family.
2685 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2686
2687 CONFIG_FPGA_COUNT
2688
2689 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002690
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302691 CONFIG_CMD_FPGA_LOADMK
2692
2693 Enable support for fpga loadmk command
2694
Michal Simek64c70982014-05-02 13:43:39 +02002695 CONFIG_CMD_FPGA_LOADP
2696
2697 Enable support for fpga loadp command - load partial bitstream
2698
2699 CONFIG_CMD_FPGA_LOADBP
2700
2701 Enable support for fpga loadbp command - load partial bitstream
2702 (Xilinx only)
2703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002704 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002705
wdenk57b2d802003-06-27 21:31:46 +00002706 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002707
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002708 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002709
wdenk4a5c8a72003-03-06 00:02:04 +00002710 Enable checks on FPGA configuration interface busy
2711 status by the configuration function. This option
2712 will require a board or device specific function to
2713 be written.
wdenkc6097192002-11-03 00:24:07 +00002714
2715 CONFIG_FPGA_DELAY
2716
2717 If defined, a function that provides delays in the FPGA
2718 configuration driver.
2719
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002720 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002721 Allow Control-C to interrupt FPGA configuration
2722
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002723 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002724
wdenk4a5c8a72003-03-06 00:02:04 +00002725 Check for configuration errors during FPGA bitfile
2726 loading. For example, abort during Virtex II
2727 configuration if the INIT_B line goes low (which
2728 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002729
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002730 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002731
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002732 Maximum time to wait for the INIT_B line to de-assert
2733 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002734 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002735 ms.
wdenkc6097192002-11-03 00:24:07 +00002736
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002737 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002738
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002739 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002740 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002741
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002742 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002743
wdenk4a5c8a72003-03-06 00:02:04 +00002744 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002745 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002746
2747- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002748 CONFIG_BUILD_TARGET
2749
2750 Some SoCs need special image types (e.g. U-Boot binary
2751 with a special header) as build targets. By defining
2752 CONFIG_BUILD_TARGET in the SoC / board header, this
2753 special image will be automatically built upon calling
2754 make / MAKEALL.
2755
wdenkc6097192002-11-03 00:24:07 +00002756 CONFIG_IDENT_STRING
2757
wdenk4a5c8a72003-03-06 00:02:04 +00002758 If defined, this string will be added to the U-Boot
2759 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002760
2761- Vendor Parameter Protection:
2762
wdenk4a5c8a72003-03-06 00:02:04 +00002763 U-Boot considers the values of the environment
2764 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002765 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002766 are set once by the board vendor / manufacturer, and
2767 protects these variables from casual modification by
2768 the user. Once set, these variables are read-only,
2769 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002770 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002771
2772 If CONFIG_ENV_OVERWRITE is #defined in your config
2773 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002774 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002775 these parameters.
2776
Joe Hershberger76f353e2015-05-04 14:55:14 -05002777 Alternatively, if you define _both_ an ethaddr in the
2778 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002779 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002780 which can be changed exactly ONCE by the user. [The
2781 serial# is unaffected by this, i. e. it remains
2782 read-only.]
2783
Joe Hershberger71497d02012-12-11 22:16:31 -06002784 The same can be accomplished in a more flexible way
2785 for any variable by configuring the type of access
2786 to allow for those variables in the ".flags" variable
2787 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2788
wdenkc6097192002-11-03 00:24:07 +00002789- Protected RAM:
2790 CONFIG_PRAM
2791
2792 Define this variable to enable the reservation of
2793 "protected RAM", i. e. RAM which is not overwritten
2794 by U-Boot. Define CONFIG_PRAM to hold the number of
2795 kB you want to reserve for pRAM. You can overwrite
2796 this default value by defining an environment
2797 variable "pram" to the number of kB you want to
2798 reserve. Note that the board info structure will
2799 still show the full amount of RAM. If pRAM is
2800 reserved, a new environment variable "mem" will
2801 automatically be defined to hold the amount of
2802 remaining RAM in a form that can be passed as boot
2803 argument to Linux, for instance like that:
2804
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002805 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002806 saveenv
2807
2808 This way you can tell Linux not to use this memory,
2809 either, which results in a memory region that will
2810 not be affected by reboots.
2811
2812 *WARNING* If your board configuration uses automatic
2813 detection of the RAM size, you must make sure that
2814 this memory test is non-destructive. So far, the
2815 following board configurations are known to be
2816 "pRAM-clean":
2817
Wolfgang Denk90326762012-10-24 02:36:15 +00002818 IVMS8, IVML24, SPD8xx, TQM8xxL,
2819 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002820 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002821
Gabe Blacka2f3a932012-12-02 04:55:18 +00002822- Access to physical memory region (> 4GB)
2823 Some basic support is provided for operations on memory not
2824 normally accessible to U-Boot - e.g. some architectures
2825 support access to more than 4GB of memory on 32-bit
2826 machines using physical address extension or similar.
2827 Define CONFIG_PHYSMEM to access this basic support, which
2828 currently only supports clearing the memory.
2829
wdenkc6097192002-11-03 00:24:07 +00002830- Error Recovery:
2831 CONFIG_PANIC_HANG
2832
2833 Define this variable to stop the system in case of a
2834 fatal error, so that you have to reset it manually.
2835 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002836 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002837 automatically as fast as possible, but it may be
2838 useful during development since you can try to debug
2839 the conditions that lead to the situation.
2840
2841 CONFIG_NET_RETRY_COUNT
2842
wdenk4a5c8a72003-03-06 00:02:04 +00002843 This variable defines the number of retries for
2844 network operations like ARP, RARP, TFTP, or BOOTP
2845 before giving up the operation. If not defined, a
2846 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002847
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002848 CONFIG_ARP_TIMEOUT
2849
2850 Timeout waiting for an ARP reply in milliseconds.
2851
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002852 CONFIG_NFS_TIMEOUT
2853
2854 Timeout in milliseconds used in NFS protocol.
2855 If you encounter "ERROR: Cannot umount" in nfs command,
2856 try longer timeout such as
2857 #define CONFIG_NFS_TIMEOUT 10000UL
2858
wdenkc6097192002-11-03 00:24:07 +00002859- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002860 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002861
2862 Enable auto completion of commands using TAB.
2863
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002864 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002865
2866 This defines the secondary prompt string, which is
2867 printed when the command interpreter needs more input
2868 to complete a command. Usually "> ".
2869
2870 Note:
2871
wdenk57b2d802003-06-27 21:31:46 +00002872 In the current implementation, the local variables
2873 space and global environment variables space are
2874 separated. Local variables are those you define by
2875 simply typing `name=value'. To access a local
2876 variable later on, you have write `$name' or
2877 `${name}'; to execute the contents of a variable
2878 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002879
wdenk4a5c8a72003-03-06 00:02:04 +00002880 Global environment variables are those you use
2881 setenv/printenv to work with. To run a command stored
2882 in such a variable, you need to use the run command,
2883 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002884
2885 To store commands and special characters in a
2886 variable, please use double quotation marks
2887 surrounding the whole text of the variable, instead
2888 of the backslashes before semicolons and special
2889 symbols.
2890
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002891- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002892 CONFIG_CMDLINE_EDITING
2893
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002894 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002895 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002896
wdenkc0aa5c52003-12-06 19:49:23 +00002897- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002898 CONFIG_EXTRA_ENV_SETTINGS
2899
wdenk4a5c8a72003-03-06 00:02:04 +00002900 Define this to contain any number of null terminated
2901 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002902 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002903
wdenk4a5c8a72003-03-06 00:02:04 +00002904 For example, place something like this in your
2905 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002906
2907 #define CONFIG_EXTRA_ENV_SETTINGS \
2908 "myvar1=value1\0" \
2909 "myvar2=value2\0"
2910
wdenk4a5c8a72003-03-06 00:02:04 +00002911 Warning: This method is based on knowledge about the
2912 internal format how the environment is stored by the
2913 U-Boot code. This is NOT an official, exported
2914 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002915 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002916 You better know what you are doing here.
2917
wdenk4a5c8a72003-03-06 00:02:04 +00002918 Note: overly (ab)use of the default environment is
2919 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002920 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002921 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002922
Stephen Warren1465d5f2012-05-22 09:21:54 +00002923 CONFIG_ENV_VARS_UBOOT_CONFIG
2924
2925 Define this in order to add variables describing the
2926 U-Boot build configuration to the default environment.
2927 These will be named arch, cpu, board, vendor, and soc.
2928
2929 Enabling this option will cause the following to be defined:
2930
2931 - CONFIG_SYS_ARCH
2932 - CONFIG_SYS_CPU
2933 - CONFIG_SYS_BOARD
2934 - CONFIG_SYS_VENDOR
2935 - CONFIG_SYS_SOC
2936
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002937 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2938
2939 Define this in order to add variables describing certain
2940 run-time determined information about the hardware to the
2941 environment. These will be named board_name, board_rev.
2942
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002943 CONFIG_DELAY_ENVIRONMENT
2944
2945 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002946 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002947 that so that the environment is not available until
2948 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2949 this is instead controlled by the value of
2950 /config/load-environment.
2951
Chris Packham2216ddb2015-06-19 20:25:59 +12002952- Parallel Flash support:
2953 CONFIG_SYS_NO_FLASH
2954
2955 Traditionally U-boot was run on systems with parallel NOR
2956 flash. This option is used to disable support for parallel NOR
2957 flash. This option should be defined if the board does not have
2958 parallel flash.
2959
2960 If this option is not defined one of the generic flash drivers
2961 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2962 selected or the board must provide an implementation of the
2963 flash API (see include/flash.h).
2964
wdenkc0aa5c52003-12-06 19:49:23 +00002965- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002966 CONFIG_HAS_DATAFLASH
2967
wdenk57b2d802003-06-27 21:31:46 +00002968 Defining this option enables DataFlash features and
2969 allows to read/write in Dataflash via the standard
2970 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002971
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002972- Serial Flash support
2973 CONFIG_CMD_SF
2974
2975 Defining this option enables SPI flash commands
2976 'sf probe/read/write/erase/update'.
2977
2978 Usage requires an initial 'probe' to define the serial
2979 flash parameters, followed by read/write/erase/update
2980 commands.
2981
2982 The following defaults may be provided by the platform
2983 to handle the common case when only a single serial
2984 flash is present on the system.
2985
2986 CONFIG_SF_DEFAULT_BUS Bus identifier
2987 CONFIG_SF_DEFAULT_CS Chip-select
2988 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2989 CONFIG_SF_DEFAULT_SPEED in Hz
2990
Simon Glass4b5545e2012-10-08 13:16:02 +00002991 CONFIG_CMD_SF_TEST
2992
2993 Define this option to include a destructive SPI flash
2994 test ('sf test').
2995
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05302996 CONFIG_SF_DUAL_FLASH Dual flash memories
2997
2998 Define this option to use dual flash support where two flash
2999 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003000 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303001
wdenkef893942004-02-23 16:11:30 +00003002- SystemACE Support:
3003 CONFIG_SYSTEMACE
3004
3005 Adding this option adds support for Xilinx SystemACE
3006 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003007 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003008 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003009
3010 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003011 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003012
3013 When SystemACE support is added, the "ace" device type
3014 becomes available to the fat commands, i.e. fatls.
3015
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003016- TFTP Fixed UDP Port:
3017 CONFIG_TFTP_PORT
3018
Wolfgang Denk227b5192005-09-24 23:25:46 +02003019 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003020 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003021 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003022 number generator is used.
3023
Wolfgang Denk227b5192005-09-24 23:25:46 +02003024 Also, the environment variable tftpdstp is used to supply
3025 the TFTP UDP destination port value. If tftpdstp isn't
3026 defined, the normal port 69 is used.
3027
3028 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003029 blindly start the TFTP transfer using the pre-configured
3030 target IP address and UDP port. This has the effect of
3031 "punching through" the (Windows XP) firewall, allowing
3032 the remainder of the TFTP transfer to proceed normally.
3033 A better solution is to properly configure the firewall,
3034 but sometimes that is not allowed.
3035
Simon Glass058bb8d2012-12-05 14:46:38 +00003036- Hashing support:
3037 CONFIG_CMD_HASH
3038
3039 This enables a generic 'hash' command which can produce
3040 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3041
3042 CONFIG_HASH_VERIFY
3043
3044 Enable the hash verify command (hash -v). This adds to code
3045 size a little.
3046
gaurav ranaef201592015-02-20 12:51:46 +05303047 CONFIG_SHA1 - This option enables support of hashing using SHA1
3048 algorithm. The hash is calculated in software.
3049 CONFIG_SHA256 - This option enables support of hashing using
3050 SHA256 algorithm. The hash is calculated in software.
3051 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3052 for SHA1/SHA256 hashing.
3053 This affects the 'hash' command and also the
3054 hash_lookup_algo() function.
3055 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3056 hardware-acceleration for SHA1/SHA256 progressive hashing.
3057 Data can be streamed in a block at a time and the hashing
3058 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003059
3060 Note: There is also a sha1sum command, which should perhaps
3061 be deprecated in favour of 'hash sha1'.
3062
Robert Winkler765ccf42013-07-24 17:57:06 -07003063- Freescale i.MX specific commands:
3064 CONFIG_CMD_HDMIDETECT
3065 This enables 'hdmidet' command which returns true if an
3066 HDMI monitor is detected. This command is i.MX 6 specific.
3067
3068 CONFIG_CMD_BMODE
3069 This enables the 'bmode' (bootmode) command for forcing
3070 a boot from specific media.
3071
3072 This is useful for forcing the ROM's usb downloader to
3073 activate upon a watchdog reset which is nice when iterating
3074 on U-Boot. Using the reset button or running bmode normal
3075 will set it back to normal. This command currently
3076 supports i.MX53 and i.MX6.
3077
Simon Glass35191a32013-06-13 15:10:02 -07003078- Signing support:
3079 CONFIG_RSA
3080
3081 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003082 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003083
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303084 The Modular Exponentiation algorithm in RSA is implemented using
3085 driver model. So CONFIG_DM needs to be enabled by default for this
3086 library to function.
3087
Simon Glass35191a32013-06-13 15:10:02 -07003088 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303089 option. The software based modular exponentiation is built into
3090 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003091
Heiko Schocher443ca402014-01-25 07:27:13 +01003092- bootcount support:
3093 CONFIG_BOOTCOUNT_LIMIT
3094
3095 This enables the bootcounter support, see:
3096 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3097
3098 CONFIG_AT91SAM9XE
3099 enable special bootcounter support on at91sam9xe based boards.
3100 CONFIG_BLACKFIN
3101 enable special bootcounter support on blackfin based boards.
3102 CONFIG_SOC_DA8XX
3103 enable special bootcounter support on da850 based boards.
3104 CONFIG_BOOTCOUNT_RAM
3105 enable support for the bootcounter in RAM
3106 CONFIG_BOOTCOUNT_I2C
3107 enable support for the bootcounter on an i2c (like RTC) device.
3108 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3109 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3110 the bootcounter.
3111 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003112
wdenkc0aa5c52003-12-06 19:49:23 +00003113- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003114 CONFIG_SHOW_BOOT_PROGRESS
3115
wdenk4a5c8a72003-03-06 00:02:04 +00003116 Defining this option allows to add some board-
3117 specific code (calling a user-provided function
3118 "show_boot_progress(int)") that enables you to show
3119 the system's boot progress on some display (for
3120 example, some LED's) on your board. At the moment,
3121 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003122
Simon Glass0fa36a42012-09-28 08:56:37 +00003123
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003124Legacy uImage format:
3125
wdenkc6097192002-11-03 00:24:07 +00003126 Arg Where When
3127 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003128 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003129 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003130 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003131 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003132 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003133 4 common/cmd_bootm.c Image data has correct checksum
3134 -4 common/cmd_bootm.c Image is for unsupported architecture
3135 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003136 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003137 6 common/cmd_bootm.c Image Type check OK
3138 -6 common/cmd_bootm.c gunzip uncompression error
3139 -7 common/cmd_bootm.c Unimplemented compression type
3140 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003141 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003142 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003143
3144 9 common/image.c Start initial ramdisk verification
3145 -10 common/image.c Ramdisk header has bad magic number
3146 -11 common/image.c Ramdisk header has bad checksum
3147 10 common/image.c Ramdisk header is OK
3148 -12 common/image.c Ramdisk data has bad checksum
3149 11 common/image.c Ramdisk data has correct checksum
3150 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003151 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003152 13 common/image.c Start multifile image verification
3153 14 common/image.c No initial ramdisk, no multifile, continue.
3154
Wolfgang Denk092ae952011-10-26 10:21:21 +00003155 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003156
Stefan Roese88fbf932010-04-15 16:07:28 +02003157 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003158 -31 post/post.c POST test failed, detected by post_output_backlog()
3159 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003160
Heiko Schocher633e03a2007-06-22 19:11:54 +02003161 34 common/cmd_doc.c before loading a Image from a DOC device
3162 -35 common/cmd_doc.c Bad usage of "doc" command
3163 35 common/cmd_doc.c correct usage of "doc" command
3164 -36 common/cmd_doc.c No boot device
3165 36 common/cmd_doc.c correct boot device
3166 -37 common/cmd_doc.c Unknown Chip ID on boot device
3167 37 common/cmd_doc.c correct chip ID found, device available
3168 -38 common/cmd_doc.c Read Error on boot device
3169 38 common/cmd_doc.c reading Image header from DOC device OK
3170 -39 common/cmd_doc.c Image header has bad magic number
3171 39 common/cmd_doc.c Image header has correct magic number
3172 -40 common/cmd_doc.c Error reading Image from DOC device
3173 40 common/cmd_doc.c Image header has correct magic number
3174 41 common/cmd_ide.c before loading a Image from a IDE device
3175 -42 common/cmd_ide.c Bad usage of "ide" command
3176 42 common/cmd_ide.c correct usage of "ide" command
3177 -43 common/cmd_ide.c No boot device
3178 43 common/cmd_ide.c boot device found
3179 -44 common/cmd_ide.c Device not available
3180 44 common/cmd_ide.c Device available
3181 -45 common/cmd_ide.c wrong partition selected
3182 45 common/cmd_ide.c partition selected
3183 -46 common/cmd_ide.c Unknown partition table
3184 46 common/cmd_ide.c valid partition table found
3185 -47 common/cmd_ide.c Invalid partition type
3186 47 common/cmd_ide.c correct partition type
3187 -48 common/cmd_ide.c Error reading Image Header on boot device
3188 48 common/cmd_ide.c reading Image Header from IDE device OK
3189 -49 common/cmd_ide.c Image header has bad magic number
3190 49 common/cmd_ide.c Image header has correct magic number
3191 -50 common/cmd_ide.c Image header has bad checksum
3192 50 common/cmd_ide.c Image header has correct checksum
3193 -51 common/cmd_ide.c Error reading Image from IDE device
3194 51 common/cmd_ide.c reading Image from IDE device OK
3195 52 common/cmd_nand.c before loading a Image from a NAND device
3196 -53 common/cmd_nand.c Bad usage of "nand" command
3197 53 common/cmd_nand.c correct usage of "nand" command
3198 -54 common/cmd_nand.c No boot device
3199 54 common/cmd_nand.c boot device found
3200 -55 common/cmd_nand.c Unknown Chip ID on boot device
3201 55 common/cmd_nand.c correct chip ID found, device available
3202 -56 common/cmd_nand.c Error reading Image Header on boot device
3203 56 common/cmd_nand.c reading Image Header from NAND device OK
3204 -57 common/cmd_nand.c Image header has bad magic number
3205 57 common/cmd_nand.c Image header has correct magic number
3206 -58 common/cmd_nand.c Error reading Image from NAND device
3207 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003208
Heiko Schocher633e03a2007-06-22 19:11:54 +02003209 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003210
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003211 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003212 -64 net/eth.c no Ethernet found.
3213 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003214
Heiko Schocher633e03a2007-06-22 19:11:54 +02003215 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003216 80 common/cmd_net.c before calling net_loop()
3217 -81 common/cmd_net.c some error in net_loop() occurred
3218 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003219 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3220 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003221 83 common/cmd_net.c running "source" command
3222 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003223 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003224
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003225FIT uImage format:
3226
3227 Arg Where When
3228 100 common/cmd_bootm.c Kernel FIT Image has correct format
3229 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3230 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3231 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3232 102 common/cmd_bootm.c Kernel unit name specified
3233 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003234 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003235 104 common/cmd_bootm.c Got kernel subimage node offset
3236 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3237 105 common/cmd_bootm.c Kernel subimage hash verification OK
3238 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3239 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003240 -106 common/cmd_bootm.c Kernel subimage has wrong type
3241 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003242 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3243 108 common/cmd_bootm.c Got kernel subimage data/size
3244 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3245 -109 common/cmd_bootm.c Can't get kernel subimage type
3246 -110 common/cmd_bootm.c Can't get kernel subimage comp
3247 -111 common/cmd_bootm.c Can't get kernel subimage os
3248 -112 common/cmd_bootm.c Can't get kernel subimage load address
3249 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3250
3251 120 common/image.c Start initial ramdisk verification
3252 -120 common/image.c Ramdisk FIT image has incorrect format
3253 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003254 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003255 -122 common/image.c Can't get configuration for ramdisk subimage
3256 123 common/image.c Ramdisk unit name specified
3257 -124 common/image.c Can't get ramdisk subimage node offset
3258 125 common/image.c Got ramdisk subimage node offset
3259 -125 common/image.c Ramdisk subimage hash verification failed
3260 126 common/image.c Ramdisk subimage hash verification OK
3261 -126 common/image.c Ramdisk subimage for unsupported architecture
3262 127 common/image.c Architecture check OK
3263 -127 common/image.c Can't get ramdisk subimage data/size
3264 128 common/image.c Got ramdisk subimage data/size
3265 129 common/image.c Can't get ramdisk load address
3266 -129 common/image.c Got ramdisk load address
3267
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003268 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003269 131 common/cmd_doc.c FIT image format OK
3270
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003271 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003272 141 common/cmd_ide.c FIT image format OK
3273
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003274 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003275 151 common/cmd_nand.c FIT image format OK
3276
Heiko Schocher515eb122014-05-28 11:33:33 +02003277- legacy image format:
3278 CONFIG_IMAGE_FORMAT_LEGACY
3279 enables the legacy image format support in U-Boot.
3280
3281 Default:
3282 enabled if CONFIG_FIT_SIGNATURE is not defined.
3283
3284 CONFIG_DISABLE_IMAGE_LEGACY
3285 disable the legacy image format
3286
3287 This define is introduced, as the legacy image format is
3288 enabled per default for backward compatibility.
3289
Gabe Blackd572e162012-10-25 16:31:10 +00003290- FIT image support:
3291 CONFIG_FIT
3292 Enable support for the FIT uImage format.
3293
3294 CONFIG_FIT_BEST_MATCH
3295 When no configuration is explicitly selected, default to the
3296 one whose fdt's compatibility field best matches that of
3297 U-Boot itself. A match is considered "best" if it matches the
3298 most specific compatibility entry of U-Boot's fdt's root node.
3299 The order of entries in the configuration's fdt is ignored.
3300
Simon Glass58fe7e52013-06-13 15:10:00 -07003301 CONFIG_FIT_SIGNATURE
3302 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303303 using a hash signed and verified using RSA. If
3304 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3305 hashing is available using hardware, RSA library will use it.
3306 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003307
Heiko Schocher515eb122014-05-28 11:33:33 +02003308 WARNING: When relying on signed FIT images with required
3309 signature check the legacy image format is default
3310 disabled. If a board need legacy image format support
3311 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3312
Dirk Eibach88919ca2014-07-03 09:28:26 +02003313 CONFIG_FIT_DISABLE_SHA256
3314 Supporting SHA256 hashes has quite an impact on binary size.
3315 For constrained systems sha256 hash support can be disabled
3316 with this option.
3317
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003318- Standalone program support:
3319 CONFIG_STANDALONE_LOAD_ADDR
3320
Wolfgang Denk23f78482011-10-09 21:06:34 +02003321 This option defines a board specific value for the
3322 address where standalone program gets loaded, thus
3323 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003324 settings.
3325
3326- Frame Buffer Address:
3327 CONFIG_FB_ADDR
3328
3329 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003330 address for frame buffer. This is typically the case
3331 when using a graphics controller has separate video
3332 memory. U-Boot will then place the frame buffer at
3333 the given address instead of dynamically reserving it
3334 in system RAM by calling lcd_setmem(), which grabs
3335 the memory for the frame buffer depending on the
3336 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003337
3338 Please see board_init_f function.
3339
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003340- Automatic software updates via TFTP server
3341 CONFIG_UPDATE_TFTP
3342 CONFIG_UPDATE_TFTP_CNT_MAX
3343 CONFIG_UPDATE_TFTP_MSEC_MAX
3344
3345 These options enable and control the auto-update feature;
3346 for a more detailed description refer to doc/README.update.
3347
3348- MTD Support (mtdparts command, UBI support)
3349 CONFIG_MTD_DEVICE
3350
3351 Adds the MTD device infrastructure from the Linux kernel.
3352 Needed for mtdparts command support.
3353
3354 CONFIG_MTD_PARTITIONS
3355
3356 Adds the MTD partitioning infrastructure from the Linux
3357 kernel. Needed for UBI support.
3358
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003359- UBI support
3360 CONFIG_CMD_UBI
3361
3362 Adds commands for interacting with MTD partitions formatted
3363 with the UBI flash translation layer
3364
3365 Requires also defining CONFIG_RBTREE
3366
Joe Hershberger47550fc2013-04-08 10:32:49 +00003367 CONFIG_UBI_SILENCE_MSG
3368
3369 Make the verbose messages from UBI stop printing. This leaves
3370 warnings and errors enabled.
3371
Heiko Schocherf5895d12014-06-24 10:10:04 +02003372
3373 CONFIG_MTD_UBI_WL_THRESHOLD
3374 This parameter defines the maximum difference between the highest
3375 erase counter value and the lowest erase counter value of eraseblocks
3376 of UBI devices. When this threshold is exceeded, UBI starts performing
3377 wear leveling by means of moving data from eraseblock with low erase
3378 counter to eraseblocks with high erase counter.
3379
3380 The default value should be OK for SLC NAND flashes, NOR flashes and
3381 other flashes which have eraseblock life-cycle 100000 or more.
3382 However, in case of MLC NAND flashes which typically have eraseblock
3383 life-cycle less than 10000, the threshold should be lessened (e.g.,
3384 to 128 or 256, although it does not have to be power of 2).
3385
3386 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003387
Heiko Schocherf5895d12014-06-24 10:10:04 +02003388 CONFIG_MTD_UBI_BEB_LIMIT
3389 This option specifies the maximum bad physical eraseblocks UBI
3390 expects on the MTD device (per 1024 eraseblocks). If the
3391 underlying flash does not admit of bad eraseblocks (e.g. NOR
3392 flash), this value is ignored.
3393
3394 NAND datasheets often specify the minimum and maximum NVM
3395 (Number of Valid Blocks) for the flashes' endurance lifetime.
3396 The maximum expected bad eraseblocks per 1024 eraseblocks
3397 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3398 which gives 20 for most NANDs (MaxNVB is basically the total
3399 count of eraseblocks on the chip).
3400
3401 To put it differently, if this value is 20, UBI will try to
3402 reserve about 1.9% of physical eraseblocks for bad blocks
3403 handling. And that will be 1.9% of eraseblocks on the entire
3404 NAND chip, not just the MTD partition UBI attaches. This means
3405 that if you have, say, a NAND flash chip admits maximum 40 bad
3406 eraseblocks, and it is split on two MTD partitions of the same
3407 size, UBI will reserve 40 eraseblocks when attaching a
3408 partition.
3409
3410 default: 20
3411
3412 CONFIG_MTD_UBI_FASTMAP
3413 Fastmap is a mechanism which allows attaching an UBI device
3414 in nearly constant time. Instead of scanning the whole MTD device it
3415 only has to locate a checkpoint (called fastmap) on the device.
3416 The on-flash fastmap contains all information needed to attach
3417 the device. Using fastmap makes only sense on large devices where
3418 attaching by scanning takes long. UBI will not automatically install
3419 a fastmap on old images, but you can set the UBI parameter
3420 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3421 that fastmap-enabled images are still usable with UBI implementations
3422 without fastmap support. On typical flash devices the whole fastmap
3423 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3424
3425 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3426 Set this parameter to enable fastmap automatically on images
3427 without a fastmap.
3428 default: 0
3429
Heiko Schocher94b66de2015-10-22 06:19:21 +02003430 CONFIG_MTD_UBI_FM_DEBUG
3431 Enable UBI fastmap debug
3432 default: 0
3433
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003434- UBIFS support
3435 CONFIG_CMD_UBIFS
3436
3437 Adds commands for interacting with UBI volumes formatted as
3438 UBIFS. UBIFS is read-only in u-boot.
3439
3440 Requires UBI support as well as CONFIG_LZO
3441
Joe Hershberger47550fc2013-04-08 10:32:49 +00003442 CONFIG_UBIFS_SILENCE_MSG
3443
3444 Make the verbose messages from UBIFS stop printing. This leaves
3445 warnings and errors enabled.
3446
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003447- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003448 CONFIG_SPL
3449 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003450
Tom Rini36853852012-02-14 07:29:40 +00003451 CONFIG_SPL_LDSCRIPT
3452 LDSCRIPT for linking the SPL binary.
3453
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003454 CONFIG_SPL_MAX_FOOTPRINT
3455 Maximum size in memory allocated to the SPL, BSS included.
3456 When defined, the linker checks that the actual memory
3457 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003458 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003459 must not be both defined at the same time.
3460
Tom Rini36853852012-02-14 07:29:40 +00003461 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003462 Maximum size of the SPL image (text, data, rodata, and
3463 linker lists sections), BSS excluded.
3464 When defined, the linker checks that the actual size does
3465 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003466
Wolfgang Denk825223d2011-09-11 21:24:09 +02003467 CONFIG_SPL_TEXT_BASE
3468 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003469
Scott Woodc4f0d002012-09-20 19:05:12 -05003470 CONFIG_SPL_RELOC_TEXT_BASE
3471 Address to relocate to. If unspecified, this is equal to
3472 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3473
Tom Rini36853852012-02-14 07:29:40 +00003474 CONFIG_SPL_BSS_START_ADDR
3475 Link address for the BSS within the SPL binary.
3476
3477 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003478 Maximum size in memory allocated to the SPL BSS.
3479 When defined, the linker checks that the actual memory used
3480 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003481 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003482 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003483
3484 CONFIG_SPL_STACK
3485 Adress of the start of the stack SPL will use
3486
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003487 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3488 When defined, SPL will panic() if the image it has
3489 loaded does not have a signature.
3490 Defining this is useful when code which loads images
3491 in SPL cannot guarantee that absolutely all read errors
3492 will be caught.
3493 An example is the LPC32XX MLC NAND driver, which will
3494 consider that a completely unreadable NAND block is bad,
3495 and thus should be skipped silently.
3496
Scott Woodc4f0d002012-09-20 19:05:12 -05003497 CONFIG_SPL_RELOC_STACK
3498 Adress of the start of the stack SPL will use after
3499 relocation. If unspecified, this is equal to
3500 CONFIG_SPL_STACK.
3501
Tom Rini36853852012-02-14 07:29:40 +00003502 CONFIG_SYS_SPL_MALLOC_START
3503 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003504 When this option is set the full malloc is used in SPL and
3505 it is set up by spl_init() and before that, the simple malloc()
3506 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003507
3508 CONFIG_SYS_SPL_MALLOC_SIZE
3509 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003510
Tom Rini28591df2012-08-13 12:03:19 -07003511 CONFIG_SPL_FRAMEWORK
3512 Enable the SPL framework under common/. This framework
3513 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3514 NAND loading of the Linux Kernel.
3515
Tom Rinic2b76002014-03-28 12:03:39 -04003516 CONFIG_SPL_OS_BOOT
3517 Enable booting directly to an OS from SPL.
3518 See also: doc/README.falcon
3519
Tom Rinife3b0c72012-08-13 11:37:56 -07003520 CONFIG_SPL_DISPLAY_PRINT
3521 For ARM, enable an optional function to print more information
3522 about the running system.
3523
Scott Wood7c810902012-09-20 16:35:21 -05003524 CONFIG_SPL_INIT_MINIMAL
3525 Arch init code should be built for a very small image
3526
Wolfgang Denk825223d2011-09-11 21:24:09 +02003527 CONFIG_SPL_LIBCOMMON_SUPPORT
3528 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003529
Wolfgang Denk825223d2011-09-11 21:24:09 +02003530 CONFIG_SPL_LIBDISK_SUPPORT
3531 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003532
Wolfgang Denk825223d2011-09-11 21:24:09 +02003533 CONFIG_SPL_I2C_SUPPORT
3534 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003535
Wolfgang Denk825223d2011-09-11 21:24:09 +02003536 CONFIG_SPL_GPIO_SUPPORT
3537 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003538
Wolfgang Denk825223d2011-09-11 21:24:09 +02003539 CONFIG_SPL_MMC_SUPPORT
3540 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003541
Tom Rini36853852012-02-14 07:29:40 +00003542 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3543 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003544 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003545 when the MMC is being used in raw mode.
3546
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003547 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3548 Partition on the MMC to load U-Boot from when the MMC is being
3549 used in raw mode
3550
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003551 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3552 Sector to load kernel uImage from when MMC is being
3553 used in raw mode (for Falcon mode)
3554
3555 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3556 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3557 Sector and number of sectors to load kernel argument
3558 parameters from when MMC is being used in raw mode
3559 (for falcon mode)
3560
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003561 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3562 Partition on the MMC to load U-Boot from when the MMC is being
3563 used in fs mode
3564
Tom Rini36853852012-02-14 07:29:40 +00003565 CONFIG_SPL_FAT_SUPPORT
3566 Support for fs/fat/libfat.o in SPL binary
3567
Guillaume GARDET5065b712014-10-15 17:53:13 +02003568 CONFIG_SPL_EXT_SUPPORT
3569 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003570
Guillaume GARDET5065b712014-10-15 17:53:13 +02003571 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3572 Filename to read to load U-Boot when reading from filesystem
3573
3574 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003575 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003576 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003577
Guillaume GARDET5065b712014-10-15 17:53:13 +02003578 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003579 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003580 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003581
Scott Wood2b36fbb2012-12-06 13:33:17 +00003582 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3583 Set this for NAND SPL on PPC mpc83xx targets, so that
3584 start.S waits for the rest of the SPL to load before
3585 continuing (the hardware starts execution after just
3586 loading the first page rather than the full 4K).
3587
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303588 CONFIG_SPL_SKIP_RELOCATE
3589 Avoid SPL relocation
3590
Scott Woodc352a0c2012-09-20 19:09:07 -05003591 CONFIG_SPL_NAND_BASE
3592 Include nand_base.c in the SPL. Requires
3593 CONFIG_SPL_NAND_DRIVERS.
3594
3595 CONFIG_SPL_NAND_DRIVERS
3596 SPL uses normal NAND drivers, not minimal drivers.
3597
3598 CONFIG_SPL_NAND_ECC
3599 Include standard software ECC in the SPL
3600
Tom Rini36853852012-02-14 07:29:40 +00003601 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003602 Support for NAND boot using simple NAND drivers that
3603 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003604
Tom Rini543c9f12014-03-28 12:03:36 -04003605 CONFIG_SPL_MTD_SUPPORT
3606 Support for the MTD subsystem within SPL. Useful for
3607 environment on NAND support within SPL.
3608
Heiko Schochercf000272014-10-31 08:31:00 +01003609 CONFIG_SPL_NAND_RAW_ONLY
3610 Support to boot only raw u-boot.bin images. Use this only
3611 if you need to save space.
3612
Ying Zhang9ff70262013-08-16 15:16:11 +08003613 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3614 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003615 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003616
Ying Zhangdfb2b152013-08-16 15:16:12 +08003617 CONFIG_SPL_COMMON_INIT_DDR
3618 Set for common ddr init with serial presence detect in
3619 SPL binary.
3620
Tom Rini36853852012-02-14 07:29:40 +00003621 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3622 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3623 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3624 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3625 CONFIG_SYS_NAND_ECCBYTES
3626 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003627 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003628
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303629 CONFIG_SPL_NAND_BOOT
3630 Add support NAND boot
3631
Tom Rini36853852012-02-14 07:29:40 +00003632 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003633 Location in NAND to read U-Boot from
3634
3635 CONFIG_SYS_NAND_U_BOOT_DST
3636 Location in memory to load U-Boot to
3637
3638 CONFIG_SYS_NAND_U_BOOT_SIZE
3639 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003640
3641 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003642 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003643
3644 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3645 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003646 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003647
3648 CONFIG_SPL_OMAP3_ID_NAND
3649 Support for an OMAP3-specific set of functions to return the
3650 ID and MFR of the first attached NAND chip, if present.
3651
Wolfgang Denk825223d2011-09-11 21:24:09 +02003652 CONFIG_SPL_SERIAL_SUPPORT
3653 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003654
Wolfgang Denk825223d2011-09-11 21:24:09 +02003655 CONFIG_SPL_SPI_FLASH_SUPPORT
3656 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003657
Wolfgang Denk825223d2011-09-11 21:24:09 +02003658 CONFIG_SPL_SPI_SUPPORT
3659 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003660
Pavel Machekde997252012-08-30 22:42:11 +02003661 CONFIG_SPL_RAM_DEVICE
3662 Support for running image already present in ram, in SPL binary
3663
Wolfgang Denk825223d2011-09-11 21:24:09 +02003664 CONFIG_SPL_LIBGENERIC_SUPPORT
3665 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003666
Ying Zhang602f7d32013-05-20 14:07:25 +08003667 CONFIG_SPL_ENV_SUPPORT
3668 Support for the environment operating in SPL binary
3669
3670 CONFIG_SPL_NET_SUPPORT
3671 Support for the net/libnet.o in SPL binary.
3672 It conflicts with SPL env from storage medium specified by
3673 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3674
Scott Woodeb7bd972012-12-06 13:33:16 +00003675 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003676 Image offset to which the SPL should be padded before appending
3677 the SPL payload. By default, this is defined as
3678 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3679 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3680 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003681
Scott Woodf147eb72012-09-21 16:27:32 -05003682 CONFIG_SPL_TARGET
3683 Final target image containing SPL and payload. Some SPLs
3684 use an arch-specific makefile fragment instead, for
3685 example if more than one image needs to be produced.
3686
Simon Glass82d94532013-05-08 08:05:59 +00003687 CONFIG_FIT_SPL_PRINT
3688 Printing information about a FIT image adds quite a bit of
3689 code to SPL. So this is normally disabled in SPL. Use this
3690 option to re-enable it. This will affect the output of the
3691 bootm command when booting a FIT image.
3692
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003693- TPL framework
3694 CONFIG_TPL
3695 Enable building of TPL globally.
3696
3697 CONFIG_TPL_PAD_TO
3698 Image offset to which the TPL should be padded before appending
3699 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003700 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3701 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3702 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003703
wdenkc6097192002-11-03 00:24:07 +00003704Modem Support:
3705--------------
3706
Wolfgang Denk8f399b32011-05-01 20:44:23 +02003707[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003708
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003709- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003710 CONFIG_MODEM_SUPPORT
3711
3712- RTS/CTS Flow control enable:
3713 CONFIG_HWFLOW
3714
wdenkc0aa5c52003-12-06 19:49:23 +00003715- Interrupt support (PPC):
3716
wdenk1ebf41e2004-01-02 14:00:00 +00003717 There are common interrupt_init() and timer_interrupt()
3718 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003719 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003720 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003721 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003722 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003723 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003724 specific handling. If board has watchdog / status_led
3725 / other_activity_monitor it works automatically from
3726 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003727
wdenkc6097192002-11-03 00:24:07 +00003728- General:
3729
wdenk4a5c8a72003-03-06 00:02:04 +00003730 In the target system modem support is enabled when a
3731 specific key (key combination) is pressed during
3732 power-on. Otherwise U-Boot will boot normally
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003733 (autoboot). The key_pressed() function is called from
wdenk4a5c8a72003-03-06 00:02:04 +00003734 board_init(). Currently key_pressed() is a dummy
3735 function, returning 1 and thus enabling modem
3736 initialization.
wdenkc6097192002-11-03 00:24:07 +00003737
wdenk4a5c8a72003-03-06 00:02:04 +00003738 If there are no modem init strings in the
3739 environment, U-Boot proceed to autoboot; the
3740 previous output (banner, info printfs) will be
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003741 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003742
3743 See also: doc/README.Modem
3744
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003745Board initialization settings:
3746------------------------------
3747
3748During Initialization u-boot calls a number of board specific functions
3749to allow the preparation of board specific prerequisites, e.g. pin setup
3750before drivers are initialized. To enable these callbacks the
3751following configuration macros have to be defined. Currently this is
3752architecture specific, so please check arch/your_architecture/lib/board.c
3753typically in board_init_f() and board_init_r().
3754
3755- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3756- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3757- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3758- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003759
wdenkc6097192002-11-03 00:24:07 +00003760Configuration Settings:
3761-----------------------
3762
York Sun6c480012014-02-26 17:03:19 -08003763- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3764 Optionally it can be defined to support 64-bit memory commands.
3765
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003766- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003767 undefine this when you're short of memory.
3768
Peter Tyserdfb72b82009-01-27 18:03:12 -06003769- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3770 width of the commands listed in the 'help' command output.
3771
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003772- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003773 prompt for user input.
3774
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003775- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003776
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003777- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003778
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003779- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003780
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003781- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003782 the application (usually a Linux kernel) when it is
3783 booted
3784
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003785- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003786 List of legal baudrate settings for this board.
3787
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003788- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003789 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003790
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003791- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003792 If the board specific function
3793 extern int overwrite_console (void);
3794 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003795 serial port, else the settings in the environment are used.
3796
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003797- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003798 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003799
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003800- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003801 Enable overwrite of previous console environment settings.
3802
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003803- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003804 Begin and End addresses of the area used by the
3805 simple memory test.
3806
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003807- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003808 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003809
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003810- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003811 Scratch address used by the alternate memory test
3812 You only need to set this if address zero isn't writeable
3813
York Sun5d286cd2015-12-04 11:57:07 -08003814- CONFIG_SYS_MEM_RESERVE_SECURE
3815 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3816 is substracted from total RAM and won't be reported to OS.
3817 This memory can be used as secure memory. A variable
3818 gd->secure_ram is used to track the location. In systems
3819 the RAM base is not zero, or RAM is divided into banks,
3820 this variable needs to be recalcuated to get the address.
3821
York Sun50739372015-12-07 11:05:29 -08003822- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003823 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003824 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003825 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003826 fixing up gd->ram_size the Linux kernel should gets passed
3827 the now "corrected" memory size and won't touch it either.
3828 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003829 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003830 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003831 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003832
3833 This option can be used as a workaround for the 440EPx/GRx
3834 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3835 be touched.
3836
3837 WARNING: Please make sure that this value is a multiple of
3838 the Linux page size (normally 4k). If this is not the case,
3839 then the end address of the Linux memory will be located at a
3840 non page size aligned address and this could cause major
3841 problems.
3842
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003843- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003844 Enable temporary baudrate change while serial download
3845
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003846- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003847 Physical start address of SDRAM. _Must_ be 0 here.
3848
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003849- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003850 Physical start address of Motherboard I/O (if using a
3851 Cogent motherboard)
3852
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003853- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003854 Physical start address of Flash memory.
3855
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003856- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003857 Physical start address of boot monitor code (set by
3858 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003859 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003860 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003861
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003862- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003863 Size of memory reserved for monitor code, used to
3864 determine _at_compile_time_ (!) if the environment is
3865 embedded within the U-Boot image, or in a separate
3866 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003867
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003868- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003869 Size of DRAM reserved for malloc() use.
3870
Simon Glass863e4042014-07-10 22:23:28 -06003871- CONFIG_SYS_MALLOC_F_LEN
3872 Size of the malloc() pool for use before relocation. If
3873 this is defined, then a very simple malloc() implementation
3874 will become available before relocation. The address is just
3875 below the global data, and the stack is moved down to make
3876 space.
3877
3878 This feature allocates regions with increasing addresses
3879 within the region. calloc() is supported, but realloc()
3880 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003881 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003882 U-Boot relocates itself.
3883
Simon Glasse997f752014-09-15 06:33:18 -06003884 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003885 at present but is fairly easy to enable for other archs.
3886
Simon Glass9fa901b2014-11-10 17:16:54 -07003887- CONFIG_SYS_MALLOC_SIMPLE
3888 Provides a simple and small malloc() and calloc() for those
3889 boards which do not use the full malloc in SPL (which is
3890 enabled with CONFIG_SYS_SPL_MALLOC_START).
3891
Thierry Redingc97d9742014-12-09 22:25:22 -07003892- CONFIG_SYS_NONCACHED_MEMORY:
3893 Size of non-cached memory area. This area of memory will be
3894 typically located right below the malloc() area and mapped
3895 uncached in the MMU. This is useful for drivers that would
3896 otherwise require a lot of explicit cache maintenance. For
3897 some drivers it's also impossible to properly maintain the
3898 cache. For example if the regions that need to be flushed
3899 are not a multiple of the cache-line size, *and* padding
3900 cannot be allocated between the regions to align them (i.e.
3901 if the HW requires a contiguous array of regions, and the
3902 size of each region is not cache-aligned), then a flush of
3903 one region may result in overwriting data that hardware has
3904 written to another region in the same cache-line. This can
3905 happen for example in network drivers where descriptors for
3906 buffers are typically smaller than the CPU cache-line (e.g.
3907 16 bytes vs. 32 or 64 bytes).
3908
3909 Non-cached memory is only supported on 32-bit ARM at present.
3910
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003911- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003912 Normally compressed uImages are limited to an
3913 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003914 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003915 to adjust this setting to your needs.
3916
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003917- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003918 Maximum size of memory mapped by the startup code of
3919 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003920 the Linux kernel (bd_info, boot arguments, FDT blob if
3921 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003922 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003923 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003924 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003925 variable "bootm_mapsize" will override the value of
3926 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3927 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003928
John Rigbyeea8e692010-10-13 13:57:35 -06003929- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3930 Enable initrd_high functionality. If defined then the
3931 initrd_high feature is enabled and the bootm ramdisk subcommand
3932 is enabled.
3933
3934- CONFIG_SYS_BOOT_GET_CMDLINE:
3935 Enables allocating and saving kernel cmdline in space between
3936 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3937
3938- CONFIG_SYS_BOOT_GET_KBD:
3939 Enables allocating and saving a kernel copy of the bd_info in
3940 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3941
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003942- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003943 Max number of Flash memory banks
3944
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003945- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003946 Max number of sectors on a Flash chip
3947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003948- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003949 Timeout for Flash erase operations (in ms)
3950
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003951- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003952 Timeout for Flash write operations (in ms)
3953
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003954- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003955 Timeout for Flash set sector lock bit operation (in ms)
3956
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003957- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003958 Timeout for Flash clear lock bits operation (in ms)
3959
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003960- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003961 If defined, hardware flash sectors protection is used
3962 instead of U-Boot software protection.
3963
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003964- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003965
3966 Enable TFTP transfers directly to flash memory;
3967 without this option such a download has to be
3968 performed in two steps: (1) download to RAM, and (2)
3969 copy from RAM to flash.
3970
3971 The two-step approach is usually more reliable, since
3972 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003973 the flash, but in some situations (when system RAM is
3974 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003975 downloaded image) this option may be very useful.
3976
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003977- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003978 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003979 common flash structure for storing flash geometry.
3980
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003981- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003982 This option also enables the building of the cfi_flash driver
3983 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003984
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003985- CONFIG_FLASH_CFI_MTD
3986 This option enables the building of the cfi_mtd driver
3987 in the drivers directory. The driver exports CFI flash
3988 to the MTD layer.
3989
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003990- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003991 Use buffered writes to flash.
3992
3993- CONFIG_FLASH_SPANSION_S29WS_N
3994 s29ws-n MirrorBit flash has non-standard addresses for buffered
3995 write commands.
3996
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003997- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003998 If this option is defined, the common CFI flash doesn't
3999 print it's warning upon not recognized FLASH banks. This
4000 is useful, if some of the configured banks are only
4001 optionally available.
4002
Jerry Van Barenaae73572008-03-08 13:48:01 -05004003- CONFIG_FLASH_SHOW_PROGRESS
4004 If defined (must be an integer), print out countdown
4005 digits and dots. Recommended value: 45 (9..1) for 80
4006 column displays, 15 (3..1) for 40 column displays.
4007
Stefan Roesed20cba52013-04-04 15:53:14 +02004008- CONFIG_FLASH_VERIFY
4009 If defined, the content of the flash (destination) is compared
4010 against the source after the write operation. An error message
4011 will be printed when the contents are not identical.
4012 Please note that this option is useless in nearly all cases,
4013 since such flash programming errors usually are detected earlier
4014 while unprotecting/erasing/programming. Please only enable
4015 this option if you really know what you are doing.
4016
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004017- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004018 Defines the number of Ethernet receive buffers. On some
4019 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004020 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4021 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004022 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004023 Defaults to 4 if not defined.
4024
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004025- CONFIG_ENV_MAX_ENTRIES
4026
Wolfgang Denk1136f692010-10-27 22:48:30 +02004027 Maximum number of entries in the hash table that is used
4028 internally to store the environment settings. The default
4029 setting is supposed to be generous and should work in most
4030 cases. This setting can be used to tune behaviour; see
4031 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004032
Joe Hershberger71497d02012-12-11 22:16:31 -06004033- CONFIG_ENV_FLAGS_LIST_DEFAULT
4034- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004035 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004036 calling env set. Variables can be restricted to only decimal,
4037 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4038 the variables can also be restricted to IP address or MAC address.
4039
4040 The format of the list is:
4041 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004042 access_attribute = [a|r|o|c]
4043 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004044 entry = variable_name[:attributes]
4045 list = entry[,list]
4046
4047 The type attributes are:
4048 s - String (default)
4049 d - Decimal
4050 x - Hexadecimal
4051 b - Boolean ([1yYtT|0nNfF])
4052 i - IP address
4053 m - MAC address
4054
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004055 The access attributes are:
4056 a - Any (default)
4057 r - Read-only
4058 o - Write-once
4059 c - Change-default
4060
Joe Hershberger71497d02012-12-11 22:16:31 -06004061 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4062 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004063 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004064
4065 - CONFIG_ENV_FLAGS_LIST_STATIC
4066 Define this to a list (string) to define validation that
4067 should be done if an entry is not found in the ".flags"
4068 environment variable. To override a setting in the static
4069 list, simply add an entry for the same variable name to the
4070 ".flags" variable.
4071
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004072 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4073 regular expression. This allows multiple variables to define the same
4074 flags without explicitly listing them for each variable.
4075
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004076- CONFIG_ENV_ACCESS_IGNORE_FORCE
4077 If defined, don't allow the -f switch to env set override variable
4078 access flags.
4079
Simon Glass66828322013-03-08 13:45:27 +00004080- CONFIG_SYS_GENERIC_BOARD
4081 This selects the architecture-generic board system instead of the
4082 architecture-specific board files. It is intended to move boards
4083 to this new framework over time. Defining this will disable the
4084 arch/foo/lib/board.c file and use common/board_f.c and
4085 common/board_r.c instead. To use this option your architecture
Masahiro Yamada9e4af832015-03-19 19:42:51 +09004086 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4087 If you find problems enabling this option on your board please report
4088 the problem and send patches!
Simon Glass66828322013-03-08 13:45:27 +00004089
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004090- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4091 This is set by OMAP boards for the max time that reset should
4092 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004093 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004094
Gabe Black3687fe42014-10-15 04:38:30 -06004095- CONFIG_USE_STDINT
4096 If stdint.h is available with your toolchain you can define this
4097 option to enable it. You can provide option 'USE_STDINT=1' when
4098 building U-Boot to enable this.
4099
wdenkc6097192002-11-03 00:24:07 +00004100The following definitions that deal with the placement and management
4101of environment data (variable area); in general, we support the
4102following configurations:
4103
Mike Frysinger63b8f122011-07-08 10:44:25 +00004104- CONFIG_BUILD_ENVCRC:
4105
4106 Builds up envcrc with the target environment so that external utils
4107 may easily extract it and embed it in final U-Boot images.
4108
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004109- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004110
4111 Define this if the environment is in flash memory.
4112
4113 a) The environment occupies one whole flash sector, which is
4114 "embedded" in the text segment with the U-Boot code. This
4115 happens usually with "bottom boot sector" or "top boot
4116 sector" type flash chips, which have several smaller
4117 sectors at the start or the end. For instance, such a
4118 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4119 such a case you would place the environment in one of the
4120 4 kB sectors - with U-Boot code before and after it. With
4121 "top boot sector" type flash chips, you would put the
4122 environment in one of the last sectors, leaving a gap
4123 between U-Boot and the environment.
4124
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004125 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004126
4127 Offset of environment data (variable area) to the
4128 beginning of flash memory; for instance, with bottom boot
4129 type flash chips the second sector can be used: the offset
4130 for this sector is given here.
4131
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004132 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004133
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004134 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004135
4136 This is just another way to specify the start address of
4137 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004138 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004139
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004140 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004141
4142 Size of the sector containing the environment.
4143
4144
4145 b) Sometimes flash chips have few, equal sized, BIG sectors.
4146 In such a case you don't want to spend a whole sector for
4147 the environment.
4148
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004149 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004150
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004151 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004152 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004153 of this flash sector for the environment. This saves
4154 memory for the RAM copy of the environment.
4155
4156 It may also save flash memory if you decide to use this
4157 when your environment is "embedded" within U-Boot code,
4158 since then the remainder of the flash sector could be used
4159 for U-Boot code. It should be pointed out that this is
4160 STRONGLY DISCOURAGED from a robustness point of view:
4161 updating the environment in flash makes it always
4162 necessary to erase the WHOLE sector. If something goes
4163 wrong before the contents has been restored from a copy in
4164 RAM, your target system will be dead.
4165
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004166 - CONFIG_ENV_ADDR_REDUND
4167 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004168
wdenk4a5c8a72003-03-06 00:02:04 +00004169 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004170 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004171 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004172 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004173
4174BE CAREFUL! Any changes to the flash layout, and some changes to the
4175source code will make it necessary to adapt <board>/u-boot.lds*
4176accordingly!
4177
4178
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004179- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004180
4181 Define this if you have some non-volatile memory device
4182 (NVRAM, battery buffered SRAM) which you want to use for the
4183 environment.
4184
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004185 - CONFIG_ENV_ADDR:
4186 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004187
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004188 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004189 want to use for environment. It is assumed that this memory
4190 can just be read and written to, without any special
4191 provision.
4192
4193BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004194in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004195console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004196U-Boot will hang.
4197
4198Please note that even with NVRAM we still use a copy of the
4199environment in RAM: we could work on NVRAM directly, but we want to
4200keep settings there always unmodified except somebody uses "saveenv"
4201to save the current settings.
4202
4203
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004204- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004205
4206 Use this if you have an EEPROM or similar serial access
4207 device and a driver for it.
4208
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004209 - CONFIG_ENV_OFFSET:
4210 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004211
4212 These two #defines specify the offset and size of the
4213 environment area within the total memory of your EEPROM.
4214
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004215 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004216 If defined, specified the chip address of the EEPROM device.
4217 The default address is zero.
4218
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004219 - CONFIG_SYS_I2C_EEPROM_BUS:
4220 If defined, specified the i2c bus of the EEPROM device.
4221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004222 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004223 If defined, the number of bits used to address bytes in a
4224 single page in the EEPROM device. A 64 byte page, for example
4225 would require six bits.
4226
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004227 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004228 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004229 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004230
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004231 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004232 The length in bytes of the EEPROM memory array address. Note
4233 that this is NOT the chip address length!
4234
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004235 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004236 EEPROM chips that implement "address overflow" are ones
4237 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4238 address and the extra bits end up in the "chip address" bit
4239 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4240 byte chips.
4241
4242 Note that we consider the length of the address field to
4243 still be one byte because the extra address bits are hidden
4244 in the chip address.
4245
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004246 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004247 The size in bytes of the EEPROM device.
4248
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004249 - CONFIG_ENV_EEPROM_IS_ON_I2C
4250 define this, if you have I2C and SPI activated, and your
4251 EEPROM, which holds the environment, is on the I2C bus.
4252
4253 - CONFIG_I2C_ENV_EEPROM_BUS
4254 if you have an Environment on an EEPROM reached over
4255 I2C muxes, you can define here, how to reach this
4256 EEPROM. For example:
4257
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004258 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004259
4260 EEPROM which holds the environment, is reached over
4261 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004262
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004263- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004264
wdenk1ebf41e2004-01-02 14:00:00 +00004265 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004266 want to use for the environment.
4267
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004268 - CONFIG_ENV_OFFSET:
4269 - CONFIG_ENV_ADDR:
4270 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004271
4272 These three #defines specify the offset and size of the
4273 environment area within the total memory of your DataFlash placed
4274 at the specified address.
4275
Wu, Josh76db7bf2014-07-01 19:30:13 +08004276- CONFIG_ENV_IS_IN_SPI_FLASH:
4277
4278 Define this if you have a SPI Flash memory device which you
4279 want to use for the environment.
4280
4281 - CONFIG_ENV_OFFSET:
4282 - CONFIG_ENV_SIZE:
4283
4284 These two #defines specify the offset and size of the
4285 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4286 aligned to an erase sector boundary.
4287
4288 - CONFIG_ENV_SECT_SIZE:
4289
4290 Define the SPI flash's sector size.
4291
4292 - CONFIG_ENV_OFFSET_REDUND (optional):
4293
4294 This setting describes a second storage area of CONFIG_ENV_SIZE
4295 size used to hold a redundant copy of the environment data, so
4296 that there is a valid backup copy in case there is a power failure
4297 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4298 aligned to an erase sector boundary.
4299
4300 - CONFIG_ENV_SPI_BUS (optional):
4301 - CONFIG_ENV_SPI_CS (optional):
4302
4303 Define the SPI bus and chip select. If not defined they will be 0.
4304
4305 - CONFIG_ENV_SPI_MAX_HZ (optional):
4306
4307 Define the SPI max work clock. If not defined then use 1MHz.
4308
4309 - CONFIG_ENV_SPI_MODE (optional):
4310
4311 Define the SPI work mode. If not defined then use SPI_MODE_3.
4312
Liu Gang85bcd732012-03-08 00:33:20 +00004313- CONFIG_ENV_IS_IN_REMOTE:
4314
4315 Define this if you have a remote memory space which you
4316 want to use for the local device's environment.
4317
4318 - CONFIG_ENV_ADDR:
4319 - CONFIG_ENV_SIZE:
4320
4321 These two #defines specify the address and size of the
4322 environment area within the remote memory space. The
4323 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004324 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004325
4326BE CAREFUL! For some special cases, the local device can not use
4327"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004328environment stored in a remote NOR flash by SRIO or PCIE link,
4329but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004330
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004331- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004332
4333 Define this if you have a NAND device which you want to use
4334 for the environment.
4335
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004336 - CONFIG_ENV_OFFSET:
4337 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004338
4339 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004340 area within the first NAND device. CONFIG_ENV_OFFSET must be
4341 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004342
Scott Wood08239322010-09-17 14:38:37 -05004343 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004344
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004345 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004346 size used to hold a redundant copy of the environment data, so
4347 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004348 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004349 aligned to an erase block boundary.
4350
4351 - CONFIG_ENV_RANGE (optional):
4352
4353 Specifies the length of the region in which the environment
4354 can be written. This should be a multiple of the NAND device's
4355 block size. Specifying a range with more erase blocks than
4356 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4357 the range to be avoided.
4358
4359 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004360
Scott Wood08239322010-09-17 14:38:37 -05004361 Enables support for dynamically retrieving the offset of the
4362 environment from block zero's out-of-band data. The
4363 "nand env.oob" command can be used to record this offset.
4364 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4365 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004366
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004367- CONFIG_NAND_ENV_DST
4368
4369 Defines address in RAM to which the nand_spl code should copy the
4370 environment. If redundant environment is used, it will be copied to
4371 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4372
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004373- CONFIG_ENV_IS_IN_UBI:
4374
4375 Define this if you have an UBI volume that you want to use for the
4376 environment. This has the benefit of wear-leveling the environment
4377 accesses, which is important on NAND.
4378
4379 - CONFIG_ENV_UBI_PART:
4380
4381 Define this to a string that is the mtd partition containing the UBI.
4382
4383 - CONFIG_ENV_UBI_VOLUME:
4384
4385 Define this to the name of the volume that you want to store the
4386 environment in.
4387
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004388 - CONFIG_ENV_UBI_VOLUME_REDUND:
4389
4390 Define this to the name of another volume to store a second copy of
4391 the environment in. This will enable redundant environments in UBI.
4392 It is assumed that both volumes are in the same MTD partition.
4393
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004394 - CONFIG_UBI_SILENCE_MSG
4395 - CONFIG_UBIFS_SILENCE_MSG
4396
4397 You will probably want to define these to avoid a really noisy system
4398 when storing the env in UBI.
4399
Wu, Josha7d0c872014-06-24 17:31:03 +08004400- CONFIG_ENV_IS_IN_FAT:
4401 Define this if you want to use the FAT file system for the environment.
4402
4403 - FAT_ENV_INTERFACE:
4404
4405 Define this to a string that is the name of the block device.
4406
4407 - FAT_ENV_DEV_AND_PART:
4408
4409 Define this to a string to specify the partition of the device. It can
4410 be as following:
4411
4412 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4413 - "D:P": device D partition P. Error occurs if device D has no
4414 partition table.
4415 - "D:0": device D.
4416 - "D" or "D:": device D partition 1 if device D has partition
4417 table, or the whole device D if has no partition
4418 table.
4419 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004420 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004421 partition table then means device D.
4422
4423 - FAT_ENV_FILE:
4424
4425 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004426 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004427
4428 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004429 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004430
Stephen Warreneedcacd2013-06-11 15:14:00 -06004431- CONFIG_ENV_IS_IN_MMC:
4432
4433 Define this if you have an MMC device which you want to use for the
4434 environment.
4435
4436 - CONFIG_SYS_MMC_ENV_DEV:
4437
4438 Specifies which MMC device the environment is stored in.
4439
4440 - CONFIG_SYS_MMC_ENV_PART (optional):
4441
4442 Specifies which MMC partition the environment is stored in. If not
4443 set, defaults to partition 0, the user area. Common values might be
4444 1 (first MMC boot partition), 2 (second MMC boot partition).
4445
4446 - CONFIG_ENV_OFFSET:
4447 - CONFIG_ENV_SIZE:
4448
4449 These two #defines specify the offset and size of the environment
4450 area within the specified MMC device.
4451
Stephen Warren24dc2032013-06-11 15:14:02 -06004452 If offset is positive (the usual case), it is treated as relative to
4453 the start of the MMC partition. If offset is negative, it is treated
4454 as relative to the end of the MMC partition. This can be useful if
4455 your board may be fitted with different MMC devices, which have
4456 different sizes for the MMC partitions, and you always want the
4457 environment placed at the very end of the partition, to leave the
4458 maximum possible space before it, to store other data.
4459
Stephen Warreneedcacd2013-06-11 15:14:00 -06004460 These two values are in units of bytes, but must be aligned to an
4461 MMC sector boundary.
4462
4463 - CONFIG_ENV_OFFSET_REDUND (optional):
4464
4465 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4466 hold a redundant copy of the environment data. This provides a
4467 valid backup copy in case the other copy is corrupted, e.g. due
4468 to a power failure during a "saveenv" operation.
4469
Stephen Warren24dc2032013-06-11 15:14:02 -06004470 This value may also be positive or negative; this is handled in the
4471 same way as CONFIG_ENV_OFFSET.
4472
Stephen Warreneedcacd2013-06-11 15:14:00 -06004473 This value is also in units of bytes, but must also be aligned to
4474 an MMC sector boundary.
4475
4476 - CONFIG_ENV_SIZE_REDUND (optional):
4477
4478 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4479 set. If this value is set, it must be set to the same value as
4480 CONFIG_ENV_SIZE.
4481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004482- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004483
4484 Defines offset to the initial SPI buffer area in DPRAM. The
4485 area is used at an early stage (ROM part) if the environment
4486 is configured to reside in the SPI EEPROM: We need a 520 byte
4487 scratch DPRAM area. It is used between the two initialization
4488 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4489 to be a good choice since it makes it far enough from the
4490 start of the data area as well as from the stack pointer.
4491
Bruce Adleredecc942007-11-02 13:15:42 -07004492Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004493has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004494created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004495until then to read environment variables.
4496
wdenk8dba0502003-03-31 16:34:49 +00004497The environment is protected by a CRC32 checksum. Before the monitor
4498is relocated into RAM, as a result of a bad CRC you will be working
4499with the compiled-in default environment - *silently*!!! [This is
4500necessary, because the first environment variable we need is the
4501"baudrate" setting for the console - if we have a bad CRC, we don't
4502have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004503
4504Note: once the monitor has been relocated, then it will complain if
4505the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004506use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004507
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004508- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004509 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004510
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004511 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004512 also needs to be defined.
4513
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004514- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004515 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004516
Ron Madriddfa028a2009-02-18 14:30:44 -08004517- CONFIG_NS16550_MIN_FUNCTIONS:
4518 Define this if you desire to only have use of the NS16550_init
4519 and NS16550_putc functions for the serial driver located at
4520 drivers/serial/ns16550.c. This option is useful for saving
4521 space for already greatly restricted images, including but not
4522 limited to NAND_SPL configurations.
4523
Simon Glass28a9e332012-11-30 13:01:18 +00004524- CONFIG_DISPLAY_BOARDINFO
4525 Display information about the board that U-Boot is running on
4526 when U-Boot starts up. The board function checkboard() is called
4527 to do this.
4528
Simon Glasse8822012012-11-30 13:01:19 +00004529- CONFIG_DISPLAY_BOARDINFO_LATE
4530 Similar to the previous option, but display this information
4531 later, once stdio is running and output goes to the LCD, if
4532 present.
4533
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004534- CONFIG_BOARD_SIZE_LIMIT:
4535 Maximum size of the U-Boot image. When defined, the
4536 build system checks that the actual size does not
4537 exceed it.
4538
wdenkc6097192002-11-03 00:24:07 +00004539Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004540---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004541
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004542- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004543 Cache Line Size of the CPU.
4544
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004545- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004546 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004547
wdenk9c53f402003-10-15 23:53:47 +00004548 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4549 and RPXsuper) to be able to adjust the position of
4550 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004551
Timur Tabid8f341c2011-08-04 18:03:41 -05004552- CONFIG_SYS_CCSRBAR_DEFAULT:
4553 Default (power-on reset) physical address of CCSR on Freescale
4554 PowerPC SOCs.
4555
4556- CONFIG_SYS_CCSRBAR:
4557 Virtual address of CCSR. On a 32-bit build, this is typically
4558 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4559
4560 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4561 for cross-platform code that uses that macro instead.
4562
4563- CONFIG_SYS_CCSRBAR_PHYS:
4564 Physical address of CCSR. CCSR can be relocated to a new
4565 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004566 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004567 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4568 is typically relocated on 36-bit builds. It is recommended
4569 that this macro be defined via the _HIGH and _LOW macros:
4570
4571 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4572 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4573
4574- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004575 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4576 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004577 used in assembly code, so it must not contain typecasts or
4578 integer size suffixes (e.g. "ULL").
4579
4580- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4581 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4582 used in assembly code, so it must not contain typecasts or
4583 integer size suffixes (e.g. "ULL").
4584
4585- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4586 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4587 forced to a value that ensures that CCSR is not relocated.
4588
wdenk1272e232002-11-10 22:06:23 +00004589- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004590 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004591
4592 the default drive number (default value 0)
4593
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004594 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004595
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004596 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004597 (default value 1)
4598
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004599 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004600
wdenk4a5c8a72003-03-06 00:02:04 +00004601 defines the offset of register from address. It
4602 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004603 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004604
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004605 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4606 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004607 default value.
wdenk1272e232002-11-10 22:06:23 +00004608
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004609 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004610 fdc_hw_init() is called at the beginning of the FDC
4611 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004612 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004613 initializations.
wdenk1272e232002-11-10 22:06:23 +00004614
Macpaul Lind1e49942011-04-11 20:45:32 +00004615- CONFIG_IDE_AHB:
4616 Most IDE controllers were designed to be connected with PCI
4617 interface. Only few of them were designed for AHB interface.
4618 When software is doing ATA command and data transfer to
4619 IDE devices through IDE-AHB controller, some additional
4620 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004621 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004623- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004624 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004625 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004626
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004627- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004628
wdenkeb20ad32003-09-05 23:19:14 +00004629 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004630 initial data and stack; please note that this must be
4631 writable memory that is working WITHOUT special
4632 initialization, i. e. you CANNOT use normal RAM which
4633 will become available only after programming the
4634 memory controller and running certain initialization
4635 sequences.
4636
4637 U-Boot uses the following memory types:
4638 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4639 - MPC824X: data cache
4640 - PPC4xx: data cache
4641
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004642- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004643
4644 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004645 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4646 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004647 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004648 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004649 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4650 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4651 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004652
4653 Note:
4654 On the MPC824X (or other systems that use the data
4655 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004656 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004657 point to an otherwise UNUSED address space between
4658 the top of RAM and the start of the PCI space.
4659
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004660- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004662- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004663
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004664- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004665
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004666- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004667
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004668- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004669
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004670- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004671
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004672- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004673 SDRAM timing
4674
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004675- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004676 periodic timer for refresh
4677
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004678- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004679
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004680- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4681 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4682 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4683 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004684 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4685
4686- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004687 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4688 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004689 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004691- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4692 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004693 Machine Mode Register and Memory Periodic Timer
4694 Prescaler definitions (SDRAM timing)
4695
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004696- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004697 enable I2C microcode relocation patch (MPC8xx);
4698 define relocation offset in DPRAM [DSP2]
4699
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004700- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004701 enable SMC microcode relocation patch (MPC8xx);
4702 define relocation offset in DPRAM [SMC1]
4703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004705 enable SPI microcode relocation patch (MPC8xx);
4706 define relocation offset in DPRAM [SCC4]
4707
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004708- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004709 Use OSCM clock mode on MBX8xx board. Be careful,
4710 wrong setting might damage your board. Read
4711 doc/README.MBX before setting this variable!
4712
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004713- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004714 Offset of the bootmode word in DPRAM used by post
4715 (Power On Self Tests). This definition overrides
4716 #define'd default value in commproc.h resp.
4717 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004718
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004719- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4720 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4721 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4722 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4723 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4724 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4725 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4726 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004727 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004728
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004729- CONFIG_PCI_DISABLE_PCIE:
4730 Disable PCI-Express on systems where it is supported but not
4731 required.
4732
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004733- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004734 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004735 Don't do any setup work, presumably because someone or
4736 something has already done it, and we don't need to do it
4737 a second time. Useful for platforms that are pre-booted
4738 by coreboot or similar.
4739
Gabor Juhosb4458732013-05-30 07:06:12 +00004740- CONFIG_PCI_INDIRECT_BRIDGE:
4741 Enable support for indirect PCI bridges.
4742
Kumar Gala8975d7a2010-12-30 12:09:53 -06004743- CONFIG_SYS_SRIO:
4744 Chip has SRIO or not
4745
4746- CONFIG_SRIO1:
4747 Board has SRIO 1 port available
4748
4749- CONFIG_SRIO2:
4750 Board has SRIO 2 port available
4751
Liu Gang27afb9c2013-05-07 16:30:46 +08004752- CONFIG_SRIO_PCIE_BOOT_MASTER
4753 Board can support master function for Boot from SRIO and PCIE
4754
Kumar Gala8975d7a2010-12-30 12:09:53 -06004755- CONFIG_SYS_SRIOn_MEM_VIRT:
4756 Virtual Address of SRIO port 'n' memory region
4757
4758- CONFIG_SYS_SRIOn_MEM_PHYS:
4759 Physical Address of SRIO port 'n' memory region
4760
4761- CONFIG_SYS_SRIOn_MEM_SIZE:
4762 Size of SRIO port 'n' memory region
4763
Fabio Estevamf17e8782013-04-11 09:35:34 +00004764- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4765 Defined to tell the NAND controller that the NAND chip is using
4766 a 16 bit bus.
4767 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004768 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004769 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004770 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004771
4772- CONFIG_SYS_NDFC_EBC0_CFG
4773 Sets the EBC0_CFG register for the NDFC. If not defined
4774 a default value will be used.
4775
Ben Warren45657152006-09-07 16:50:54 -04004776- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004777 Get DDR timing information from an I2C EEPROM. Common
4778 with pluggable memory modules such as SODIMMs
4779
Ben Warren45657152006-09-07 16:50:54 -04004780 SPD_EEPROM_ADDRESS
4781 I2C address of the SPD EEPROM
4782
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004783- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004784 If SPD EEPROM is on an I2C bus other than the first
4785 one, specify here. Note that the value must resolve
4786 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004787
York Sune73cc042011-06-07 09:42:16 +08004788- CONFIG_SYS_DDR_RAW_TIMING
4789 Get DDR timing information from other than SPD. Common with
4790 soldered DDR chips onboard without SPD. DDR raw timing
4791 parameters are extracted from datasheet and hard-coded into
4792 header files or board specific files.
4793
York Sunbd495cf2011-09-16 13:21:35 -07004794- CONFIG_FSL_DDR_INTERACTIVE
4795 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4796
York Sun8ced0502015-01-06 13:18:55 -08004797- CONFIG_FSL_DDR_SYNC_REFRESH
4798 Enable sync of refresh for multiple controllers.
4799
York Sunb6a35f82015-03-19 09:30:28 -07004800- CONFIG_FSL_DDR_BIST
4801 Enable built-in memory test for Freescale DDR controllers.
4802
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004803- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004804 Only for 83xx systems. If specified, then DDR should
4805 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004806
wdenk6203e402004-04-18 10:13:26 +00004807- CONFIG_ETHER_ON_FEC[12]
4808 Define to enable FEC[12] on a 8xx series processor.
4809
4810- CONFIG_FEC[12]_PHY
4811 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004812 to the given FEC; i. e.
4813 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004814 means that the PHY with address 4 is connected to FEC1
4815
4816 When set to -1, means to probe for first available.
4817
4818- CONFIG_FEC[12]_PHY_NORXERR
4819 The PHY does not have a RXERR line (RMII only).
4820 (so program the FEC to ignore it).
4821
4822- CONFIG_RMII
4823 Enable RMII mode for all FECs.
4824 Note that this is a global option, we can't
4825 have one FEC in standard MII mode and another in RMII mode.
4826
wdenk20c98a62004-04-23 20:32:05 +00004827- CONFIG_CRC32_VERIFY
4828 Add a verify option to the crc32 command.
4829 The syntax is:
4830
4831 => crc32 -v <address> <count> <crc32>
4832
4833 Where address/count indicate a memory area
4834 and crc32 is the correct crc32 which the
4835 area should have.
4836
wdenk64519362004-07-11 17:40:54 +00004837- CONFIG_LOOPW
4838 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004839 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004840
stroesecc3af832004-12-16 18:46:55 +00004841- CONFIG_MX_CYCLIC
4842 Add the "mdc" and "mwc" memory commands. These are cyclic
4843 "md/mw" commands.
4844 Examples:
4845
wdenk07d7e6b2004-12-16 21:44:03 +00004846 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004847 This command will print 4 bytes (10,11,12,13) each 500 ms.
4848
wdenk07d7e6b2004-12-16 21:44:03 +00004849 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004850 This command will write 12345678 to address 100 all 10 ms.
4851
wdenk07d7e6b2004-12-16 21:44:03 +00004852 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004853 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004854
wdenk3d3d99f2005-04-04 12:44:11 +00004855- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004856 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004857 low level initializations (like setting up the memory
4858 controller) are omitted and/or U-Boot does not
4859 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004860
Wolfgang Denk302141d2010-11-27 23:30:56 +01004861 Normally this variable MUST NOT be defined. The only
4862 exception is when U-Boot is loaded (to RAM) by some
4863 other boot loader or by a debugger which performs
4864 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004865
Aneesh V552a3192011-07-13 05:11:07 +00004866- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004867 Modifies the behaviour of start.S when compiling a loader
4868 that is executed before the actual U-Boot. E.g. when
4869 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004870
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004871- CONFIG_TPL_BUILD
4872 Modifies the behaviour of start.S when compiling a loader
4873 that is executed after the SPL and before the actual U-Boot.
4874 It is loaded by the SPL.
4875
Ying Zhang0d4f5442013-05-20 14:07:23 +08004876- CONFIG_SYS_MPC85XX_NO_RESETVEC
4877 Only for 85xx systems. If this variable is specified, the section
4878 .resetvec is not kept and the section .bootpg is placed in the
4879 previous 4k of the .text section.
4880
Simon Glass17dabf02013-02-24 17:33:14 +00004881- CONFIG_ARCH_MAP_SYSMEM
4882 Generally U-Boot (and in particular the md command) uses
4883 effective address. It is therefore not necessary to regard
4884 U-Boot address as virtual addresses that need to be translated
4885 to physical addresses. However, sandbox requires this, since
4886 it maintains its own little RAM buffer which contains all
4887 addressable memory. This option causes some memory accesses
4888 to be mapped through map_sysmem() / unmap_sysmem().
4889
Matthias Weisser93416c12011-03-10 21:36:32 +00004890- CONFIG_USE_ARCH_MEMCPY
4891 CONFIG_USE_ARCH_MEMSET
4892 If these options are used a optimized version of memcpy/memset will
4893 be used if available. These functions may be faster under some
4894 conditions but may increase the binary size.
4895
Simon Glassbfb59802013-02-14 04:18:54 +00004896- CONFIG_X86_RESET_VECTOR
4897 If defined, the x86 reset vector code is included. This is not
4898 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004899
Mark Jackson52b003c2013-03-04 01:27:20 +00004900- CONFIG_SYS_MPUCLK
4901 Defines the MPU clock speed (in MHz).
4902
4903 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004904
Heiko Schocher2233e462013-11-04 14:05:00 +01004905- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4906 Enables the RTC32K OSC on AM33xx based plattforms
4907
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004908- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4909 Option to disable subpage write in NAND driver
4910 driver that uses this:
4911 drivers/mtd/nand/davinci_nand.c
4912
Timur Tabi275f4bb2011-11-22 09:21:25 -06004913Freescale QE/FMAN Firmware Support:
4914-----------------------------------
4915
4916The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4917loading of "firmware", which is encoded in the QE firmware binary format.
4918This firmware often needs to be loaded during U-Boot booting, so macros
4919are used to identify the storage device (NOR flash, SPI, etc) and the address
4920within that device.
4921
Zhao Qiang83a90842014-03-21 16:21:44 +08004922- CONFIG_SYS_FMAN_FW_ADDR
4923 The address in the storage device where the FMAN microcode is located. The
4924 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4925 is also specified.
4926
4927- CONFIG_SYS_QE_FW_ADDR
4928 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004929 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4930 is also specified.
4931
4932- CONFIG_SYS_QE_FMAN_FW_LENGTH
4933 The maximum possible size of the firmware. The firmware binary format
4934 has a field that specifies the actual size of the firmware, but it
4935 might not be possible to read any part of the firmware unless some
4936 local storage is allocated to hold the entire firmware first.
4937
4938- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4939 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4940 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4941 virtual address in NOR flash.
4942
4943- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4944 Specifies that QE/FMAN firmware is located in NAND flash.
4945 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4946
4947- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4948 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4949 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4950
4951- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4952 Specifies that QE/FMAN firmware is located on the primary SPI
4953 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4954
Liu Gang1e084582012-03-08 00:33:18 +00004955- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4956 Specifies that QE/FMAN firmware is located in the remote (master)
4957 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004958 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4959 window->master inbound window->master LAW->the ucode address in
4960 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004961
J. German Rivera8ff14b72014-06-23 15:15:55 -07004962Freescale Layerscape Management Complex Firmware Support:
4963---------------------------------------------------------
4964The Freescale Layerscape Management Complex (MC) supports the loading of
4965"firmware".
4966This firmware often needs to be loaded during U-Boot booting, so macros
4967are used to identify the storage device (NOR flash, SPI, etc) and the address
4968within that device.
4969
4970- CONFIG_FSL_MC_ENET
4971 Enable the MC driver for Layerscape SoCs.
4972
4973- CONFIG_SYS_LS_MC_FW_ADDR
4974 The address in the storage device where the firmware is located. The
4975 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4976 is also specified.
4977
4978- CONFIG_SYS_LS_MC_FW_LENGTH
4979 The maximum possible size of the firmware. The firmware binary format
4980 has a field that specifies the actual size of the firmware, but it
4981 might not be possible to read any part of the firmware unless some
4982 local storage is allocated to hold the entire firmware first.
4983
4984- CONFIG_SYS_LS_MC_FW_IN_NOR
4985 Specifies that MC firmware is located in NOR flash, mapped as
4986 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4987 virtual address in NOR flash.
4988
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304989Freescale Layerscape Debug Server Support:
4990-------------------------------------------
4991The Freescale Layerscape Debug Server Support supports the loading of
4992"Debug Server firmware" and triggering SP boot-rom.
4993This firmware often needs to be loaded during U-Boot booting.
4994
4995- CONFIG_FSL_DEBUG_SERVER
4996 Enable the Debug Server for Layerscape SoCs.
4997
4998- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
4999 Define minimum DDR size required for debug server image
5000
York Sun928b6812015-12-07 11:08:58 -08005001- CONFIG_SYS_MC_RSV_MEM_ALIGN
5002 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05305003
Paul Kocialkowski7b917022015-07-26 18:48:15 +02005004Reproducible builds
5005-------------------
5006
5007In order to achieve reproducible builds, timestamps used in the U-Boot build
5008process have to be set to a fixed value.
5009
5010This is done using the SOURCE_DATE_EPOCH environment variable.
5011SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
5012option for U-Boot or an environment variable in U-Boot.
5013
5014SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
5015
wdenkc6097192002-11-03 00:24:07 +00005016Building the Software:
5017======================
5018
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005019Building U-Boot has been tested in several native build environments
5020and in many different cross environments. Of course we cannot support
5021all possibly existing versions of cross development tools in all
5022(potentially obsolete) versions. In case of tool chain problems we
5023recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5024which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005025
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005026If you are not using a native environment, it is assumed that you
5027have GNU cross compiling tools available in your path. In this case,
5028you must set the environment variable CROSS_COMPILE in your shell.
5029Note that no changes to the Makefile or any other source files are
5030necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005031
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005032 $ CROSS_COMPILE=ppc_4xx-
5033 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005034
Peter Tyserb06976d2009-03-13 18:54:51 -05005035Note: If you wish to generate Windows versions of the utilities in
5036 the tools directory you can use the MinGW toolchain
5037 (http://www.mingw.org). Set your HOST tools to the MinGW
5038 toolchain and execute 'make tools'. For example:
5039
5040 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5041
5042 Binaries such as tools/mkimage.exe will be created which can
5043 be executed on computers running Windows.
5044
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005045U-Boot is intended to be simple to build. After installing the
5046sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005047is done by typing:
5048
Holger Freyther7ba4e572014-08-04 09:26:05 +02005049 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005050
Holger Freyther7ba4e572014-08-04 09:26:05 +02005051where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005052rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005053
wdenk6c59edc2004-05-03 20:45:30 +00005054Note: for some board special configuration names may exist; check if
5055 additional information is available from the board vendor; for
5056 instance, the TQM823L systems are available without (standard)
5057 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005058 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005059
Holger Freyther7ba4e572014-08-04 09:26:05 +02005060 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005061 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005062
Holger Freyther7ba4e572014-08-04 09:26:05 +02005063 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005064 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005065
wdenk6c59edc2004-05-03 20:45:30 +00005066 etc.
wdenkc6097192002-11-03 00:24:07 +00005067
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk6c59edc2004-05-03 20:45:30 +00005069Finally, type "make all", and you should get some working U-Boot
5070images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005071
wdenk6c59edc2004-05-03 20:45:30 +00005072- "u-boot.bin" is a raw binary image
5073- "u-boot" is an image in ELF binary format
5074- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005075
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005076By default the build is performed locally and the objects are saved
5077in the source directory. One of the two methods can be used to change
5078this behavior and build U-Boot to some external directory:
5079
50801. Add O= to the make command line invocations:
5081
5082 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005083 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005084 make O=/tmp/build all
5085
Timo Ketolac8c67602014-11-06 14:39:05 +020050862. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005087
Timo Ketolac8c67602014-11-06 14:39:05 +02005088 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005089 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005090 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005091 make all
5092
Timo Ketolac8c67602014-11-06 14:39:05 +02005093Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005094variable.
5095
wdenkc6097192002-11-03 00:24:07 +00005096
wdenk6c59edc2004-05-03 20:45:30 +00005097Please be aware that the Makefiles assume you are using GNU make, so
5098for instance on NetBSD you might need to use "gmake" instead of
5099native "make".
wdenkc6097192002-11-03 00:24:07 +00005100
wdenkc6097192002-11-03 00:24:07 +00005101
wdenk6c59edc2004-05-03 20:45:30 +00005102If the system board that you have is not listed, then you will need
5103to port U-Boot to your hardware platform. To do this, follow these
5104steps:
wdenkc6097192002-11-03 00:24:07 +00005105
Phil Sutterc77b4882015-12-25 14:41:18 +010051061. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00005107 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01005108 the "Makefile" and a "<board>.c".
51092. Create a new configuration file "include/configs/<board>.h" for
5110 your board.
wdenk6c59edc2004-05-03 20:45:30 +000051113. If you're porting U-Boot to a new CPU, then also create a new
5112 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020051134. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000051145. Type "make", and you should get a working "u-boot.srec" file
5115 to be installed on your target system.
51166. Debug and solve any problems that might arise.
5117 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005118
wdenkc6097192002-11-03 00:24:07 +00005119
wdenk6c59edc2004-05-03 20:45:30 +00005120Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5121==============================================================
wdenkc6097192002-11-03 00:24:07 +00005122
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005123If you have modified U-Boot sources (for instance added a new board
5124or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005125provide feedback to the other developers. The feedback normally takes
5126the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005127official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005128
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005129But before you submit such a patch, please verify that your modifi-
5130cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005131the supported boards compile WITHOUT ANY compiler warnings. To do so,
5132just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005133for ALL supported system. Be warned, this will take a while. You can
5134select which (cross) compiler to use by passing a `CROSS_COMPILE'
5135environment variable to the script, i. e. to use the ELDK cross tools
5136you can type
wdenkc6097192002-11-03 00:24:07 +00005137
wdenk6c59edc2004-05-03 20:45:30 +00005138 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005139
wdenk6c59edc2004-05-03 20:45:30 +00005140or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005141
wdenk6c59edc2004-05-03 20:45:30 +00005142 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005143
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005144When using the MAKEALL script, the default behaviour is to build
5145U-Boot in the source directory. This location can be changed by
5146setting the BUILD_DIR environment variable. Also, for each target
5147built, the MAKEALL script saves two log files (<target>.ERR and
5148<target>.MAKEALL) in the <source dir>/LOG directory. This default
5149location can be changed by setting the MAKEALL_LOGDIR environment
5150variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005151
5152 export BUILD_DIR=/tmp/build
5153 export MAKEALL_LOGDIR=/tmp/log
5154 CROSS_COMPILE=ppc_8xx- MAKEALL
5155
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005156With the above settings build objects are saved in the /tmp/build,
5157log files are saved in the /tmp/log and the source tree remains clean
5158during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005159
5160
wdenk6c59edc2004-05-03 20:45:30 +00005161See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005162
wdenkc6097192002-11-03 00:24:07 +00005163
wdenk6c59edc2004-05-03 20:45:30 +00005164Monitor Commands - Overview:
5165============================
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk6c59edc2004-05-03 20:45:30 +00005167go - start application at address 'addr'
5168run - run commands in an environment variable
5169bootm - boot application image from memory
5170bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005171bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005172tftpboot- boot image via network using TFTP protocol
5173 and env variables "ipaddr" and "serverip"
5174 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005175tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005176rarpboot- boot image via network using RARP/TFTP protocol
5177diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5178loads - load S-Record file over serial line
5179loadb - load binary file over serial line (kermit mode)
5180md - memory display
5181mm - memory modify (auto-incrementing)
5182nm - memory modify (constant address)
5183mw - memory write (fill)
5184cp - memory copy
5185cmp - memory compare
5186crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005187i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005188sspi - SPI utility commands
5189base - print or set address offset
5190printenv- print environment variables
5191setenv - set environment variables
5192saveenv - save environment variables to persistent storage
5193protect - enable or disable FLASH write protection
5194erase - erase FLASH memory
5195flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005196nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005197bdinfo - print Board Info structure
5198iminfo - print header information for application image
5199coninfo - print console devices and informations
5200ide - IDE sub-system
5201loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005202loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005203mtest - simple RAM test
5204icache - enable or disable instruction cache
5205dcache - enable or disable data cache
5206reset - Perform RESET of the CPU
5207echo - echo args to console
5208version - print monitor version
5209help - print online help
5210? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005211
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk6c59edc2004-05-03 20:45:30 +00005213Monitor Commands - Detailed Description:
5214========================================
wdenkc6097192002-11-03 00:24:07 +00005215
wdenk6c59edc2004-05-03 20:45:30 +00005216TODO.
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005219
5220
wdenk6c59edc2004-05-03 20:45:30 +00005221Environment Variables:
5222======================
wdenkc6097192002-11-03 00:24:07 +00005223
wdenk6c59edc2004-05-03 20:45:30 +00005224U-Boot supports user configuration using Environment Variables which
5225can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005226
wdenk6c59edc2004-05-03 20:45:30 +00005227Environment Variables are set using "setenv", printed using
5228"printenv", and saved to Flash using "saveenv". Using "setenv"
5229without a value can be used to delete a variable from the
5230environment. As long as you don't save the environment you are
5231working with an in-memory copy. In case the Flash area containing the
5232environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005233
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005234Some configuration options can be set using Environment Variables.
5235
5236List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk6c59edc2004-05-03 20:45:30 +00005238 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005239
wdenk6c59edc2004-05-03 20:45:30 +00005240 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk6c59edc2004-05-03 20:45:30 +00005242 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005243
wdenk6c59edc2004-05-03 20:45:30 +00005244 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005245
wdenk6c59edc2004-05-03 20:45:30 +00005246 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005247
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005248 bootm_low - Memory range available for image processing in the bootm
5249 command can be restricted. This variable is given as
5250 a hexadecimal number and defines lowest address allowed
5251 for use by the bootm command. See also "bootm_size"
5252 environment variable. Address defined by "bootm_low" is
5253 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005254 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5255 bootm_mapsize.
5256
Wolfgang Denk092ae952011-10-26 10:21:21 +00005257 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005258 This variable is given as a hexadecimal number and it
5259 defines the size of the memory region starting at base
5260 address bootm_low that is accessible by the Linux kernel
5261 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5262 as the default value if it is defined, and bootm_size is
5263 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005264
5265 bootm_size - Memory range available for image processing in the bootm
5266 command can be restricted. This variable is given as
5267 a hexadecimal number and defines the size of the region
5268 allowed for use by the bootm command. See also "bootm_low"
5269 environment variable.
5270
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005271 updatefile - Location of the software update file on a TFTP server, used
5272 by the automatic software update feature. Please refer to
5273 documentation in doc/README.update for more details.
5274
wdenk6c59edc2004-05-03 20:45:30 +00005275 autoload - if set to "no" (any string beginning with 'n'),
5276 "bootp" will just load perform a lookup of the
5277 configuration from the BOOTP server, but not try to
5278 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005279
wdenk6c59edc2004-05-03 20:45:30 +00005280 autostart - if set to "yes", an image loaded using the "bootp",
5281 "rarpboot", "tftpboot" or "diskboot" commands will
5282 be automatically started (by internally calling
5283 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005284
wdenk6c59edc2004-05-03 20:45:30 +00005285 If set to "no", a standalone image passed to the
5286 "bootm" command will be copied to the load address
5287 (and eventually uncompressed), but NOT be started.
5288 This can be used to load and uncompress arbitrary
5289 data.
wdenkc6097192002-11-03 00:24:07 +00005290
David A. Longd558a4e2011-07-09 16:40:19 -04005291 fdt_high - if set this restricts the maximum address that the
5292 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005293 For example, if you have a system with 1 GB memory
5294 at physical address 0x10000000, while Linux kernel
5295 only recognizes the first 704 MB as low memory, you
5296 may need to set fdt_high as 0x3C000000 to have the
5297 device tree blob be copied to the maximum address
5298 of the 704 MB low memory, so that Linux kernel can
5299 access it during the boot procedure.
5300
David A. Longd558a4e2011-07-09 16:40:19 -04005301 If this is set to the special value 0xFFFFFFFF then
5302 the fdt will not be copied at all on boot. For this
5303 to work it must reside in writable memory, have
5304 sufficient padding on the end of it for u-boot to
5305 add the information it needs into it, and the memory
5306 must be accessible by the kernel.
5307
Simon Glassdc6fa642011-10-24 19:15:34 +00005308 fdtcontroladdr- if set this is the address of the control flattened
5309 device tree used by U-Boot when CONFIG_OF_CONTROL is
5310 defined.
5311
wdenk0e2bd9c2004-06-06 21:51:03 +00005312 i2cfast - (PPC405GP|PPC405EP only)
5313 if set to 'y' configures Linux I2C driver for fast
5314 mode (400kHZ). This environment variable is used in
5315 initialization code. So, for changes to be effective
5316 it must be saved and board must be reset.
5317
wdenk6c59edc2004-05-03 20:45:30 +00005318 initrd_high - restrict positioning of initrd images:
5319 If this variable is not set, initrd images will be
5320 copied to the highest possible address in RAM; this
5321 is usually what you want since it allows for
5322 maximum initrd size. If for some reason you want to
5323 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005324 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005325 variable to a value of "no" or "off" or "0".
5326 Alternatively, you can set it to a maximum upper
5327 address to use (U-Boot will still check that it
5328 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330 For instance, when you have a system with 16 MB
5331 RAM, and want to reserve 4 MB from use by Linux,
5332 you can do this by adding "mem=12M" to the value of
5333 the "bootargs" variable. However, now you must make
5334 sure that the initrd image is placed in the first
5335 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005336
wdenk6c59edc2004-05-03 20:45:30 +00005337 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005338
wdenk6c59edc2004-05-03 20:45:30 +00005339 If you set initrd_high to 0xFFFFFFFF, this is an
5340 indication to U-Boot that all addresses are legal
5341 for the Linux kernel, including addresses in flash
5342 memory. In this case U-Boot will NOT COPY the
5343 ramdisk at all. This may be useful to reduce the
5344 boot time on your system, but requires that this
5345 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005346
wdenk6c59edc2004-05-03 20:45:30 +00005347 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349 loadaddr - Default load address for commands like "bootp",
5350 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005351
wdenk6c59edc2004-05-03 20:45:30 +00005352 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005353
wdenk6c59edc2004-05-03 20:45:30 +00005354 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005355
wdenk6c59edc2004-05-03 20:45:30 +00005356 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005357
wdenk6c59edc2004-05-03 20:45:30 +00005358 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005359
wdenk6c59edc2004-05-03 20:45:30 +00005360 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005361
Mike Frysingera23230c2011-10-02 10:01:27 +00005362 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005363
Mike Frysingera23230c2011-10-02 10:01:27 +00005364 ethact - controls which interface is currently active.
5365 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005366
Heiko Schocherc5e84052010-07-20 17:45:02 +02005367 => setenv ethact FEC
5368 => ping 192.168.0.1 # traffic sent on FEC
5369 => setenv ethact SCC
5370 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005371
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005372 ethrotate - When set to "no" U-Boot does not go through all
5373 available network interfaces.
5374 It just stays at the currently selected interface.
5375
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005376 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005377 either succeed or fail without retrying.
5378 When set to "once" the network operation will
5379 fail when all the available network interfaces
5380 are tried once without success.
5381 Useful on scripts which control the retry operation
5382 themselves.
wdenkc6097192002-11-03 00:24:07 +00005383
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005384 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005385
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005386 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005387 changing the console to be empty. If "yes" it will be
5388 made silent. If "no" it will not be made silent. If
5389 unset, then it will be made silent if the U-Boot console
5390 is silent.
5391
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005392 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005393 UDP source port.
5394
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005395 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005396 destination port instead of the Well Know Port 69.
5397
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005398 tftpblocksize - Block size to use for TFTP transfers; if not set,
5399 we use the TFTP server's default block size
5400
5401 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5402 seconds, minimum value is 1000 = 1 second). Defines
5403 when a packet is considered to be lost so it has to
5404 be retransmitted. The default is 5000 = 5 seconds.
5405 Lowering this value may make downloads succeed
5406 faster in networks with high packet loss rates or
5407 with unreliable TFTP servers.
5408
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005409 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5410 unit, minimum value = 0). Defines how many timeouts
5411 can happen during a single file transfer before that
5412 transfer is aborted. The default is 10, and 0 means
5413 'no timeouts allowed'. Increasing this value may help
5414 downloads succeed with high packet loss rates, or with
5415 unreliable TFTP servers or client hardware.
5416
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005417 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005418 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005419 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005420
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005421The following image location variables contain the location of images
5422used in booting. The "Image" column gives the role of the image and is
5423not an environment variable name. The other columns are environment
5424variable names. "File Name" gives the name of the file on a TFTP
5425server, "RAM Address" gives the location in RAM the image will be
5426loaded to, and "Flash Location" gives the image's address in NOR
5427flash or offset in NAND flash.
5428
5429*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005430boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005431boards use these variables for other purposes.
5432
Wolfgang Denk092ae952011-10-26 10:21:21 +00005433Image File Name RAM Address Flash Location
5434----- --------- ----------- --------------
5435u-boot u-boot u-boot_addr_r u-boot_addr
5436Linux kernel bootfile kernel_addr_r kernel_addr
5437device tree blob fdtfile fdt_addr_r fdt_addr
5438ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005439
wdenk6c59edc2004-05-03 20:45:30 +00005440The following environment variables may be used and automatically
5441updated by the network boot commands ("bootp" and "rarpboot"),
5442depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005443
wdenk6c59edc2004-05-03 20:45:30 +00005444 bootfile - see above
5445 dnsip - IP address of your Domain Name Server
5446 dnsip2 - IP address of your secondary Domain Name Server
5447 gatewayip - IP address of the Gateway (Router) to use
5448 hostname - Target hostname
5449 ipaddr - see above
5450 netmask - Subnet Mask
5451 rootpath - Pathname of the root filesystem on the NFS server
5452 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005453
wdenk145d2c12004-04-15 21:48:45 +00005454
wdenk6c59edc2004-05-03 20:45:30 +00005455There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005456
wdenk6c59edc2004-05-03 20:45:30 +00005457 serial# - contains hardware identification information such
5458 as type string and/or serial number
5459 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005460
wdenk6c59edc2004-05-03 20:45:30 +00005461These variables can be set only once (usually during manufacturing of
5462the board). U-Boot refuses to delete or overwrite these variables
5463once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005464
5465
wdenk6c59edc2004-05-03 20:45:30 +00005466Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk6c59edc2004-05-03 20:45:30 +00005468 ver - Contains the U-Boot version string as printed
5469 with the "version" command. This variable is
5470 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005471
wdenkc6097192002-11-03 00:24:07 +00005472
wdenk6c59edc2004-05-03 20:45:30 +00005473Please note that changes to some configuration parameters may take
5474only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005475
stroeseb9c17c52003-04-04 15:53:41 +00005476
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005477Callback functions for environment variables:
5478---------------------------------------------
5479
5480For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005481when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005482be associated with arbitrary variables. On creation, overwrite, or
5483deletion, the callback will provide the opportunity for some side
5484effect to happen or for the change to be rejected.
5485
5486The callbacks are named and associated with a function using the
5487U_BOOT_ENV_CALLBACK macro in your board or driver code.
5488
5489These callbacks are associated with variables in one of two ways. The
5490static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5491in the board configuration to a string that defines a list of
5492associations. The list must be in the following format:
5493
5494 entry = variable_name[:callback_name]
5495 list = entry[,list]
5496
5497If the callback name is not specified, then the callback is deleted.
5498Spaces are also allowed anywhere in the list.
5499
5500Callbacks can also be associated by defining the ".callbacks" variable
5501with the same list format above. Any association in ".callbacks" will
5502override any association in the static list. You can define
5503CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005504".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005505
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005506If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5507regular expression. This allows multiple variables to be connected to
5508the same callback without explicitly listing them all out.
5509
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005510
wdenk6c59edc2004-05-03 20:45:30 +00005511Command Line Parsing:
5512=====================
stroeseb9c17c52003-04-04 15:53:41 +00005513
wdenk6c59edc2004-05-03 20:45:30 +00005514There are two different command line parsers available with U-Boot:
5515the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005516
wdenk6c59edc2004-05-03 20:45:30 +00005517Old, simple command line parser:
5518--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520- supports environment variables (through setenv / saveenv commands)
5521- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005522- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005523- special characters ('$', ';') can be escaped by prefixing with '\',
5524 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005525 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005526- You can also escape text by enclosing in single apostrophes, for example:
5527 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005528
wdenk6c59edc2004-05-03 20:45:30 +00005529Hush shell:
5530-----------
wdenkf4688a22003-05-28 08:06:31 +00005531
wdenk6c59edc2004-05-03 20:45:30 +00005532- similar to Bourne shell, with control structures like
5533 if...then...else...fi, for...do...done; while...do...done,
5534 until...do...done, ...
5535- supports environment ("global") variables (through setenv / saveenv
5536 commands) and local shell variables (through standard shell syntax
5537 "name=value"); only environment variables can be used with "run"
5538 command
wdenkf4688a22003-05-28 08:06:31 +00005539
wdenk6c59edc2004-05-03 20:45:30 +00005540General rules:
5541--------------
wdenkf4688a22003-05-28 08:06:31 +00005542
wdenk6c59edc2004-05-03 20:45:30 +00005543(1) If a command line (or an environment variable executed by a "run"
5544 command) contains several commands separated by semicolon, and
5545 one of these commands fails, then the remaining commands will be
5546 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005547
wdenk6c59edc2004-05-03 20:45:30 +00005548(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005549 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005550 command will cause "run" to terminate, i. e. the remaining
5551 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005552
wdenk6c59edc2004-05-03 20:45:30 +00005553Note for Redundant Ethernet Interfaces:
5554=======================================
wdenkf4688a22003-05-28 08:06:31 +00005555
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005556Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005557such configurations and is capable of automatic selection of a
5558"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005559
wdenk6c59edc2004-05-03 20:45:30 +00005560Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5561MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5562"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005563
wdenk6c59edc2004-05-03 20:45:30 +00005564If the network interface stores some valid MAC address (for instance
5565in SROM), this is used as default address if there is NO correspon-
5566ding setting in the environment; if the corresponding environment
5567variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005568
wdenk6c59edc2004-05-03 20:45:30 +00005569o If the SROM has a valid MAC address, and there is no address in the
5570 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005571
wdenk6c59edc2004-05-03 20:45:30 +00005572o If there is no valid address in the SROM, and a definition in the
5573 environment exists, then the value from the environment variable is
5574 used.
wdenkc6097192002-11-03 00:24:07 +00005575
wdenk6c59edc2004-05-03 20:45:30 +00005576o If both the SROM and the environment contain a MAC address, and
5577 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005578
wdenk6c59edc2004-05-03 20:45:30 +00005579o If both the SROM and the environment contain a MAC address, and the
5580 addresses differ, the value from the environment is used and a
5581 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk6c59edc2004-05-03 20:45:30 +00005583o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005584 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5585 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005586
Ben Warren6db991a2010-04-26 11:11:46 -07005587If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005588will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005589may be skipped by setting the appropriate 'ethmacskip' environment variable.
5590The naming convention is as follows:
5591"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005592
wdenk6c59edc2004-05-03 20:45:30 +00005593Image Formats:
5594==============
wdenkc6097192002-11-03 00:24:07 +00005595
Marian Balakowicz18710b82008-03-12 12:13:13 +01005596U-Boot is capable of booting (and performing other auxiliary operations on)
5597images in two formats:
5598
5599New uImage format (FIT)
5600-----------------------
5601
5602Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5603to Flattened Device Tree). It allows the use of images with multiple
5604components (several kernels, ramdisks, etc.), with contents protected by
5605SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5606
5607
5608Old uImage format
5609-----------------
5610
5611Old image format is based on binary files which can be basically anything,
5612preceded by a special header; see the definitions in include/image.h for
5613details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005614
wdenk6c59edc2004-05-03 20:45:30 +00005615* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5616 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005617 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5618 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5619 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005620* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005621 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5622 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005623* Compression Type (uncompressed, gzip, bzip2)
5624* Load Address
5625* Entry Point
5626* Image Name
5627* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005628
wdenk6c59edc2004-05-03 20:45:30 +00005629The header is marked by a special Magic Number, and both the header
5630and the data portions of the image are secured against corruption by
5631CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005632
wdenkc6097192002-11-03 00:24:07 +00005633
wdenk6c59edc2004-05-03 20:45:30 +00005634Linux Support:
5635==============
wdenkc6097192002-11-03 00:24:07 +00005636
wdenk6c59edc2004-05-03 20:45:30 +00005637Although U-Boot should support any OS or standalone application
5638easily, the main focus has always been on Linux during the design of
5639U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005640
wdenk6c59edc2004-05-03 20:45:30 +00005641U-Boot includes many features that so far have been part of some
5642special "boot loader" code within the Linux kernel. Also, any
5643"initrd" images to be used are no longer part of one big Linux image;
5644instead, kernel and "initrd" are separate images. This implementation
5645serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005646
wdenk6c59edc2004-05-03 20:45:30 +00005647- the same features can be used for other OS or standalone
5648 applications (for instance: using compressed images to reduce the
5649 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005650
wdenk6c59edc2004-05-03 20:45:30 +00005651- it becomes much easier to port new Linux kernel versions because
5652 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005653
wdenk6c59edc2004-05-03 20:45:30 +00005654- the same Linux kernel image can now be used with different "initrd"
5655 images; of course this also means that different kernel images can
5656 be run with the same "initrd". This makes testing easier (you don't
5657 have to build a new "zImage.initrd" Linux image when you just
5658 change a file in your "initrd"). Also, a field-upgrade of the
5659 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005660
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk6c59edc2004-05-03 20:45:30 +00005662Linux HOWTO:
5663============
wdenkc6097192002-11-03 00:24:07 +00005664
wdenk6c59edc2004-05-03 20:45:30 +00005665Porting Linux to U-Boot based systems:
5666---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005667
wdenk6c59edc2004-05-03 20:45:30 +00005668U-Boot cannot save you from doing all the necessary modifications to
5669configure the Linux device drivers for use with your target hardware
5670(no, we don't intend to provide a full virtual machine interface to
5671Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005672
Stefan Roese88fbf932010-04-15 16:07:28 +02005673But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005674
wdenk6c59edc2004-05-03 20:45:30 +00005675Just make sure your machine specific header file (for instance
5676include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005677Information structure as we define in include/asm-<arch>/u-boot.h,
5678and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005679as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005680
Simon Glassd097e592014-06-11 23:29:46 -06005681Note that U-Boot now has a driver model, a unified model for drivers.
5682If you are adding a new driver, plumb it into driver model. If there
5683is no uclass available, you are encouraged to create one. See
5684doc/driver-model.
5685
wdenkc6097192002-11-03 00:24:07 +00005686
wdenk6c59edc2004-05-03 20:45:30 +00005687Configuring the Linux kernel:
5688-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005689
wdenk6c59edc2004-05-03 20:45:30 +00005690No specific requirements for U-Boot. Make sure you have some root
5691device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005692
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694Building a Linux Image:
5695-----------------------
wdenkc6097192002-11-03 00:24:07 +00005696
wdenk6c59edc2004-05-03 20:45:30 +00005697With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5698not used. If you use recent kernel source, a new build target
5699"uImage" will exist which automatically builds an image usable by
5700U-Boot. Most older kernels also have support for a "pImage" target,
5701which was introduced for our predecessor project PPCBoot and uses a
5702100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005703
wdenk6c59edc2004-05-03 20:45:30 +00005704Example:
wdenkc6097192002-11-03 00:24:07 +00005705
Holger Freyther7ba4e572014-08-04 09:26:05 +02005706 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005707 make oldconfig
5708 make dep
5709 make uImage
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk6c59edc2004-05-03 20:45:30 +00005711The "uImage" build target uses a special tool (in 'tools/mkimage') to
5712encapsulate a compressed Linux kernel image with header information,
5713CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005714
wdenk6c59edc2004-05-03 20:45:30 +00005715* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005716
wdenk6c59edc2004-05-03 20:45:30 +00005717* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005718
wdenk6c59edc2004-05-03 20:45:30 +00005719 ${CROSS_COMPILE}-objcopy -O binary \
5720 -R .note -R .comment \
5721 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005722
wdenk6c59edc2004-05-03 20:45:30 +00005723* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005726
wdenk6c59edc2004-05-03 20:45:30 +00005727* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005728
wdenk6c59edc2004-05-03 20:45:30 +00005729 mkimage -A ppc -O linux -T kernel -C gzip \
5730 -a 0 -e 0 -n "Linux Kernel Image" \
5731 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005732
wdenkc6097192002-11-03 00:24:07 +00005733
wdenk6c59edc2004-05-03 20:45:30 +00005734The "mkimage" tool can also be used to create ramdisk images for use
5735with U-Boot, either separated from the Linux kernel image, or
5736combined into one file. "mkimage" encapsulates the images with a 64
5737byte header containing information about target architecture,
5738operating system, image type, compression method, entry points, time
5739stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005740
wdenk6c59edc2004-05-03 20:45:30 +00005741"mkimage" can be called in two ways: to verify existing images and
5742print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005743
wdenk6c59edc2004-05-03 20:45:30 +00005744In the first form (with "-l" option) mkimage lists the information
5745contained in the header of an existing U-Boot image; this includes
5746checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005747
wdenk6c59edc2004-05-03 20:45:30 +00005748 tools/mkimage -l image
5749 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005750
wdenk6c59edc2004-05-03 20:45:30 +00005751The second form (with "-d" option) is used to build a U-Boot image
5752from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005753
wdenk6c59edc2004-05-03 20:45:30 +00005754 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5755 -n name -d data_file image
5756 -A ==> set architecture to 'arch'
5757 -O ==> set operating system to 'os'
5758 -T ==> set image type to 'type'
5759 -C ==> set compression type 'comp'
5760 -a ==> set load address to 'addr' (hex)
5761 -e ==> set entry point to 'ep' (hex)
5762 -n ==> set image name to 'name'
5763 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005764
wdenkcd914452004-05-29 16:53:29 +00005765Right now, all Linux kernels for PowerPC systems use the same load
5766address (0x00000000), but the entry point address depends on the
5767kernel version:
wdenkc6097192002-11-03 00:24:07 +00005768
wdenk6c59edc2004-05-03 20:45:30 +00005769- 2.2.x kernels have the entry point at 0x0000000C,
5770- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005771
wdenk6c59edc2004-05-03 20:45:30 +00005772So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005773
wdenk6c59edc2004-05-03 20:45:30 +00005774 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5775 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005776 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005777 > examples/uImage.TQM850L
5778 Image Name: 2.4.4 kernel for TQM850L
5779 Created: Wed Jul 19 02:34:59 2000
5780 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5781 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5782 Load Address: 0x00000000
5783 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005784
wdenk6c59edc2004-05-03 20:45:30 +00005785To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005786
wdenk6c59edc2004-05-03 20:45:30 +00005787 -> tools/mkimage -l examples/uImage.TQM850L
5788 Image Name: 2.4.4 kernel for TQM850L
5789 Created: Wed Jul 19 02:34:59 2000
5790 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5791 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5792 Load Address: 0x00000000
5793 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005794
wdenk6c59edc2004-05-03 20:45:30 +00005795NOTE: for embedded systems where boot time is critical you can trade
5796speed for memory and install an UNCOMPRESSED image instead: this
5797needs more space in Flash, but boots much faster since it does not
5798need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005799
Stefan Roese88fbf932010-04-15 16:07:28 +02005800 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005801 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5802 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005803 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005804 > examples/uImage.TQM850L-uncompressed
5805 Image Name: 2.4.4 kernel for TQM850L
5806 Created: Wed Jul 19 02:34:59 2000
5807 Image Type: PowerPC Linux Kernel Image (uncompressed)
5808 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5809 Load Address: 0x00000000
5810 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005811
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk6c59edc2004-05-03 20:45:30 +00005813Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5814when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk6c59edc2004-05-03 20:45:30 +00005816 -> tools/mkimage -n 'Simple Ramdisk Image' \
5817 > -A ppc -O linux -T ramdisk -C gzip \
5818 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5819 Image Name: Simple Ramdisk Image
5820 Created: Wed Jan 12 14:01:50 2000
5821 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5822 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5823 Load Address: 0x00000000
5824 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005825
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005826The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5827option performs the converse operation of the mkimage's second form (the "-d"
5828option). Given an image built by mkimage, the dumpimage extracts a "data file"
5829from the image:
5830
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005831 tools/dumpimage -i image -T type -p position data_file
5832 -i ==> extract from the 'image' a specific 'data_file'
5833 -T ==> set image type to 'type'
5834 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005835
wdenkc6097192002-11-03 00:24:07 +00005836
wdenk6c59edc2004-05-03 20:45:30 +00005837Installing a Linux Image:
5838-------------------------
wdenkc6097192002-11-03 00:24:07 +00005839
wdenk6c59edc2004-05-03 20:45:30 +00005840To downloading a U-Boot image over the serial (console) interface,
5841you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005842
wdenk6c59edc2004-05-03 20:45:30 +00005843 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005844
wdenk6c59edc2004-05-03 20:45:30 +00005845The 'objcopy' does not understand the information in the U-Boot
5846image header, so the resulting S-Record file will be relative to
5847address 0x00000000. To load it to a given address, you need to
5848specify the target address as 'offset' parameter with the 'loads'
5849command.
wdenkc6097192002-11-03 00:24:07 +00005850
wdenk6c59edc2004-05-03 20:45:30 +00005851Example: install the image to address 0x40100000 (which on the
5852TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005853
wdenk6c59edc2004-05-03 20:45:30 +00005854 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005855
wdenk6c59edc2004-05-03 20:45:30 +00005856 .......... done
5857 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005858
wdenk6c59edc2004-05-03 20:45:30 +00005859 => loads 40100000
5860 ## Ready for S-Record download ...
5861 ~>examples/image.srec
5862 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5863 ...
5864 15989 15990 15991 15992
5865 [file transfer complete]
5866 [connected]
5867 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005868
wdenkc6097192002-11-03 00:24:07 +00005869
wdenk6c59edc2004-05-03 20:45:30 +00005870You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005871this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005872corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005873
wdenk6c59edc2004-05-03 20:45:30 +00005874 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005875
wdenk6c59edc2004-05-03 20:45:30 +00005876 ## Checking Image at 40100000 ...
5877 Image Name: 2.2.13 for initrd on TQM850L
5878 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5879 Data Size: 335725 Bytes = 327 kB = 0 MB
5880 Load Address: 00000000
5881 Entry Point: 0000000c
5882 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005883
5884
wdenk6c59edc2004-05-03 20:45:30 +00005885Boot Linux:
5886-----------
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk6c59edc2004-05-03 20:45:30 +00005888The "bootm" command is used to boot an application that is stored in
5889memory (RAM or Flash). In case of a Linux kernel image, the contents
5890of the "bootargs" environment variable is passed to the kernel as
5891parameters. You can check and modify this variable using the
5892"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005893
wdenkc6097192002-11-03 00:24:07 +00005894
wdenk6c59edc2004-05-03 20:45:30 +00005895 => printenv bootargs
5896 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005897
wdenk6c59edc2004-05-03 20:45:30 +00005898 => 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 +00005899
wdenk6c59edc2004-05-03 20:45:30 +00005900 => printenv bootargs
5901 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 +00005902
wdenk6c59edc2004-05-03 20:45:30 +00005903 => bootm 40020000
5904 ## Booting Linux kernel at 40020000 ...
5905 Image Name: 2.2.13 for NFS on TQM850L
5906 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5907 Data Size: 381681 Bytes = 372 kB = 0 MB
5908 Load Address: 00000000
5909 Entry Point: 0000000c
5910 Verifying Checksum ... OK
5911 Uncompressing Kernel Image ... OK
5912 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
5913 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5914 time_init: decrementer frequency = 187500000/60
5915 Calibrating delay loop... 49.77 BogoMIPS
5916 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5917 ...
wdenkc6097192002-11-03 00:24:07 +00005918
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005919If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005920the memory addresses of both the kernel and the initrd image (PPBCOOT
5921format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005922
wdenk6c59edc2004-05-03 20:45:30 +00005923 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005924
wdenk6c59edc2004-05-03 20:45:30 +00005925 ## Checking Image at 40100000 ...
5926 Image Name: 2.2.13 for initrd on TQM850L
5927 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5928 Data Size: 335725 Bytes = 327 kB = 0 MB
5929 Load Address: 00000000
5930 Entry Point: 0000000c
5931 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005932
wdenk6c59edc2004-05-03 20:45:30 +00005933 ## Checking Image at 40200000 ...
5934 Image Name: Simple Ramdisk Image
5935 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5936 Data Size: 566530 Bytes = 553 kB = 0 MB
5937 Load Address: 00000000
5938 Entry Point: 00000000
5939 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005940
wdenk6c59edc2004-05-03 20:45:30 +00005941 => bootm 40100000 40200000
5942 ## Booting Linux kernel at 40100000 ...
5943 Image Name: 2.2.13 for initrd on TQM850L
5944 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5945 Data Size: 335725 Bytes = 327 kB = 0 MB
5946 Load Address: 00000000
5947 Entry Point: 0000000c
5948 Verifying Checksum ... OK
5949 Uncompressing Kernel Image ... OK
5950 ## Loading RAMDisk Image at 40200000 ...
5951 Image Name: Simple Ramdisk Image
5952 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5953 Data Size: 566530 Bytes = 553 kB = 0 MB
5954 Load Address: 00000000
5955 Entry Point: 00000000
5956 Verifying Checksum ... OK
5957 Loading Ramdisk ... OK
5958 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
5959 Boot arguments: root=/dev/ram
5960 time_init: decrementer frequency = 187500000/60
5961 Calibrating delay loop... 49.77 BogoMIPS
5962 ...
5963 RAMDISK: Compressed image found at block 0
5964 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005965
wdenk6c59edc2004-05-03 20:45:30 +00005966 bash#
wdenkc6097192002-11-03 00:24:07 +00005967
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005968Boot Linux and pass a flat device tree:
5969-----------
5970
5971First, U-Boot must be compiled with the appropriate defines. See the section
5972titled "Linux Kernel Interface" above for a more in depth explanation. The
5973following is an example of how to start a kernel and pass an updated
5974flat device tree:
5975
5976=> print oftaddr
5977oftaddr=0x300000
5978=> print oft
5979oft=oftrees/mpc8540ads.dtb
5980=> tftp $oftaddr $oft
5981Speed: 1000, full duplex
5982Using TSEC0 device
5983TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5984Filename 'oftrees/mpc8540ads.dtb'.
5985Load address: 0x300000
5986Loading: #
5987done
5988Bytes transferred = 4106 (100a hex)
5989=> tftp $loadaddr $bootfile
5990Speed: 1000, full duplex
5991Using TSEC0 device
5992TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5993Filename 'uImage'.
5994Load address: 0x200000
5995Loading:############
5996done
5997Bytes transferred = 1029407 (fb51f hex)
5998=> print loadaddr
5999loadaddr=200000
6000=> print oftaddr
6001oftaddr=0x300000
6002=> bootm $loadaddr - $oftaddr
6003## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01006004 Image Name: Linux-2.6.17-dirty
6005 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6006 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006007 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01006008 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006009 Verifying Checksum ... OK
6010 Uncompressing Kernel Image ... OK
6011Booting using flat device tree at 0x300000
6012Using MPC85xx ADS machine description
6013Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6014[snip]
6015
6016
wdenk6c59edc2004-05-03 20:45:30 +00006017More About U-Boot Image Types:
6018------------------------------
wdenkc6097192002-11-03 00:24:07 +00006019
wdenk6c59edc2004-05-03 20:45:30 +00006020U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006021
wdenk6c59edc2004-05-03 20:45:30 +00006022 "Standalone Programs" are directly runnable in the environment
6023 provided by U-Boot; it is expected that (if they behave
6024 well) you can continue to work in U-Boot after return from
6025 the Standalone Program.
6026 "OS Kernel Images" are usually images of some Embedded OS which
6027 will take over control completely. Usually these programs
6028 will install their own set of exception handlers, device
6029 drivers, set up the MMU, etc. - this means, that you cannot
6030 expect to re-enter U-Boot except by resetting the CPU.
6031 "RAMDisk Images" are more or less just data blocks, and their
6032 parameters (address, size) are passed to an OS kernel that is
6033 being started.
6034 "Multi-File Images" contain several images, typically an OS
6035 (Linux) kernel image and one or more data images like
6036 RAMDisks. This construct is useful for instance when you want
6037 to boot over the network using BOOTP etc., where the boot
6038 server provides just a single image file, but you want to get
6039 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006040
wdenk6c59edc2004-05-03 20:45:30 +00006041 "Multi-File Images" start with a list of image sizes, each
6042 image size (in bytes) specified by an "uint32_t" in network
6043 byte order. This list is terminated by an "(uint32_t)0".
6044 Immediately after the terminating 0 follow the images, one by
6045 one, all aligned on "uint32_t" boundaries (size rounded up to
6046 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006047
wdenk6c59edc2004-05-03 20:45:30 +00006048 "Firmware Images" are binary images containing firmware (like
6049 U-Boot or FPGA images) which usually will be programmed to
6050 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006051
wdenk6c59edc2004-05-03 20:45:30 +00006052 "Script files" are command sequences that will be executed by
6053 U-Boot's command interpreter; this feature is especially
6054 useful when you configure U-Boot to use a real shell (hush)
6055 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006056
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006057Booting the Linux zImage:
6058-------------------------
6059
6060On some platforms, it's possible to boot Linux zImage. This is done
6061using the "bootz" command. The syntax of "bootz" command is the same
6062as the syntax of "bootm" command.
6063
Tom Rini45f46d12013-05-16 11:40:11 -04006064Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006065kernel with raw initrd images. The syntax is slightly different, the
6066address of the initrd must be augmented by it's size, in the following
6067format: "<initrd addres>:<initrd size>".
6068
stroeseb9c17c52003-04-04 15:53:41 +00006069
wdenk6c59edc2004-05-03 20:45:30 +00006070Standalone HOWTO:
6071=================
stroeseb9c17c52003-04-04 15:53:41 +00006072
wdenk6c59edc2004-05-03 20:45:30 +00006073One of the features of U-Boot is that you can dynamically load and
6074run "standalone" applications, which can use some resources of
6075U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006076
wdenk6c59edc2004-05-03 20:45:30 +00006077Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006078
wdenk6c59edc2004-05-03 20:45:30 +00006079"Hello World" Demo:
6080-------------------
wdenkc6097192002-11-03 00:24:07 +00006081
wdenk6c59edc2004-05-03 20:45:30 +00006082'examples/hello_world.c' contains a small "Hello World" Demo
6083application; it is automatically compiled when you build U-Boot.
6084It's configured to run at address 0x00040004, so you can play with it
6085like that:
wdenkc6097192002-11-03 00:24:07 +00006086
wdenk6c59edc2004-05-03 20:45:30 +00006087 => loads
6088 ## Ready for S-Record download ...
6089 ~>examples/hello_world.srec
6090 1 2 3 4 5 6 7 8 9 10 11 ...
6091 [file transfer complete]
6092 [connected]
6093 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006094
wdenk6c59edc2004-05-03 20:45:30 +00006095 => go 40004 Hello World! This is a test.
6096 ## Starting application at 0x00040004 ...
6097 Hello World
6098 argc = 7
6099 argv[0] = "40004"
6100 argv[1] = "Hello"
6101 argv[2] = "World!"
6102 argv[3] = "This"
6103 argv[4] = "is"
6104 argv[5] = "a"
6105 argv[6] = "test."
6106 argv[7] = "<NULL>"
6107 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006108
wdenk6c59edc2004-05-03 20:45:30 +00006109 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006110
wdenk6c59edc2004-05-03 20:45:30 +00006111Another example, which demonstrates how to register a CPM interrupt
6112handler with the U-Boot code, can be found in 'examples/timer.c'.
6113Here, a CPM timer is set up to generate an interrupt every second.
6114The interrupt service routine is trivial, just printing a '.'
6115character, but this is just a demo program. The application can be
6116controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006117
wdenk6c59edc2004-05-03 20:45:30 +00006118 ? - print current values og the CPM Timer registers
6119 b - enable interrupts and start timer
6120 e - stop timer and disable interrupts
6121 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006122
wdenk6c59edc2004-05-03 20:45:30 +00006123 => loads
6124 ## Ready for S-Record download ...
6125 ~>examples/timer.srec
6126 1 2 3 4 5 6 7 8 9 10 11 ...
6127 [file transfer complete]
6128 [connected]
6129 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006130
wdenk6c59edc2004-05-03 20:45:30 +00006131 => go 40004
6132 ## Starting application at 0x00040004 ...
6133 TIMERS=0xfff00980
6134 Using timer 1
6135 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006136
wdenk6c59edc2004-05-03 20:45:30 +00006137Hit 'b':
6138 [q, b, e, ?] Set interval 1000000 us
6139 Enabling timer
6140Hit '?':
6141 [q, b, e, ?] ........
6142 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6143Hit '?':
6144 [q, b, e, ?] .
6145 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6146Hit '?':
6147 [q, b, e, ?] .
6148 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6149Hit '?':
6150 [q, b, e, ?] .
6151 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6152Hit 'e':
6153 [q, b, e, ?] ...Stopping timer
6154Hit 'q':
6155 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006156
wdenkc6097192002-11-03 00:24:07 +00006157
wdenk6c59edc2004-05-03 20:45:30 +00006158Minicom warning:
6159================
wdenkc6097192002-11-03 00:24:07 +00006160
wdenk6c59edc2004-05-03 20:45:30 +00006161Over time, many people have reported problems when trying to use the
6162"minicom" terminal emulation program for serial download. I (wd)
6163consider minicom to be broken, and recommend not to use it. Under
6164Unix, I recommend to use C-Kermit for general purpose use (and
6165especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006166use "cu" for S-Record download ("loads" command). See
6167http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6168for help with kermit.
6169
wdenkc6097192002-11-03 00:24:07 +00006170
wdenk6c59edc2004-05-03 20:45:30 +00006171Nevertheless, if you absolutely want to use it try adding this
6172configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006173
wdenk6c59edc2004-05-03 20:45:30 +00006174 Name Program Name U/D FullScr IO-Red. Multi
6175 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6176 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006177
wdenk8dba0502003-03-31 16:34:49 +00006178
wdenk6c59edc2004-05-03 20:45:30 +00006179NetBSD Notes:
6180=============
wdenkc6097192002-11-03 00:24:07 +00006181
wdenk6c59edc2004-05-03 20:45:30 +00006182Starting at version 0.9.2, U-Boot supports NetBSD both as host
6183(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006184
wdenk6c59edc2004-05-03 20:45:30 +00006185Building requires a cross environment; it is known to work on
6186NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6187need gmake since the Makefiles are not compatible with BSD make).
6188Note that the cross-powerpc package does not install include files;
6189attempting to build U-Boot will fail because <machine/ansi.h> is
6190missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006191
wdenk6c59edc2004-05-03 20:45:30 +00006192 # cd /usr/pkg/cross/powerpc-netbsd/include
6193 # mkdir powerpc
6194 # ln -s powerpc machine
6195 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6196 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006197
wdenk6c59edc2004-05-03 20:45:30 +00006198Native builds *don't* work due to incompatibilities between native
6199and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006200
wdenk6c59edc2004-05-03 20:45:30 +00006201Booting assumes that (the first part of) the image booted is a
6202stage-2 loader which in turn loads and then invokes the kernel
6203proper. Loader sources will eventually appear in the NetBSD source
6204tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006205meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006206
wdenkc6097192002-11-03 00:24:07 +00006207
wdenk6c59edc2004-05-03 20:45:30 +00006208Implementation Internals:
6209=========================
wdenkc6097192002-11-03 00:24:07 +00006210
wdenk6c59edc2004-05-03 20:45:30 +00006211The following is not intended to be a complete description of every
6212implementation detail. However, it should help to understand the
6213inner workings of U-Boot and make it easier to port it to custom
6214hardware.
wdenkc6097192002-11-03 00:24:07 +00006215
wdenkc6097192002-11-03 00:24:07 +00006216
wdenk6c59edc2004-05-03 20:45:30 +00006217Initial Stack, Global Data:
6218---------------------------
wdenkc6097192002-11-03 00:24:07 +00006219
wdenk6c59edc2004-05-03 20:45:30 +00006220The implementation of U-Boot is complicated by the fact that U-Boot
6221starts running out of ROM (flash memory), usually without access to
6222system RAM (because the memory controller is not initialized yet).
6223This means that we don't have writable Data or BSS segments, and BSS
6224is not initialized as zero. To be able to get a C environment working
6225at all, we have to allocate at least a minimal stack. Implementation
6226options for this are defined and restricted by the CPU used: Some CPU
6227models provide on-chip memory (like the IMMR area on MPC8xx and
6228MPC826x processors), on others (parts of) the data cache can be
6229locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006230
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006231 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006232 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006233
wdenk6c59edc2004-05-03 20:45:30 +00006234 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6235 From: "Chris Hallinan" <clh@net1plus.com>
6236 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6237 ...
wdenkc6097192002-11-03 00:24:07 +00006238
wdenk6c59edc2004-05-03 20:45:30 +00006239 Correct me if I'm wrong, folks, but the way I understand it
6240 is this: Using DCACHE as initial RAM for Stack, etc, does not
6241 require any physical RAM backing up the cache. The cleverness
6242 is that the cache is being used as a temporary supply of
6243 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006244 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006245 can see how this works by studying the cache architecture and
6246 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006247
wdenk6c59edc2004-05-03 20:45:30 +00006248 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6249 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006250 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006251 option should work for you. Using CS 4 should be fine if your
6252 board designers haven't used it for something that would
6253 cause you grief during the initial boot! It is frequently not
6254 used.
wdenkc6097192002-11-03 00:24:07 +00006255
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006256 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006257 with your processor/board/system design. The default value
6258 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006259 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006260 than your SDRAM module. If you have a 64MB SDRAM module, set
6261 it above 400_0000. Just make sure your board has no resources
6262 that are supposed to respond to that address! That code in
6263 start.S has been around a while and should work as is when
6264 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006265
wdenk6c59edc2004-05-03 20:45:30 +00006266 -Chris Hallinan
6267 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006268
wdenk6c59edc2004-05-03 20:45:30 +00006269It is essential to remember this, since it has some impact on the C
6270code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006271
wdenk6c59edc2004-05-03 20:45:30 +00006272* Initialized global data (data segment) is read-only. Do not attempt
6273 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006274
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006275* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006276 as zero data - BSS segment) at all - this is undefined, initiali-
6277 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006278
wdenk6c59edc2004-05-03 20:45:30 +00006279* Stack space is very limited. Avoid big data buffers or things like
6280 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006281
wdenk6c59edc2004-05-03 20:45:30 +00006282Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006283normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006284turned out that the implementation of U-Boot can be greatly
6285simplified by making a global data structure (gd_t) available to all
6286functions. We could pass a pointer to this data as argument to _all_
6287functions, but this would bloat the code. Instead we use a feature of
6288the GCC compiler (Global Register Variables) to share the data: we
6289place a pointer (gd) to the global data into a register which we
6290reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006291
wdenk6c59edc2004-05-03 20:45:30 +00006292When choosing a register for such a purpose we are restricted by the
6293relevant (E)ABI specifications for the current architecture, and by
6294GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006295
wdenk6c59edc2004-05-03 20:45:30 +00006296For PowerPC, the following registers have specific use:
6297 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006298 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006299 R3-R4: parameter passing and return values
6300 R5-R10: parameter passing
6301 R13: small data area pointer
6302 R30: GOT pointer
6303 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006304
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006305 (U-Boot also uses R12 as internal GOT pointer. r12
6306 is a volatile register so r12 needs to be reset when
6307 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006308
Wolfgang Denk69c09642008-02-14 22:43:22 +01006309 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006310
wdenk6c59edc2004-05-03 20:45:30 +00006311 Note: on PPC, we could use a static initializer (since the
6312 address of the global data structure is known at compile time),
6313 but it turned out that reserving a register results in somewhat
6314 smaller code - although the code savings are not that big (on
6315 average for all boards 752 bytes for the whole U-Boot image,
6316 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006317
Robin Getz2773d5f2009-08-17 15:23:02 +00006318On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006319 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6320
Robin Getz2773d5f2009-08-17 15:23:02 +00006321 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006322
wdenk6c59edc2004-05-03 20:45:30 +00006323On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006324
wdenk6c59edc2004-05-03 20:45:30 +00006325 R0: function argument word/integer result
6326 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006327 R9: platform specific
6328 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006329 R11: argument (frame) pointer
6330 R12: temporary workspace
6331 R13: stack pointer
6332 R14: link register
6333 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006334
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006335 ==> U-Boot will use R9 to hold a pointer to the global data
6336
6337 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006338
Thomas Chou8fa38582010-05-21 11:08:03 +08006339On Nios II, the ABI is documented here:
6340 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6341
6342 ==> U-Boot will use gp to hold a pointer to the global data
6343
6344 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6345 to access small data sections, so gp is free.
6346
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006347On NDS32, the following registers are used:
6348
6349 R0-R1: argument/return
6350 R2-R5: argument
6351 R15: temporary register for assembler
6352 R16: trampoline register
6353 R28: frame pointer (FP)
6354 R29: global pointer (GP)
6355 R30: link register (LP)
6356 R31: stack pointer (SP)
6357 PC: program counter (PC)
6358
6359 ==> U-Boot will use R10 to hold a pointer to the global data
6360
Wolfgang Denk6405a152006-03-31 18:32:53 +02006361NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6362or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006363
wdenk6c59edc2004-05-03 20:45:30 +00006364Memory Management:
6365------------------
wdenkc6097192002-11-03 00:24:07 +00006366
wdenk6c59edc2004-05-03 20:45:30 +00006367U-Boot runs in system state and uses physical addresses, i.e. the
6368MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006369
wdenk6c59edc2004-05-03 20:45:30 +00006370The available memory is mapped to fixed addresses using the memory
6371controller. In this process, a contiguous block is formed for each
6372memory type (Flash, SDRAM, SRAM), even when it consists of several
6373physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006374
wdenk6c59edc2004-05-03 20:45:30 +00006375U-Boot is installed in the first 128 kB of the first Flash bank (on
6376TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6377booting and sizing and initializing DRAM, the code relocates itself
6378to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006379memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006380configuration setting]. Below that, a structure with global Board
6381Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006382
wdenk6c59edc2004-05-03 20:45:30 +00006383Additionally, some exception handler code is copied to the low 8 kB
6384of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006385
wdenk6c59edc2004-05-03 20:45:30 +00006386So a typical memory configuration with 16 MB of DRAM could look like
6387this:
wdenkc6097192002-11-03 00:24:07 +00006388
wdenk6c59edc2004-05-03 20:45:30 +00006389 0x0000 0000 Exception Vector code
6390 :
6391 0x0000 1FFF
6392 0x0000 2000 Free for Application Use
6393 :
6394 :
wdenkc6097192002-11-03 00:24:07 +00006395
wdenk6c59edc2004-05-03 20:45:30 +00006396 :
6397 :
6398 0x00FB FF20 Monitor Stack (Growing downward)
6399 0x00FB FFAC Board Info Data and permanent copy of global data
6400 0x00FC 0000 Malloc Arena
6401 :
6402 0x00FD FFFF
6403 0x00FE 0000 RAM Copy of Monitor Code
6404 ... eventually: LCD or video framebuffer
6405 ... eventually: pRAM (Protected RAM - unchanged by reset)
6406 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006407
wdenkc6097192002-11-03 00:24:07 +00006408
wdenk6c59edc2004-05-03 20:45:30 +00006409System Initialization:
6410----------------------
wdenkc6097192002-11-03 00:24:07 +00006411
wdenk6c59edc2004-05-03 20:45:30 +00006412In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006413(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006414configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006415To be able to re-map memory U-Boot then jumps to its link address.
6416To be able to implement the initialization code in C, a (small!)
6417initial stack is set up in the internal Dual Ported RAM (in case CPUs
6418which provide such a feature like MPC8xx or MPC8260), or in a locked
6419part of the data cache. After that, U-Boot initializes the CPU core,
6420the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006421
wdenk6c59edc2004-05-03 20:45:30 +00006422Next, all (potentially) available memory banks are mapped using a
6423preliminary mapping. For example, we put them on 512 MB boundaries
6424(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6425on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6426programmed for SDRAM access. Using the temporary configuration, a
6427simple memory test is run that determines the size of the SDRAM
6428banks.
wdenkc6097192002-11-03 00:24:07 +00006429
wdenk6c59edc2004-05-03 20:45:30 +00006430When there is more than one SDRAM bank, and the banks are of
6431different size, the largest is mapped first. For equal size, the first
6432bank (CS2#) is mapped first. The first mapping is always for address
64330x00000000, with any additional banks following immediately to create
6434contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006435
wdenk6c59edc2004-05-03 20:45:30 +00006436Then, the monitor installs itself at the upper end of the SDRAM area
6437and allocates memory for use by malloc() and for the global Board
6438Info data; also, the exception vector code is copied to the low RAM
6439pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006440
wdenk6c59edc2004-05-03 20:45:30 +00006441Only after this relocation will you have a "normal" C environment;
6442until that you are restricted in several ways, mostly because you are
6443running from ROM, and because the code will have to be relocated to a
6444new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006445
wdenkc6097192002-11-03 00:24:07 +00006446
wdenk6c59edc2004-05-03 20:45:30 +00006447U-Boot Porting Guide:
6448----------------------
wdenkc6097192002-11-03 00:24:07 +00006449
wdenk6c59edc2004-05-03 20:45:30 +00006450[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6451list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006452
wdenkc6097192002-11-03 00:24:07 +00006453
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006454int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006455{
6456 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006457
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006458 signal(SIGALRM, no_more_time);
6459 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006460
wdenk6c59edc2004-05-03 20:45:30 +00006461 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006462 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006463 return 0;
6464 }
wdenkc6097192002-11-03 00:24:07 +00006465
wdenk6c59edc2004-05-03 20:45:30 +00006466 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006467
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006468 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006469
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006470 if (clueless)
6471 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006472
wdenk6c59edc2004-05-03 20:45:30 +00006473 while (learning) {
6474 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006475 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6476 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006477 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006478 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006479 }
wdenkc6097192002-11-03 00:24:07 +00006480
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006481 if (available_money > toLocalCurrency ($2500))
6482 Buy a BDI3000;
6483 else
wdenk6c59edc2004-05-03 20:45:30 +00006484 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006485
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006486 if (a similar board exists) { /* hopefully... */
6487 cp -a board/<similar> board/<myboard>
6488 cp include/configs/<similar>.h include/configs/<myboard>.h
6489 } else {
6490 Create your own board support subdirectory;
6491 Create your own board include/configs/<myboard>.h file;
6492 }
6493 Edit new board/<myboard> files
6494 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006495
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006496 while (!accepted) {
6497 while (!running) {
6498 do {
6499 Add / modify source code;
6500 } until (compiles);
6501 Debug;
6502 if (clueless)
6503 email("Hi, I am having problems...");
6504 }
6505 Send patch file to the U-Boot email list;
6506 if (reasonable critiques)
6507 Incorporate improvements from email list code review;
6508 else
6509 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006510 }
wdenkc6097192002-11-03 00:24:07 +00006511
wdenk6c59edc2004-05-03 20:45:30 +00006512 return 0;
6513}
wdenkc6097192002-11-03 00:24:07 +00006514
wdenk6c59edc2004-05-03 20:45:30 +00006515void no_more_time (int sig)
6516{
6517 hire_a_guru();
6518}
wdenkc6097192002-11-03 00:24:07 +00006519
wdenkc6097192002-11-03 00:24:07 +00006520
wdenk6c59edc2004-05-03 20:45:30 +00006521Coding Standards:
6522-----------------
wdenkc6097192002-11-03 00:24:07 +00006523
wdenk6c59edc2004-05-03 20:45:30 +00006524All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006525coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006526"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006527
6528Source files originating from a different project (for example the
6529MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006530reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006531sources.
wdenkc6097192002-11-03 00:24:07 +00006532
Detlev Zundelaa63d482006-09-01 15:39:02 +02006533Please note that U-Boot is implemented in C (and to some small parts in
6534Assembler); no C++ is used, so please do not use C++ style comments (//)
6535in your code.
wdenkad276f22004-01-04 16:28:35 +00006536
wdenk6c59edc2004-05-03 20:45:30 +00006537Please also stick to the following formatting rules:
6538- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006539- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006540- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006541- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006542- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006543
wdenk6c59edc2004-05-03 20:45:30 +00006544Submissions which do not conform to the standards may be returned
6545with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006546
wdenkc6097192002-11-03 00:24:07 +00006547
wdenk6c59edc2004-05-03 20:45:30 +00006548Submitting Patches:
6549-------------------
wdenkc6097192002-11-03 00:24:07 +00006550
wdenk6c59edc2004-05-03 20:45:30 +00006551Since the number of patches for U-Boot is growing, we need to
6552establish some rules. Submissions which do not conform to these rules
6553may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006554
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006555Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006556
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006557Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6558see http://lists.denx.de/mailman/listinfo/u-boot
6559
wdenk6c59edc2004-05-03 20:45:30 +00006560When you send a patch, please include the following information with
6561it:
wdenkc6097192002-11-03 00:24:07 +00006562
wdenk6c59edc2004-05-03 20:45:30 +00006563* For bug fixes: a description of the bug and how your patch fixes
6564 this bug. Please try to include a way of demonstrating that the
6565 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006566
wdenk6c59edc2004-05-03 20:45:30 +00006567* For new features: a description of the feature and your
6568 implementation.
wdenkc6097192002-11-03 00:24:07 +00006569
wdenk6c59edc2004-05-03 20:45:30 +00006570* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006571
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006572* For major contributions, add a MAINTAINERS file with your
6573 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006574
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006575* When you add support for a new board, don't forget to add a
6576 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006577
wdenk6c59edc2004-05-03 20:45:30 +00006578* If your patch adds new configuration options, don't forget to
6579 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006580
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006581* The patch itself. If you are using git (which is *strongly*
6582 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006583 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006584 the U-Boot mailing list, you will avoid most of the common problems
6585 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006586
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006587 If you cannot use git, use "diff -purN OLD NEW". If your version of
6588 diff does not support these options, then get the latest version of
6589 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006590
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006591 The current directory when running this command shall be the parent
6592 directory of the U-Boot source tree (i. e. please make sure that
6593 your patch includes sufficient directory information for the
6594 affected files).
6595
6596 We prefer patches as plain text. MIME attachments are discouraged,
6597 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006598
wdenk6c59edc2004-05-03 20:45:30 +00006599* If one logical set of modifications affects or creates several
6600 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006601
wdenk6c59edc2004-05-03 20:45:30 +00006602* Changesets that contain different, unrelated modifications shall be
6603 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006604
wdenkc6097192002-11-03 00:24:07 +00006605
wdenk6c59edc2004-05-03 20:45:30 +00006606Notes:
wdenkc6097192002-11-03 00:24:07 +00006607
wdenk6c59edc2004-05-03 20:45:30 +00006608* Before sending the patch, run the MAKEALL script on your patched
6609 source tree and make sure that no errors or warnings are reported
6610 for any of the boards.
6611
6612* Keep your modifications to the necessary minimum: A patch
6613 containing several unrelated changes or arbitrary reformats will be
6614 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006615
wdenk6c59edc2004-05-03 20:45:30 +00006616* If you modify existing code, make sure that your new code does not
6617 add to the memory footprint of the code ;-) Small is beautiful!
6618 When adding new features, these should compile conditionally only
6619 (using #ifdef), and the resulting code with the new feature
6620 disabled must not need more memory than the old code without your
6621 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006622
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006623* Remember that there is a size limit of 100 kB per message on the
6624 u-boot mailing list. Bigger patches will be moderated. If they are
6625 reasonable and not too big, they will be acknowledged. But patches
6626 bigger than the size limit should be avoided.