blob: 362ff19ebf138e4f65366a0b064f704390bb0d00 [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
Bin Meng75574052016-02-05 19:30:11 -0800463 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansal8bcbc272014-03-18 23:40:26 +0530464
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_I2C * I2C serial bus support
1027 CONFIG_CMD_IDE * IDE harddisk support
1028 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001029 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001030 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001031 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001032 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001033 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001034 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001035 CONFIG_CMD_IRQ * irqinfo
1036 CONFIG_CMD_ITEST Integer/string test of 2 values
1037 CONFIG_CMD_JFFS2 * JFFS2 Support
1038 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001039 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001040 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1041 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001042 CONFIG_CMD_LOADB loadb
1043 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001044 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001045 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001046 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001047 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001048 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001049 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001050 CONFIG_CMD_MISC Misc functions like sleep etc
1051 CONFIG_CMD_MMC * MMC memory mapped support
1052 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001053 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001054 CONFIG_CMD_NAND * NAND support
1055 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001056 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001057 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001058 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001059 CONFIG_CMD_PCI * pciinfo
1060 CONFIG_CMD_PCMCIA * PCMCIA support
1061 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1062 host
1063 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001064 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001065 CONFIG_CMD_REGINFO * Register dump
1066 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001067 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001068 CONFIG_CMD_SAVES * save S record dump
1069 CONFIG_CMD_SCSI * SCSI Support
1070 CONFIG_CMD_SDRAM * print SDRAM configuration information
1071 (requires CONFIG_CMD_I2C)
1072 CONFIG_CMD_SETGETDCR Support for DCR Register access
1073 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001074 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001075 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001076 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001077 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001078 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001079 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001080 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001081 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001082 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1083 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001084 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001085 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001086 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001087 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001088 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001089
1090 EXAMPLE: If you want all functions except of network
1091 support you can write:
1092
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001093 #include "config_cmd_all.h"
1094 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001095
Gerald Van Barend6abef42007-03-31 12:23:51 -04001096 Other Commands:
1097 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001098
1099 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001100 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001101 what you (and your U-Boot users) are doing. Data
1102 cache cannot be enabled on systems like the 8xx or
1103 8260 (where accesses to the IMMR region must be
1104 uncached), and it cannot be disabled on all other
1105 systems where we (mis-) use the data cache to hold an
1106 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001107
1108
1109 XXX - this list needs to get updated!
1110
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001111- Regular expression support:
1112 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001113 If this variable is defined, U-Boot is linked against
1114 the SLRE (Super Light Regular Expression) library,
1115 which adds regex support to some commands, as for
1116 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001117
Simon Glass3d686442011-10-15 05:48:20 +00001118- Device tree:
1119 CONFIG_OF_CONTROL
1120 If this variable is defined, U-Boot will use a device tree
1121 to configure its devices, instead of relying on statically
1122 compiled #defines in the board file. This option is
1123 experimental and only available on a few boards. The device
1124 tree is available in the global data as gd->fdt_blob.
1125
Simon Glass5cb34db2011-10-24 19:15:31 +00001126 U-Boot needs to get its device tree from somewhere. This can
1127 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001128
1129 CONFIG_OF_EMBED
1130 If this variable is defined, U-Boot will embed a device tree
1131 binary in its image. This device tree file should be in the
1132 board directory and called <soc>-<board>.dts. The binary file
1133 is then picked up in board_init_f() and made available through
1134 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001135
Simon Glass5cb34db2011-10-24 19:15:31 +00001136 CONFIG_OF_SEPARATE
1137 If this variable is defined, U-Boot will build a device tree
1138 binary. It will be called u-boot.dtb. Architecture-specific
1139 code will locate it at run-time. Generally this works by:
1140
1141 cat u-boot.bin u-boot.dtb >image.bin
1142
1143 and in fact, U-Boot does this for you, creating a file called
1144 u-boot-dtb.bin which is useful in the common case. You can
1145 still use the individual files if you need something more
1146 exotic.
1147
wdenkc6097192002-11-03 00:24:07 +00001148- Watchdog:
1149 CONFIG_WATCHDOG
1150 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001151 support for the SoC. There must be support in the SoC
1152 specific code for a watchdog. For the 8xx and 8260
1153 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1154 register. When supported for a specific SoC is
1155 available, then no further board specific code should
1156 be needed to use it.
1157
1158 CONFIG_HW_WATCHDOG
1159 When using a watchdog circuitry external to the used
1160 SoC, then define this variable and provide board
1161 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001162
Heiko Schocher735326c2015-01-21 08:38:22 +01001163 CONFIG_AT91_HW_WDT_TIMEOUT
1164 specify the timeout in seconds. default 2 seconds.
1165
stroeseb9c17c52003-04-04 15:53:41 +00001166- U-Boot Version:
1167 CONFIG_VERSION_VARIABLE
1168 If this variable is defined, an environment variable
1169 named "ver" is created by U-Boot showing the U-Boot
1170 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001171 Any change to this variable will be reverted at the
1172 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001173
wdenkc6097192002-11-03 00:24:07 +00001174- Real-Time Clock:
1175
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001176 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001177 has to be selected, too. Define exactly one of the
1178 following options:
1179
1180 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1181 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001182 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001183 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001184 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001185 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001186 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001187 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001188 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001189 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001190 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001191 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001192 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1193 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001194
wdenkb9bbd242003-06-30 16:24:52 +00001195 Note that if the RTC uses I2C, then the I2C interface
1196 must also be configured. See I2C Support, below.
1197
Peter Tyser9902e422008-12-17 16:36:21 -06001198- GPIO Support:
1199 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001200
Chris Packham9b383202010-12-19 10:12:13 +00001201 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1202 chip-ngpio pairs that tell the PCA953X driver the number of
1203 pins supported by a particular chip.
1204
Peter Tyser9902e422008-12-17 16:36:21 -06001205 Note that if the GPIO device uses I2C, then the I2C interface
1206 must also be configured. See I2C Support, below.
1207
Simon Glass4dc47ca2014-06-11 23:29:41 -06001208- I/O tracing:
1209 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1210 accesses and can checksum them or write a list of them out
1211 to memory. See the 'iotrace' command for details. This is
1212 useful for testing device drivers since it can confirm that
1213 the driver behaves the same way before and after a code
1214 change. Currently this is supported on sandbox and arm. To
1215 add support for your architecture, add '#include <iotrace.h>'
1216 to the bottom of arch/<arch>/include/asm/io.h and test.
1217
1218 Example output from the 'iotrace stats' command is below.
1219 Note that if the trace buffer is exhausted, the checksum will
1220 still continue to operate.
1221
1222 iotrace is enabled
1223 Start: 10000000 (buffer start address)
1224 Size: 00010000 (buffer size)
1225 Offset: 00000120 (current buffer offset)
1226 Output: 10000120 (start + offset)
1227 Count: 00000018 (number of trace records)
1228 CRC32: 9526fb66 (CRC32 of all trace records)
1229
wdenkc6097192002-11-03 00:24:07 +00001230- Timestamp Support:
1231
wdenk4a5c8a72003-03-06 00:02:04 +00001232 When CONFIG_TIMESTAMP is selected, the timestamp
1233 (date and time) of an image is printed by image
1234 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001235 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001236
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001237- Partition Labels (disklabels) Supported:
1238 Zero or more of the following:
1239 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1240 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1241 Intel architecture, USB sticks, etc.
1242 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1243 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1244 bootloader. Note 2TB partition limit; see
1245 disk/part_efi.c
1246 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001247
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001248 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1249 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001250 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001251
1252- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001253 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1254 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001255
wdenk369d43d2004-03-14 14:09:05 +00001256 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1257 be performed by calling the function
1258 ide_set_reset(int reset)
1259 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001260
1261- ATAPI Support:
1262 CONFIG_ATAPI
1263
1264 Set this to enable ATAPI support.
1265
wdenkf602aa02004-03-13 23:29:43 +00001266- LBA48 Support
1267 CONFIG_LBA48
1268
1269 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001270 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001271 Whithout these , LBA48 support uses 32bit variables and will 'only'
1272 support disks up to 2.1TB.
1273
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001274 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001275 When enabled, makes the IDE subsystem use 64bit sector addresses.
1276 Default is 32bit.
1277
wdenkc6097192002-11-03 00:24:07 +00001278- SCSI Support:
1279 At the moment only there is only support for the
1280 SYM53C8XX SCSI controller; define
1281 CONFIG_SCSI_SYM53C8XX to enable it.
1282
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001283 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1284 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1285 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001286 maximum numbers of LUNs, SCSI ID's and target
1287 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001288 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001289
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001290 The environment variable 'scsidevs' is set to the number of
1291 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001292
wdenkc6097192002-11-03 00:24:07 +00001293- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001294 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001295 Support for Intel 8254x/8257x gigabit chips.
1296
1297 CONFIG_E1000_SPI
1298 Utility code for direct access to the SPI bus on Intel 8257x.
1299 This does not do anything useful unless you set at least one
1300 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1301
1302 CONFIG_E1000_SPI_GENERIC
1303 Allow generic access to the SPI bus on the Intel 8257x, for
1304 example with the "sspi" command.
1305
1306 CONFIG_CMD_E1000
1307 Management command for E1000 devices. When used on devices
1308 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001309
wdenkc6097192002-11-03 00:24:07 +00001310 CONFIG_EEPRO100
1311 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001312 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001313 write routine for first time initialisation.
1314
1315 CONFIG_TULIP
1316 Support for Digital 2114x chips.
1317 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1318 modem chip initialisation (KS8761/QS6611).
1319
1320 CONFIG_NATSEMI
1321 Support for National dp83815 chips.
1322
1323 CONFIG_NS8382X
1324 Support for National dp8382[01] gigabit chips.
1325
wdenkaa603362003-05-12 21:50:16 +00001326- NETWORK Support (other):
1327
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001328 CONFIG_DRIVER_AT91EMAC
1329 Support for AT91RM9200 EMAC.
1330
1331 CONFIG_RMII
1332 Define this to use reduced MII inteface
1333
1334 CONFIG_DRIVER_AT91EMAC_QUIET
1335 If this defined, the driver is quiet.
1336 The driver doen't show link status messages.
1337
Rob Herringc9830dc2011-12-15 11:15:49 +00001338 CONFIG_CALXEDA_XGMAC
1339 Support for the Calxeda XGMAC device
1340
Ashok93fb8722012-10-15 06:20:47 +00001341 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001342 Support for SMSC's LAN91C96 chips.
1343
1344 CONFIG_LAN91C96_BASE
1345 Define this to hold the physical address
1346 of the LAN91C96's I/O space
1347
1348 CONFIG_LAN91C96_USE_32_BIT
1349 Define this to enable 32 bit addressing
1350
Ashok93fb8722012-10-15 06:20:47 +00001351 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001352 Support for SMSC's LAN91C111 chip
1353
1354 CONFIG_SMC91111_BASE
1355 Define this to hold the physical address
1356 of the device (I/O space)
1357
1358 CONFIG_SMC_USE_32_BIT
1359 Define this if data bus is 32 bits
1360
1361 CONFIG_SMC_USE_IOFUNCS
1362 Define this to use i/o functions instead of macros
1363 (some hardware wont work with macros)
1364
Heiko Schocher7d037f72011-11-15 10:00:04 -05001365 CONFIG_DRIVER_TI_EMAC
1366 Support for davinci emac
1367
1368 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1369 Define this if you have more then 3 PHYs.
1370
Macpaul Lin199c6252010-12-21 16:59:46 +08001371 CONFIG_FTGMAC100
1372 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1373
1374 CONFIG_FTGMAC100_EGIGA
1375 Define this to use GE link update with gigabit PHY.
1376 Define this if FTGMAC100 is connected to gigabit PHY.
1377 If your system has 10/100 PHY only, it might not occur
1378 wrong behavior. Because PHY usually return timeout or
1379 useless data when polling gigabit status and gigabit
1380 control registers. This behavior won't affect the
1381 correctnessof 10/100 link speed update.
1382
Mike Rapoportf4761af2009-11-11 10:03:03 +02001383 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001384 Support for SMSC's LAN911x and LAN921x chips
1385
Mike Rapoportf4761af2009-11-11 10:03:03 +02001386 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001387 Define this to hold the physical address
1388 of the device (I/O space)
1389
Mike Rapoportf4761af2009-11-11 10:03:03 +02001390 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001391 Define this if data bus is 32 bits
1392
Mike Rapoportf4761af2009-11-11 10:03:03 +02001393 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001394 Define this if data bus is 16 bits. If your processor
1395 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001396 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001397
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001398 CONFIG_SH_ETHER
1399 Support for Renesas on-chip Ethernet controller
1400
1401 CONFIG_SH_ETHER_USE_PORT
1402 Define the number of ports to be used
1403
1404 CONFIG_SH_ETHER_PHY_ADDR
1405 Define the ETH PHY's address
1406
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001407 CONFIG_SH_ETHER_CACHE_WRITEBACK
1408 If this option is set, the driver enables cache flush.
1409
Heiko Schocher2b387762014-07-18 06:07:19 +02001410- PWM Support:
1411 CONFIG_PWM_IMX
1412 Support for PWM modul on the imx6.
1413
Vadim Bendeburydac69642011-10-17 08:36:14 +00001414- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001415 CONFIG_TPM
1416 Support TPM devices.
1417
Christophe Ricard8759ff82015-10-06 22:54:41 +02001418 CONFIG_TPM_TIS_INFINEON
1419 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001420 per system is supported at this time.
1421
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001422 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1423 Define the burst count bytes upper limit
1424
Christophe Ricard88249232016-01-21 23:27:13 +01001425 CONFIG_TPM_ST33ZP24
1426 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1427
1428 CONFIG_TPM_ST33ZP24_I2C
1429 Support for STMicroelectronics ST33ZP24 I2C devices.
1430 Requires TPM_ST33ZP24 and I2C.
1431
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001432 CONFIG_TPM_ST33ZP24_SPI
1433 Support for STMicroelectronics ST33ZP24 SPI devices.
1434 Requires TPM_ST33ZP24 and SPI.
1435
Dirk Eibach20489092013-06-26 15:55:15 +02001436 CONFIG_TPM_ATMEL_TWI
1437 Support for Atmel TWI TPM device. Requires I2C support.
1438
Che-liang Chiouacea5702013-04-12 11:04:34 +00001439 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001440 Support for generic parallel port TPM devices. Only one device
1441 per system is supported at this time.
1442
1443 CONFIG_TPM_TIS_BASE_ADDRESS
1444 Base address where the generic TPM device is mapped
1445 to. Contemporary x86 systems usually map it at
1446 0xfed40000.
1447
Reinhard Pfau4fece432013-06-26 15:55:13 +02001448 CONFIG_CMD_TPM
1449 Add tpm monitor functions.
1450 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1451 provides monitor access to authorized functions.
1452
1453 CONFIG_TPM
1454 Define this to enable the TPM support library which provides
1455 functional interfaces to some TPM commands.
1456 Requires support for a TPM device.
1457
1458 CONFIG_TPM_AUTH_SESSIONS
1459 Define this to enable authorized functions in the TPM library.
1460 Requires CONFIG_TPM and CONFIG_SHA1.
1461
wdenkc6097192002-11-03 00:24:07 +00001462- USB Support:
1463 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001464 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001465 CONFIG_USB_UHCI to enable it.
1466 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001467 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001468 storage devices.
1469 Note:
1470 Supported are USB Keyboards and USB Floppy drives
1471 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001472 MPC5200 USB requires additional defines:
1473 CONFIG_USB_CLOCK
1474 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001475 CONFIG_PSC3_USB
1476 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001477 CONFIG_USB_CONFIG
1478 for differential drivers: 0x00001000
1479 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001480 for differential drivers on PSC3: 0x00000100
1481 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001482 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001483 May be defined to allow interrupt polling
1484 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001485
Simon Glass5978cdb2012-02-27 10:52:47 +00001486 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1487 txfilltuning field in the EHCI controller on reset.
1488
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001489 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1490 HW module registers.
1491
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001492- USB Device:
1493 Define the below if you wish to use the USB console.
1494 Once firmware is rebuilt from a serial console issue the
1495 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001496 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001497 it has found a new device. The environment variable usbtty
1498 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001499 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001500 Common Device Class Abstract Control Model serial device.
1501 If you select usbtty = gserial you should be able to enumerate
1502 a Linux host by
1503 # modprobe usbserial vendor=0xVendorID product=0xProductID
1504 else if using cdc_acm, simply setting the environment
1505 variable usbtty to be cdc_acm should suffice. The following
1506 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001507
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001508 CONFIG_USB_DEVICE
1509 Define this to build a UDC device
1510
1511 CONFIG_USB_TTY
1512 Define this to have a tty type of device available to
1513 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001514
Vipin KUMARbdb17702012-03-26 15:38:06 +05301515 CONFIG_USBD_HS
1516 Define this to enable the high speed support for usb
1517 device and usbtty. If this feature is enabled, a routine
1518 int is_usbd_high_speed(void)
1519 also needs to be defined by the driver to dynamically poll
1520 whether the enumeration has succeded at high speed or full
1521 speed.
1522
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001523 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001524 Define this if you want stdin, stdout &/or stderr to
1525 be set to usbtty.
1526
1527 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001528 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001529 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001530 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001531
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001532 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001533 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001534 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001535
Wolfgang Denke2601822006-06-14 18:14:56 +02001536 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001537 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001538 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001539 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1540 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1541 should pretend to be a Linux device to it's target host.
1542
1543 CONFIG_USBD_MANUFACTURER
1544 Define this string as the name of your company for
1545 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001546
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001547 CONFIG_USBD_PRODUCT_NAME
1548 Define this string as the name of your product
1549 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001550
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001551 CONFIG_USBD_VENDORID
1552 Define this as your assigned Vendor ID from the USB
1553 Implementors Forum. This *must* be a genuine Vendor ID
1554 to avoid polluting the USB namespace.
1555 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001556
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001557 CONFIG_USBD_PRODUCTID
1558 Define this as the unique Product ID
1559 for your device
1560 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001561
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001562- ULPI Layer Support:
1563 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1564 the generic ULPI layer. The generic layer accesses the ULPI PHY
1565 via the platform viewport, so you need both the genric layer and
1566 the viewport enabled. Currently only Chipidea/ARC based
1567 viewport is supported.
1568 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1569 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001570 If your ULPI phy needs a different reference clock than the
1571 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1572 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001573
wdenk7a428cc2003-06-15 22:40:42 +00001574- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001575 The MMC controller on the Intel PXA is supported. To
1576 enable this define CONFIG_MMC. The MMC can be
1577 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001578 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001579 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1580 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001581
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001582 CONFIG_SH_MMCIF
1583 Support for Renesas on-chip MMCIF controller
1584
1585 CONFIG_SH_MMCIF_ADDR
1586 Define the base address of MMCIF registers
1587
1588 CONFIG_SH_MMCIF_CLK
1589 Define the clock frequency for MMCIF
1590
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001591 CONFIG_GENERIC_MMC
1592 Enable the generic MMC driver
1593
1594 CONFIG_SUPPORT_EMMC_BOOT
1595 Enable some additional features of the eMMC boot partitions.
1596
1597 CONFIG_SUPPORT_EMMC_RPMB
1598 Enable the commands for reading, writing and programming the
1599 key for the Replay Protection Memory Block partition in eMMC.
1600
Tom Rini58a8d322013-03-14 05:32:47 +00001601- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001602 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001603 This enables the USB portion of the DFU USB class
1604
1605 CONFIG_CMD_DFU
1606 This enables the command "dfu" which is used to have
1607 U-Boot create a DFU class device via USB. This command
1608 requires that the "dfu_alt_info" environment variable be
1609 set and define the alt settings to expose to the host.
1610
1611 CONFIG_DFU_MMC
1612 This enables support for exposing (e)MMC devices via DFU.
1613
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001614 CONFIG_DFU_NAND
1615 This enables support for exposing NAND devices via DFU.
1616
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301617 CONFIG_DFU_RAM
1618 This enables support for exposing RAM via DFU.
1619 Note: DFU spec refer to non-volatile memory usage, but
1620 allow usages beyond the scope of spec - here RAM usage,
1621 one that would help mostly the developer.
1622
Heiko Schochera2f831e2013-06-12 06:05:51 +02001623 CONFIG_SYS_DFU_DATA_BUF_SIZE
1624 Dfu transfer uses a buffer before writing data to the
1625 raw storage device. Make the size (in bytes) of this buffer
1626 configurable. The size of this buffer is also configurable
1627 through the "dfu_bufsiz" environment variable.
1628
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001629 CONFIG_SYS_DFU_MAX_FILE_SIZE
1630 When updating files rather than the raw storage device,
1631 we use a static buffer to copy the file into and then write
1632 the buffer once we've been given the whole file. Define
1633 this to the maximum filesize (in bytes) for the buffer.
1634 Default is 4 MiB if undefined.
1635
Heiko Schochere1ba1512014-03-18 08:09:56 +01001636 DFU_DEFAULT_POLL_TIMEOUT
1637 Poll timeout [ms], is the timeout a device can send to the
1638 host. The host must wait for this timeout before sending
1639 a subsequent DFU_GET_STATUS request to the device.
1640
1641 DFU_MANIFEST_POLL_TIMEOUT
1642 Poll timeout [ms], which the device sends to the host when
1643 entering dfuMANIFEST state. Host waits this timeout, before
1644 sending again an USB request to the device.
1645
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001646- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001647 CONFIG_USB_FUNCTION_FASTBOOT
1648 This enables the USB part of the fastboot gadget
1649
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001650 CONFIG_CMD_FASTBOOT
1651 This enables the command "fastboot" which enables the Android
1652 fastboot mode for the platform's USB device. Fastboot is a USB
1653 protocol for downloading images, flashing and device control
1654 used on Android devices.
1655 See doc/README.android-fastboot for more information.
1656
1657 CONFIG_ANDROID_BOOT_IMAGE
1658 This enables support for booting images which use the Android
1659 image format header.
1660
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001661 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001662 The fastboot protocol requires a large memory buffer for
1663 downloads. Define this to the starting RAM address to use for
1664 downloaded images.
1665
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001666 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001667 The fastboot protocol requires a large memory buffer for
1668 downloads. This buffer should be as large as possible for a
1669 platform. Define this to the size available RAM for fastboot.
1670
Steve Raebfb9ba42014-08-26 11:47:28 -07001671 CONFIG_FASTBOOT_FLASH
1672 The fastboot protocol includes a "flash" command for writing
1673 the downloaded image to a non-volatile storage device. Define
1674 this to enable the "fastboot flash" command.
1675
1676 CONFIG_FASTBOOT_FLASH_MMC_DEV
1677 The fastboot "flash" command requires additional information
1678 regarding the non-volatile storage device. Define this to
1679 the eMMC device that fastboot should use to store the image.
1680
Steve Rae7d059342014-12-12 15:51:54 -08001681 CONFIG_FASTBOOT_GPT_NAME
1682 The fastboot "flash" command supports writing the downloaded
1683 image to the Protective MBR and the Primary GUID Partition
1684 Table. (Additionally, this downloaded image is post-processed
1685 to generate and write the Backup GUID Partition Table.)
1686 This occurs when the specified "partition name" on the
1687 "fastboot flash" command line matches this value.
1688 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1689
wdenkda04a8b2004-08-02 23:22:59 +00001690- Journaling Flash filesystem support:
1691 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1692 CONFIG_JFFS2_NAND_DEV
1693 Define these for a default partition on a NAND device
1694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001695 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1696 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001697 Define these for a default partition on a NOR device
1698
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001699 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001700 Define this to create an own partition. You have to provide a
1701 function struct part_info* jffs2_part_info(int part_num)
1702
1703 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001704 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001705 to disable the command chpart. This is the default when you
1706 have not defined a custom partition
1707
Donggeun Kim8f814002011-10-24 21:15:28 +00001708- FAT(File Allocation Table) filesystem write function support:
1709 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001710
1711 Define this to enable support for saving memory data as a
1712 file in FAT formatted partition.
1713
1714 This will also enable the command "fatwrite" enabling the
1715 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001716
Gabe Black7f8574c2012-10-12 14:26:11 +00001717CBFS (Coreboot Filesystem) support
1718 CONFIG_CMD_CBFS
1719
1720 Define this to enable support for reading from a Coreboot
1721 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1722 and cbfsload.
1723
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301724- FAT(File Allocation Table) filesystem cluster size:
1725 CONFIG_FS_FAT_MAX_CLUSTSIZE
1726
1727 Define the max cluster size for fat operations else
1728 a default value of 65536 will be defined.
1729
wdenkc6097192002-11-03 00:24:07 +00001730- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001731 See Kconfig help for available keyboard drivers.
1732
1733 CONFIG_KEYBOARD
1734
1735 Define this to enable a custom keyboard support.
1736 This simply calls drv_keyboard_init() which must be
1737 defined in your board-specific files. This option is deprecated
1738 and is only used by novena. For new boards, use driver model
1739 instead.
wdenkc6097192002-11-03 00:24:07 +00001740
1741- Video support:
1742 CONFIG_VIDEO
1743
1744 Define this to enable video support (for output to
1745 video).
1746
1747 CONFIG_VIDEO_CT69000
1748
1749 Enable Chips & Technologies 69000 Video chip
1750
1751 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001752 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001753 video output is selected via environment 'videoout'
1754 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1755 assumed.
wdenkc6097192002-11-03 00:24:07 +00001756
wdenkd3602132004-03-25 15:14:43 +00001757 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001758 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001759 are possible:
1760 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001761 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001762
1763 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1764 -------------+---------------------------------------------
1765 8 bits | 0x301* 0x303 0x305 0x161 0x307
1766 15 bits | 0x310 0x313 0x316 0x162 0x319
1767 16 bits | 0x311 0x314 0x317 0x163 0x31A
1768 24 bits | 0x312 0x315 0x318 ? 0x31B
1769 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001770 (i.e. setenv videomode 317; saveenv; reset;)
1771
wdenkd3602132004-03-25 15:14:43 +00001772 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001773 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001774
1775
stroeseb9c17c52003-04-04 15:53:41 +00001776 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001777 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001778 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1779 or CONFIG_VIDEO_SED13806_16BPP
1780
Timur Tabi020edd22011-02-15 17:09:19 -06001781 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001782 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001783 SOCs that have a DIU should define this macro to enable DIU
1784 support, and should also define these other macros:
1785
1786 CONFIG_SYS_DIU_ADDR
1787 CONFIG_VIDEO
1788 CONFIG_CMD_BMP
1789 CONFIG_CFB_CONSOLE
1790 CONFIG_VIDEO_SW_CURSOR
1791 CONFIG_VGA_AS_SINGLE_DEVICE
1792 CONFIG_VIDEO_LOGO
1793 CONFIG_VIDEO_BMP_LOGO
1794
Timur Tabi32f709e2011-04-11 14:18:22 -05001795 The DIU driver will look for the 'video-mode' environment
1796 variable, and if defined, enable the DIU as a console during
1797 boot. See the documentation file README.video for a
1798 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001799
wdenkc6097192002-11-03 00:24:07 +00001800- LCD Support: CONFIG_LCD
1801
1802 Define this to enable LCD support (for output to LCD
1803 display); also select one of the supported displays
1804 by defining one of these:
1805
Stelian Popf6f86652008-05-09 21:57:18 +02001806 CONFIG_ATMEL_LCD:
1807
1808 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1809
wdenkc0d54ae2003-11-25 16:55:19 +00001810 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001811
wdenkc0d54ae2003-11-25 16:55:19 +00001812 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001813
wdenkc0d54ae2003-11-25 16:55:19 +00001814 CONFIG_NEC_NL6448BC20
1815
1816 NEC NL6448BC20-08. 6.5", 640x480.
1817 Active, color, single scan.
1818
1819 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001820
wdenkc0d54ae2003-11-25 16:55:19 +00001821 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001822 Active, color, single scan.
1823
1824 CONFIG_SHARP_16x9
1825
1826 Sharp 320x240. Active, color, single scan.
1827 It isn't 16x9, and I am not sure what it is.
1828
1829 CONFIG_SHARP_LQ64D341
1830
1831 Sharp LQ64D341 display, 640x480.
1832 Active, color, single scan.
1833
1834 CONFIG_HLD1045
1835
1836 HLD1045 display, 640x480.
1837 Active, color, single scan.
1838
1839 CONFIG_OPTREX_BW
1840
1841 Optrex CBL50840-2 NF-FW 99 22 M5
1842 or
1843 Hitachi LMG6912RPFC-00T
1844 or
1845 Hitachi SP14Q002
1846
1847 320x240. Black & white.
1848
1849 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001850 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001851
Simon Glass599a4df2012-10-17 13:24:54 +00001852 CONFIG_LCD_ALIGNMENT
1853
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001854 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001855 defined then the LCD will be aligned to this value instead.
1856 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1857 here, since it is cheaper to change data cache settings on
1858 a per-section basis.
1859
Simon Glassaf3e2802012-10-17 13:24:59 +00001860 CONFIG_CONSOLE_SCROLL_LINES
1861
1862 When the console need to be scrolled, this is the number of
1863 lines to scroll by. It defaults to 1. Increasing this makes
1864 the console jump but can help speed up operation when scrolling
1865 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001866
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001867 CONFIG_LCD_ROTATION
1868
1869 Sometimes, for example if the display is mounted in portrait
1870 mode or even if it's mounted landscape but rotated by 180degree,
1871 we need to rotate our content of the display relative to the
1872 framebuffer, so that user can read the messages which are
1873 printed out.
1874 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1875 initialized with a given rotation from "vl_rot" out of
1876 "vidinfo_t" which is provided by the board specific code.
1877 The value for vl_rot is coded as following (matching to
1878 fbcon=rotate:<n> linux-kernel commandline):
1879 0 = no rotation respectively 0 degree
1880 1 = 90 degree rotation
1881 2 = 180 degree rotation
1882 3 = 270 degree rotation
1883
1884 If CONFIG_LCD_ROTATION is not defined, the console will be
1885 initialized with 0degree rotation.
1886
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001887 CONFIG_LCD_BMP_RLE8
1888
1889 Support drawing of RLE8-compressed bitmaps on the LCD.
1890
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001891 CONFIG_I2C_EDID
1892
1893 Enables an 'i2c edid' command which can read EDID
1894 information over I2C from an attached LCD display.
1895
wdenkeb20ad32003-09-05 23:19:14 +00001896- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001897
wdenk57b2d802003-06-27 21:31:46 +00001898 If this option is set, the environment is checked for
1899 a variable "splashimage". If found, the usual display
1900 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001901 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001902 specified in "splashimage" is loaded instead. The
1903 console is redirected to the "nulldev", too. This
1904 allows for a "silent" boot where a splash screen is
1905 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001906
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001907 CONFIG_SPLASHIMAGE_GUARD
1908
1909 If this option is set, then U-Boot will prevent the environment
1910 variable "splashimage" from being set to a problematic address
Tom Rini958a8f82014-02-25 10:27:01 -05001911 (see README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001912 This option is useful for targets where, due to alignment
1913 restrictions, an improperly aligned BMP image will cause a data
1914 abort. If you think you will not have problems with unaligned
1915 accesses (for example because your toolchain prevents them)
1916 there is no need to set this option.
1917
Matthias Weisser53884182009-07-09 16:07:30 +02001918 CONFIG_SPLASH_SCREEN_ALIGN
1919
1920 If this option is set the splash image can be freely positioned
1921 on the screen. Environment variable "splashpos" specifies the
1922 position as "x,y". If a positive number is given it is used as
1923 number of pixel from left/top. If a negative number is given it
1924 is used as number of pixel from right/bottom. You can also
1925 specify 'm' for centering the image.
1926
1927 Example:
1928 setenv splashpos m,m
1929 => image at center of screen
1930
1931 setenv splashpos 30,20
1932 => image at x = 30 and y = 20
1933
1934 setenv splashpos -10,m
1935 => vertically centered image
1936 at x = dspWidth - bmpWidth - 9
1937
Stefan Roesed9d97742005-09-22 09:04:17 +02001938- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1939
1940 If this option is set, additionally to standard BMP
1941 images, gzipped BMP images can be displayed via the
1942 splashscreen support or the bmp command.
1943
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001944- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1945
1946 If this option is set, 8-bit RLE compressed BMP images
1947 can be displayed via the splashscreen support or the
1948 bmp command.
1949
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001950- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001951 CONFIG_CMD_ZIP
1952
1953 If this option is set, it would use zlib deflate method
1954 to compress the specified memory at its best effort.
1955
wdenk710e3502003-08-29 20:57:53 +00001956- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001957 CONFIG_GZIP
1958
1959 Enabled by default to support gzip compressed images.
1960
wdenk710e3502003-08-29 20:57:53 +00001961 CONFIG_BZIP2
1962
1963 If this option is set, support for bzip2 compressed
1964 images is included. If not, only uncompressed and gzip
1965 compressed images are supported.
1966
wdenk9c53f402003-10-15 23:53:47 +00001967 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001968 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001969 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001970
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001971 CONFIG_LZMA
1972
1973 If this option is set, support for lzma compressed
1974 images is included.
1975
1976 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1977 requires an amount of dynamic memory that is given by the
1978 formula:
1979
1980 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1981
1982 Where lc and lp stand for, respectively, Literal context bits
1983 and Literal pos bits.
1984
1985 This value is upper-bounded by 14MB in the worst case. Anyway,
1986 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1987 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1988 a very small buffer.
1989
1990 Use the lzmainfo tool to determinate the lc and lp values and
1991 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001992 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001993
Kees Cook5b06e642013-08-16 07:59:12 -07001994 CONFIG_LZO
1995
1996 If this option is set, support for LZO compressed images
1997 is included.
1998
wdenk0e2bd9c2004-06-06 21:51:03 +00001999- MII/PHY support:
2000 CONFIG_PHY_ADDR
2001
2002 The address of PHY on MII bus.
2003
2004 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2005
2006 The clock frequency of the MII bus
2007
2008 CONFIG_PHY_GIGE
2009
2010 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002011 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002012
2013 CONFIG_PHY_RESET_DELAY
2014
2015 Some PHY like Intel LXT971A need extra delay after
2016 reset before any MII register access is possible.
2017 For such PHY, set this option to the usec delay
2018 required. (minimum 300usec for LXT971A)
2019
2020 CONFIG_PHY_CMD_DELAY (ppc4xx)
2021
2022 Some PHY like Intel LXT971A need extra delay after
2023 command issued before MII status register can be read
2024
wdenkc6097192002-11-03 00:24:07 +00002025- IP address:
2026 CONFIG_IPADDR
2027
2028 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002029 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002030 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002031 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002032
2033- Server IP address:
2034 CONFIG_SERVERIP
2035
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002036 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002037 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002038 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002039
Robin Getz470a6d42009-07-21 12:15:28 -04002040 CONFIG_KEEP_SERVERADDR
2041
2042 Keeps the server's MAC address, in the env 'serveraddr'
2043 for passing to bootargs (like Linux's netconsole option)
2044
Wolfgang Denk26da2992011-10-26 10:21:22 +00002045- Gateway IP address:
2046 CONFIG_GATEWAYIP
2047
2048 Defines a default value for the IP address of the
2049 default router where packets to other networks are
2050 sent to.
2051 (Environment variable "gatewayip")
2052
2053- Subnet mask:
2054 CONFIG_NETMASK
2055
2056 Defines a default value for the subnet mask (or
2057 routing prefix) which is used to determine if an IP
2058 address belongs to the local subnet or needs to be
2059 forwarded through a router.
2060 (Environment variable "netmask")
2061
David Updegraff7280da72007-06-11 10:41:07 -05002062- Multicast TFTP Mode:
2063 CONFIG_MCAST_TFTP
2064
2065 Defines whether you want to support multicast TFTP as per
2066 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002067 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002068 driver in use must provide a function: mcast() to join/leave a
2069 multicast group.
2070
wdenkc6097192002-11-03 00:24:07 +00002071- BOOTP Recovery Mode:
2072 CONFIG_BOOTP_RANDOM_DELAY
2073
2074 If you have many targets in a network that try to
2075 boot using BOOTP, you may want to avoid that all
2076 systems send out BOOTP requests at precisely the same
2077 moment (which would happen for instance at recovery
2078 from a power failure, when all systems will try to
2079 boot, thus flooding the BOOTP server. Defining
2080 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2081 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002082 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002083
2084 1st BOOTP request: delay 0 ... 1 sec
2085 2nd BOOTP request: delay 0 ... 2 sec
2086 3rd BOOTP request: delay 0 ... 4 sec
2087 4th and following
2088 BOOTP requests: delay 0 ... 8 sec
2089
Thierry Reding8977cda2014-08-19 10:21:24 +02002090 CONFIG_BOOTP_ID_CACHE_SIZE
2091
2092 BOOTP packets are uniquely identified using a 32-bit ID. The
2093 server will copy the ID from client requests to responses and
2094 U-Boot will use this to determine if it is the destination of
2095 an incoming response. Some servers will check that addresses
2096 aren't in use before handing them out (usually using an ARP
2097 ping) and therefore take up to a few hundred milliseconds to
2098 respond. Network congestion may also influence the time it
2099 takes for a response to make it back to the client. If that
2100 time is too long, U-Boot will retransmit requests. In order
2101 to allow earlier responses to still be accepted after these
2102 retransmissions, U-Boot's BOOTP client keeps a small cache of
2103 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2104 cache. The default is to keep IDs for up to four outstanding
2105 requests. Increasing this will allow U-Boot to accept offers
2106 from a BOOTP client in networks with unusually high latency.
2107
stroesee0aadfb2003-08-28 14:17:32 +00002108- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002109 You can fine tune the DHCP functionality by defining
2110 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002111
Jon Loeliger5336a762007-07-09 22:08:34 -05002112 CONFIG_BOOTP_SUBNETMASK
2113 CONFIG_BOOTP_GATEWAY
2114 CONFIG_BOOTP_HOSTNAME
2115 CONFIG_BOOTP_NISDOMAIN
2116 CONFIG_BOOTP_BOOTPATH
2117 CONFIG_BOOTP_BOOTFILESIZE
2118 CONFIG_BOOTP_DNS
2119 CONFIG_BOOTP_DNS2
2120 CONFIG_BOOTP_SEND_HOSTNAME
2121 CONFIG_BOOTP_NTPSERVER
2122 CONFIG_BOOTP_TIMEOFFSET
2123 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002124 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002125
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002126 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2127 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002128
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002129 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2130 after the configured retry count, the call will fail
2131 instead of starting over. This can be used to fail over
2132 to Link-local IP address configuration if the DHCP server
2133 is not available.
2134
stroesee0aadfb2003-08-28 14:17:32 +00002135 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2136 serverip from a DHCP server, it is possible that more
2137 than one DNS serverip is offered to the client.
2138 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2139 serverip will be stored in the additional environment
2140 variable "dnsip2". The first DNS serverip is always
2141 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002142 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002143
2144 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2145 to do a dynamic update of a DNS server. To do this, they
2146 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002147 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002148 of the "hostname" environment variable is passed as
2149 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002150
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002151 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2152
2153 A 32bit value in microseconds for a delay between
2154 receiving a "DHCP Offer" and sending the "DHCP Request".
2155 This fixes a problem with certain DHCP servers that don't
2156 respond 100% of the time to a "DHCP request". E.g. On an
2157 AT91RM9200 processor running at 180MHz, this delay needed
2158 to be *at least* 15,000 usec before a Windows Server 2003
2159 DHCP server would reply 100% of the time. I recommend at
2160 least 50,000 usec to be safe. The alternative is to hope
2161 that one of the retries will be successful but note that
2162 the DHCP timeout and retry process takes a longer than
2163 this delay.
2164
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002165 - Link-local IP address negotiation:
2166 Negotiate with other link-local clients on the local network
2167 for an address that doesn't require explicit configuration.
2168 This is especially useful if a DHCP server cannot be guaranteed
2169 to exist in all environments that the device must operate.
2170
2171 See doc/README.link-local for more information.
2172
wdenk145d2c12004-04-15 21:48:45 +00002173 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002174 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002175
2176 The device id used in CDP trigger frames.
2177
2178 CONFIG_CDP_DEVICE_ID_PREFIX
2179
2180 A two character string which is prefixed to the MAC address
2181 of the device.
2182
2183 CONFIG_CDP_PORT_ID
2184
2185 A printf format string which contains the ascii name of
2186 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002187 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002188
2189 CONFIG_CDP_CAPABILITIES
2190
2191 A 32bit integer which indicates the device capabilities;
2192 0x00000010 for a normal host which does not forwards.
2193
2194 CONFIG_CDP_VERSION
2195
2196 An ascii string containing the version of the software.
2197
2198 CONFIG_CDP_PLATFORM
2199
2200 An ascii string containing the name of the platform.
2201
2202 CONFIG_CDP_TRIGGER
2203
2204 A 32bit integer sent on the trigger.
2205
2206 CONFIG_CDP_POWER_CONSUMPTION
2207
2208 A 16bit integer containing the power consumption of the
2209 device in .1 of milliwatts.
2210
2211 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2212
2213 A byte containing the id of the VLAN.
2214
wdenkc6097192002-11-03 00:24:07 +00002215- Status LED: CONFIG_STATUS_LED
2216
2217 Several configurations allow to display the current
2218 status using a LED. For instance, the LED will blink
2219 fast while running U-Boot code, stop blinking as
2220 soon as a reply to a BOOTP request was received, and
2221 start blinking slow once the Linux kernel is running
2222 (supported by a status LED driver in the Linux
2223 kernel). Defining CONFIG_STATUS_LED enables this
2224 feature in U-Boot.
2225
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002226 Additional options:
2227
2228 CONFIG_GPIO_LED
2229 The status LED can be connected to a GPIO pin.
2230 In such cases, the gpio_led driver can be used as a
2231 status LED backend implementation. Define CONFIG_GPIO_LED
2232 to include the gpio_led driver in the U-Boot binary.
2233
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002234 CONFIG_GPIO_LED_INVERTED_TABLE
2235 Some GPIO connected LEDs may have inverted polarity in which
2236 case the GPIO high value corresponds to LED off state and
2237 GPIO low value corresponds to LED on state.
2238 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2239 with a list of GPIO LEDs that have inverted polarity.
2240
wdenkc6097192002-11-03 00:24:07 +00002241- CAN Support: CONFIG_CAN_DRIVER
2242
2243 Defining CONFIG_CAN_DRIVER enables CAN driver support
2244 on those systems that support this (optional)
2245 feature, like the TQM8xxL modules.
2246
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002247- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002248
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002249 This enable the NEW i2c subsystem, and will allow you to use
2250 i2c commands at the u-boot command line (as long as you set
2251 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2252 based realtime clock chips or other i2c devices. See
2253 common/cmd_i2c.c for a description of the command line
2254 interface.
2255
2256 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002257 - drivers/i2c/soft_i2c.c:
2258 - activate first bus with CONFIG_SYS_I2C_SOFT define
2259 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2260 for defining speed and slave address
2261 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2262 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2263 for defining speed and slave address
2264 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2265 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2266 for defining speed and slave address
2267 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2268 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2269 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002270
Heiko Schocherf2850742012-10-24 13:48:22 +02002271 - drivers/i2c/fsl_i2c.c:
2272 - activate i2c driver with CONFIG_SYS_I2C_FSL
2273 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2274 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2275 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2276 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002277 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002278 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2279 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2280 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2281 second bus.
2282
Simon Glass026fefb2012-10-30 07:28:53 +00002283 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002284 - activate this driver with CONFIG_SYS_I2C_TEGRA
2285 - This driver adds 4 i2c buses with a fix speed from
2286 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002287
Dirk Eibach42b204f2013-04-25 02:40:01 +00002288 - drivers/i2c/ppc4xx_i2c.c
2289 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2290 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2291 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2292
trema49f40a2013-09-21 18:13:35 +02002293 - drivers/i2c/i2c_mxc.c
2294 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002295 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2296 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2297 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2298 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002299 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2300 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2301 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2302 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2303 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2304 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002305 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2306 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002307 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002308 for speed, and 0 for slave.
2309
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002310 - drivers/i2c/rcar_i2c.c:
2311 - activate this driver with CONFIG_SYS_I2C_RCAR
2312 - This driver adds 4 i2c buses
2313
2314 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2315 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2316 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2317 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2318 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2319 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2320 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2321 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2322 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2323
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002324 - drivers/i2c/sh_i2c.c:
2325 - activate this driver with CONFIG_SYS_I2C_SH
2326 - This driver adds from 2 to 5 i2c buses
2327
2328 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2329 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2330 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2331 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2332 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2333 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2334 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2335 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2336 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2337 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2338 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2339 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002340 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002341
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002342 - drivers/i2c/omap24xx_i2c.c
2343 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2344 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2345 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2346 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2347 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2348 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2349 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2350 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2351 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2352 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2353 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2354
Heiko Schocher465819a2013-11-08 07:30:53 +01002355 - drivers/i2c/zynq_i2c.c
2356 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2357 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2358 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2359
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302360 - drivers/i2c/s3c24x0_i2c.c:
2361 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2362 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2363 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2364 with a fix speed from 100000 and the slave addr 0!
2365
Dirk Eibachb9577432014-07-03 09:28:18 +02002366 - drivers/i2c/ihs_i2c.c
2367 - activate this driver with CONFIG_SYS_I2C_IHS
2368 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2369 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2370 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2371 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2372 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2373 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2374 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2375 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2376 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2377 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2378 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2379 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002380 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2381 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2382 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2383 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2384 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2385 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2386 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2387 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2388 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002389
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002390 additional defines:
2391
2392 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002393 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002394 don't use/have i2c muxes on your i2c bus, this
2395 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2396 omit this define.
2397
2398 CONFIG_SYS_I2C_DIRECT_BUS
2399 define this, if you don't use i2c muxes on your hardware.
2400 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2401 omit this define.
2402
2403 CONFIG_SYS_I2C_MAX_HOPS
2404 define how many muxes are maximal consecutively connected
2405 on one i2c bus. If you not use i2c muxes, omit this
2406 define.
2407
2408 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002409 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002410 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2411 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2412 CONFIG_SYS_NUM_I2C_BUSES = 9:
2413
2414 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2415 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2416 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2417 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2418 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2419 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2420 {1, {I2C_NULL_HOP}}, \
2421 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2422 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2423 }
2424
2425 which defines
2426 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002427 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2428 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2429 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2430 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2431 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002432 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002433 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2434 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002435
2436 If you do not have i2c muxes on your board, omit this define.
2437
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002438- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002439
2440 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2441 provides the following compelling advantages:
2442
2443 - more than one i2c adapter is usable
2444 - approved multibus support
2445 - better i2c mux support
2446
2447 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002448
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002449 These enable legacy I2C serial bus commands. Defining
2450 CONFIG_HARD_I2C will include the appropriate I2C driver
2451 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002452
wdenk21136db2003-07-16 21:53:01 +00002453 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002454 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002455 CONFIG_COMMANDS) and communicate with i2c based realtime
2456 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002457 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002458
Ben Warren45657152006-09-07 16:50:54 -04002459 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002460
wdenk21136db2003-07-16 21:53:01 +00002461 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002462 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002463
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002464 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002465 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002466 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002467 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002468
Peter Tysere4d1abc2010-04-12 22:28:21 -05002469 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002470 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002471 and so its address should therefore be cleared to 0 (See,
2472 eg, MPC823e User's Manual p.16-473). So, set
2473 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002474
Eric Millbrandt12990a42009-09-03 08:09:44 -05002475 CONFIG_SYS_I2C_INIT_MPC5XXX
2476
2477 When a board is reset during an i2c bus transfer
2478 chips might think that the current transfer is still
2479 in progress. Reset the slave devices by sending start
2480 commands until the slave device responds.
2481
wdenk21136db2003-07-16 21:53:01 +00002482 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002483
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002484 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002485 then the following macros need to be defined (examples are
2486 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002487
2488 I2C_INIT
2489
wdenkb9bbd242003-06-30 16:24:52 +00002490 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002491 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002492
wdenk544e9732004-02-06 23:19:44 +00002493 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002494
wdenkc6097192002-11-03 00:24:07 +00002495 I2C_PORT
2496
wdenk4a5c8a72003-03-06 00:02:04 +00002497 (Only for MPC8260 CPU). The I/O port to use (the code
2498 assumes both bits are on the same port). Valid values
2499 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002500
2501 I2C_ACTIVE
2502
2503 The code necessary to make the I2C data line active
2504 (driven). If the data line is open collector, this
2505 define can be null.
2506
wdenkb9bbd242003-06-30 16:24:52 +00002507 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2508
wdenkc6097192002-11-03 00:24:07 +00002509 I2C_TRISTATE
2510
2511 The code necessary to make the I2C data line tri-stated
2512 (inactive). If the data line is open collector, this
2513 define can be null.
2514
wdenkb9bbd242003-06-30 16:24:52 +00002515 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2516
wdenkc6097192002-11-03 00:24:07 +00002517 I2C_READ
2518
York Sun4a598092013-04-01 11:29:11 -07002519 Code that returns true if the I2C data line is high,
2520 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002521
wdenkb9bbd242003-06-30 16:24:52 +00002522 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2523
wdenkc6097192002-11-03 00:24:07 +00002524 I2C_SDA(bit)
2525
York Sun4a598092013-04-01 11:29:11 -07002526 If <bit> is true, sets the I2C data line high. If it
2527 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002528
wdenkb9bbd242003-06-30 16:24:52 +00002529 eg: #define I2C_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002530 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002531 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002532
wdenkc6097192002-11-03 00:24:07 +00002533 I2C_SCL(bit)
2534
York Sun4a598092013-04-01 11:29:11 -07002535 If <bit> is true, sets the I2C clock line high. If it
2536 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002537
wdenkb9bbd242003-06-30 16:24:52 +00002538 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002539 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002540 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002541
wdenkc6097192002-11-03 00:24:07 +00002542 I2C_DELAY
2543
2544 This delay is invoked four times per clock cycle so this
2545 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002546 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002547 like:
2548
wdenkb9bbd242003-06-30 16:24:52 +00002549 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002550
Mike Frysingeree12d542010-07-21 13:38:02 -04002551 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2552
2553 If your arch supports the generic GPIO framework (asm/gpio.h),
2554 then you may alternatively define the two GPIOs that are to be
2555 used as SCL / SDA. Any of the previous I2C_xxx macros will
2556 have GPIO-based defaults assigned to them as appropriate.
2557
2558 You should define these to the GPIO value as given directly to
2559 the generic GPIO functions.
2560
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002561 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002562
wdenk57b2d802003-06-27 21:31:46 +00002563 When a board is reset during an i2c bus transfer
2564 chips might think that the current transfer is still
2565 in progress. On some boards it is possible to access
2566 the i2c SCLK line directly, either by using the
2567 processor pin as a GPIO or by having a second pin
2568 connected to the bus. If this option is defined a
2569 custom i2c_init_board() routine in boards/xxx/board.c
2570 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002571
Richard Retanubundf0149c2010-04-12 15:08:17 -04002572 CONFIG_SYS_I2C_BOARD_LATE_INIT
2573
2574 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2575 defined a custom i2c_board_late_init() routine in
2576 boards/xxx/board.c is run AFTER the operations in i2c_init()
2577 is completed. This callpoint can be used to unreset i2c bus
2578 using CPU i2c controller register accesses for CPUs whose i2c
2579 controller provide such a method. It is called at the end of
2580 i2c_init() to allow i2c_init operations to setup the i2c bus
2581 controller on the CPU (e.g. setting bus speed & slave address).
2582
wdenk0e2bd9c2004-06-06 21:51:03 +00002583 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2584
2585 This option enables configuration of bi_iic_fast[] flags
2586 in u-boot bd_info structure based on u-boot environment
2587 variable "i2cfast". (see also i2cfast)
2588
Ben Warren45657152006-09-07 16:50:54 -04002589 CONFIG_I2C_MULTI_BUS
2590
2591 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002592 must have a controller. At any point in time, only one bus is
2593 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002594 Note that bus numbering is zero-based.
2595
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002596 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002597
2598 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002599 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002600 is set, specify a list of bus-device pairs. Otherwise, specify
2601 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002602
2603 e.g.
2604 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002605 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002606
2607 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2608
Wolfgang Denk092ae952011-10-26 10:21:21 +00002609 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002610 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002611
2612 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2613
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002614 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002615
2616 If defined, then this indicates the I2C bus number for DDR SPD.
2617 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2618
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002619 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002620
2621 If defined, then this indicates the I2C bus number for the RTC.
2622 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2623
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002624 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002625
2626 If defined, then this indicates the I2C bus number for the DTT.
2627 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2628
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002629 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002630
2631 If defined, specifies the I2C address of the DTT device.
2632 If not defined, then U-Boot uses predefined value for
2633 specified DTT device.
2634
Andrew Dyer58c41f92008-12-29 17:36:01 -06002635 CONFIG_SOFT_I2C_READ_REPEATED_START
2636
2637 defining this will force the i2c_read() function in
2638 the soft_i2c driver to perform an I2C repeated start
2639 between writing the address pointer and reading the
2640 data. If this define is omitted the default behaviour
2641 of doing a stop-start sequence will be used. Most I2C
2642 devices can use either method, but some require one or
2643 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002644
wdenkc6097192002-11-03 00:24:07 +00002645- SPI Support: CONFIG_SPI
2646
2647 Enables SPI driver (so far only tested with
2648 SPI EEPROM, also an instance works with Crystal A/D and
2649 D/As on the SACSng board)
2650
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002651 CONFIG_SH_SPI
2652
2653 Enables the driver for SPI controller on SuperH. Currently
2654 only SH7757 is supported.
2655
wdenkc6097192002-11-03 00:24:07 +00002656 CONFIG_SOFT_SPI
2657
wdenk4a5c8a72003-03-06 00:02:04 +00002658 Enables a software (bit-bang) SPI driver rather than
2659 using hardware support. This is a general purpose
2660 driver that only requires three general I/O port pins
2661 (two outputs, one input) to function. If this is
2662 defined, the board configuration must define several
2663 SPI configuration items (port pins to use, etc). For
2664 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002665
Ben Warren7efe9272008-01-16 22:37:35 -05002666 CONFIG_HARD_SPI
2667
2668 Enables a hardware SPI driver for general-purpose reads
2669 and writes. As with CONFIG_SOFT_SPI, the board configuration
2670 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002671 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002672 example, see include/configs/mpc8349emds.h.
2673
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002674 CONFIG_MXC_SPI
2675
2676 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002677 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002678
Heiko Schocherb77c8882014-07-14 10:22:11 +02002679 CONFIG_SYS_SPI_MXC_WAIT
2680 Timeout for waiting until spi transfer completed.
2681 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2682
Matthias Fuchsa4400872007-12-27 17:12:34 +01002683- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002684
Matthias Fuchsa4400872007-12-27 17:12:34 +01002685 Enables FPGA subsystem.
2686
2687 CONFIG_FPGA_<vendor>
2688
2689 Enables support for specific chip vendors.
2690 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002691
Matthias Fuchsa4400872007-12-27 17:12:34 +01002692 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002693
Matthias Fuchsa4400872007-12-27 17:12:34 +01002694 Enables support for FPGA family.
2695 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2696
2697 CONFIG_FPGA_COUNT
2698
2699 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002700
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302701 CONFIG_CMD_FPGA_LOADMK
2702
2703 Enable support for fpga loadmk command
2704
Michal Simek64c70982014-05-02 13:43:39 +02002705 CONFIG_CMD_FPGA_LOADP
2706
2707 Enable support for fpga loadp command - load partial bitstream
2708
2709 CONFIG_CMD_FPGA_LOADBP
2710
2711 Enable support for fpga loadbp command - load partial bitstream
2712 (Xilinx only)
2713
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002714 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002715
wdenk57b2d802003-06-27 21:31:46 +00002716 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002717
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002718 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002719
wdenk4a5c8a72003-03-06 00:02:04 +00002720 Enable checks on FPGA configuration interface busy
2721 status by the configuration function. This option
2722 will require a board or device specific function to
2723 be written.
wdenkc6097192002-11-03 00:24:07 +00002724
2725 CONFIG_FPGA_DELAY
2726
2727 If defined, a function that provides delays in the FPGA
2728 configuration driver.
2729
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002730 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002731 Allow Control-C to interrupt FPGA configuration
2732
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002733 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002734
wdenk4a5c8a72003-03-06 00:02:04 +00002735 Check for configuration errors during FPGA bitfile
2736 loading. For example, abort during Virtex II
2737 configuration if the INIT_B line goes low (which
2738 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002739
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002740 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002741
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002742 Maximum time to wait for the INIT_B line to de-assert
2743 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002744 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002745 ms.
wdenkc6097192002-11-03 00:24:07 +00002746
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002747 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002748
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002749 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002750 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002751
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002752 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002753
wdenk4a5c8a72003-03-06 00:02:04 +00002754 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002755 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002756
2757- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002758 CONFIG_BUILD_TARGET
2759
2760 Some SoCs need special image types (e.g. U-Boot binary
2761 with a special header) as build targets. By defining
2762 CONFIG_BUILD_TARGET in the SoC / board header, this
2763 special image will be automatically built upon calling
2764 make / MAKEALL.
2765
wdenkc6097192002-11-03 00:24:07 +00002766 CONFIG_IDENT_STRING
2767
wdenk4a5c8a72003-03-06 00:02:04 +00002768 If defined, this string will be added to the U-Boot
2769 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002770
2771- Vendor Parameter Protection:
2772
wdenk4a5c8a72003-03-06 00:02:04 +00002773 U-Boot considers the values of the environment
2774 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002775 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002776 are set once by the board vendor / manufacturer, and
2777 protects these variables from casual modification by
2778 the user. Once set, these variables are read-only,
2779 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002780 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002781
2782 If CONFIG_ENV_OVERWRITE is #defined in your config
2783 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002784 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002785 these parameters.
2786
Joe Hershberger76f353e2015-05-04 14:55:14 -05002787 Alternatively, if you define _both_ an ethaddr in the
2788 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002789 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002790 which can be changed exactly ONCE by the user. [The
2791 serial# is unaffected by this, i. e. it remains
2792 read-only.]
2793
Joe Hershberger71497d02012-12-11 22:16:31 -06002794 The same can be accomplished in a more flexible way
2795 for any variable by configuring the type of access
2796 to allow for those variables in the ".flags" variable
2797 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2798
wdenkc6097192002-11-03 00:24:07 +00002799- Protected RAM:
2800 CONFIG_PRAM
2801
2802 Define this variable to enable the reservation of
2803 "protected RAM", i. e. RAM which is not overwritten
2804 by U-Boot. Define CONFIG_PRAM to hold the number of
2805 kB you want to reserve for pRAM. You can overwrite
2806 this default value by defining an environment
2807 variable "pram" to the number of kB you want to
2808 reserve. Note that the board info structure will
2809 still show the full amount of RAM. If pRAM is
2810 reserved, a new environment variable "mem" will
2811 automatically be defined to hold the amount of
2812 remaining RAM in a form that can be passed as boot
2813 argument to Linux, for instance like that:
2814
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002815 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002816 saveenv
2817
2818 This way you can tell Linux not to use this memory,
2819 either, which results in a memory region that will
2820 not be affected by reboots.
2821
2822 *WARNING* If your board configuration uses automatic
2823 detection of the RAM size, you must make sure that
2824 this memory test is non-destructive. So far, the
2825 following board configurations are known to be
2826 "pRAM-clean":
2827
Wolfgang Denk90326762012-10-24 02:36:15 +00002828 IVMS8, IVML24, SPD8xx, TQM8xxL,
2829 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002830 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002831
Gabe Blacka2f3a932012-12-02 04:55:18 +00002832- Access to physical memory region (> 4GB)
2833 Some basic support is provided for operations on memory not
2834 normally accessible to U-Boot - e.g. some architectures
2835 support access to more than 4GB of memory on 32-bit
2836 machines using physical address extension or similar.
2837 Define CONFIG_PHYSMEM to access this basic support, which
2838 currently only supports clearing the memory.
2839
wdenkc6097192002-11-03 00:24:07 +00002840- Error Recovery:
2841 CONFIG_PANIC_HANG
2842
2843 Define this variable to stop the system in case of a
2844 fatal error, so that you have to reset it manually.
2845 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002846 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002847 automatically as fast as possible, but it may be
2848 useful during development since you can try to debug
2849 the conditions that lead to the situation.
2850
2851 CONFIG_NET_RETRY_COUNT
2852
wdenk4a5c8a72003-03-06 00:02:04 +00002853 This variable defines the number of retries for
2854 network operations like ARP, RARP, TFTP, or BOOTP
2855 before giving up the operation. If not defined, a
2856 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002857
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002858 CONFIG_ARP_TIMEOUT
2859
2860 Timeout waiting for an ARP reply in milliseconds.
2861
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002862 CONFIG_NFS_TIMEOUT
2863
2864 Timeout in milliseconds used in NFS protocol.
2865 If you encounter "ERROR: Cannot umount" in nfs command,
2866 try longer timeout such as
2867 #define CONFIG_NFS_TIMEOUT 10000UL
2868
wdenkc6097192002-11-03 00:24:07 +00002869- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002870 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002871
2872 Enable auto completion of commands using TAB.
2873
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002874 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002875
2876 This defines the secondary prompt string, which is
2877 printed when the command interpreter needs more input
2878 to complete a command. Usually "> ".
2879
2880 Note:
2881
wdenk57b2d802003-06-27 21:31:46 +00002882 In the current implementation, the local variables
2883 space and global environment variables space are
2884 separated. Local variables are those you define by
2885 simply typing `name=value'. To access a local
2886 variable later on, you have write `$name' or
2887 `${name}'; to execute the contents of a variable
2888 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002889
wdenk4a5c8a72003-03-06 00:02:04 +00002890 Global environment variables are those you use
2891 setenv/printenv to work with. To run a command stored
2892 in such a variable, you need to use the run command,
2893 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002894
2895 To store commands and special characters in a
2896 variable, please use double quotation marks
2897 surrounding the whole text of the variable, instead
2898 of the backslashes before semicolons and special
2899 symbols.
2900
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002901- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002902 CONFIG_CMDLINE_EDITING
2903
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002904 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002905 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002906
Marek Vasut734fb042016-01-27 04:47:55 +01002907- Command Line PS1/PS2 support:
2908 CONFIG_CMDLINE_PS_SUPPORT
2909
2910 Enable support for changing the command prompt string
2911 at run-time. Only static string is supported so far.
2912 The string is obtained from environment variables PS1
2913 and PS2.
2914
wdenkc0aa5c52003-12-06 19:49:23 +00002915- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002916 CONFIG_EXTRA_ENV_SETTINGS
2917
wdenk4a5c8a72003-03-06 00:02:04 +00002918 Define this to contain any number of null terminated
2919 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002920 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002921
wdenk4a5c8a72003-03-06 00:02:04 +00002922 For example, place something like this in your
2923 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002924
2925 #define CONFIG_EXTRA_ENV_SETTINGS \
2926 "myvar1=value1\0" \
2927 "myvar2=value2\0"
2928
wdenk4a5c8a72003-03-06 00:02:04 +00002929 Warning: This method is based on knowledge about the
2930 internal format how the environment is stored by the
2931 U-Boot code. This is NOT an official, exported
2932 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002933 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002934 You better know what you are doing here.
2935
wdenk4a5c8a72003-03-06 00:02:04 +00002936 Note: overly (ab)use of the default environment is
2937 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002938 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002939 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002940
Stephen Warren1465d5f2012-05-22 09:21:54 +00002941 CONFIG_ENV_VARS_UBOOT_CONFIG
2942
2943 Define this in order to add variables describing the
2944 U-Boot build configuration to the default environment.
2945 These will be named arch, cpu, board, vendor, and soc.
2946
2947 Enabling this option will cause the following to be defined:
2948
2949 - CONFIG_SYS_ARCH
2950 - CONFIG_SYS_CPU
2951 - CONFIG_SYS_BOARD
2952 - CONFIG_SYS_VENDOR
2953 - CONFIG_SYS_SOC
2954
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002955 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2956
2957 Define this in order to add variables describing certain
2958 run-time determined information about the hardware to the
2959 environment. These will be named board_name, board_rev.
2960
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002961 CONFIG_DELAY_ENVIRONMENT
2962
2963 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002964 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002965 that so that the environment is not available until
2966 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2967 this is instead controlled by the value of
2968 /config/load-environment.
2969
Chris Packham2216ddb2015-06-19 20:25:59 +12002970- Parallel Flash support:
2971 CONFIG_SYS_NO_FLASH
2972
Bin Meng75574052016-02-05 19:30:11 -08002973 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham2216ddb2015-06-19 20:25:59 +12002974 flash. This option is used to disable support for parallel NOR
2975 flash. This option should be defined if the board does not have
2976 parallel flash.
2977
2978 If this option is not defined one of the generic flash drivers
2979 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2980 selected or the board must provide an implementation of the
2981 flash API (see include/flash.h).
2982
wdenkc0aa5c52003-12-06 19:49:23 +00002983- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002984 CONFIG_HAS_DATAFLASH
2985
wdenk57b2d802003-06-27 21:31:46 +00002986 Defining this option enables DataFlash features and
2987 allows to read/write in Dataflash via the standard
2988 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002989
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002990- Serial Flash support
2991 CONFIG_CMD_SF
2992
2993 Defining this option enables SPI flash commands
2994 'sf probe/read/write/erase/update'.
2995
2996 Usage requires an initial 'probe' to define the serial
2997 flash parameters, followed by read/write/erase/update
2998 commands.
2999
3000 The following defaults may be provided by the platform
3001 to handle the common case when only a single serial
3002 flash is present on the system.
3003
3004 CONFIG_SF_DEFAULT_BUS Bus identifier
3005 CONFIG_SF_DEFAULT_CS Chip-select
3006 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3007 CONFIG_SF_DEFAULT_SPEED in Hz
3008
Simon Glass4b5545e2012-10-08 13:16:02 +00003009 CONFIG_CMD_SF_TEST
3010
3011 Define this option to include a destructive SPI flash
3012 test ('sf test').
3013
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303014 CONFIG_SF_DUAL_FLASH Dual flash memories
3015
3016 Define this option to use dual flash support where two flash
3017 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003018 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303019
wdenkef893942004-02-23 16:11:30 +00003020- SystemACE Support:
3021 CONFIG_SYSTEMACE
3022
3023 Adding this option adds support for Xilinx SystemACE
3024 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003025 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003026 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003027
3028 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003029 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003030
3031 When SystemACE support is added, the "ace" device type
3032 becomes available to the fat commands, i.e. fatls.
3033
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003034- TFTP Fixed UDP Port:
3035 CONFIG_TFTP_PORT
3036
Wolfgang Denk227b5192005-09-24 23:25:46 +02003037 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003038 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003039 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003040 number generator is used.
3041
Wolfgang Denk227b5192005-09-24 23:25:46 +02003042 Also, the environment variable tftpdstp is used to supply
3043 the TFTP UDP destination port value. If tftpdstp isn't
3044 defined, the normal port 69 is used.
3045
3046 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003047 blindly start the TFTP transfer using the pre-configured
3048 target IP address and UDP port. This has the effect of
3049 "punching through" the (Windows XP) firewall, allowing
3050 the remainder of the TFTP transfer to proceed normally.
3051 A better solution is to properly configure the firewall,
3052 but sometimes that is not allowed.
3053
Simon Glass058bb8d2012-12-05 14:46:38 +00003054- Hashing support:
3055 CONFIG_CMD_HASH
3056
3057 This enables a generic 'hash' command which can produce
3058 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3059
3060 CONFIG_HASH_VERIFY
3061
3062 Enable the hash verify command (hash -v). This adds to code
3063 size a little.
3064
gaurav ranaef201592015-02-20 12:51:46 +05303065 CONFIG_SHA1 - This option enables support of hashing using SHA1
3066 algorithm. The hash is calculated in software.
3067 CONFIG_SHA256 - This option enables support of hashing using
3068 SHA256 algorithm. The hash is calculated in software.
3069 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3070 for SHA1/SHA256 hashing.
3071 This affects the 'hash' command and also the
3072 hash_lookup_algo() function.
3073 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3074 hardware-acceleration for SHA1/SHA256 progressive hashing.
3075 Data can be streamed in a block at a time and the hashing
3076 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003077
3078 Note: There is also a sha1sum command, which should perhaps
3079 be deprecated in favour of 'hash sha1'.
3080
Robert Winkler765ccf42013-07-24 17:57:06 -07003081- Freescale i.MX specific commands:
3082 CONFIG_CMD_HDMIDETECT
3083 This enables 'hdmidet' command which returns true if an
3084 HDMI monitor is detected. This command is i.MX 6 specific.
3085
3086 CONFIG_CMD_BMODE
3087 This enables the 'bmode' (bootmode) command for forcing
3088 a boot from specific media.
3089
3090 This is useful for forcing the ROM's usb downloader to
3091 activate upon a watchdog reset which is nice when iterating
3092 on U-Boot. Using the reset button or running bmode normal
3093 will set it back to normal. This command currently
3094 supports i.MX53 and i.MX6.
3095
Simon Glass35191a32013-06-13 15:10:02 -07003096- Signing support:
3097 CONFIG_RSA
3098
3099 This enables the RSA algorithm used for FIT image verification
Detlev Zundel49dc73b2014-01-20 16:21:46 +01003100 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass35191a32013-06-13 15:10:02 -07003101
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303102 The Modular Exponentiation algorithm in RSA is implemented using
3103 driver model. So CONFIG_DM needs to be enabled by default for this
3104 library to function.
3105
Simon Glass35191a32013-06-13 15:10:02 -07003106 The signing part is build into mkimage regardless of this
Ruchika Guptaa0d3ca62015-01-23 16:01:54 +05303107 option. The software based modular exponentiation is built into
3108 mkimage irrespective of this option.
Simon Glass35191a32013-06-13 15:10:02 -07003109
Heiko Schocher443ca402014-01-25 07:27:13 +01003110- bootcount support:
3111 CONFIG_BOOTCOUNT_LIMIT
3112
3113 This enables the bootcounter support, see:
3114 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3115
3116 CONFIG_AT91SAM9XE
3117 enable special bootcounter support on at91sam9xe based boards.
3118 CONFIG_BLACKFIN
3119 enable special bootcounter support on blackfin based boards.
3120 CONFIG_SOC_DA8XX
3121 enable special bootcounter support on da850 based boards.
3122 CONFIG_BOOTCOUNT_RAM
3123 enable support for the bootcounter in RAM
3124 CONFIG_BOOTCOUNT_I2C
3125 enable support for the bootcounter on an i2c (like RTC) device.
3126 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3127 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3128 the bootcounter.
3129 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003130
wdenkc0aa5c52003-12-06 19:49:23 +00003131- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003132 CONFIG_SHOW_BOOT_PROGRESS
3133
wdenk4a5c8a72003-03-06 00:02:04 +00003134 Defining this option allows to add some board-
3135 specific code (calling a user-provided function
3136 "show_boot_progress(int)") that enables you to show
3137 the system's boot progress on some display (for
3138 example, some LED's) on your board. At the moment,
3139 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003140
Simon Glass0fa36a42012-09-28 08:56:37 +00003141
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003142Legacy uImage format:
3143
wdenkc6097192002-11-03 00:24:07 +00003144 Arg Where When
3145 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003146 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003147 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003148 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003149 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003150 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003151 4 common/cmd_bootm.c Image data has correct checksum
3152 -4 common/cmd_bootm.c Image is for unsupported architecture
3153 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003154 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003155 6 common/cmd_bootm.c Image Type check OK
3156 -6 common/cmd_bootm.c gunzip uncompression error
3157 -7 common/cmd_bootm.c Unimplemented compression type
3158 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003159 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003160 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003161
3162 9 common/image.c Start initial ramdisk verification
3163 -10 common/image.c Ramdisk header has bad magic number
3164 -11 common/image.c Ramdisk header has bad checksum
3165 10 common/image.c Ramdisk header is OK
3166 -12 common/image.c Ramdisk data has bad checksum
3167 11 common/image.c Ramdisk data has correct checksum
3168 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003169 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003170 13 common/image.c Start multifile image verification
3171 14 common/image.c No initial ramdisk, no multifile, continue.
3172
Wolfgang Denk092ae952011-10-26 10:21:21 +00003173 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003174
Stefan Roese88fbf932010-04-15 16:07:28 +02003175 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003176 -31 post/post.c POST test failed, detected by post_output_backlog()
3177 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003178
Heiko Schocher633e03a2007-06-22 19:11:54 +02003179 34 common/cmd_doc.c before loading a Image from a DOC device
3180 -35 common/cmd_doc.c Bad usage of "doc" command
3181 35 common/cmd_doc.c correct usage of "doc" command
3182 -36 common/cmd_doc.c No boot device
3183 36 common/cmd_doc.c correct boot device
3184 -37 common/cmd_doc.c Unknown Chip ID on boot device
3185 37 common/cmd_doc.c correct chip ID found, device available
3186 -38 common/cmd_doc.c Read Error on boot device
3187 38 common/cmd_doc.c reading Image header from DOC device OK
3188 -39 common/cmd_doc.c Image header has bad magic number
3189 39 common/cmd_doc.c Image header has correct magic number
3190 -40 common/cmd_doc.c Error reading Image from DOC device
3191 40 common/cmd_doc.c Image header has correct magic number
3192 41 common/cmd_ide.c before loading a Image from a IDE device
3193 -42 common/cmd_ide.c Bad usage of "ide" command
3194 42 common/cmd_ide.c correct usage of "ide" command
3195 -43 common/cmd_ide.c No boot device
3196 43 common/cmd_ide.c boot device found
3197 -44 common/cmd_ide.c Device not available
3198 44 common/cmd_ide.c Device available
3199 -45 common/cmd_ide.c wrong partition selected
3200 45 common/cmd_ide.c partition selected
3201 -46 common/cmd_ide.c Unknown partition table
3202 46 common/cmd_ide.c valid partition table found
3203 -47 common/cmd_ide.c Invalid partition type
3204 47 common/cmd_ide.c correct partition type
3205 -48 common/cmd_ide.c Error reading Image Header on boot device
3206 48 common/cmd_ide.c reading Image Header from IDE device OK
3207 -49 common/cmd_ide.c Image header has bad magic number
3208 49 common/cmd_ide.c Image header has correct magic number
3209 -50 common/cmd_ide.c Image header has bad checksum
3210 50 common/cmd_ide.c Image header has correct checksum
3211 -51 common/cmd_ide.c Error reading Image from IDE device
3212 51 common/cmd_ide.c reading Image from IDE device OK
3213 52 common/cmd_nand.c before loading a Image from a NAND device
3214 -53 common/cmd_nand.c Bad usage of "nand" command
3215 53 common/cmd_nand.c correct usage of "nand" command
3216 -54 common/cmd_nand.c No boot device
3217 54 common/cmd_nand.c boot device found
3218 -55 common/cmd_nand.c Unknown Chip ID on boot device
3219 55 common/cmd_nand.c correct chip ID found, device available
3220 -56 common/cmd_nand.c Error reading Image Header on boot device
3221 56 common/cmd_nand.c reading Image Header from NAND device OK
3222 -57 common/cmd_nand.c Image header has bad magic number
3223 57 common/cmd_nand.c Image header has correct magic number
3224 -58 common/cmd_nand.c Error reading Image from NAND device
3225 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003226
Heiko Schocher633e03a2007-06-22 19:11:54 +02003227 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003228
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003229 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003230 -64 net/eth.c no Ethernet found.
3231 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003232
Heiko Schocher633e03a2007-06-22 19:11:54 +02003233 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003234 80 common/cmd_net.c before calling net_loop()
3235 -81 common/cmd_net.c some error in net_loop() occurred
3236 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003237 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3238 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003239 83 common/cmd_net.c running "source" command
3240 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003241 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003242
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003243FIT uImage format:
3244
3245 Arg Where When
3246 100 common/cmd_bootm.c Kernel FIT Image has correct format
3247 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3248 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3249 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3250 102 common/cmd_bootm.c Kernel unit name specified
3251 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003252 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003253 104 common/cmd_bootm.c Got kernel subimage node offset
3254 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3255 105 common/cmd_bootm.c Kernel subimage hash verification OK
3256 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3257 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003258 -106 common/cmd_bootm.c Kernel subimage has wrong type
3259 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003260 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3261 108 common/cmd_bootm.c Got kernel subimage data/size
3262 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3263 -109 common/cmd_bootm.c Can't get kernel subimage type
3264 -110 common/cmd_bootm.c Can't get kernel subimage comp
3265 -111 common/cmd_bootm.c Can't get kernel subimage os
3266 -112 common/cmd_bootm.c Can't get kernel subimage load address
3267 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3268
3269 120 common/image.c Start initial ramdisk verification
3270 -120 common/image.c Ramdisk FIT image has incorrect format
3271 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003272 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003273 -122 common/image.c Can't get configuration for ramdisk subimage
3274 123 common/image.c Ramdisk unit name specified
3275 -124 common/image.c Can't get ramdisk subimage node offset
3276 125 common/image.c Got ramdisk subimage node offset
3277 -125 common/image.c Ramdisk subimage hash verification failed
3278 126 common/image.c Ramdisk subimage hash verification OK
3279 -126 common/image.c Ramdisk subimage for unsupported architecture
3280 127 common/image.c Architecture check OK
3281 -127 common/image.c Can't get ramdisk subimage data/size
3282 128 common/image.c Got ramdisk subimage data/size
3283 129 common/image.c Can't get ramdisk load address
3284 -129 common/image.c Got ramdisk load address
3285
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003286 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003287 131 common/cmd_doc.c FIT image format OK
3288
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003289 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003290 141 common/cmd_ide.c FIT image format OK
3291
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003292 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003293 151 common/cmd_nand.c FIT image format OK
3294
Heiko Schocher515eb122014-05-28 11:33:33 +02003295- legacy image format:
3296 CONFIG_IMAGE_FORMAT_LEGACY
3297 enables the legacy image format support in U-Boot.
3298
3299 Default:
3300 enabled if CONFIG_FIT_SIGNATURE is not defined.
3301
3302 CONFIG_DISABLE_IMAGE_LEGACY
3303 disable the legacy image format
3304
3305 This define is introduced, as the legacy image format is
3306 enabled per default for backward compatibility.
3307
Gabe Blackd572e162012-10-25 16:31:10 +00003308- FIT image support:
3309 CONFIG_FIT
3310 Enable support for the FIT uImage format.
3311
3312 CONFIG_FIT_BEST_MATCH
3313 When no configuration is explicitly selected, default to the
3314 one whose fdt's compatibility field best matches that of
3315 U-Boot itself. A match is considered "best" if it matches the
3316 most specific compatibility entry of U-Boot's fdt's root node.
3317 The order of entries in the configuration's fdt is ignored.
3318
Simon Glass58fe7e52013-06-13 15:10:00 -07003319 CONFIG_FIT_SIGNATURE
3320 This option enables signature verification of FIT uImages,
gaurav ranaef201592015-02-20 12:51:46 +05303321 using a hash signed and verified using RSA. If
3322 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3323 hashing is available using hardware, RSA library will use it.
3324 See doc/uImage.FIT/signature.txt for more details.
Simon Glass58fe7e52013-06-13 15:10:00 -07003325
Heiko Schocher515eb122014-05-28 11:33:33 +02003326 WARNING: When relying on signed FIT images with required
3327 signature check the legacy image format is default
3328 disabled. If a board need legacy image format support
3329 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3330
Dirk Eibach88919ca2014-07-03 09:28:26 +02003331 CONFIG_FIT_DISABLE_SHA256
3332 Supporting SHA256 hashes has quite an impact on binary size.
3333 For constrained systems sha256 hash support can be disabled
3334 with this option.
3335
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003336- Standalone program support:
3337 CONFIG_STANDALONE_LOAD_ADDR
3338
Wolfgang Denk23f78482011-10-09 21:06:34 +02003339 This option defines a board specific value for the
3340 address where standalone program gets loaded, thus
3341 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003342 settings.
3343
3344- Frame Buffer Address:
3345 CONFIG_FB_ADDR
3346
3347 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003348 address for frame buffer. This is typically the case
3349 when using a graphics controller has separate video
3350 memory. U-Boot will then place the frame buffer at
3351 the given address instead of dynamically reserving it
3352 in system RAM by calling lcd_setmem(), which grabs
3353 the memory for the frame buffer depending on the
3354 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003355
3356 Please see board_init_f function.
3357
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003358- Automatic software updates via TFTP server
3359 CONFIG_UPDATE_TFTP
3360 CONFIG_UPDATE_TFTP_CNT_MAX
3361 CONFIG_UPDATE_TFTP_MSEC_MAX
3362
3363 These options enable and control the auto-update feature;
3364 for a more detailed description refer to doc/README.update.
3365
3366- MTD Support (mtdparts command, UBI support)
3367 CONFIG_MTD_DEVICE
3368
3369 Adds the MTD device infrastructure from the Linux kernel.
3370 Needed for mtdparts command support.
3371
3372 CONFIG_MTD_PARTITIONS
3373
3374 Adds the MTD partitioning infrastructure from the Linux
3375 kernel. Needed for UBI support.
3376
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003377- UBI support
3378 CONFIG_CMD_UBI
3379
3380 Adds commands for interacting with MTD partitions formatted
3381 with the UBI flash translation layer
3382
3383 Requires also defining CONFIG_RBTREE
3384
Joe Hershberger47550fc2013-04-08 10:32:49 +00003385 CONFIG_UBI_SILENCE_MSG
3386
3387 Make the verbose messages from UBI stop printing. This leaves
3388 warnings and errors enabled.
3389
Heiko Schocherf5895d12014-06-24 10:10:04 +02003390
3391 CONFIG_MTD_UBI_WL_THRESHOLD
3392 This parameter defines the maximum difference between the highest
3393 erase counter value and the lowest erase counter value of eraseblocks
3394 of UBI devices. When this threshold is exceeded, UBI starts performing
3395 wear leveling by means of moving data from eraseblock with low erase
3396 counter to eraseblocks with high erase counter.
3397
3398 The default value should be OK for SLC NAND flashes, NOR flashes and
3399 other flashes which have eraseblock life-cycle 100000 or more.
3400 However, in case of MLC NAND flashes which typically have eraseblock
3401 life-cycle less than 10000, the threshold should be lessened (e.g.,
3402 to 128 or 256, although it does not have to be power of 2).
3403
3404 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003405
Heiko Schocherf5895d12014-06-24 10:10:04 +02003406 CONFIG_MTD_UBI_BEB_LIMIT
3407 This option specifies the maximum bad physical eraseblocks UBI
3408 expects on the MTD device (per 1024 eraseblocks). If the
3409 underlying flash does not admit of bad eraseblocks (e.g. NOR
3410 flash), this value is ignored.
3411
3412 NAND datasheets often specify the minimum and maximum NVM
3413 (Number of Valid Blocks) for the flashes' endurance lifetime.
3414 The maximum expected bad eraseblocks per 1024 eraseblocks
3415 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3416 which gives 20 for most NANDs (MaxNVB is basically the total
3417 count of eraseblocks on the chip).
3418
3419 To put it differently, if this value is 20, UBI will try to
3420 reserve about 1.9% of physical eraseblocks for bad blocks
3421 handling. And that will be 1.9% of eraseblocks on the entire
3422 NAND chip, not just the MTD partition UBI attaches. This means
3423 that if you have, say, a NAND flash chip admits maximum 40 bad
3424 eraseblocks, and it is split on two MTD partitions of the same
3425 size, UBI will reserve 40 eraseblocks when attaching a
3426 partition.
3427
3428 default: 20
3429
3430 CONFIG_MTD_UBI_FASTMAP
3431 Fastmap is a mechanism which allows attaching an UBI device
3432 in nearly constant time. Instead of scanning the whole MTD device it
3433 only has to locate a checkpoint (called fastmap) on the device.
3434 The on-flash fastmap contains all information needed to attach
3435 the device. Using fastmap makes only sense on large devices where
3436 attaching by scanning takes long. UBI will not automatically install
3437 a fastmap on old images, but you can set the UBI parameter
3438 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3439 that fastmap-enabled images are still usable with UBI implementations
3440 without fastmap support. On typical flash devices the whole fastmap
3441 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3442
3443 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3444 Set this parameter to enable fastmap automatically on images
3445 without a fastmap.
3446 default: 0
3447
Heiko Schocher94b66de2015-10-22 06:19:21 +02003448 CONFIG_MTD_UBI_FM_DEBUG
3449 Enable UBI fastmap debug
3450 default: 0
3451
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003452- UBIFS support
3453 CONFIG_CMD_UBIFS
3454
3455 Adds commands for interacting with UBI volumes formatted as
3456 UBIFS. UBIFS is read-only in u-boot.
3457
3458 Requires UBI support as well as CONFIG_LZO
3459
Joe Hershberger47550fc2013-04-08 10:32:49 +00003460 CONFIG_UBIFS_SILENCE_MSG
3461
3462 Make the verbose messages from UBIFS stop printing. This leaves
3463 warnings and errors enabled.
3464
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003465- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003466 CONFIG_SPL
3467 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003468
Tom Rini36853852012-02-14 07:29:40 +00003469 CONFIG_SPL_LDSCRIPT
3470 LDSCRIPT for linking the SPL binary.
3471
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003472 CONFIG_SPL_MAX_FOOTPRINT
3473 Maximum size in memory allocated to the SPL, BSS included.
3474 When defined, the linker checks that the actual memory
3475 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003476 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003477 must not be both defined at the same time.
3478
Tom Rini36853852012-02-14 07:29:40 +00003479 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003480 Maximum size of the SPL image (text, data, rodata, and
3481 linker lists sections), BSS excluded.
3482 When defined, the linker checks that the actual size does
3483 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003484
Wolfgang Denk825223d2011-09-11 21:24:09 +02003485 CONFIG_SPL_TEXT_BASE
3486 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003487
Scott Woodc4f0d002012-09-20 19:05:12 -05003488 CONFIG_SPL_RELOC_TEXT_BASE
3489 Address to relocate to. If unspecified, this is equal to
3490 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3491
Tom Rini36853852012-02-14 07:29:40 +00003492 CONFIG_SPL_BSS_START_ADDR
3493 Link address for the BSS within the SPL binary.
3494
3495 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003496 Maximum size in memory allocated to the SPL BSS.
3497 When defined, the linker checks that the actual memory used
3498 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003499 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003500 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003501
3502 CONFIG_SPL_STACK
3503 Adress of the start of the stack SPL will use
3504
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003505 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3506 When defined, SPL will panic() if the image it has
3507 loaded does not have a signature.
3508 Defining this is useful when code which loads images
3509 in SPL cannot guarantee that absolutely all read errors
3510 will be caught.
3511 An example is the LPC32XX MLC NAND driver, which will
3512 consider that a completely unreadable NAND block is bad,
3513 and thus should be skipped silently.
3514
Scott Woodc4f0d002012-09-20 19:05:12 -05003515 CONFIG_SPL_RELOC_STACK
3516 Adress of the start of the stack SPL will use after
3517 relocation. If unspecified, this is equal to
3518 CONFIG_SPL_STACK.
3519
Tom Rini36853852012-02-14 07:29:40 +00003520 CONFIG_SYS_SPL_MALLOC_START
3521 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003522 When this option is set the full malloc is used in SPL and
3523 it is set up by spl_init() and before that, the simple malloc()
3524 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003525
3526 CONFIG_SYS_SPL_MALLOC_SIZE
3527 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003528
Tom Rini28591df2012-08-13 12:03:19 -07003529 CONFIG_SPL_FRAMEWORK
3530 Enable the SPL framework under common/. This framework
3531 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3532 NAND loading of the Linux Kernel.
3533
Tom Rinic2b76002014-03-28 12:03:39 -04003534 CONFIG_SPL_OS_BOOT
3535 Enable booting directly to an OS from SPL.
3536 See also: doc/README.falcon
3537
Tom Rinife3b0c72012-08-13 11:37:56 -07003538 CONFIG_SPL_DISPLAY_PRINT
3539 For ARM, enable an optional function to print more information
3540 about the running system.
3541
Scott Wood7c810902012-09-20 16:35:21 -05003542 CONFIG_SPL_INIT_MINIMAL
3543 Arch init code should be built for a very small image
3544
Wolfgang Denk825223d2011-09-11 21:24:09 +02003545 CONFIG_SPL_LIBCOMMON_SUPPORT
3546 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003547
Wolfgang Denk825223d2011-09-11 21:24:09 +02003548 CONFIG_SPL_LIBDISK_SUPPORT
3549 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003550
Wolfgang Denk825223d2011-09-11 21:24:09 +02003551 CONFIG_SPL_I2C_SUPPORT
3552 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003553
Wolfgang Denk825223d2011-09-11 21:24:09 +02003554 CONFIG_SPL_GPIO_SUPPORT
3555 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003556
Wolfgang Denk825223d2011-09-11 21:24:09 +02003557 CONFIG_SPL_MMC_SUPPORT
3558 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003559
Tom Rini36853852012-02-14 07:29:40 +00003560 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3561 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003562 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003563 when the MMC is being used in raw mode.
3564
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003565 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3566 Partition on the MMC to load U-Boot from when the MMC is being
3567 used in raw mode
3568
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003569 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3570 Sector to load kernel uImage from when MMC is being
3571 used in raw mode (for Falcon mode)
3572
3573 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3574 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3575 Sector and number of sectors to load kernel argument
3576 parameters from when MMC is being used in raw mode
3577 (for falcon mode)
3578
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003579 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3580 Partition on the MMC to load U-Boot from when the MMC is being
3581 used in fs mode
3582
Tom Rini36853852012-02-14 07:29:40 +00003583 CONFIG_SPL_FAT_SUPPORT
3584 Support for fs/fat/libfat.o in SPL binary
3585
Guillaume GARDET5065b712014-10-15 17:53:13 +02003586 CONFIG_SPL_EXT_SUPPORT
3587 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003588
Guillaume GARDET5065b712014-10-15 17:53:13 +02003589 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3590 Filename to read to load U-Boot when reading from filesystem
3591
3592 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003593 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003594 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003595
Guillaume GARDET5065b712014-10-15 17:53:13 +02003596 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003597 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003598 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003599
Scott Wood2b36fbb2012-12-06 13:33:17 +00003600 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3601 Set this for NAND SPL on PPC mpc83xx targets, so that
3602 start.S waits for the rest of the SPL to load before
3603 continuing (the hardware starts execution after just
3604 loading the first page rather than the full 4K).
3605
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303606 CONFIG_SPL_SKIP_RELOCATE
3607 Avoid SPL relocation
3608
Scott Woodc352a0c2012-09-20 19:09:07 -05003609 CONFIG_SPL_NAND_BASE
3610 Include nand_base.c in the SPL. Requires
3611 CONFIG_SPL_NAND_DRIVERS.
3612
3613 CONFIG_SPL_NAND_DRIVERS
3614 SPL uses normal NAND drivers, not minimal drivers.
3615
3616 CONFIG_SPL_NAND_ECC
3617 Include standard software ECC in the SPL
3618
Tom Rini36853852012-02-14 07:29:40 +00003619 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003620 Support for NAND boot using simple NAND drivers that
3621 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003622
Tom Rini543c9f12014-03-28 12:03:36 -04003623 CONFIG_SPL_MTD_SUPPORT
3624 Support for the MTD subsystem within SPL. Useful for
3625 environment on NAND support within SPL.
3626
Heiko Schochercf000272014-10-31 08:31:00 +01003627 CONFIG_SPL_NAND_RAW_ONLY
3628 Support to boot only raw u-boot.bin images. Use this only
3629 if you need to save space.
3630
Ying Zhang9ff70262013-08-16 15:16:11 +08003631 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3632 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003633 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003634
Ying Zhangdfb2b152013-08-16 15:16:12 +08003635 CONFIG_SPL_COMMON_INIT_DDR
3636 Set for common ddr init with serial presence detect in
3637 SPL binary.
3638
Tom Rini36853852012-02-14 07:29:40 +00003639 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3640 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3641 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3642 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3643 CONFIG_SYS_NAND_ECCBYTES
3644 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003645 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003646
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303647 CONFIG_SPL_NAND_BOOT
3648 Add support NAND boot
3649
Tom Rini36853852012-02-14 07:29:40 +00003650 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003651 Location in NAND to read U-Boot from
3652
3653 CONFIG_SYS_NAND_U_BOOT_DST
3654 Location in memory to load U-Boot to
3655
3656 CONFIG_SYS_NAND_U_BOOT_SIZE
3657 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003658
3659 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003660 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003661
3662 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3663 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003664 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003665
3666 CONFIG_SPL_OMAP3_ID_NAND
3667 Support for an OMAP3-specific set of functions to return the
3668 ID and MFR of the first attached NAND chip, if present.
3669
Wolfgang Denk825223d2011-09-11 21:24:09 +02003670 CONFIG_SPL_SERIAL_SUPPORT
3671 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003672
Wolfgang Denk825223d2011-09-11 21:24:09 +02003673 CONFIG_SPL_SPI_FLASH_SUPPORT
3674 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003675
Wolfgang Denk825223d2011-09-11 21:24:09 +02003676 CONFIG_SPL_SPI_SUPPORT
3677 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003678
Pavel Machekde997252012-08-30 22:42:11 +02003679 CONFIG_SPL_RAM_DEVICE
3680 Support for running image already present in ram, in SPL binary
3681
Wolfgang Denk825223d2011-09-11 21:24:09 +02003682 CONFIG_SPL_LIBGENERIC_SUPPORT
3683 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003684
Ying Zhang602f7d32013-05-20 14:07:25 +08003685 CONFIG_SPL_ENV_SUPPORT
3686 Support for the environment operating in SPL binary
3687
3688 CONFIG_SPL_NET_SUPPORT
3689 Support for the net/libnet.o in SPL binary.
3690 It conflicts with SPL env from storage medium specified by
3691 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3692
Scott Woodeb7bd972012-12-06 13:33:16 +00003693 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003694 Image offset to which the SPL should be padded before appending
3695 the SPL payload. By default, this is defined as
3696 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3697 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3698 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003699
Scott Woodf147eb72012-09-21 16:27:32 -05003700 CONFIG_SPL_TARGET
3701 Final target image containing SPL and payload. Some SPLs
3702 use an arch-specific makefile fragment instead, for
3703 example if more than one image needs to be produced.
3704
Simon Glass82d94532013-05-08 08:05:59 +00003705 CONFIG_FIT_SPL_PRINT
3706 Printing information about a FIT image adds quite a bit of
3707 code to SPL. So this is normally disabled in SPL. Use this
3708 option to re-enable it. This will affect the output of the
3709 bootm command when booting a FIT image.
3710
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003711- TPL framework
3712 CONFIG_TPL
3713 Enable building of TPL globally.
3714
3715 CONFIG_TPL_PAD_TO
3716 Image offset to which the TPL should be padded before appending
3717 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003718 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3719 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3720 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003721
wdenkc0aa5c52003-12-06 19:49:23 +00003722- Interrupt support (PPC):
3723
wdenk1ebf41e2004-01-02 14:00:00 +00003724 There are common interrupt_init() and timer_interrupt()
3725 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003726 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003727 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003728 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003729 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003730 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003731 specific handling. If board has watchdog / status_led
3732 / other_activity_monitor it works automatically from
3733 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003734
wdenkc6097192002-11-03 00:24:07 +00003735
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003736Board initialization settings:
3737------------------------------
3738
3739During Initialization u-boot calls a number of board specific functions
3740to allow the preparation of board specific prerequisites, e.g. pin setup
3741before drivers are initialized. To enable these callbacks the
3742following configuration macros have to be defined. Currently this is
3743architecture specific, so please check arch/your_architecture/lib/board.c
3744typically in board_init_f() and board_init_r().
3745
3746- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3747- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3748- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3749- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003750
wdenkc6097192002-11-03 00:24:07 +00003751Configuration Settings:
3752-----------------------
3753
York Sun6c480012014-02-26 17:03:19 -08003754- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3755 Optionally it can be defined to support 64-bit memory commands.
3756
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003757- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003758 undefine this when you're short of memory.
3759
Peter Tyserdfb72b82009-01-27 18:03:12 -06003760- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3761 width of the commands listed in the 'help' command output.
3762
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003763- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003764 prompt for user input.
3765
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003766- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003768- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003769
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003770- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003771
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003772- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003773 the application (usually a Linux kernel) when it is
3774 booted
3775
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003776- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003777 List of legal baudrate settings for this board.
3778
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003779- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003780 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003781
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003782- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003783 If the board specific function
3784 extern int overwrite_console (void);
3785 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003786 serial port, else the settings in the environment are used.
3787
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003788- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003789 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003790
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003791- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003792 Enable overwrite of previous console environment settings.
3793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003794- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003795 Begin and End addresses of the area used by the
3796 simple memory test.
3797
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003798- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003799 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003800
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003801- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003802 Scratch address used by the alternate memory test
3803 You only need to set this if address zero isn't writeable
3804
York Sun5d286cd2015-12-04 11:57:07 -08003805- CONFIG_SYS_MEM_RESERVE_SECURE
3806 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3807 is substracted from total RAM and won't be reported to OS.
3808 This memory can be used as secure memory. A variable
3809 gd->secure_ram is used to track the location. In systems
3810 the RAM base is not zero, or RAM is divided into banks,
3811 this variable needs to be recalcuated to get the address.
3812
York Sun50739372015-12-07 11:05:29 -08003813- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003814 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003815 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003816 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003817 fixing up gd->ram_size the Linux kernel should gets passed
3818 the now "corrected" memory size and won't touch it either.
3819 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003820 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003821 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003822 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003823
3824 This option can be used as a workaround for the 440EPx/GRx
3825 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3826 be touched.
3827
3828 WARNING: Please make sure that this value is a multiple of
3829 the Linux page size (normally 4k). If this is not the case,
3830 then the end address of the Linux memory will be located at a
3831 non page size aligned address and this could cause major
3832 problems.
3833
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003834- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003835 Enable temporary baudrate change while serial download
3836
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003837- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003838 Physical start address of SDRAM. _Must_ be 0 here.
3839
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003840- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003841 Physical start address of Motherboard I/O (if using a
3842 Cogent motherboard)
3843
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003844- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003845 Physical start address of Flash memory.
3846
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003847- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003848 Physical start address of boot monitor code (set by
3849 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003850 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003851 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003852
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003853- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003854 Size of memory reserved for monitor code, used to
3855 determine _at_compile_time_ (!) if the environment is
3856 embedded within the U-Boot image, or in a separate
3857 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003858
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003859- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003860 Size of DRAM reserved for malloc() use.
3861
Simon Glass863e4042014-07-10 22:23:28 -06003862- CONFIG_SYS_MALLOC_F_LEN
3863 Size of the malloc() pool for use before relocation. If
3864 this is defined, then a very simple malloc() implementation
3865 will become available before relocation. The address is just
3866 below the global data, and the stack is moved down to make
3867 space.
3868
3869 This feature allocates regions with increasing addresses
3870 within the region. calloc() is supported, but realloc()
3871 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003872 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003873 U-Boot relocates itself.
3874
Simon Glasse997f752014-09-15 06:33:18 -06003875 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003876 at present but is fairly easy to enable for other archs.
3877
Simon Glass9fa901b2014-11-10 17:16:54 -07003878- CONFIG_SYS_MALLOC_SIMPLE
3879 Provides a simple and small malloc() and calloc() for those
3880 boards which do not use the full malloc in SPL (which is
3881 enabled with CONFIG_SYS_SPL_MALLOC_START).
3882
Thierry Redingc97d9742014-12-09 22:25:22 -07003883- CONFIG_SYS_NONCACHED_MEMORY:
3884 Size of non-cached memory area. This area of memory will be
3885 typically located right below the malloc() area and mapped
3886 uncached in the MMU. This is useful for drivers that would
3887 otherwise require a lot of explicit cache maintenance. For
3888 some drivers it's also impossible to properly maintain the
3889 cache. For example if the regions that need to be flushed
3890 are not a multiple of the cache-line size, *and* padding
3891 cannot be allocated between the regions to align them (i.e.
3892 if the HW requires a contiguous array of regions, and the
3893 size of each region is not cache-aligned), then a flush of
3894 one region may result in overwriting data that hardware has
3895 written to another region in the same cache-line. This can
3896 happen for example in network drivers where descriptors for
3897 buffers are typically smaller than the CPU cache-line (e.g.
3898 16 bytes vs. 32 or 64 bytes).
3899
3900 Non-cached memory is only supported on 32-bit ARM at present.
3901
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003902- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003903 Normally compressed uImages are limited to an
3904 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003905 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003906 to adjust this setting to your needs.
3907
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003908- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003909 Maximum size of memory mapped by the startup code of
3910 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003911 the Linux kernel (bd_info, boot arguments, FDT blob if
3912 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003913 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003914 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003915 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003916 variable "bootm_mapsize" will override the value of
3917 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3918 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003919
John Rigbyeea8e692010-10-13 13:57:35 -06003920- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3921 Enable initrd_high functionality. If defined then the
3922 initrd_high feature is enabled and the bootm ramdisk subcommand
3923 is enabled.
3924
3925- CONFIG_SYS_BOOT_GET_CMDLINE:
3926 Enables allocating and saving kernel cmdline in space between
3927 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3928
3929- CONFIG_SYS_BOOT_GET_KBD:
3930 Enables allocating and saving a kernel copy of the bd_info in
3931 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3932
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003933- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003934 Max number of Flash memory banks
3935
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003936- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003937 Max number of sectors on a Flash chip
3938
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003939- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003940 Timeout for Flash erase operations (in ms)
3941
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003942- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003943 Timeout for Flash write operations (in ms)
3944
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003945- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003946 Timeout for Flash set sector lock bit operation (in ms)
3947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003948- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003949 Timeout for Flash clear lock bits operation (in ms)
3950
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003951- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003952 If defined, hardware flash sectors protection is used
3953 instead of U-Boot software protection.
3954
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003955- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003956
3957 Enable TFTP transfers directly to flash memory;
3958 without this option such a download has to be
3959 performed in two steps: (1) download to RAM, and (2)
3960 copy from RAM to flash.
3961
3962 The two-step approach is usually more reliable, since
3963 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003964 the flash, but in some situations (when system RAM is
3965 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003966 downloaded image) this option may be very useful.
3967
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003968- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003969 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003970 common flash structure for storing flash geometry.
3971
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003972- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003973 This option also enables the building of the cfi_flash driver
3974 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003975
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003976- CONFIG_FLASH_CFI_MTD
3977 This option enables the building of the cfi_mtd driver
3978 in the drivers directory. The driver exports CFI flash
3979 to the MTD layer.
3980
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003981- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003982 Use buffered writes to flash.
3983
3984- CONFIG_FLASH_SPANSION_S29WS_N
3985 s29ws-n MirrorBit flash has non-standard addresses for buffered
3986 write commands.
3987
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003988- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003989 If this option is defined, the common CFI flash doesn't
3990 print it's warning upon not recognized FLASH banks. This
3991 is useful, if some of the configured banks are only
3992 optionally available.
3993
Jerry Van Barenaae73572008-03-08 13:48:01 -05003994- CONFIG_FLASH_SHOW_PROGRESS
3995 If defined (must be an integer), print out countdown
3996 digits and dots. Recommended value: 45 (9..1) for 80
3997 column displays, 15 (3..1) for 40 column displays.
3998
Stefan Roesed20cba52013-04-04 15:53:14 +02003999- CONFIG_FLASH_VERIFY
4000 If defined, the content of the flash (destination) is compared
4001 against the source after the write operation. An error message
4002 will be printed when the contents are not identical.
4003 Please note that this option is useless in nearly all cases,
4004 since such flash programming errors usually are detected earlier
4005 while unprotecting/erasing/programming. Please only enable
4006 this option if you really know what you are doing.
4007
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004008- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004009 Defines the number of Ethernet receive buffers. On some
4010 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00004011 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4012 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004013 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00004014 Defaults to 4 if not defined.
4015
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004016- CONFIG_ENV_MAX_ENTRIES
4017
Wolfgang Denk1136f692010-10-27 22:48:30 +02004018 Maximum number of entries in the hash table that is used
4019 internally to store the environment settings. The default
4020 setting is supposed to be generous and should work in most
4021 cases. This setting can be used to tune behaviour; see
4022 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004023
Joe Hershberger71497d02012-12-11 22:16:31 -06004024- CONFIG_ENV_FLAGS_LIST_DEFAULT
4025- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004026 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004027 calling env set. Variables can be restricted to only decimal,
4028 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4029 the variables can also be restricted to IP address or MAC address.
4030
4031 The format of the list is:
4032 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004033 access_attribute = [a|r|o|c]
4034 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004035 entry = variable_name[:attributes]
4036 list = entry[,list]
4037
4038 The type attributes are:
4039 s - String (default)
4040 d - Decimal
4041 x - Hexadecimal
4042 b - Boolean ([1yYtT|0nNfF])
4043 i - IP address
4044 m - MAC address
4045
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004046 The access attributes are:
4047 a - Any (default)
4048 r - Read-only
4049 o - Write-once
4050 c - Change-default
4051
Joe Hershberger71497d02012-12-11 22:16:31 -06004052 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4053 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004054 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004055
4056 - CONFIG_ENV_FLAGS_LIST_STATIC
4057 Define this to a list (string) to define validation that
4058 should be done if an entry is not found in the ".flags"
4059 environment variable. To override a setting in the static
4060 list, simply add an entry for the same variable name to the
4061 ".flags" variable.
4062
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004063 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4064 regular expression. This allows multiple variables to define the same
4065 flags without explicitly listing them for each variable.
4066
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004067- CONFIG_ENV_ACCESS_IGNORE_FORCE
4068 If defined, don't allow the -f switch to env set override variable
4069 access flags.
4070
Simon Glass66828322013-03-08 13:45:27 +00004071- CONFIG_SYS_GENERIC_BOARD
4072 This selects the architecture-generic board system instead of the
4073 architecture-specific board files. It is intended to move boards
4074 to this new framework over time. Defining this will disable the
4075 arch/foo/lib/board.c file and use common/board_f.c and
4076 common/board_r.c instead. To use this option your architecture
Masahiro Yamada9e4af832015-03-19 19:42:51 +09004077 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4078 If you find problems enabling this option on your board please report
4079 the problem and send patches!
Simon Glass66828322013-03-08 13:45:27 +00004080
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004081- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4082 This is set by OMAP boards for the max time that reset should
4083 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004084 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004085
Gabe Black3687fe42014-10-15 04:38:30 -06004086- CONFIG_USE_STDINT
4087 If stdint.h is available with your toolchain you can define this
4088 option to enable it. You can provide option 'USE_STDINT=1' when
4089 building U-Boot to enable this.
4090
wdenkc6097192002-11-03 00:24:07 +00004091The following definitions that deal with the placement and management
4092of environment data (variable area); in general, we support the
4093following configurations:
4094
Mike Frysinger63b8f122011-07-08 10:44:25 +00004095- CONFIG_BUILD_ENVCRC:
4096
4097 Builds up envcrc with the target environment so that external utils
4098 may easily extract it and embed it in final U-Boot images.
4099
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004100- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004101
4102 Define this if the environment is in flash memory.
4103
4104 a) The environment occupies one whole flash sector, which is
4105 "embedded" in the text segment with the U-Boot code. This
4106 happens usually with "bottom boot sector" or "top boot
4107 sector" type flash chips, which have several smaller
4108 sectors at the start or the end. For instance, such a
4109 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4110 such a case you would place the environment in one of the
4111 4 kB sectors - with U-Boot code before and after it. With
4112 "top boot sector" type flash chips, you would put the
4113 environment in one of the last sectors, leaving a gap
4114 between U-Boot and the environment.
4115
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004116 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004117
4118 Offset of environment data (variable area) to the
4119 beginning of flash memory; for instance, with bottom boot
4120 type flash chips the second sector can be used: the offset
4121 for this sector is given here.
4122
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004123 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004124
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004125 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004126
4127 This is just another way to specify the start address of
4128 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004129 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004130
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004131 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004132
4133 Size of the sector containing the environment.
4134
4135
4136 b) Sometimes flash chips have few, equal sized, BIG sectors.
4137 In such a case you don't want to spend a whole sector for
4138 the environment.
4139
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004140 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004141
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004142 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004143 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004144 of this flash sector for the environment. This saves
4145 memory for the RAM copy of the environment.
4146
4147 It may also save flash memory if you decide to use this
4148 when your environment is "embedded" within U-Boot code,
4149 since then the remainder of the flash sector could be used
4150 for U-Boot code. It should be pointed out that this is
4151 STRONGLY DISCOURAGED from a robustness point of view:
4152 updating the environment in flash makes it always
4153 necessary to erase the WHOLE sector. If something goes
4154 wrong before the contents has been restored from a copy in
4155 RAM, your target system will be dead.
4156
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004157 - CONFIG_ENV_ADDR_REDUND
4158 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004159
wdenk4a5c8a72003-03-06 00:02:04 +00004160 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004161 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004162 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004163 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004164
4165BE CAREFUL! Any changes to the flash layout, and some changes to the
4166source code will make it necessary to adapt <board>/u-boot.lds*
4167accordingly!
4168
4169
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004170- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004171
4172 Define this if you have some non-volatile memory device
4173 (NVRAM, battery buffered SRAM) which you want to use for the
4174 environment.
4175
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004176 - CONFIG_ENV_ADDR:
4177 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004178
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004179 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004180 want to use for environment. It is assumed that this memory
4181 can just be read and written to, without any special
4182 provision.
4183
4184BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004185in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004186console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004187U-Boot will hang.
4188
4189Please note that even with NVRAM we still use a copy of the
4190environment in RAM: we could work on NVRAM directly, but we want to
4191keep settings there always unmodified except somebody uses "saveenv"
4192to save the current settings.
4193
4194
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004195- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004196
4197 Use this if you have an EEPROM or similar serial access
4198 device and a driver for it.
4199
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004200 - CONFIG_ENV_OFFSET:
4201 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004202
4203 These two #defines specify the offset and size of the
4204 environment area within the total memory of your EEPROM.
4205
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004206 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004207 If defined, specified the chip address of the EEPROM device.
4208 The default address is zero.
4209
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004210 - CONFIG_SYS_I2C_EEPROM_BUS:
4211 If defined, specified the i2c bus of the EEPROM device.
4212
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004213 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004214 If defined, the number of bits used to address bytes in a
4215 single page in the EEPROM device. A 64 byte page, for example
4216 would require six bits.
4217
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004218 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004219 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004220 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004221
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004222 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004223 The length in bytes of the EEPROM memory array address. Note
4224 that this is NOT the chip address length!
4225
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004226 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004227 EEPROM chips that implement "address overflow" are ones
4228 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4229 address and the extra bits end up in the "chip address" bit
4230 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4231 byte chips.
4232
4233 Note that we consider the length of the address field to
4234 still be one byte because the extra address bits are hidden
4235 in the chip address.
4236
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004237 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004238 The size in bytes of the EEPROM device.
4239
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004240 - CONFIG_ENV_EEPROM_IS_ON_I2C
4241 define this, if you have I2C and SPI activated, and your
4242 EEPROM, which holds the environment, is on the I2C bus.
4243
4244 - CONFIG_I2C_ENV_EEPROM_BUS
4245 if you have an Environment on an EEPROM reached over
4246 I2C muxes, you can define here, how to reach this
4247 EEPROM. For example:
4248
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004249 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004250
4251 EEPROM which holds the environment, is reached over
4252 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004253
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004254- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004255
wdenk1ebf41e2004-01-02 14:00:00 +00004256 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004257 want to use for the environment.
4258
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004259 - CONFIG_ENV_OFFSET:
4260 - CONFIG_ENV_ADDR:
4261 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004262
4263 These three #defines specify the offset and size of the
4264 environment area within the total memory of your DataFlash placed
4265 at the specified address.
4266
Wu, Josh76db7bf2014-07-01 19:30:13 +08004267- CONFIG_ENV_IS_IN_SPI_FLASH:
4268
4269 Define this if you have a SPI Flash memory device which you
4270 want to use for the environment.
4271
4272 - CONFIG_ENV_OFFSET:
4273 - CONFIG_ENV_SIZE:
4274
4275 These two #defines specify the offset and size of the
4276 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4277 aligned to an erase sector boundary.
4278
4279 - CONFIG_ENV_SECT_SIZE:
4280
4281 Define the SPI flash's sector size.
4282
4283 - CONFIG_ENV_OFFSET_REDUND (optional):
4284
4285 This setting describes a second storage area of CONFIG_ENV_SIZE
4286 size used to hold a redundant copy of the environment data, so
4287 that there is a valid backup copy in case there is a power failure
4288 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4289 aligned to an erase sector boundary.
4290
4291 - CONFIG_ENV_SPI_BUS (optional):
4292 - CONFIG_ENV_SPI_CS (optional):
4293
4294 Define the SPI bus and chip select. If not defined they will be 0.
4295
4296 - CONFIG_ENV_SPI_MAX_HZ (optional):
4297
4298 Define the SPI max work clock. If not defined then use 1MHz.
4299
4300 - CONFIG_ENV_SPI_MODE (optional):
4301
4302 Define the SPI work mode. If not defined then use SPI_MODE_3.
4303
Liu Gang85bcd732012-03-08 00:33:20 +00004304- CONFIG_ENV_IS_IN_REMOTE:
4305
4306 Define this if you have a remote memory space which you
4307 want to use for the local device's environment.
4308
4309 - CONFIG_ENV_ADDR:
4310 - CONFIG_ENV_SIZE:
4311
4312 These two #defines specify the address and size of the
4313 environment area within the remote memory space. The
4314 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004315 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004316
4317BE CAREFUL! For some special cases, the local device can not use
4318"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004319environment stored in a remote NOR flash by SRIO or PCIE link,
4320but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004321
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004322- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004323
4324 Define this if you have a NAND device which you want to use
4325 for the environment.
4326
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004327 - CONFIG_ENV_OFFSET:
4328 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004329
4330 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004331 area within the first NAND device. CONFIG_ENV_OFFSET must be
4332 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004333
Scott Wood08239322010-09-17 14:38:37 -05004334 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004335
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004336 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004337 size used to hold a redundant copy of the environment data, so
4338 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004339 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004340 aligned to an erase block boundary.
4341
4342 - CONFIG_ENV_RANGE (optional):
4343
4344 Specifies the length of the region in which the environment
4345 can be written. This should be a multiple of the NAND device's
4346 block size. Specifying a range with more erase blocks than
4347 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4348 the range to be avoided.
4349
4350 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004351
Scott Wood08239322010-09-17 14:38:37 -05004352 Enables support for dynamically retrieving the offset of the
4353 environment from block zero's out-of-band data. The
4354 "nand env.oob" command can be used to record this offset.
4355 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4356 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004357
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004358- CONFIG_NAND_ENV_DST
4359
4360 Defines address in RAM to which the nand_spl code should copy the
4361 environment. If redundant environment is used, it will be copied to
4362 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4363
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004364- CONFIG_ENV_IS_IN_UBI:
4365
4366 Define this if you have an UBI volume that you want to use for the
4367 environment. This has the benefit of wear-leveling the environment
4368 accesses, which is important on NAND.
4369
4370 - CONFIG_ENV_UBI_PART:
4371
4372 Define this to a string that is the mtd partition containing the UBI.
4373
4374 - CONFIG_ENV_UBI_VOLUME:
4375
4376 Define this to the name of the volume that you want to store the
4377 environment in.
4378
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004379 - CONFIG_ENV_UBI_VOLUME_REDUND:
4380
4381 Define this to the name of another volume to store a second copy of
4382 the environment in. This will enable redundant environments in UBI.
4383 It is assumed that both volumes are in the same MTD partition.
4384
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004385 - CONFIG_UBI_SILENCE_MSG
4386 - CONFIG_UBIFS_SILENCE_MSG
4387
4388 You will probably want to define these to avoid a really noisy system
4389 when storing the env in UBI.
4390
Wu, Josha7d0c872014-06-24 17:31:03 +08004391- CONFIG_ENV_IS_IN_FAT:
4392 Define this if you want to use the FAT file system for the environment.
4393
4394 - FAT_ENV_INTERFACE:
4395
4396 Define this to a string that is the name of the block device.
4397
4398 - FAT_ENV_DEV_AND_PART:
4399
4400 Define this to a string to specify the partition of the device. It can
4401 be as following:
4402
4403 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4404 - "D:P": device D partition P. Error occurs if device D has no
4405 partition table.
4406 - "D:0": device D.
4407 - "D" or "D:": device D partition 1 if device D has partition
4408 table, or the whole device D if has no partition
4409 table.
4410 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004411 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004412 partition table then means device D.
4413
4414 - FAT_ENV_FILE:
4415
4416 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004417 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004418
4419 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004420 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004421
Stephen Warreneedcacd2013-06-11 15:14:00 -06004422- CONFIG_ENV_IS_IN_MMC:
4423
4424 Define this if you have an MMC device which you want to use for the
4425 environment.
4426
4427 - CONFIG_SYS_MMC_ENV_DEV:
4428
4429 Specifies which MMC device the environment is stored in.
4430
4431 - CONFIG_SYS_MMC_ENV_PART (optional):
4432
4433 Specifies which MMC partition the environment is stored in. If not
4434 set, defaults to partition 0, the user area. Common values might be
4435 1 (first MMC boot partition), 2 (second MMC boot partition).
4436
4437 - CONFIG_ENV_OFFSET:
4438 - CONFIG_ENV_SIZE:
4439
4440 These two #defines specify the offset and size of the environment
4441 area within the specified MMC device.
4442
Stephen Warren24dc2032013-06-11 15:14:02 -06004443 If offset is positive (the usual case), it is treated as relative to
4444 the start of the MMC partition. If offset is negative, it is treated
4445 as relative to the end of the MMC partition. This can be useful if
4446 your board may be fitted with different MMC devices, which have
4447 different sizes for the MMC partitions, and you always want the
4448 environment placed at the very end of the partition, to leave the
4449 maximum possible space before it, to store other data.
4450
Stephen Warreneedcacd2013-06-11 15:14:00 -06004451 These two values are in units of bytes, but must be aligned to an
4452 MMC sector boundary.
4453
4454 - CONFIG_ENV_OFFSET_REDUND (optional):
4455
4456 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4457 hold a redundant copy of the environment data. This provides a
4458 valid backup copy in case the other copy is corrupted, e.g. due
4459 to a power failure during a "saveenv" operation.
4460
Stephen Warren24dc2032013-06-11 15:14:02 -06004461 This value may also be positive or negative; this is handled in the
4462 same way as CONFIG_ENV_OFFSET.
4463
Stephen Warreneedcacd2013-06-11 15:14:00 -06004464 This value is also in units of bytes, but must also be aligned to
4465 an MMC sector boundary.
4466
4467 - CONFIG_ENV_SIZE_REDUND (optional):
4468
4469 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4470 set. If this value is set, it must be set to the same value as
4471 CONFIG_ENV_SIZE.
4472
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004473- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004474
4475 Defines offset to the initial SPI buffer area in DPRAM. The
4476 area is used at an early stage (ROM part) if the environment
4477 is configured to reside in the SPI EEPROM: We need a 520 byte
4478 scratch DPRAM area. It is used between the two initialization
4479 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4480 to be a good choice since it makes it far enough from the
4481 start of the data area as well as from the stack pointer.
4482
Bruce Adleredecc942007-11-02 13:15:42 -07004483Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004484has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004485created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004486until then to read environment variables.
4487
wdenk8dba0502003-03-31 16:34:49 +00004488The environment is protected by a CRC32 checksum. Before the monitor
4489is relocated into RAM, as a result of a bad CRC you will be working
4490with the compiled-in default environment - *silently*!!! [This is
4491necessary, because the first environment variable we need is the
4492"baudrate" setting for the console - if we have a bad CRC, we don't
4493have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004494
4495Note: once the monitor has been relocated, then it will complain if
4496the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004497use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004498
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004499- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004500 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004501
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004502 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004503 also needs to be defined.
4504
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004505- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004506 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004507
Ron Madriddfa028a2009-02-18 14:30:44 -08004508- CONFIG_NS16550_MIN_FUNCTIONS:
4509 Define this if you desire to only have use of the NS16550_init
4510 and NS16550_putc functions for the serial driver located at
4511 drivers/serial/ns16550.c. This option is useful for saving
4512 space for already greatly restricted images, including but not
4513 limited to NAND_SPL configurations.
4514
Simon Glass28a9e332012-11-30 13:01:18 +00004515- CONFIG_DISPLAY_BOARDINFO
4516 Display information about the board that U-Boot is running on
4517 when U-Boot starts up. The board function checkboard() is called
4518 to do this.
4519
Simon Glasse8822012012-11-30 13:01:19 +00004520- CONFIG_DISPLAY_BOARDINFO_LATE
4521 Similar to the previous option, but display this information
4522 later, once stdio is running and output goes to the LCD, if
4523 present.
4524
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004525- CONFIG_BOARD_SIZE_LIMIT:
4526 Maximum size of the U-Boot image. When defined, the
4527 build system checks that the actual size does not
4528 exceed it.
4529
wdenkc6097192002-11-03 00:24:07 +00004530Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004531---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004532
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004533- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004534 Cache Line Size of the CPU.
4535
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004536- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004537 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004538
wdenk9c53f402003-10-15 23:53:47 +00004539 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4540 and RPXsuper) to be able to adjust the position of
4541 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004542
Timur Tabid8f341c2011-08-04 18:03:41 -05004543- CONFIG_SYS_CCSRBAR_DEFAULT:
4544 Default (power-on reset) physical address of CCSR on Freescale
4545 PowerPC SOCs.
4546
4547- CONFIG_SYS_CCSRBAR:
4548 Virtual address of CCSR. On a 32-bit build, this is typically
4549 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4550
4551 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4552 for cross-platform code that uses that macro instead.
4553
4554- CONFIG_SYS_CCSRBAR_PHYS:
4555 Physical address of CCSR. CCSR can be relocated to a new
4556 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004557 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004558 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4559 is typically relocated on 36-bit builds. It is recommended
4560 that this macro be defined via the _HIGH and _LOW macros:
4561
4562 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4563 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4564
4565- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004566 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4567 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004568 used in assembly code, so it must not contain typecasts or
4569 integer size suffixes (e.g. "ULL").
4570
4571- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4572 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4573 used in assembly code, so it must not contain typecasts or
4574 integer size suffixes (e.g. "ULL").
4575
4576- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4577 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4578 forced to a value that ensures that CCSR is not relocated.
4579
wdenk1272e232002-11-10 22:06:23 +00004580- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004581 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004582
4583 the default drive number (default value 0)
4584
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004585 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004586
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004587 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004588 (default value 1)
4589
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004590 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004591
wdenk4a5c8a72003-03-06 00:02:04 +00004592 defines the offset of register from address. It
4593 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004594 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004595
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004596 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4597 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004598 default value.
wdenk1272e232002-11-10 22:06:23 +00004599
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004600 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004601 fdc_hw_init() is called at the beginning of the FDC
4602 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004603 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004604 initializations.
wdenk1272e232002-11-10 22:06:23 +00004605
Macpaul Lind1e49942011-04-11 20:45:32 +00004606- CONFIG_IDE_AHB:
4607 Most IDE controllers were designed to be connected with PCI
4608 interface. Only few of them were designed for AHB interface.
4609 When software is doing ATA command and data transfer to
4610 IDE devices through IDE-AHB controller, some additional
4611 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004612 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004613
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004614- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004615 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004616 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004617
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004618- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004619
wdenkeb20ad32003-09-05 23:19:14 +00004620 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004621 initial data and stack; please note that this must be
4622 writable memory that is working WITHOUT special
4623 initialization, i. e. you CANNOT use normal RAM which
4624 will become available only after programming the
4625 memory controller and running certain initialization
4626 sequences.
4627
4628 U-Boot uses the following memory types:
4629 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4630 - MPC824X: data cache
4631 - PPC4xx: data cache
4632
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004633- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004634
4635 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004636 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4637 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004638 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004639 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004640 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4641 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4642 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004643
4644 Note:
4645 On the MPC824X (or other systems that use the data
4646 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004647 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004648 point to an otherwise UNUSED address space between
4649 the top of RAM and the start of the PCI space.
4650
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004651- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004652
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004653- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004654
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004655- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004656
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004657- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004658
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004659- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004660
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004661- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004662
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004663- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004664 SDRAM timing
4665
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004666- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004667 periodic timer for refresh
4668
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004669- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004670
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004671- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4672 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4673 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4674 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004675 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4676
4677- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004678 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4679 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004680 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4681
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004682- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4683 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004684 Machine Mode Register and Memory Periodic Timer
4685 Prescaler definitions (SDRAM timing)
4686
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004687- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004688 enable I2C microcode relocation patch (MPC8xx);
4689 define relocation offset in DPRAM [DSP2]
4690
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004691- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004692 enable SMC microcode relocation patch (MPC8xx);
4693 define relocation offset in DPRAM [SMC1]
4694
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004695- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004696 enable SPI microcode relocation patch (MPC8xx);
4697 define relocation offset in DPRAM [SCC4]
4698
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004699- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004700 Use OSCM clock mode on MBX8xx board. Be careful,
4701 wrong setting might damage your board. Read
4702 doc/README.MBX before setting this variable!
4703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004704- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004705 Offset of the bootmode word in DPRAM used by post
4706 (Power On Self Tests). This definition overrides
4707 #define'd default value in commproc.h resp.
4708 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004709
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004710- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4711 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4712 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4713 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4714 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4715 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4716 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4717 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004718 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004719
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004720- CONFIG_PCI_DISABLE_PCIE:
4721 Disable PCI-Express on systems where it is supported but not
4722 required.
4723
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004724- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004725 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004726 Don't do any setup work, presumably because someone or
4727 something has already done it, and we don't need to do it
4728 a second time. Useful for platforms that are pre-booted
4729 by coreboot or similar.
4730
Gabor Juhosb4458732013-05-30 07:06:12 +00004731- CONFIG_PCI_INDIRECT_BRIDGE:
4732 Enable support for indirect PCI bridges.
4733
Kumar Gala8975d7a2010-12-30 12:09:53 -06004734- CONFIG_SYS_SRIO:
4735 Chip has SRIO or not
4736
4737- CONFIG_SRIO1:
4738 Board has SRIO 1 port available
4739
4740- CONFIG_SRIO2:
4741 Board has SRIO 2 port available
4742
Liu Gang27afb9c2013-05-07 16:30:46 +08004743- CONFIG_SRIO_PCIE_BOOT_MASTER
4744 Board can support master function for Boot from SRIO and PCIE
4745
Kumar Gala8975d7a2010-12-30 12:09:53 -06004746- CONFIG_SYS_SRIOn_MEM_VIRT:
4747 Virtual Address of SRIO port 'n' memory region
4748
4749- CONFIG_SYS_SRIOn_MEM_PHYS:
4750 Physical Address of SRIO port 'n' memory region
4751
4752- CONFIG_SYS_SRIOn_MEM_SIZE:
4753 Size of SRIO port 'n' memory region
4754
Fabio Estevamf17e8782013-04-11 09:35:34 +00004755- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4756 Defined to tell the NAND controller that the NAND chip is using
4757 a 16 bit bus.
4758 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004759 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004760 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004761 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004762
4763- CONFIG_SYS_NDFC_EBC0_CFG
4764 Sets the EBC0_CFG register for the NDFC. If not defined
4765 a default value will be used.
4766
Ben Warren45657152006-09-07 16:50:54 -04004767- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004768 Get DDR timing information from an I2C EEPROM. Common
4769 with pluggable memory modules such as SODIMMs
4770
Ben Warren45657152006-09-07 16:50:54 -04004771 SPD_EEPROM_ADDRESS
4772 I2C address of the SPD EEPROM
4773
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004774- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004775 If SPD EEPROM is on an I2C bus other than the first
4776 one, specify here. Note that the value must resolve
4777 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004778
York Sune73cc042011-06-07 09:42:16 +08004779- CONFIG_SYS_DDR_RAW_TIMING
4780 Get DDR timing information from other than SPD. Common with
4781 soldered DDR chips onboard without SPD. DDR raw timing
4782 parameters are extracted from datasheet and hard-coded into
4783 header files or board specific files.
4784
York Sunbd495cf2011-09-16 13:21:35 -07004785- CONFIG_FSL_DDR_INTERACTIVE
4786 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4787
York Sun8ced0502015-01-06 13:18:55 -08004788- CONFIG_FSL_DDR_SYNC_REFRESH
4789 Enable sync of refresh for multiple controllers.
4790
York Sunb6a35f82015-03-19 09:30:28 -07004791- CONFIG_FSL_DDR_BIST
4792 Enable built-in memory test for Freescale DDR controllers.
4793
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004794- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004795 Only for 83xx systems. If specified, then DDR should
4796 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004797
wdenk6203e402004-04-18 10:13:26 +00004798- CONFIG_ETHER_ON_FEC[12]
4799 Define to enable FEC[12] on a 8xx series processor.
4800
4801- CONFIG_FEC[12]_PHY
4802 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004803 to the given FEC; i. e.
4804 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004805 means that the PHY with address 4 is connected to FEC1
4806
4807 When set to -1, means to probe for first available.
4808
4809- CONFIG_FEC[12]_PHY_NORXERR
4810 The PHY does not have a RXERR line (RMII only).
4811 (so program the FEC to ignore it).
4812
4813- CONFIG_RMII
4814 Enable RMII mode for all FECs.
4815 Note that this is a global option, we can't
4816 have one FEC in standard MII mode and another in RMII mode.
4817
wdenk20c98a62004-04-23 20:32:05 +00004818- CONFIG_CRC32_VERIFY
4819 Add a verify option to the crc32 command.
4820 The syntax is:
4821
4822 => crc32 -v <address> <count> <crc32>
4823
4824 Where address/count indicate a memory area
4825 and crc32 is the correct crc32 which the
4826 area should have.
4827
wdenk64519362004-07-11 17:40:54 +00004828- CONFIG_LOOPW
4829 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004830 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004831
stroesecc3af832004-12-16 18:46:55 +00004832- CONFIG_MX_CYCLIC
4833 Add the "mdc" and "mwc" memory commands. These are cyclic
4834 "md/mw" commands.
4835 Examples:
4836
wdenk07d7e6b2004-12-16 21:44:03 +00004837 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004838 This command will print 4 bytes (10,11,12,13) each 500 ms.
4839
wdenk07d7e6b2004-12-16 21:44:03 +00004840 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004841 This command will write 12345678 to address 100 all 10 ms.
4842
wdenk07d7e6b2004-12-16 21:44:03 +00004843 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004844 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004845
wdenk3d3d99f2005-04-04 12:44:11 +00004846- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004847 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004848 low level initializations (like setting up the memory
4849 controller) are omitted and/or U-Boot does not
4850 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004851
Wolfgang Denk302141d2010-11-27 23:30:56 +01004852 Normally this variable MUST NOT be defined. The only
4853 exception is when U-Boot is loaded (to RAM) by some
4854 other boot loader or by a debugger which performs
4855 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004856
Aneesh V552a3192011-07-13 05:11:07 +00004857- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004858 Modifies the behaviour of start.S when compiling a loader
4859 that is executed before the actual U-Boot. E.g. when
4860 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004861
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004862- CONFIG_TPL_BUILD
4863 Modifies the behaviour of start.S when compiling a loader
4864 that is executed after the SPL and before the actual U-Boot.
4865 It is loaded by the SPL.
4866
Ying Zhang0d4f5442013-05-20 14:07:23 +08004867- CONFIG_SYS_MPC85XX_NO_RESETVEC
4868 Only for 85xx systems. If this variable is specified, the section
4869 .resetvec is not kept and the section .bootpg is placed in the
4870 previous 4k of the .text section.
4871
Simon Glass17dabf02013-02-24 17:33:14 +00004872- CONFIG_ARCH_MAP_SYSMEM
4873 Generally U-Boot (and in particular the md command) uses
4874 effective address. It is therefore not necessary to regard
4875 U-Boot address as virtual addresses that need to be translated
4876 to physical addresses. However, sandbox requires this, since
4877 it maintains its own little RAM buffer which contains all
4878 addressable memory. This option causes some memory accesses
4879 to be mapped through map_sysmem() / unmap_sysmem().
4880
Matthias Weisser93416c12011-03-10 21:36:32 +00004881- CONFIG_USE_ARCH_MEMCPY
4882 CONFIG_USE_ARCH_MEMSET
4883 If these options are used a optimized version of memcpy/memset will
4884 be used if available. These functions may be faster under some
4885 conditions but may increase the binary size.
4886
Simon Glassbfb59802013-02-14 04:18:54 +00004887- CONFIG_X86_RESET_VECTOR
4888 If defined, the x86 reset vector code is included. This is not
4889 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004890
Mark Jackson52b003c2013-03-04 01:27:20 +00004891- CONFIG_SYS_MPUCLK
4892 Defines the MPU clock speed (in MHz).
4893
4894 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004895
Heiko Schocher2233e462013-11-04 14:05:00 +01004896- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4897 Enables the RTC32K OSC on AM33xx based plattforms
4898
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004899- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4900 Option to disable subpage write in NAND driver
4901 driver that uses this:
4902 drivers/mtd/nand/davinci_nand.c
4903
Timur Tabi275f4bb2011-11-22 09:21:25 -06004904Freescale QE/FMAN Firmware Support:
4905-----------------------------------
4906
4907The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4908loading of "firmware", which is encoded in the QE firmware binary format.
4909This firmware often needs to be loaded during U-Boot booting, so macros
4910are used to identify the storage device (NOR flash, SPI, etc) and the address
4911within that device.
4912
Zhao Qiang83a90842014-03-21 16:21:44 +08004913- CONFIG_SYS_FMAN_FW_ADDR
4914 The address in the storage device where the FMAN microcode is located. The
4915 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4916 is also specified.
4917
4918- CONFIG_SYS_QE_FW_ADDR
4919 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004920 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4921 is also specified.
4922
4923- CONFIG_SYS_QE_FMAN_FW_LENGTH
4924 The maximum possible size of the firmware. The firmware binary format
4925 has a field that specifies the actual size of the firmware, but it
4926 might not be possible to read any part of the firmware unless some
4927 local storage is allocated to hold the entire firmware first.
4928
4929- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4930 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4931 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4932 virtual address in NOR flash.
4933
4934- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4935 Specifies that QE/FMAN firmware is located in NAND flash.
4936 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4937
4938- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4939 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4940 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4941
4942- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4943 Specifies that QE/FMAN firmware is located on the primary SPI
4944 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4945
Liu Gang1e084582012-03-08 00:33:18 +00004946- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4947 Specifies that QE/FMAN firmware is located in the remote (master)
4948 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004949 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4950 window->master inbound window->master LAW->the ucode address in
4951 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004952
J. German Rivera8ff14b72014-06-23 15:15:55 -07004953Freescale Layerscape Management Complex Firmware Support:
4954---------------------------------------------------------
4955The Freescale Layerscape Management Complex (MC) supports the loading of
4956"firmware".
4957This firmware often needs to be loaded during U-Boot booting, so macros
4958are used to identify the storage device (NOR flash, SPI, etc) and the address
4959within that device.
4960
4961- CONFIG_FSL_MC_ENET
4962 Enable the MC driver for Layerscape SoCs.
4963
4964- CONFIG_SYS_LS_MC_FW_ADDR
4965 The address in the storage device where the firmware is located. The
4966 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4967 is also specified.
4968
4969- CONFIG_SYS_LS_MC_FW_LENGTH
4970 The maximum possible size of the firmware. The firmware binary format
4971 has a field that specifies the actual size of the firmware, but it
4972 might not be possible to read any part of the firmware unless some
4973 local storage is allocated to hold the entire firmware first.
4974
4975- CONFIG_SYS_LS_MC_FW_IN_NOR
4976 Specifies that MC firmware is located in NOR flash, mapped as
4977 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4978 virtual address in NOR flash.
4979
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304980Freescale Layerscape Debug Server Support:
4981-------------------------------------------
4982The Freescale Layerscape Debug Server Support supports the loading of
4983"Debug Server firmware" and triggering SP boot-rom.
4984This firmware often needs to be loaded during U-Boot booting.
4985
4986- CONFIG_FSL_DEBUG_SERVER
4987 Enable the Debug Server for Layerscape SoCs.
4988
4989- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
4990 Define minimum DDR size required for debug server image
4991
York Sun928b6812015-12-07 11:08:58 -08004992- CONFIG_SYS_MC_RSV_MEM_ALIGN
4993 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304994
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004995Reproducible builds
4996-------------------
4997
4998In order to achieve reproducible builds, timestamps used in the U-Boot build
4999process have to be set to a fixed value.
5000
5001This is done using the SOURCE_DATE_EPOCH environment variable.
5002SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
5003option for U-Boot or an environment variable in U-Boot.
5004
5005SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
5006
wdenkc6097192002-11-03 00:24:07 +00005007Building the Software:
5008======================
5009
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005010Building U-Boot has been tested in several native build environments
5011and in many different cross environments. Of course we cannot support
5012all possibly existing versions of cross development tools in all
5013(potentially obsolete) versions. In case of tool chain problems we
5014recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5015which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005016
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005017If you are not using a native environment, it is assumed that you
5018have GNU cross compiling tools available in your path. In this case,
5019you must set the environment variable CROSS_COMPILE in your shell.
5020Note that no changes to the Makefile or any other source files are
5021necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005022
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005023 $ CROSS_COMPILE=ppc_4xx-
5024 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005025
Peter Tyserb06976d2009-03-13 18:54:51 -05005026Note: If you wish to generate Windows versions of the utilities in
5027 the tools directory you can use the MinGW toolchain
5028 (http://www.mingw.org). Set your HOST tools to the MinGW
5029 toolchain and execute 'make tools'. For example:
5030
5031 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5032
5033 Binaries such as tools/mkimage.exe will be created which can
5034 be executed on computers running Windows.
5035
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005036U-Boot is intended to be simple to build. After installing the
5037sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005038is done by typing:
5039
Holger Freyther7ba4e572014-08-04 09:26:05 +02005040 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005041
Holger Freyther7ba4e572014-08-04 09:26:05 +02005042where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005043rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005044
wdenk6c59edc2004-05-03 20:45:30 +00005045Note: for some board special configuration names may exist; check if
5046 additional information is available from the board vendor; for
5047 instance, the TQM823L systems are available without (standard)
5048 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005049 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005050
Holger Freyther7ba4e572014-08-04 09:26:05 +02005051 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005052 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005053
Holger Freyther7ba4e572014-08-04 09:26:05 +02005054 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005055 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005056
wdenk6c59edc2004-05-03 20:45:30 +00005057 etc.
wdenkc6097192002-11-03 00:24:07 +00005058
wdenkc6097192002-11-03 00:24:07 +00005059
wdenk6c59edc2004-05-03 20:45:30 +00005060Finally, type "make all", and you should get some working U-Boot
5061images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005062
wdenk6c59edc2004-05-03 20:45:30 +00005063- "u-boot.bin" is a raw binary image
5064- "u-boot" is an image in ELF binary format
5065- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005066
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005067By default the build is performed locally and the objects are saved
5068in the source directory. One of the two methods can be used to change
5069this behavior and build U-Boot to some external directory:
5070
50711. Add O= to the make command line invocations:
5072
5073 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005074 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005075 make O=/tmp/build all
5076
Timo Ketolac8c67602014-11-06 14:39:05 +020050772. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005078
Timo Ketolac8c67602014-11-06 14:39:05 +02005079 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005080 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005081 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005082 make all
5083
Timo Ketolac8c67602014-11-06 14:39:05 +02005084Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005085variable.
5086
wdenkc6097192002-11-03 00:24:07 +00005087
wdenk6c59edc2004-05-03 20:45:30 +00005088Please be aware that the Makefiles assume you are using GNU make, so
5089for instance on NetBSD you might need to use "gmake" instead of
5090native "make".
wdenkc6097192002-11-03 00:24:07 +00005091
wdenkc6097192002-11-03 00:24:07 +00005092
wdenk6c59edc2004-05-03 20:45:30 +00005093If the system board that you have is not listed, then you will need
5094to port U-Boot to your hardware platform. To do this, follow these
5095steps:
wdenkc6097192002-11-03 00:24:07 +00005096
Phil Sutterc77b4882015-12-25 14:41:18 +010050971. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00005098 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01005099 the "Makefile" and a "<board>.c".
51002. Create a new configuration file "include/configs/<board>.h" for
5101 your board.
wdenk6c59edc2004-05-03 20:45:30 +000051023. If you're porting U-Boot to a new CPU, then also create a new
5103 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020051044. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000051055. Type "make", and you should get a working "u-boot.srec" file
5106 to be installed on your target system.
51076. Debug and solve any problems that might arise.
5108 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005109
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5112==============================================================
wdenkc6097192002-11-03 00:24:07 +00005113
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005114If you have modified U-Boot sources (for instance added a new board
5115or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005116provide feedback to the other developers. The feedback normally takes
5117the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005118official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005119
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005120But before you submit such a patch, please verify that your modifi-
5121cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005122the supported boards compile WITHOUT ANY compiler warnings. To do so,
5123just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005124for ALL supported system. Be warned, this will take a while. You can
5125select which (cross) compiler to use by passing a `CROSS_COMPILE'
5126environment variable to the script, i. e. to use the ELDK cross tools
5127you can type
wdenkc6097192002-11-03 00:24:07 +00005128
wdenk6c59edc2004-05-03 20:45:30 +00005129 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk6c59edc2004-05-03 20:45:30 +00005131or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005132
wdenk6c59edc2004-05-03 20:45:30 +00005133 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005134
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005135When using the MAKEALL script, the default behaviour is to build
5136U-Boot in the source directory. This location can be changed by
5137setting the BUILD_DIR environment variable. Also, for each target
5138built, the MAKEALL script saves two log files (<target>.ERR and
5139<target>.MAKEALL) in the <source dir>/LOG directory. This default
5140location can be changed by setting the MAKEALL_LOGDIR environment
5141variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005142
5143 export BUILD_DIR=/tmp/build
5144 export MAKEALL_LOGDIR=/tmp/log
5145 CROSS_COMPILE=ppc_8xx- MAKEALL
5146
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005147With the above settings build objects are saved in the /tmp/build,
5148log files are saved in the /tmp/log and the source tree remains clean
5149during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005150
5151
wdenk6c59edc2004-05-03 20:45:30 +00005152See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005153
wdenkc6097192002-11-03 00:24:07 +00005154
wdenk6c59edc2004-05-03 20:45:30 +00005155Monitor Commands - Overview:
5156============================
wdenkc6097192002-11-03 00:24:07 +00005157
wdenk6c59edc2004-05-03 20:45:30 +00005158go - start application at address 'addr'
5159run - run commands in an environment variable
5160bootm - boot application image from memory
5161bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005162bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005163tftpboot- boot image via network using TFTP protocol
5164 and env variables "ipaddr" and "serverip"
5165 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005166tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005167rarpboot- boot image via network using RARP/TFTP protocol
5168diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5169loads - load S-Record file over serial line
5170loadb - load binary file over serial line (kermit mode)
5171md - memory display
5172mm - memory modify (auto-incrementing)
5173nm - memory modify (constant address)
5174mw - memory write (fill)
5175cp - memory copy
5176cmp - memory compare
5177crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005178i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005179sspi - SPI utility commands
5180base - print or set address offset
5181printenv- print environment variables
5182setenv - set environment variables
5183saveenv - save environment variables to persistent storage
5184protect - enable or disable FLASH write protection
5185erase - erase FLASH memory
5186flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005187nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005188bdinfo - print Board Info structure
5189iminfo - print header information for application image
5190coninfo - print console devices and informations
5191ide - IDE sub-system
5192loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005193loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005194mtest - simple RAM test
5195icache - enable or disable instruction cache
5196dcache - enable or disable data cache
5197reset - Perform RESET of the CPU
5198echo - echo args to console
5199version - print monitor version
5200help - print online help
5201? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005202
wdenkc6097192002-11-03 00:24:07 +00005203
wdenk6c59edc2004-05-03 20:45:30 +00005204Monitor Commands - Detailed Description:
5205========================================
wdenkc6097192002-11-03 00:24:07 +00005206
wdenk6c59edc2004-05-03 20:45:30 +00005207TODO.
wdenkc6097192002-11-03 00:24:07 +00005208
wdenk6c59edc2004-05-03 20:45:30 +00005209For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005210
5211
wdenk6c59edc2004-05-03 20:45:30 +00005212Environment Variables:
5213======================
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215U-Boot supports user configuration using Environment Variables which
5216can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005217
wdenk6c59edc2004-05-03 20:45:30 +00005218Environment Variables are set using "setenv", printed using
5219"printenv", and saved to Flash using "saveenv". Using "setenv"
5220without a value can be used to delete a variable from the
5221environment. As long as you don't save the environment you are
5222working with an in-memory copy. In case the Flash area containing the
5223environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005224
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005225Some configuration options can be set using Environment Variables.
5226
5227List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk6c59edc2004-05-03 20:45:30 +00005229 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk6c59edc2004-05-03 20:45:30 +00005231 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005232
wdenk6c59edc2004-05-03 20:45:30 +00005233 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk6c59edc2004-05-03 20:45:30 +00005235 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005236
wdenk6c59edc2004-05-03 20:45:30 +00005237 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005238
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005239 bootm_low - Memory range available for image processing in the bootm
5240 command can be restricted. This variable is given as
5241 a hexadecimal number and defines lowest address allowed
5242 for use by the bootm command. See also "bootm_size"
5243 environment variable. Address defined by "bootm_low" is
5244 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005245 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5246 bootm_mapsize.
5247
Wolfgang Denk092ae952011-10-26 10:21:21 +00005248 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005249 This variable is given as a hexadecimal number and it
5250 defines the size of the memory region starting at base
5251 address bootm_low that is accessible by the Linux kernel
5252 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5253 as the default value if it is defined, and bootm_size is
5254 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005255
5256 bootm_size - Memory range available for image processing in the bootm
5257 command can be restricted. This variable is given as
5258 a hexadecimal number and defines the size of the region
5259 allowed for use by the bootm command. See also "bootm_low"
5260 environment variable.
5261
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005262 updatefile - Location of the software update file on a TFTP server, used
5263 by the automatic software update feature. Please refer to
5264 documentation in doc/README.update for more details.
5265
wdenk6c59edc2004-05-03 20:45:30 +00005266 autoload - if set to "no" (any string beginning with 'n'),
5267 "bootp" will just load perform a lookup of the
5268 configuration from the BOOTP server, but not try to
5269 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005270
wdenk6c59edc2004-05-03 20:45:30 +00005271 autostart - if set to "yes", an image loaded using the "bootp",
5272 "rarpboot", "tftpboot" or "diskboot" commands will
5273 be automatically started (by internally calling
5274 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005275
wdenk6c59edc2004-05-03 20:45:30 +00005276 If set to "no", a standalone image passed to the
5277 "bootm" command will be copied to the load address
5278 (and eventually uncompressed), but NOT be started.
5279 This can be used to load and uncompress arbitrary
5280 data.
wdenkc6097192002-11-03 00:24:07 +00005281
David A. Longd558a4e2011-07-09 16:40:19 -04005282 fdt_high - if set this restricts the maximum address that the
5283 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005284 For example, if you have a system with 1 GB memory
5285 at physical address 0x10000000, while Linux kernel
5286 only recognizes the first 704 MB as low memory, you
5287 may need to set fdt_high as 0x3C000000 to have the
5288 device tree blob be copied to the maximum address
5289 of the 704 MB low memory, so that Linux kernel can
5290 access it during the boot procedure.
5291
David A. Longd558a4e2011-07-09 16:40:19 -04005292 If this is set to the special value 0xFFFFFFFF then
5293 the fdt will not be copied at all on boot. For this
5294 to work it must reside in writable memory, have
5295 sufficient padding on the end of it for u-boot to
5296 add the information it needs into it, and the memory
5297 must be accessible by the kernel.
5298
Simon Glassdc6fa642011-10-24 19:15:34 +00005299 fdtcontroladdr- if set this is the address of the control flattened
5300 device tree used by U-Boot when CONFIG_OF_CONTROL is
5301 defined.
5302
wdenk0e2bd9c2004-06-06 21:51:03 +00005303 i2cfast - (PPC405GP|PPC405EP only)
5304 if set to 'y' configures Linux I2C driver for fast
5305 mode (400kHZ). This environment variable is used in
5306 initialization code. So, for changes to be effective
5307 it must be saved and board must be reset.
5308
wdenk6c59edc2004-05-03 20:45:30 +00005309 initrd_high - restrict positioning of initrd images:
5310 If this variable is not set, initrd images will be
5311 copied to the highest possible address in RAM; this
5312 is usually what you want since it allows for
5313 maximum initrd size. If for some reason you want to
5314 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005315 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005316 variable to a value of "no" or "off" or "0".
5317 Alternatively, you can set it to a maximum upper
5318 address to use (U-Boot will still check that it
5319 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005320
wdenk6c59edc2004-05-03 20:45:30 +00005321 For instance, when you have a system with 16 MB
5322 RAM, and want to reserve 4 MB from use by Linux,
5323 you can do this by adding "mem=12M" to the value of
5324 the "bootargs" variable. However, now you must make
5325 sure that the initrd image is placed in the first
5326 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005327
wdenk6c59edc2004-05-03 20:45:30 +00005328 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005329
wdenk6c59edc2004-05-03 20:45:30 +00005330 If you set initrd_high to 0xFFFFFFFF, this is an
5331 indication to U-Boot that all addresses are legal
5332 for the Linux kernel, including addresses in flash
5333 memory. In this case U-Boot will NOT COPY the
5334 ramdisk at all. This may be useful to reduce the
5335 boot time on your system, but requires that this
5336 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005337
wdenk6c59edc2004-05-03 20:45:30 +00005338 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005339
wdenk6c59edc2004-05-03 20:45:30 +00005340 loadaddr - Default load address for commands like "bootp",
5341 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005342
wdenk6c59edc2004-05-03 20:45:30 +00005343 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005344
wdenk6c59edc2004-05-03 20:45:30 +00005345 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005346
wdenk6c59edc2004-05-03 20:45:30 +00005347 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005348
wdenk6c59edc2004-05-03 20:45:30 +00005349 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005350
wdenk6c59edc2004-05-03 20:45:30 +00005351 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005352
Mike Frysingera23230c2011-10-02 10:01:27 +00005353 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005354
Mike Frysingera23230c2011-10-02 10:01:27 +00005355 ethact - controls which interface is currently active.
5356 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005357
Heiko Schocherc5e84052010-07-20 17:45:02 +02005358 => setenv ethact FEC
5359 => ping 192.168.0.1 # traffic sent on FEC
5360 => setenv ethact SCC
5361 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005362
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005363 ethrotate - When set to "no" U-Boot does not go through all
5364 available network interfaces.
5365 It just stays at the currently selected interface.
5366
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005367 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005368 either succeed or fail without retrying.
5369 When set to "once" the network operation will
5370 fail when all the available network interfaces
5371 are tried once without success.
5372 Useful on scripts which control the retry operation
5373 themselves.
wdenkc6097192002-11-03 00:24:07 +00005374
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005375 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005376
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005377 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005378 changing the console to be empty. If "yes" it will be
5379 made silent. If "no" it will not be made silent. If
5380 unset, then it will be made silent if the U-Boot console
5381 is silent.
5382
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005383 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005384 UDP source port.
5385
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005386 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005387 destination port instead of the Well Know Port 69.
5388
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005389 tftpblocksize - Block size to use for TFTP transfers; if not set,
5390 we use the TFTP server's default block size
5391
5392 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5393 seconds, minimum value is 1000 = 1 second). Defines
5394 when a packet is considered to be lost so it has to
5395 be retransmitted. The default is 5000 = 5 seconds.
5396 Lowering this value may make downloads succeed
5397 faster in networks with high packet loss rates or
5398 with unreliable TFTP servers.
5399
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005400 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5401 unit, minimum value = 0). Defines how many timeouts
5402 can happen during a single file transfer before that
5403 transfer is aborted. The default is 10, and 0 means
5404 'no timeouts allowed'. Increasing this value may help
5405 downloads succeed with high packet loss rates, or with
5406 unreliable TFTP servers or client hardware.
5407
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005408 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005409 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005410 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005411
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005412The following image location variables contain the location of images
5413used in booting. The "Image" column gives the role of the image and is
5414not an environment variable name. The other columns are environment
5415variable names. "File Name" gives the name of the file on a TFTP
5416server, "RAM Address" gives the location in RAM the image will be
5417loaded to, and "Flash Location" gives the image's address in NOR
5418flash or offset in NAND flash.
5419
5420*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005421boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005422boards use these variables for other purposes.
5423
Wolfgang Denk092ae952011-10-26 10:21:21 +00005424Image File Name RAM Address Flash Location
5425----- --------- ----------- --------------
5426u-boot u-boot u-boot_addr_r u-boot_addr
5427Linux kernel bootfile kernel_addr_r kernel_addr
5428device tree blob fdtfile fdt_addr_r fdt_addr
5429ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005430
wdenk6c59edc2004-05-03 20:45:30 +00005431The following environment variables may be used and automatically
5432updated by the network boot commands ("bootp" and "rarpboot"),
5433depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005434
wdenk6c59edc2004-05-03 20:45:30 +00005435 bootfile - see above
5436 dnsip - IP address of your Domain Name Server
5437 dnsip2 - IP address of your secondary Domain Name Server
5438 gatewayip - IP address of the Gateway (Router) to use
5439 hostname - Target hostname
5440 ipaddr - see above
5441 netmask - Subnet Mask
5442 rootpath - Pathname of the root filesystem on the NFS server
5443 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005444
wdenk145d2c12004-04-15 21:48:45 +00005445
wdenk6c59edc2004-05-03 20:45:30 +00005446There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005447
wdenk6c59edc2004-05-03 20:45:30 +00005448 serial# - contains hardware identification information such
5449 as type string and/or serial number
5450 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005451
wdenk6c59edc2004-05-03 20:45:30 +00005452These variables can be set only once (usually during manufacturing of
5453the board). U-Boot refuses to delete or overwrite these variables
5454once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005455
5456
wdenk6c59edc2004-05-03 20:45:30 +00005457Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005458
wdenk6c59edc2004-05-03 20:45:30 +00005459 ver - Contains the U-Boot version string as printed
5460 with the "version" command. This variable is
5461 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005462
wdenkc6097192002-11-03 00:24:07 +00005463
wdenk6c59edc2004-05-03 20:45:30 +00005464Please note that changes to some configuration parameters may take
5465only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005466
stroeseb9c17c52003-04-04 15:53:41 +00005467
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005468Callback functions for environment variables:
5469---------------------------------------------
5470
5471For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005472when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005473be associated with arbitrary variables. On creation, overwrite, or
5474deletion, the callback will provide the opportunity for some side
5475effect to happen or for the change to be rejected.
5476
5477The callbacks are named and associated with a function using the
5478U_BOOT_ENV_CALLBACK macro in your board or driver code.
5479
5480These callbacks are associated with variables in one of two ways. The
5481static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5482in the board configuration to a string that defines a list of
5483associations. The list must be in the following format:
5484
5485 entry = variable_name[:callback_name]
5486 list = entry[,list]
5487
5488If the callback name is not specified, then the callback is deleted.
5489Spaces are also allowed anywhere in the list.
5490
5491Callbacks can also be associated by defining the ".callbacks" variable
5492with the same list format above. Any association in ".callbacks" will
5493override any association in the static list. You can define
5494CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005495".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005496
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005497If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5498regular expression. This allows multiple variables to be connected to
5499the same callback without explicitly listing them all out.
5500
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005501
wdenk6c59edc2004-05-03 20:45:30 +00005502Command Line Parsing:
5503=====================
stroeseb9c17c52003-04-04 15:53:41 +00005504
wdenk6c59edc2004-05-03 20:45:30 +00005505There are two different command line parsers available with U-Boot:
5506the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005507
wdenk6c59edc2004-05-03 20:45:30 +00005508Old, simple command line parser:
5509--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005510
wdenk6c59edc2004-05-03 20:45:30 +00005511- supports environment variables (through setenv / saveenv commands)
5512- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005513- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005514- special characters ('$', ';') can be escaped by prefixing with '\',
5515 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005516 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005517- You can also escape text by enclosing in single apostrophes, for example:
5518 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520Hush shell:
5521-----------
wdenkf4688a22003-05-28 08:06:31 +00005522
wdenk6c59edc2004-05-03 20:45:30 +00005523- similar to Bourne shell, with control structures like
5524 if...then...else...fi, for...do...done; while...do...done,
5525 until...do...done, ...
5526- supports environment ("global") variables (through setenv / saveenv
5527 commands) and local shell variables (through standard shell syntax
5528 "name=value"); only environment variables can be used with "run"
5529 command
wdenkf4688a22003-05-28 08:06:31 +00005530
wdenk6c59edc2004-05-03 20:45:30 +00005531General rules:
5532--------------
wdenkf4688a22003-05-28 08:06:31 +00005533
wdenk6c59edc2004-05-03 20:45:30 +00005534(1) If a command line (or an environment variable executed by a "run"
5535 command) contains several commands separated by semicolon, and
5536 one of these commands fails, then the remaining commands will be
5537 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005538
wdenk6c59edc2004-05-03 20:45:30 +00005539(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005540 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005541 command will cause "run" to terminate, i. e. the remaining
5542 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005543
wdenk6c59edc2004-05-03 20:45:30 +00005544Note for Redundant Ethernet Interfaces:
5545=======================================
wdenkf4688a22003-05-28 08:06:31 +00005546
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005547Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005548such configurations and is capable of automatic selection of a
5549"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005550
wdenk6c59edc2004-05-03 20:45:30 +00005551Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5552MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5553"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005554
wdenk6c59edc2004-05-03 20:45:30 +00005555If the network interface stores some valid MAC address (for instance
5556in SROM), this is used as default address if there is NO correspon-
5557ding setting in the environment; if the corresponding environment
5558variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005559
wdenk6c59edc2004-05-03 20:45:30 +00005560o If the SROM has a valid MAC address, and there is no address in the
5561 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005562
wdenk6c59edc2004-05-03 20:45:30 +00005563o If there is no valid address in the SROM, and a definition in the
5564 environment exists, then the value from the environment variable is
5565 used.
wdenkc6097192002-11-03 00:24:07 +00005566
wdenk6c59edc2004-05-03 20:45:30 +00005567o If both the SROM and the environment contain a MAC address, and
5568 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005569
wdenk6c59edc2004-05-03 20:45:30 +00005570o If both the SROM and the environment contain a MAC address, and the
5571 addresses differ, the value from the environment is used and a
5572 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005573
wdenk6c59edc2004-05-03 20:45:30 +00005574o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005575 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5576 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005577
Ben Warren6db991a2010-04-26 11:11:46 -07005578If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005579will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005580may be skipped by setting the appropriate 'ethmacskip' environment variable.
5581The naming convention is as follows:
5582"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk6c59edc2004-05-03 20:45:30 +00005584Image Formats:
5585==============
wdenkc6097192002-11-03 00:24:07 +00005586
Marian Balakowicz18710b82008-03-12 12:13:13 +01005587U-Boot is capable of booting (and performing other auxiliary operations on)
5588images in two formats:
5589
5590New uImage format (FIT)
5591-----------------------
5592
5593Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5594to Flattened Device Tree). It allows the use of images with multiple
5595components (several kernels, ramdisks, etc.), with contents protected by
5596SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5597
5598
5599Old uImage format
5600-----------------
5601
5602Old image format is based on binary files which can be basically anything,
5603preceded by a special header; see the definitions in include/image.h for
5604details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk6c59edc2004-05-03 20:45:30 +00005606* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5607 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005608 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5609 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5610 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005611* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005612 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5613 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005614* Compression Type (uncompressed, gzip, bzip2)
5615* Load Address
5616* Entry Point
5617* Image Name
5618* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005619
wdenk6c59edc2004-05-03 20:45:30 +00005620The header is marked by a special Magic Number, and both the header
5621and the data portions of the image are secured against corruption by
5622CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005623
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk6c59edc2004-05-03 20:45:30 +00005625Linux Support:
5626==============
wdenkc6097192002-11-03 00:24:07 +00005627
wdenk6c59edc2004-05-03 20:45:30 +00005628Although U-Boot should support any OS or standalone application
5629easily, the main focus has always been on Linux during the design of
5630U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005631
wdenk6c59edc2004-05-03 20:45:30 +00005632U-Boot includes many features that so far have been part of some
5633special "boot loader" code within the Linux kernel. Also, any
5634"initrd" images to be used are no longer part of one big Linux image;
5635instead, kernel and "initrd" are separate images. This implementation
5636serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005637
wdenk6c59edc2004-05-03 20:45:30 +00005638- the same features can be used for other OS or standalone
5639 applications (for instance: using compressed images to reduce the
5640 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk6c59edc2004-05-03 20:45:30 +00005642- it becomes much easier to port new Linux kernel versions because
5643 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk6c59edc2004-05-03 20:45:30 +00005645- the same Linux kernel image can now be used with different "initrd"
5646 images; of course this also means that different kernel images can
5647 be run with the same "initrd". This makes testing easier (you don't
5648 have to build a new "zImage.initrd" Linux image when you just
5649 change a file in your "initrd"). Also, a field-upgrade of the
5650 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005651
wdenkc6097192002-11-03 00:24:07 +00005652
wdenk6c59edc2004-05-03 20:45:30 +00005653Linux HOWTO:
5654============
wdenkc6097192002-11-03 00:24:07 +00005655
wdenk6c59edc2004-05-03 20:45:30 +00005656Porting Linux to U-Boot based systems:
5657---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk6c59edc2004-05-03 20:45:30 +00005659U-Boot cannot save you from doing all the necessary modifications to
5660configure the Linux device drivers for use with your target hardware
5661(no, we don't intend to provide a full virtual machine interface to
5662Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005663
Stefan Roese88fbf932010-04-15 16:07:28 +02005664But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005665
wdenk6c59edc2004-05-03 20:45:30 +00005666Just make sure your machine specific header file (for instance
5667include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005668Information structure as we define in include/asm-<arch>/u-boot.h,
5669and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005670as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005671
Simon Glassd097e592014-06-11 23:29:46 -06005672Note that U-Boot now has a driver model, a unified model for drivers.
5673If you are adding a new driver, plumb it into driver model. If there
5674is no uclass available, you are encouraged to create one. See
5675doc/driver-model.
5676
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk6c59edc2004-05-03 20:45:30 +00005678Configuring the Linux kernel:
5679-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005680
wdenk6c59edc2004-05-03 20:45:30 +00005681No specific requirements for U-Boot. Make sure you have some root
5682device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005683
wdenkc6097192002-11-03 00:24:07 +00005684
wdenk6c59edc2004-05-03 20:45:30 +00005685Building a Linux Image:
5686-----------------------
wdenkc6097192002-11-03 00:24:07 +00005687
wdenk6c59edc2004-05-03 20:45:30 +00005688With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5689not used. If you use recent kernel source, a new build target
5690"uImage" will exist which automatically builds an image usable by
5691U-Boot. Most older kernels also have support for a "pImage" target,
5692which was introduced for our predecessor project PPCBoot and uses a
5693100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005694
wdenk6c59edc2004-05-03 20:45:30 +00005695Example:
wdenkc6097192002-11-03 00:24:07 +00005696
Holger Freyther7ba4e572014-08-04 09:26:05 +02005697 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005698 make oldconfig
5699 make dep
5700 make uImage
wdenkc6097192002-11-03 00:24:07 +00005701
wdenk6c59edc2004-05-03 20:45:30 +00005702The "uImage" build target uses a special tool (in 'tools/mkimage') to
5703encapsulate a compressed Linux kernel image with header information,
5704CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005707
wdenk6c59edc2004-05-03 20:45:30 +00005708* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005709
wdenk6c59edc2004-05-03 20:45:30 +00005710 ${CROSS_COMPILE}-objcopy -O binary \
5711 -R .note -R .comment \
5712 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005713
wdenk6c59edc2004-05-03 20:45:30 +00005714* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005715
wdenk6c59edc2004-05-03 20:45:30 +00005716 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005717
wdenk6c59edc2004-05-03 20:45:30 +00005718* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005719
wdenk6c59edc2004-05-03 20:45:30 +00005720 mkimage -A ppc -O linux -T kernel -C gzip \
5721 -a 0 -e 0 -n "Linux Kernel Image" \
5722 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005723
wdenkc6097192002-11-03 00:24:07 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725The "mkimage" tool can also be used to create ramdisk images for use
5726with U-Boot, either separated from the Linux kernel image, or
5727combined into one file. "mkimage" encapsulates the images with a 64
5728byte header containing information about target architecture,
5729operating system, image type, compression method, entry points, time
5730stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk6c59edc2004-05-03 20:45:30 +00005732"mkimage" can be called in two ways: to verify existing images and
5733print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005734
wdenk6c59edc2004-05-03 20:45:30 +00005735In the first form (with "-l" option) mkimage lists the information
5736contained in the header of an existing U-Boot image; this includes
5737checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005738
wdenk6c59edc2004-05-03 20:45:30 +00005739 tools/mkimage -l image
5740 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005741
wdenk6c59edc2004-05-03 20:45:30 +00005742The second form (with "-d" option) is used to build a U-Boot image
5743from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005744
wdenk6c59edc2004-05-03 20:45:30 +00005745 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5746 -n name -d data_file image
5747 -A ==> set architecture to 'arch'
5748 -O ==> set operating system to 'os'
5749 -T ==> set image type to 'type'
5750 -C ==> set compression type 'comp'
5751 -a ==> set load address to 'addr' (hex)
5752 -e ==> set entry point to 'ep' (hex)
5753 -n ==> set image name to 'name'
5754 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005755
wdenkcd914452004-05-29 16:53:29 +00005756Right now, all Linux kernels for PowerPC systems use the same load
5757address (0x00000000), but the entry point address depends on the
5758kernel version:
wdenkc6097192002-11-03 00:24:07 +00005759
wdenk6c59edc2004-05-03 20:45:30 +00005760- 2.2.x kernels have the entry point at 0x0000000C,
5761- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005762
wdenk6c59edc2004-05-03 20:45:30 +00005763So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005764
wdenk6c59edc2004-05-03 20:45:30 +00005765 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5766 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005767 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005768 > examples/uImage.TQM850L
5769 Image Name: 2.4.4 kernel for TQM850L
5770 Created: Wed Jul 19 02:34:59 2000
5771 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5772 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5773 Load Address: 0x00000000
5774 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005775
wdenk6c59edc2004-05-03 20:45:30 +00005776To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005777
wdenk6c59edc2004-05-03 20:45:30 +00005778 -> tools/mkimage -l examples/uImage.TQM850L
5779 Image Name: 2.4.4 kernel for TQM850L
5780 Created: Wed Jul 19 02:34:59 2000
5781 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5782 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5783 Load Address: 0x00000000
5784 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005785
wdenk6c59edc2004-05-03 20:45:30 +00005786NOTE: for embedded systems where boot time is critical you can trade
5787speed for memory and install an UNCOMPRESSED image instead: this
5788needs more space in Flash, but boots much faster since it does not
5789need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005790
Stefan Roese88fbf932010-04-15 16:07:28 +02005791 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005792 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5793 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005794 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005795 > examples/uImage.TQM850L-uncompressed
5796 Image Name: 2.4.4 kernel for TQM850L
5797 Created: Wed Jul 19 02:34:59 2000
5798 Image Type: PowerPC Linux Kernel Image (uncompressed)
5799 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5800 Load Address: 0x00000000
5801 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005802
wdenkc6097192002-11-03 00:24:07 +00005803
wdenk6c59edc2004-05-03 20:45:30 +00005804Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5805when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005806
wdenk6c59edc2004-05-03 20:45:30 +00005807 -> tools/mkimage -n 'Simple Ramdisk Image' \
5808 > -A ppc -O linux -T ramdisk -C gzip \
5809 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5810 Image Name: Simple Ramdisk Image
5811 Created: Wed Jan 12 14:01:50 2000
5812 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5813 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5814 Load Address: 0x00000000
5815 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005816
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005817The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5818option performs the converse operation of the mkimage's second form (the "-d"
5819option). Given an image built by mkimage, the dumpimage extracts a "data file"
5820from the image:
5821
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005822 tools/dumpimage -i image -T type -p position data_file
5823 -i ==> extract from the 'image' a specific 'data_file'
5824 -T ==> set image type to 'type'
5825 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005826
wdenkc6097192002-11-03 00:24:07 +00005827
wdenk6c59edc2004-05-03 20:45:30 +00005828Installing a Linux Image:
5829-------------------------
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk6c59edc2004-05-03 20:45:30 +00005831To downloading a U-Boot image over the serial (console) interface,
5832you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005833
wdenk6c59edc2004-05-03 20:45:30 +00005834 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk6c59edc2004-05-03 20:45:30 +00005836The 'objcopy' does not understand the information in the U-Boot
5837image header, so the resulting S-Record file will be relative to
5838address 0x00000000. To load it to a given address, you need to
5839specify the target address as 'offset' parameter with the 'loads'
5840command.
wdenkc6097192002-11-03 00:24:07 +00005841
wdenk6c59edc2004-05-03 20:45:30 +00005842Example: install the image to address 0x40100000 (which on the
5843TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005844
wdenk6c59edc2004-05-03 20:45:30 +00005845 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005846
wdenk6c59edc2004-05-03 20:45:30 +00005847 .......... done
5848 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005849
wdenk6c59edc2004-05-03 20:45:30 +00005850 => loads 40100000
5851 ## Ready for S-Record download ...
5852 ~>examples/image.srec
5853 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5854 ...
5855 15989 15990 15991 15992
5856 [file transfer complete]
5857 [connected]
5858 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005859
wdenkc6097192002-11-03 00:24:07 +00005860
wdenk6c59edc2004-05-03 20:45:30 +00005861You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005862this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005863corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005864
wdenk6c59edc2004-05-03 20:45:30 +00005865 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005866
wdenk6c59edc2004-05-03 20:45:30 +00005867 ## Checking Image at 40100000 ...
5868 Image Name: 2.2.13 for initrd on TQM850L
5869 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5870 Data Size: 335725 Bytes = 327 kB = 0 MB
5871 Load Address: 00000000
5872 Entry Point: 0000000c
5873 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005874
5875
wdenk6c59edc2004-05-03 20:45:30 +00005876Boot Linux:
5877-----------
wdenkc6097192002-11-03 00:24:07 +00005878
wdenk6c59edc2004-05-03 20:45:30 +00005879The "bootm" command is used to boot an application that is stored in
5880memory (RAM or Flash). In case of a Linux kernel image, the contents
5881of the "bootargs" environment variable is passed to the kernel as
5882parameters. You can check and modify this variable using the
5883"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005884
wdenkc6097192002-11-03 00:24:07 +00005885
wdenk6c59edc2004-05-03 20:45:30 +00005886 => printenv bootargs
5887 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005888
wdenk6c59edc2004-05-03 20:45:30 +00005889 => 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 +00005890
wdenk6c59edc2004-05-03 20:45:30 +00005891 => printenv bootargs
5892 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 +00005893
wdenk6c59edc2004-05-03 20:45:30 +00005894 => bootm 40020000
5895 ## Booting Linux kernel at 40020000 ...
5896 Image Name: 2.2.13 for NFS on TQM850L
5897 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5898 Data Size: 381681 Bytes = 372 kB = 0 MB
5899 Load Address: 00000000
5900 Entry Point: 0000000c
5901 Verifying Checksum ... OK
5902 Uncompressing Kernel Image ... OK
5903 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
5904 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5905 time_init: decrementer frequency = 187500000/60
5906 Calibrating delay loop... 49.77 BogoMIPS
5907 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5908 ...
wdenkc6097192002-11-03 00:24:07 +00005909
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005910If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005911the memory addresses of both the kernel and the initrd image (PPBCOOT
5912format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005913
wdenk6c59edc2004-05-03 20:45:30 +00005914 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005915
wdenk6c59edc2004-05-03 20:45:30 +00005916 ## Checking Image at 40100000 ...
5917 Image Name: 2.2.13 for initrd on TQM850L
5918 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5919 Data Size: 335725 Bytes = 327 kB = 0 MB
5920 Load Address: 00000000
5921 Entry Point: 0000000c
5922 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005923
wdenk6c59edc2004-05-03 20:45:30 +00005924 ## Checking Image at 40200000 ...
5925 Image Name: Simple Ramdisk Image
5926 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5927 Data Size: 566530 Bytes = 553 kB = 0 MB
5928 Load Address: 00000000
5929 Entry Point: 00000000
5930 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005931
wdenk6c59edc2004-05-03 20:45:30 +00005932 => bootm 40100000 40200000
5933 ## Booting Linux kernel at 40100000 ...
5934 Image Name: 2.2.13 for initrd on TQM850L
5935 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5936 Data Size: 335725 Bytes = 327 kB = 0 MB
5937 Load Address: 00000000
5938 Entry Point: 0000000c
5939 Verifying Checksum ... OK
5940 Uncompressing Kernel Image ... OK
5941 ## Loading RAMDisk Image at 40200000 ...
5942 Image Name: Simple Ramdisk Image
5943 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5944 Data Size: 566530 Bytes = 553 kB = 0 MB
5945 Load Address: 00000000
5946 Entry Point: 00000000
5947 Verifying Checksum ... OK
5948 Loading Ramdisk ... OK
5949 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
5950 Boot arguments: root=/dev/ram
5951 time_init: decrementer frequency = 187500000/60
5952 Calibrating delay loop... 49.77 BogoMIPS
5953 ...
5954 RAMDISK: Compressed image found at block 0
5955 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005956
wdenk6c59edc2004-05-03 20:45:30 +00005957 bash#
wdenkc6097192002-11-03 00:24:07 +00005958
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005959Boot Linux and pass a flat device tree:
5960-----------
5961
5962First, U-Boot must be compiled with the appropriate defines. See the section
5963titled "Linux Kernel Interface" above for a more in depth explanation. The
5964following is an example of how to start a kernel and pass an updated
5965flat device tree:
5966
5967=> print oftaddr
5968oftaddr=0x300000
5969=> print oft
5970oft=oftrees/mpc8540ads.dtb
5971=> tftp $oftaddr $oft
5972Speed: 1000, full duplex
5973Using TSEC0 device
5974TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5975Filename 'oftrees/mpc8540ads.dtb'.
5976Load address: 0x300000
5977Loading: #
5978done
5979Bytes transferred = 4106 (100a hex)
5980=> tftp $loadaddr $bootfile
5981Speed: 1000, full duplex
5982Using TSEC0 device
5983TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5984Filename 'uImage'.
5985Load address: 0x200000
5986Loading:############
5987done
5988Bytes transferred = 1029407 (fb51f hex)
5989=> print loadaddr
5990loadaddr=200000
5991=> print oftaddr
5992oftaddr=0x300000
5993=> bootm $loadaddr - $oftaddr
5994## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005995 Image Name: Linux-2.6.17-dirty
5996 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5997 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005998 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005999 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05006000 Verifying Checksum ... OK
6001 Uncompressing Kernel Image ... OK
6002Booting using flat device tree at 0x300000
6003Using MPC85xx ADS machine description
6004Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6005[snip]
6006
6007
wdenk6c59edc2004-05-03 20:45:30 +00006008More About U-Boot Image Types:
6009------------------------------
wdenkc6097192002-11-03 00:24:07 +00006010
wdenk6c59edc2004-05-03 20:45:30 +00006011U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00006012
wdenk6c59edc2004-05-03 20:45:30 +00006013 "Standalone Programs" are directly runnable in the environment
6014 provided by U-Boot; it is expected that (if they behave
6015 well) you can continue to work in U-Boot after return from
6016 the Standalone Program.
6017 "OS Kernel Images" are usually images of some Embedded OS which
6018 will take over control completely. Usually these programs
6019 will install their own set of exception handlers, device
6020 drivers, set up the MMU, etc. - this means, that you cannot
6021 expect to re-enter U-Boot except by resetting the CPU.
6022 "RAMDisk Images" are more or less just data blocks, and their
6023 parameters (address, size) are passed to an OS kernel that is
6024 being started.
6025 "Multi-File Images" contain several images, typically an OS
6026 (Linux) kernel image and one or more data images like
6027 RAMDisks. This construct is useful for instance when you want
6028 to boot over the network using BOOTP etc., where the boot
6029 server provides just a single image file, but you want to get
6030 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006031
wdenk6c59edc2004-05-03 20:45:30 +00006032 "Multi-File Images" start with a list of image sizes, each
6033 image size (in bytes) specified by an "uint32_t" in network
6034 byte order. This list is terminated by an "(uint32_t)0".
6035 Immediately after the terminating 0 follow the images, one by
6036 one, all aligned on "uint32_t" boundaries (size rounded up to
6037 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006038
wdenk6c59edc2004-05-03 20:45:30 +00006039 "Firmware Images" are binary images containing firmware (like
6040 U-Boot or FPGA images) which usually will be programmed to
6041 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006042
wdenk6c59edc2004-05-03 20:45:30 +00006043 "Script files" are command sequences that will be executed by
6044 U-Boot's command interpreter; this feature is especially
6045 useful when you configure U-Boot to use a real shell (hush)
6046 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006047
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006048Booting the Linux zImage:
6049-------------------------
6050
6051On some platforms, it's possible to boot Linux zImage. This is done
6052using the "bootz" command. The syntax of "bootz" command is the same
6053as the syntax of "bootm" command.
6054
Tom Rini45f46d12013-05-16 11:40:11 -04006055Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006056kernel with raw initrd images. The syntax is slightly different, the
6057address of the initrd must be augmented by it's size, in the following
6058format: "<initrd addres>:<initrd size>".
6059
stroeseb9c17c52003-04-04 15:53:41 +00006060
wdenk6c59edc2004-05-03 20:45:30 +00006061Standalone HOWTO:
6062=================
stroeseb9c17c52003-04-04 15:53:41 +00006063
wdenk6c59edc2004-05-03 20:45:30 +00006064One of the features of U-Boot is that you can dynamically load and
6065run "standalone" applications, which can use some resources of
6066U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006067
wdenk6c59edc2004-05-03 20:45:30 +00006068Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006069
wdenk6c59edc2004-05-03 20:45:30 +00006070"Hello World" Demo:
6071-------------------
wdenkc6097192002-11-03 00:24:07 +00006072
wdenk6c59edc2004-05-03 20:45:30 +00006073'examples/hello_world.c' contains a small "Hello World" Demo
6074application; it is automatically compiled when you build U-Boot.
6075It's configured to run at address 0x00040004, so you can play with it
6076like that:
wdenkc6097192002-11-03 00:24:07 +00006077
wdenk6c59edc2004-05-03 20:45:30 +00006078 => loads
6079 ## Ready for S-Record download ...
6080 ~>examples/hello_world.srec
6081 1 2 3 4 5 6 7 8 9 10 11 ...
6082 [file transfer complete]
6083 [connected]
6084 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006085
wdenk6c59edc2004-05-03 20:45:30 +00006086 => go 40004 Hello World! This is a test.
6087 ## Starting application at 0x00040004 ...
6088 Hello World
6089 argc = 7
6090 argv[0] = "40004"
6091 argv[1] = "Hello"
6092 argv[2] = "World!"
6093 argv[3] = "This"
6094 argv[4] = "is"
6095 argv[5] = "a"
6096 argv[6] = "test."
6097 argv[7] = "<NULL>"
6098 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006099
wdenk6c59edc2004-05-03 20:45:30 +00006100 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006101
wdenk6c59edc2004-05-03 20:45:30 +00006102Another example, which demonstrates how to register a CPM interrupt
6103handler with the U-Boot code, can be found in 'examples/timer.c'.
6104Here, a CPM timer is set up to generate an interrupt every second.
6105The interrupt service routine is trivial, just printing a '.'
6106character, but this is just a demo program. The application can be
6107controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006108
wdenk6c59edc2004-05-03 20:45:30 +00006109 ? - print current values og the CPM Timer registers
6110 b - enable interrupts and start timer
6111 e - stop timer and disable interrupts
6112 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006113
wdenk6c59edc2004-05-03 20:45:30 +00006114 => loads
6115 ## Ready for S-Record download ...
6116 ~>examples/timer.srec
6117 1 2 3 4 5 6 7 8 9 10 11 ...
6118 [file transfer complete]
6119 [connected]
6120 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006121
wdenk6c59edc2004-05-03 20:45:30 +00006122 => go 40004
6123 ## Starting application at 0x00040004 ...
6124 TIMERS=0xfff00980
6125 Using timer 1
6126 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006127
wdenk6c59edc2004-05-03 20:45:30 +00006128Hit 'b':
6129 [q, b, e, ?] Set interval 1000000 us
6130 Enabling timer
6131Hit '?':
6132 [q, b, e, ?] ........
6133 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6134Hit '?':
6135 [q, b, e, ?] .
6136 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6137Hit '?':
6138 [q, b, e, ?] .
6139 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6140Hit '?':
6141 [q, b, e, ?] .
6142 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6143Hit 'e':
6144 [q, b, e, ?] ...Stopping timer
6145Hit 'q':
6146 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006147
wdenkc6097192002-11-03 00:24:07 +00006148
wdenk6c59edc2004-05-03 20:45:30 +00006149Minicom warning:
6150================
wdenkc6097192002-11-03 00:24:07 +00006151
wdenk6c59edc2004-05-03 20:45:30 +00006152Over time, many people have reported problems when trying to use the
6153"minicom" terminal emulation program for serial download. I (wd)
6154consider minicom to be broken, and recommend not to use it. Under
6155Unix, I recommend to use C-Kermit for general purpose use (and
6156especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006157use "cu" for S-Record download ("loads" command). See
6158http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6159for help with kermit.
6160
wdenkc6097192002-11-03 00:24:07 +00006161
wdenk6c59edc2004-05-03 20:45:30 +00006162Nevertheless, if you absolutely want to use it try adding this
6163configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006164
wdenk6c59edc2004-05-03 20:45:30 +00006165 Name Program Name U/D FullScr IO-Red. Multi
6166 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6167 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006168
wdenk8dba0502003-03-31 16:34:49 +00006169
wdenk6c59edc2004-05-03 20:45:30 +00006170NetBSD Notes:
6171=============
wdenkc6097192002-11-03 00:24:07 +00006172
wdenk6c59edc2004-05-03 20:45:30 +00006173Starting at version 0.9.2, U-Boot supports NetBSD both as host
6174(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006175
wdenk6c59edc2004-05-03 20:45:30 +00006176Building requires a cross environment; it is known to work on
6177NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6178need gmake since the Makefiles are not compatible with BSD make).
6179Note that the cross-powerpc package does not install include files;
6180attempting to build U-Boot will fail because <machine/ansi.h> is
6181missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006182
wdenk6c59edc2004-05-03 20:45:30 +00006183 # cd /usr/pkg/cross/powerpc-netbsd/include
6184 # mkdir powerpc
6185 # ln -s powerpc machine
6186 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6187 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006188
wdenk6c59edc2004-05-03 20:45:30 +00006189Native builds *don't* work due to incompatibilities between native
6190and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006191
wdenk6c59edc2004-05-03 20:45:30 +00006192Booting assumes that (the first part of) the image booted is a
6193stage-2 loader which in turn loads and then invokes the kernel
6194proper. Loader sources will eventually appear in the NetBSD source
6195tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006196meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006197
wdenkc6097192002-11-03 00:24:07 +00006198
wdenk6c59edc2004-05-03 20:45:30 +00006199Implementation Internals:
6200=========================
wdenkc6097192002-11-03 00:24:07 +00006201
wdenk6c59edc2004-05-03 20:45:30 +00006202The following is not intended to be a complete description of every
6203implementation detail. However, it should help to understand the
6204inner workings of U-Boot and make it easier to port it to custom
6205hardware.
wdenkc6097192002-11-03 00:24:07 +00006206
wdenkc6097192002-11-03 00:24:07 +00006207
wdenk6c59edc2004-05-03 20:45:30 +00006208Initial Stack, Global Data:
6209---------------------------
wdenkc6097192002-11-03 00:24:07 +00006210
wdenk6c59edc2004-05-03 20:45:30 +00006211The implementation of U-Boot is complicated by the fact that U-Boot
6212starts running out of ROM (flash memory), usually without access to
6213system RAM (because the memory controller is not initialized yet).
6214This means that we don't have writable Data or BSS segments, and BSS
6215is not initialized as zero. To be able to get a C environment working
6216at all, we have to allocate at least a minimal stack. Implementation
6217options for this are defined and restricted by the CPU used: Some CPU
6218models provide on-chip memory (like the IMMR area on MPC8xx and
6219MPC826x processors), on others (parts of) the data cache can be
6220locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006221
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006222 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006223 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006224
wdenk6c59edc2004-05-03 20:45:30 +00006225 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6226 From: "Chris Hallinan" <clh@net1plus.com>
6227 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6228 ...
wdenkc6097192002-11-03 00:24:07 +00006229
wdenk6c59edc2004-05-03 20:45:30 +00006230 Correct me if I'm wrong, folks, but the way I understand it
6231 is this: Using DCACHE as initial RAM for Stack, etc, does not
6232 require any physical RAM backing up the cache. The cleverness
6233 is that the cache is being used as a temporary supply of
6234 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006235 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006236 can see how this works by studying the cache architecture and
6237 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006238
wdenk6c59edc2004-05-03 20:45:30 +00006239 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6240 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006241 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006242 option should work for you. Using CS 4 should be fine if your
6243 board designers haven't used it for something that would
6244 cause you grief during the initial boot! It is frequently not
6245 used.
wdenkc6097192002-11-03 00:24:07 +00006246
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006247 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006248 with your processor/board/system design. The default value
6249 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006250 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006251 than your SDRAM module. If you have a 64MB SDRAM module, set
6252 it above 400_0000. Just make sure your board has no resources
6253 that are supposed to respond to that address! That code in
6254 start.S has been around a while and should work as is when
6255 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006256
wdenk6c59edc2004-05-03 20:45:30 +00006257 -Chris Hallinan
6258 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006259
wdenk6c59edc2004-05-03 20:45:30 +00006260It is essential to remember this, since it has some impact on the C
6261code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006262
wdenk6c59edc2004-05-03 20:45:30 +00006263* Initialized global data (data segment) is read-only. Do not attempt
6264 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006265
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006266* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006267 as zero data - BSS segment) at all - this is undefined, initiali-
6268 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006269
wdenk6c59edc2004-05-03 20:45:30 +00006270* Stack space is very limited. Avoid big data buffers or things like
6271 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006272
wdenk6c59edc2004-05-03 20:45:30 +00006273Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006274normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006275turned out that the implementation of U-Boot can be greatly
6276simplified by making a global data structure (gd_t) available to all
6277functions. We could pass a pointer to this data as argument to _all_
6278functions, but this would bloat the code. Instead we use a feature of
6279the GCC compiler (Global Register Variables) to share the data: we
6280place a pointer (gd) to the global data into a register which we
6281reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006282
wdenk6c59edc2004-05-03 20:45:30 +00006283When choosing a register for such a purpose we are restricted by the
6284relevant (E)ABI specifications for the current architecture, and by
6285GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006286
wdenk6c59edc2004-05-03 20:45:30 +00006287For PowerPC, the following registers have specific use:
6288 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006289 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006290 R3-R4: parameter passing and return values
6291 R5-R10: parameter passing
6292 R13: small data area pointer
6293 R30: GOT pointer
6294 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006295
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006296 (U-Boot also uses R12 as internal GOT pointer. r12
6297 is a volatile register so r12 needs to be reset when
6298 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006299
Wolfgang Denk69c09642008-02-14 22:43:22 +01006300 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006301
wdenk6c59edc2004-05-03 20:45:30 +00006302 Note: on PPC, we could use a static initializer (since the
6303 address of the global data structure is known at compile time),
6304 but it turned out that reserving a register results in somewhat
6305 smaller code - although the code savings are not that big (on
6306 average for all boards 752 bytes for the whole U-Boot image,
6307 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006308
Robin Getz2773d5f2009-08-17 15:23:02 +00006309On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006310 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6311
Robin Getz2773d5f2009-08-17 15:23:02 +00006312 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006313
wdenk6c59edc2004-05-03 20:45:30 +00006314On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006315
wdenk6c59edc2004-05-03 20:45:30 +00006316 R0: function argument word/integer result
6317 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006318 R9: platform specific
6319 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006320 R11: argument (frame) pointer
6321 R12: temporary workspace
6322 R13: stack pointer
6323 R14: link register
6324 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006325
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006326 ==> U-Boot will use R9 to hold a pointer to the global data
6327
6328 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006329
Thomas Chou8fa38582010-05-21 11:08:03 +08006330On Nios II, the ABI is documented here:
6331 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6332
6333 ==> U-Boot will use gp to hold a pointer to the global data
6334
6335 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6336 to access small data sections, so gp is free.
6337
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006338On NDS32, the following registers are used:
6339
6340 R0-R1: argument/return
6341 R2-R5: argument
6342 R15: temporary register for assembler
6343 R16: trampoline register
6344 R28: frame pointer (FP)
6345 R29: global pointer (GP)
6346 R30: link register (LP)
6347 R31: stack pointer (SP)
6348 PC: program counter (PC)
6349
6350 ==> U-Boot will use R10 to hold a pointer to the global data
6351
Wolfgang Denk6405a152006-03-31 18:32:53 +02006352NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6353or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006354
wdenk6c59edc2004-05-03 20:45:30 +00006355Memory Management:
6356------------------
wdenkc6097192002-11-03 00:24:07 +00006357
wdenk6c59edc2004-05-03 20:45:30 +00006358U-Boot runs in system state and uses physical addresses, i.e. the
6359MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006360
wdenk6c59edc2004-05-03 20:45:30 +00006361The available memory is mapped to fixed addresses using the memory
6362controller. In this process, a contiguous block is formed for each
6363memory type (Flash, SDRAM, SRAM), even when it consists of several
6364physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006365
wdenk6c59edc2004-05-03 20:45:30 +00006366U-Boot is installed in the first 128 kB of the first Flash bank (on
6367TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6368booting and sizing and initializing DRAM, the code relocates itself
6369to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006370memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006371configuration setting]. Below that, a structure with global Board
6372Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006373
wdenk6c59edc2004-05-03 20:45:30 +00006374Additionally, some exception handler code is copied to the low 8 kB
6375of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006376
wdenk6c59edc2004-05-03 20:45:30 +00006377So a typical memory configuration with 16 MB of DRAM could look like
6378this:
wdenkc6097192002-11-03 00:24:07 +00006379
wdenk6c59edc2004-05-03 20:45:30 +00006380 0x0000 0000 Exception Vector code
6381 :
6382 0x0000 1FFF
6383 0x0000 2000 Free for Application Use
6384 :
6385 :
wdenkc6097192002-11-03 00:24:07 +00006386
wdenk6c59edc2004-05-03 20:45:30 +00006387 :
6388 :
6389 0x00FB FF20 Monitor Stack (Growing downward)
6390 0x00FB FFAC Board Info Data and permanent copy of global data
6391 0x00FC 0000 Malloc Arena
6392 :
6393 0x00FD FFFF
6394 0x00FE 0000 RAM Copy of Monitor Code
6395 ... eventually: LCD or video framebuffer
6396 ... eventually: pRAM (Protected RAM - unchanged by reset)
6397 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006398
wdenkc6097192002-11-03 00:24:07 +00006399
wdenk6c59edc2004-05-03 20:45:30 +00006400System Initialization:
6401----------------------
wdenkc6097192002-11-03 00:24:07 +00006402
wdenk6c59edc2004-05-03 20:45:30 +00006403In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006404(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006405configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006406To be able to re-map memory U-Boot then jumps to its link address.
6407To be able to implement the initialization code in C, a (small!)
6408initial stack is set up in the internal Dual Ported RAM (in case CPUs
6409which provide such a feature like MPC8xx or MPC8260), or in a locked
6410part of the data cache. After that, U-Boot initializes the CPU core,
6411the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006412
wdenk6c59edc2004-05-03 20:45:30 +00006413Next, all (potentially) available memory banks are mapped using a
6414preliminary mapping. For example, we put them on 512 MB boundaries
6415(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6416on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6417programmed for SDRAM access. Using the temporary configuration, a
6418simple memory test is run that determines the size of the SDRAM
6419banks.
wdenkc6097192002-11-03 00:24:07 +00006420
wdenk6c59edc2004-05-03 20:45:30 +00006421When there is more than one SDRAM bank, and the banks are of
6422different size, the largest is mapped first. For equal size, the first
6423bank (CS2#) is mapped first. The first mapping is always for address
64240x00000000, with any additional banks following immediately to create
6425contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006426
wdenk6c59edc2004-05-03 20:45:30 +00006427Then, the monitor installs itself at the upper end of the SDRAM area
6428and allocates memory for use by malloc() and for the global Board
6429Info data; also, the exception vector code is copied to the low RAM
6430pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006431
wdenk6c59edc2004-05-03 20:45:30 +00006432Only after this relocation will you have a "normal" C environment;
6433until that you are restricted in several ways, mostly because you are
6434running from ROM, and because the code will have to be relocated to a
6435new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006436
wdenkc6097192002-11-03 00:24:07 +00006437
wdenk6c59edc2004-05-03 20:45:30 +00006438U-Boot Porting Guide:
6439----------------------
wdenkc6097192002-11-03 00:24:07 +00006440
wdenk6c59edc2004-05-03 20:45:30 +00006441[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6442list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006443
wdenkc6097192002-11-03 00:24:07 +00006444
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006445int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006446{
6447 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006448
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006449 signal(SIGALRM, no_more_time);
6450 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006451
wdenk6c59edc2004-05-03 20:45:30 +00006452 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006453 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006454 return 0;
6455 }
wdenkc6097192002-11-03 00:24:07 +00006456
wdenk6c59edc2004-05-03 20:45:30 +00006457 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006458
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006459 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006460
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006461 if (clueless)
6462 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006463
wdenk6c59edc2004-05-03 20:45:30 +00006464 while (learning) {
6465 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006466 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6467 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006468 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006469 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006470 }
wdenkc6097192002-11-03 00:24:07 +00006471
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006472 if (available_money > toLocalCurrency ($2500))
6473 Buy a BDI3000;
6474 else
wdenk6c59edc2004-05-03 20:45:30 +00006475 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006476
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006477 if (a similar board exists) { /* hopefully... */
6478 cp -a board/<similar> board/<myboard>
6479 cp include/configs/<similar>.h include/configs/<myboard>.h
6480 } else {
6481 Create your own board support subdirectory;
6482 Create your own board include/configs/<myboard>.h file;
6483 }
6484 Edit new board/<myboard> files
6485 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006486
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006487 while (!accepted) {
6488 while (!running) {
6489 do {
6490 Add / modify source code;
6491 } until (compiles);
6492 Debug;
6493 if (clueless)
6494 email("Hi, I am having problems...");
6495 }
6496 Send patch file to the U-Boot email list;
6497 if (reasonable critiques)
6498 Incorporate improvements from email list code review;
6499 else
6500 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006501 }
wdenkc6097192002-11-03 00:24:07 +00006502
wdenk6c59edc2004-05-03 20:45:30 +00006503 return 0;
6504}
wdenkc6097192002-11-03 00:24:07 +00006505
wdenk6c59edc2004-05-03 20:45:30 +00006506void no_more_time (int sig)
6507{
6508 hire_a_guru();
6509}
wdenkc6097192002-11-03 00:24:07 +00006510
wdenkc6097192002-11-03 00:24:07 +00006511
wdenk6c59edc2004-05-03 20:45:30 +00006512Coding Standards:
6513-----------------
wdenkc6097192002-11-03 00:24:07 +00006514
wdenk6c59edc2004-05-03 20:45:30 +00006515All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006516coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006517"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006518
6519Source files originating from a different project (for example the
6520MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006521reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006522sources.
wdenkc6097192002-11-03 00:24:07 +00006523
Detlev Zundelaa63d482006-09-01 15:39:02 +02006524Please note that U-Boot is implemented in C (and to some small parts in
6525Assembler); no C++ is used, so please do not use C++ style comments (//)
6526in your code.
wdenkad276f22004-01-04 16:28:35 +00006527
wdenk6c59edc2004-05-03 20:45:30 +00006528Please also stick to the following formatting rules:
6529- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006530- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006531- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006532- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006533- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006534
wdenk6c59edc2004-05-03 20:45:30 +00006535Submissions which do not conform to the standards may be returned
6536with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006537
wdenkc6097192002-11-03 00:24:07 +00006538
wdenk6c59edc2004-05-03 20:45:30 +00006539Submitting Patches:
6540-------------------
wdenkc6097192002-11-03 00:24:07 +00006541
wdenk6c59edc2004-05-03 20:45:30 +00006542Since the number of patches for U-Boot is growing, we need to
6543establish some rules. Submissions which do not conform to these rules
6544may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006545
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006546Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006547
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006548Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6549see http://lists.denx.de/mailman/listinfo/u-boot
6550
wdenk6c59edc2004-05-03 20:45:30 +00006551When you send a patch, please include the following information with
6552it:
wdenkc6097192002-11-03 00:24:07 +00006553
wdenk6c59edc2004-05-03 20:45:30 +00006554* For bug fixes: a description of the bug and how your patch fixes
6555 this bug. Please try to include a way of demonstrating that the
6556 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006557
wdenk6c59edc2004-05-03 20:45:30 +00006558* For new features: a description of the feature and your
6559 implementation.
wdenkc6097192002-11-03 00:24:07 +00006560
wdenk6c59edc2004-05-03 20:45:30 +00006561* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006562
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006563* For major contributions, add a MAINTAINERS file with your
6564 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006565
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006566* When you add support for a new board, don't forget to add a
6567 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006568
wdenk6c59edc2004-05-03 20:45:30 +00006569* If your patch adds new configuration options, don't forget to
6570 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006571
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006572* The patch itself. If you are using git (which is *strongly*
6573 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006574 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006575 the U-Boot mailing list, you will avoid most of the common problems
6576 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006577
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006578 If you cannot use git, use "diff -purN OLD NEW". If your version of
6579 diff does not support these options, then get the latest version of
6580 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006581
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006582 The current directory when running this command shall be the parent
6583 directory of the U-Boot source tree (i. e. please make sure that
6584 your patch includes sufficient directory information for the
6585 affected files).
6586
6587 We prefer patches as plain text. MIME attachments are discouraged,
6588 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006589
wdenk6c59edc2004-05-03 20:45:30 +00006590* If one logical set of modifications affects or creates several
6591 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006592
wdenk6c59edc2004-05-03 20:45:30 +00006593* Changesets that contain different, unrelated modifications shall be
6594 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006595
wdenkc6097192002-11-03 00:24:07 +00006596
wdenk6c59edc2004-05-03 20:45:30 +00006597Notes:
wdenkc6097192002-11-03 00:24:07 +00006598
wdenk6c59edc2004-05-03 20:45:30 +00006599* Before sending the patch, run the MAKEALL script on your patched
6600 source tree and make sure that no errors or warnings are reported
6601 for any of the boards.
6602
6603* Keep your modifications to the necessary minimum: A patch
6604 containing several unrelated changes or arbitrary reformats will be
6605 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006606
wdenk6c59edc2004-05-03 20:45:30 +00006607* If you modify existing code, make sure that your new code does not
6608 add to the memory footprint of the code ;-) Small is beautiful!
6609 When adding new features, these should compile conditionally only
6610 (using #ifdef), and the resulting code with the new feature
6611 disabled must not need more memory than the old code without your
6612 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006613
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006614* Remember that there is a size limit of 100 kB per message on the
6615 u-boot mailing list. Bigger patches will be moderated. If they are
6616 reasonable and not too big, they will be acknowledged. But patches
6617 bigger than the size limit should be avoided.