blob: 6f4c09a3a1fc13b47a6510b01c5c96a260c503ff [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
Nikita Kiryanov37dda1c2016-04-16 17:55:03 +03001006 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001007 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger1b0d5512012-12-11 22:16:25 -06001008 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergera2d62b72012-12-11 22:16:33 -06001009 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder94463402013-10-22 19:07:34 -05001010 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001011 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren4f8662d2012-10-22 06:43:50 +00001012 CONFIG_CMD_EXT2 * ext2 command support
1013 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren3d5a3882014-01-24 20:46:37 -07001014 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1015 that work for multiple fs types
Christian Gmeiner9f9eec32014-11-12 14:35:04 +01001016 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysinger78dcaf42009-01-28 19:08:14 -05001017 CONFIG_CMD_SAVEENV saveenv
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001018 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren4f8662d2012-10-22 06:43:50 +00001019 CONFIG_CMD_FAT * FAT command support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001020 CONFIG_CMD_FLASH flinfo, erase, protect
1021 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001022 CONFIG_CMD_FUSE * Device fuse support
Anton Staafd1390c82012-12-05 14:46:29 +00001023 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysinger2ed02412010-12-26 23:32:22 -05001024 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsf0c9d532011-04-05 07:15:14 +00001025 CONFIG_CMD_GREPENV * search environment
Simon Glass058bb8d2012-12-05 14:46:38 +00001026 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001027 CONFIG_CMD_I2C * I2C serial bus support
1028 CONFIG_CMD_IDE * IDE harddisk support
1029 CONFIG_CMD_IMI iminfo
Vipin Kumar3df41b12012-12-16 22:32:48 +00001030 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001031 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001032 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glass4dc47ca2014-06-11 23:29:41 -06001033 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysingerf3ddf202010-12-26 23:09:45 -05001034 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershberger0fd32d72012-10-03 11:15:51 +00001035 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001036 CONFIG_CMD_IRQ * irqinfo
1037 CONFIG_CMD_ITEST Integer/string test of 2 values
1038 CONFIG_CMD_JFFS2 * JFFS2 Support
1039 CONFIG_CMD_KGDB * kgdb
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001040 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00001041 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1042 (169.254.*.*)
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001043 CONFIG_CMD_LOADB loadb
1044 CONFIG_CMD_LOADS loads
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001045 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001046 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glasseacd14f2012-11-30 13:01:20 +00001047 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001048 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denk9d009282013-03-08 10:51:32 +00001049 loop, loopw
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001050 CONFIG_CMD_MEMTEST * mtest
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001051 CONFIG_CMD_MISC Misc functions like sleep etc
1052 CONFIG_CMD_MMC * MMC memory mapped support
1053 CONFIG_CMD_MII * MII utility commands
Stefan Roeseb1423dd2009-03-19 13:30:36 +01001054 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001055 CONFIG_CMD_NAND * NAND support
1056 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001057 CONFIG_CMD_NFS NFS support
Peter Tyser9902e422008-12-17 16:36:21 -06001058 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denk092ae952011-10-26 10:21:21 +00001059 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001060 CONFIG_CMD_PCI * pciinfo
1061 CONFIG_CMD_PCMCIA * PCMCIA support
1062 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1063 host
1064 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersc889fb42012-12-05 14:46:30 +00001065 CONFIG_CMD_READ * Read raw data from partition
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001066 CONFIG_CMD_REGINFO * Register dump
1067 CONFIG_CMD_RUN run command in env variable
Simon Glassbf6ce792012-12-26 09:53:36 +00001068 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001069 CONFIG_CMD_SAVES * save S record dump
Simon Glass8706b812016-05-01 11:36:02 -06001070 CONFIG_SCSI * SCSI Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001071 CONFIG_CMD_SDRAM * print SDRAM configuration information
1072 (requires CONFIG_CMD_I2C)
1073 CONFIG_CMD_SETGETDCR Support for DCR Register access
1074 (4xx only)
Eric Nelson97f5f8f2012-01-31 10:52:08 -07001075 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001076 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz93d6cb02009-07-27 00:07:59 -04001077 (requires CONFIG_CMD_MEMORY)
Bob Liua671b702013-02-05 19:05:41 +08001078 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk85c25df2009-04-01 23:34:12 +02001079 CONFIG_CMD_SOURCE "source" command Support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001080 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7aa81a42011-05-17 00:03:40 +00001081 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass6a398d22011-10-24 18:00:07 +00001082 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershberger59f3f522012-10-03 12:14:57 +00001083 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1084 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001085 CONFIG_CMD_USB * USB support
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001086 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasut71729392012-03-31 07:47:16 +00001087 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehléa618f2b2013-06-20 18:14:22 +02001088 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak2eb40ee2014-04-02 10:20:05 +02001089 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001090
1091 EXAMPLE: If you want all functions except of network
1092 support you can write:
1093
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001094 #include "config_cmd_all.h"
1095 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001096
Gerald Van Barend6abef42007-03-31 12:23:51 -04001097 Other Commands:
1098 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001099
1100 Note: Don't enable the "icache" and "dcache" commands
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001101 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk4a5c8a72003-03-06 00:02:04 +00001102 what you (and your U-Boot users) are doing. Data
1103 cache cannot be enabled on systems like the 8xx or
1104 8260 (where accesses to the IMMR region must be
1105 uncached), and it cannot be disabled on all other
1106 systems where we (mis-) use the data cache to hold an
1107 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001108
1109
1110 XXX - this list needs to get updated!
1111
Simon Glassaa34ef22016-03-13 19:07:28 -06001112- Removal of commands
1113 If no commands are needed to boot, you can disable
1114 CONFIG_CMDLINE to remove them. In this case, the command line
1115 will not be available, and when U-Boot wants to execute the
1116 boot command (on start-up) it will call board_run_command()
1117 instead. This can reduce image size significantly for very
1118 simple boot procedures.
1119
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001120- Regular expression support:
1121 CONFIG_REGEX
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001122 If this variable is defined, U-Boot is linked against
1123 the SLRE (Super Light Regular Expression) library,
1124 which adds regex support to some commands, as for
1125 example "env grep" and "setexpr".
Wolfgang Denk2aceea12013-03-23 23:50:31 +00001126
Simon Glass3d686442011-10-15 05:48:20 +00001127- Device tree:
1128 CONFIG_OF_CONTROL
1129 If this variable is defined, U-Boot will use a device tree
1130 to configure its devices, instead of relying on statically
1131 compiled #defines in the board file. This option is
1132 experimental and only available on a few boards. The device
1133 tree is available in the global data as gd->fdt_blob.
1134
Simon Glass5cb34db2011-10-24 19:15:31 +00001135 U-Boot needs to get its device tree from somewhere. This can
1136 be done using one of the two options below:
Simon Glass38d6b8d2011-10-15 05:48:21 +00001137
1138 CONFIG_OF_EMBED
1139 If this variable is defined, U-Boot will embed a device tree
1140 binary in its image. This device tree file should be in the
1141 board directory and called <soc>-<board>.dts. The binary file
1142 is then picked up in board_init_f() and made available through
1143 the global data structure as gd->blob.
Simon Glass3d686442011-10-15 05:48:20 +00001144
Simon Glass5cb34db2011-10-24 19:15:31 +00001145 CONFIG_OF_SEPARATE
1146 If this variable is defined, U-Boot will build a device tree
1147 binary. It will be called u-boot.dtb. Architecture-specific
1148 code will locate it at run-time. Generally this works by:
1149
1150 cat u-boot.bin u-boot.dtb >image.bin
1151
1152 and in fact, U-Boot does this for you, creating a file called
1153 u-boot-dtb.bin which is useful in the common case. You can
1154 still use the individual files if you need something more
1155 exotic.
1156
wdenkc6097192002-11-03 00:24:07 +00001157- Watchdog:
1158 CONFIG_WATCHDOG
1159 If this variable is defined, it enables watchdog
Detlev Zundel6aa4d7b2011-04-27 05:25:59 +00001160 support for the SoC. There must be support in the SoC
1161 specific code for a watchdog. For the 8xx and 8260
1162 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1163 register. When supported for a specific SoC is
1164 available, then no further board specific code should
1165 be needed to use it.
1166
1167 CONFIG_HW_WATCHDOG
1168 When using a watchdog circuitry external to the used
1169 SoC, then define this variable and provide board
1170 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001171
Heiko Schocher735326c2015-01-21 08:38:22 +01001172 CONFIG_AT91_HW_WDT_TIMEOUT
1173 specify the timeout in seconds. default 2 seconds.
1174
stroeseb9c17c52003-04-04 15:53:41 +00001175- U-Boot Version:
1176 CONFIG_VERSION_VARIABLE
1177 If this variable is defined, an environment variable
1178 named "ver" is created by U-Boot showing the U-Boot
1179 version as printed by the "version" command.
Benoît Thébaudeauce9a1552012-08-13 15:01:14 +02001180 Any change to this variable will be reverted at the
1181 next reset.
stroeseb9c17c52003-04-04 15:53:41 +00001182
wdenkc6097192002-11-03 00:24:07 +00001183- Real-Time Clock:
1184
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001185 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001186 has to be selected, too. Define exactly one of the
1187 following options:
1188
1189 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1190 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam3f8d1782011-10-24 06:44:15 +00001191 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001192 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1fe2c702003-03-06 21:55:29 +00001193 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001194 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk0893c472003-05-20 14:25:27 +00001195 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel90491f22014-07-21 11:06:16 +02001196 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenkef5fe752003-03-12 10:41:04 +00001197 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krillb27939b2008-03-15 15:40:26 +01001198 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenkaeba06f2004-06-09 17:34:58 +00001199 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001200 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher1f1b7012011-03-28 09:24:22 +02001201 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1202 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001203
wdenkb9bbd242003-06-30 16:24:52 +00001204 Note that if the RTC uses I2C, then the I2C interface
1205 must also be configured. See I2C Support, below.
1206
Peter Tyser9902e422008-12-17 16:36:21 -06001207- GPIO Support:
1208 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tyser9902e422008-12-17 16:36:21 -06001209
Chris Packham9b383202010-12-19 10:12:13 +00001210 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1211 chip-ngpio pairs that tell the PCA953X driver the number of
1212 pins supported by a particular chip.
1213
Peter Tyser9902e422008-12-17 16:36:21 -06001214 Note that if the GPIO device uses I2C, then the I2C interface
1215 must also be configured. See I2C Support, below.
1216
Simon Glass4dc47ca2014-06-11 23:29:41 -06001217- I/O tracing:
1218 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1219 accesses and can checksum them or write a list of them out
1220 to memory. See the 'iotrace' command for details. This is
1221 useful for testing device drivers since it can confirm that
1222 the driver behaves the same way before and after a code
1223 change. Currently this is supported on sandbox and arm. To
1224 add support for your architecture, add '#include <iotrace.h>'
1225 to the bottom of arch/<arch>/include/asm/io.h and test.
1226
1227 Example output from the 'iotrace stats' command is below.
1228 Note that if the trace buffer is exhausted, the checksum will
1229 still continue to operate.
1230
1231 iotrace is enabled
1232 Start: 10000000 (buffer start address)
1233 Size: 00010000 (buffer size)
1234 Offset: 00000120 (current buffer offset)
1235 Output: 10000120 (start + offset)
1236 Count: 00000018 (number of trace records)
1237 CRC32: 9526fb66 (CRC32 of all trace records)
1238
wdenkc6097192002-11-03 00:24:07 +00001239- Timestamp Support:
1240
wdenk4a5c8a72003-03-06 00:02:04 +00001241 When CONFIG_TIMESTAMP is selected, the timestamp
1242 (date and time) of an image is printed by image
1243 commands like bootm or iminfo. This option is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001244 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001245
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001246- Partition Labels (disklabels) Supported:
1247 Zero or more of the following:
1248 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1249 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1250 Intel architecture, USB sticks, etc.
1251 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1252 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1253 bootloader. Note 2TB partition limit; see
1254 disk/part_efi.c
1255 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001256
Wolfgang Denkb240aef2008-03-26 10:40:12 +01001257 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glass8706b812016-05-01 11:36:02 -06001258 CONFIG_SCSI) you must configure support for at
Karl O. Pinc8b1f90a2012-08-16 06:20:15 +00001259 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001260
1261- IDE Reset method:
wdenk369d43d2004-03-14 14:09:05 +00001262 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1263 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001264
wdenk369d43d2004-03-14 14:09:05 +00001265 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1266 be performed by calling the function
1267 ide_set_reset(int reset)
1268 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001269
1270- ATAPI Support:
1271 CONFIG_ATAPI
1272
1273 Set this to enable ATAPI support.
1274
wdenkf602aa02004-03-13 23:29:43 +00001275- LBA48 Support
1276 CONFIG_LBA48
1277
1278 Set this to enable support for disks larger than 137GB
Heiko Schocher0f602e12009-12-03 11:21:21 +01001279 Also look at CONFIG_SYS_64BIT_LBA.
wdenkf602aa02004-03-13 23:29:43 +00001280 Whithout these , LBA48 support uses 32bit variables and will 'only'
1281 support disks up to 2.1TB.
1282
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001283 CONFIG_SYS_64BIT_LBA:
wdenkf602aa02004-03-13 23:29:43 +00001284 When enabled, makes the IDE subsystem use 64bit sector addresses.
1285 Default is 32bit.
1286
wdenkc6097192002-11-03 00:24:07 +00001287- SCSI Support:
1288 At the moment only there is only support for the
1289 SYM53C8XX SCSI controller; define
1290 CONFIG_SCSI_SYM53C8XX to enable it.
1291
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001292 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1293 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1294 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001295 maximum numbers of LUNs, SCSI ID's and target
1296 devices.
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001297 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001298
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02001299 The environment variable 'scsidevs' is set to the number of
1300 SCSI devices found during the last scan.
Stefan Reinauere50a10e2012-10-29 05:23:48 +00001301
wdenkc6097192002-11-03 00:24:07 +00001302- NETWORK Support (PCI):
wdenk4e112c12003-06-03 23:54:09 +00001303 CONFIG_E1000
Kyle Moffett64b94dd2011-10-18 11:05:29 +00001304 Support for Intel 8254x/8257x gigabit chips.
1305
1306 CONFIG_E1000_SPI
1307 Utility code for direct access to the SPI bus on Intel 8257x.
1308 This does not do anything useful unless you set at least one
1309 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1310
1311 CONFIG_E1000_SPI_GENERIC
1312 Allow generic access to the SPI bus on the Intel 8257x, for
1313 example with the "sspi" command.
1314
1315 CONFIG_CMD_E1000
1316 Management command for E1000 devices. When used on devices
1317 with SPI support you can reprogram the EEPROM from U-Boot.
stroese94ef1cf2003-06-05 15:39:44 +00001318
wdenkc6097192002-11-03 00:24:07 +00001319 CONFIG_EEPRO100
1320 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001321 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001322 write routine for first time initialisation.
1323
1324 CONFIG_TULIP
1325 Support for Digital 2114x chips.
1326 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1327 modem chip initialisation (KS8761/QS6611).
1328
1329 CONFIG_NATSEMI
1330 Support for National dp83815 chips.
1331
1332 CONFIG_NS8382X
1333 Support for National dp8382[01] gigabit chips.
1334
wdenkaa603362003-05-12 21:50:16 +00001335- NETWORK Support (other):
1336
Jens Scharsigdab7cb82010-01-23 12:03:45 +01001337 CONFIG_DRIVER_AT91EMAC
1338 Support for AT91RM9200 EMAC.
1339
1340 CONFIG_RMII
1341 Define this to use reduced MII inteface
1342
1343 CONFIG_DRIVER_AT91EMAC_QUIET
1344 If this defined, the driver is quiet.
1345 The driver doen't show link status messages.
1346
Rob Herringc9830dc2011-12-15 11:15:49 +00001347 CONFIG_CALXEDA_XGMAC
1348 Support for the Calxeda XGMAC device
1349
Ashok93fb8722012-10-15 06:20:47 +00001350 CONFIG_LAN91C96
wdenkaa603362003-05-12 21:50:16 +00001351 Support for SMSC's LAN91C96 chips.
1352
1353 CONFIG_LAN91C96_BASE
1354 Define this to hold the physical address
1355 of the LAN91C96's I/O space
1356
1357 CONFIG_LAN91C96_USE_32_BIT
1358 Define this to enable 32 bit addressing
1359
Ashok93fb8722012-10-15 06:20:47 +00001360 CONFIG_SMC91111
wdenk3c711762004-06-09 13:37:52 +00001361 Support for SMSC's LAN91C111 chip
1362
1363 CONFIG_SMC91111_BASE
1364 Define this to hold the physical address
1365 of the device (I/O space)
1366
1367 CONFIG_SMC_USE_32_BIT
1368 Define this if data bus is 32 bits
1369
1370 CONFIG_SMC_USE_IOFUNCS
1371 Define this to use i/o functions instead of macros
1372 (some hardware wont work with macros)
1373
Heiko Schocher7d037f72011-11-15 10:00:04 -05001374 CONFIG_DRIVER_TI_EMAC
1375 Support for davinci emac
1376
1377 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1378 Define this if you have more then 3 PHYs.
1379
Macpaul Lin199c6252010-12-21 16:59:46 +08001380 CONFIG_FTGMAC100
1381 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1382
1383 CONFIG_FTGMAC100_EGIGA
1384 Define this to use GE link update with gigabit PHY.
1385 Define this if FTGMAC100 is connected to gigabit PHY.
1386 If your system has 10/100 PHY only, it might not occur
1387 wrong behavior. Because PHY usually return timeout or
1388 useless data when polling gigabit status and gigabit
1389 control registers. This behavior won't affect the
1390 correctnessof 10/100 link speed update.
1391
Mike Rapoportf4761af2009-11-11 10:03:03 +02001392 CONFIG_SMC911X
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001393 Support for SMSC's LAN911x and LAN921x chips
1394
Mike Rapoportf4761af2009-11-11 10:03:03 +02001395 CONFIG_SMC911X_BASE
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001396 Define this to hold the physical address
1397 of the device (I/O space)
1398
Mike Rapoportf4761af2009-11-11 10:03:03 +02001399 CONFIG_SMC911X_32_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001400 Define this if data bus is 32 bits
1401
Mike Rapoportf4761af2009-11-11 10:03:03 +02001402 CONFIG_SMC911X_16_BIT
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001403 Define this if data bus is 16 bits. If your processor
1404 automatically converts one 32 bit word to two 16 bit
Mike Rapoportf4761af2009-11-11 10:03:03 +02001405 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein1dd48252008-05-05 14:06:11 +02001406
Yoshihiro Shimodaed4cea02011-01-27 10:06:03 +09001407 CONFIG_SH_ETHER
1408 Support for Renesas on-chip Ethernet controller
1409
1410 CONFIG_SH_ETHER_USE_PORT
1411 Define the number of ports to be used
1412
1413 CONFIG_SH_ETHER_PHY_ADDR
1414 Define the ETH PHY's address
1415
Yoshihiro Shimoda281aa052011-01-27 10:06:08 +09001416 CONFIG_SH_ETHER_CACHE_WRITEBACK
1417 If this option is set, the driver enables cache flush.
1418
Heiko Schocher2b387762014-07-18 06:07:19 +02001419- PWM Support:
1420 CONFIG_PWM_IMX
1421 Support for PWM modul on the imx6.
1422
Vadim Bendeburydac69642011-10-17 08:36:14 +00001423- TPM Support:
Che-liang Chiouacea5702013-04-12 11:04:34 +00001424 CONFIG_TPM
1425 Support TPM devices.
1426
Christophe Ricard8759ff82015-10-06 22:54:41 +02001427 CONFIG_TPM_TIS_INFINEON
1428 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001429 per system is supported at this time.
1430
Tom Wai-Hong Tame49fed52013-04-12 11:04:37 +00001431 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1432 Define the burst count bytes upper limit
1433
Christophe Ricard88249232016-01-21 23:27:13 +01001434 CONFIG_TPM_ST33ZP24
1435 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1436
1437 CONFIG_TPM_ST33ZP24_I2C
1438 Support for STMicroelectronics ST33ZP24 I2C devices.
1439 Requires TPM_ST33ZP24 and I2C.
1440
Christophe Ricard5ffadc32016-01-21 23:27:14 +01001441 CONFIG_TPM_ST33ZP24_SPI
1442 Support for STMicroelectronics ST33ZP24 SPI devices.
1443 Requires TPM_ST33ZP24 and SPI.
1444
Dirk Eibach20489092013-06-26 15:55:15 +02001445 CONFIG_TPM_ATMEL_TWI
1446 Support for Atmel TWI TPM device. Requires I2C support.
1447
Che-liang Chiouacea5702013-04-12 11:04:34 +00001448 CONFIG_TPM_TIS_LPC
Vadim Bendeburydac69642011-10-17 08:36:14 +00001449 Support for generic parallel port TPM devices. Only one device
1450 per system is supported at this time.
1451
1452 CONFIG_TPM_TIS_BASE_ADDRESS
1453 Base address where the generic TPM device is mapped
1454 to. Contemporary x86 systems usually map it at
1455 0xfed40000.
1456
Reinhard Pfau4fece432013-06-26 15:55:13 +02001457 CONFIG_CMD_TPM
1458 Add tpm monitor functions.
1459 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1460 provides monitor access to authorized functions.
1461
1462 CONFIG_TPM
1463 Define this to enable the TPM support library which provides
1464 functional interfaces to some TPM commands.
1465 Requires support for a TPM device.
1466
1467 CONFIG_TPM_AUTH_SESSIONS
1468 Define this to enable authorized functions in the TPM library.
1469 Requires CONFIG_TPM and CONFIG_SHA1.
1470
wdenkc6097192002-11-03 00:24:07 +00001471- USB Support:
1472 At the moment only the UHCI host controller is
wdenk369d43d2004-03-14 14:09:05 +00001473 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001474 CONFIG_USB_UHCI to enable it.
1475 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenkfb30b4c2004-10-09 22:44:59 +00001476 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001477 storage devices.
1478 Note:
1479 Supported are USB Keyboards and USB Floppy drives
1480 (TEAC FD-05PUB).
wdenk369d43d2004-03-14 14:09:05 +00001481 MPC5200 USB requires additional defines:
1482 CONFIG_USB_CLOCK
1483 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt02848522009-08-13 08:32:37 -05001484 CONFIG_PSC3_USB
1485 for USB on PSC3
wdenk369d43d2004-03-14 14:09:05 +00001486 CONFIG_USB_CONFIG
1487 for differential drivers: 0x00001000
1488 for single ended drivers: 0x00005000
Eric Millbrandt02848522009-08-13 08:32:37 -05001489 for differential drivers on PSC3: 0x00000100
1490 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001491 CONFIG_SYS_USB_EVENT_POLL
Zhang Wei063f9ff2007-06-06 10:08:13 +02001492 May be defined to allow interrupt polling
1493 instead of using asynchronous interrupts
wdenk369d43d2004-03-14 14:09:05 +00001494
Simon Glass5978cdb2012-02-27 10:52:47 +00001495 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1496 txfilltuning field in the EHCI controller on reset.
1497
Oleksandr Tymoshenko7a881752014-02-01 21:51:25 -07001498 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1499 HW module registers.
1500
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001501- USB Device:
1502 Define the below if you wish to use the USB console.
1503 Once firmware is rebuilt from a serial console issue the
1504 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001505 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001506 it has found a new device. The environment variable usbtty
1507 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denke2601822006-06-14 18:14:56 +02001508 appear to a USB host as a Linux gserial device or a
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001509 Common Device Class Abstract Control Model serial device.
1510 If you select usbtty = gserial you should be able to enumerate
1511 a Linux host by
1512 # modprobe usbserial vendor=0xVendorID product=0xProductID
1513 else if using cdc_acm, simply setting the environment
1514 variable usbtty to be cdc_acm should suffice. The following
1515 might be defined in YourBoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001516
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001517 CONFIG_USB_DEVICE
1518 Define this to build a UDC device
1519
1520 CONFIG_USB_TTY
1521 Define this to have a tty type of device available to
1522 talk to the UDC device
Wolfgang Denke2601822006-06-14 18:14:56 +02001523
Vipin KUMARbdb17702012-03-26 15:38:06 +05301524 CONFIG_USBD_HS
1525 Define this to enable the high speed support for usb
1526 device and usbtty. If this feature is enabled, a routine
1527 int is_usbd_high_speed(void)
1528 also needs to be defined by the driver to dynamically poll
1529 whether the enumeration has succeded at high speed or full
1530 speed.
1531
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001532 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001533 Define this if you want stdin, stdout &/or stderr to
1534 be set to usbtty.
1535
1536 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001537 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001538 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001539 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denke2601822006-06-14 18:14:56 +02001540
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001541 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001542 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001543 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001544
Wolfgang Denke2601822006-06-14 18:14:56 +02001545 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001546 define your own vendor specific values either in BoardName.h
Wolfgang Denke2601822006-06-14 18:14:56 +02001547 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001548 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1549 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1550 should pretend to be a Linux device to it's target host.
1551
1552 CONFIG_USBD_MANUFACTURER
1553 Define this string as the name of your company for
1554 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denke2601822006-06-14 18:14:56 +02001555
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001556 CONFIG_USBD_PRODUCT_NAME
1557 Define this string as the name of your product
1558 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
wdenkc6097192002-11-03 00:24:07 +00001559
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001560 CONFIG_USBD_VENDORID
1561 Define this as your assigned Vendor ID from the USB
1562 Implementors Forum. This *must* be a genuine Vendor ID
1563 to avoid polluting the USB namespace.
1564 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001565
Wolfgang Denk3f0137b2006-06-14 17:45:53 +02001566 CONFIG_USBD_PRODUCTID
1567 Define this as the unique Product ID
1568 for your device
1569 - CONFIG_USBD_PRODUCTID 0xFFFF
Wolfgang Denke2601822006-06-14 18:14:56 +02001570
Igor Grinbergac5f6ee2011-12-12 12:08:35 +02001571- ULPI Layer Support:
1572 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1573 the generic ULPI layer. The generic layer accesses the ULPI PHY
1574 via the platform viewport, so you need both the genric layer and
1575 the viewport enabled. Currently only Chipidea/ARC based
1576 viewport is supported.
1577 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1578 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stachf31e4112012-10-01 00:44:35 +02001579 If your ULPI phy needs a different reference clock than the
1580 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1581 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001582
wdenk7a428cc2003-06-15 22:40:42 +00001583- MMC Support:
wdenk57b2d802003-06-27 21:31:46 +00001584 The MMC controller on the Intel PXA is supported. To
1585 enable this define CONFIG_MMC. The MMC can be
1586 accessed from the boot prompt by mapping the device
wdenk7a428cc2003-06-15 22:40:42 +00001587 to physical memory similar to flash. Command line is
Jon Loeligerc1da5c92007-06-11 19:03:39 -05001588 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1589 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenk7a428cc2003-06-15 22:40:42 +00001590
Yoshihiro Shimodadb7717b2011-07-04 22:21:22 +00001591 CONFIG_SH_MMCIF
1592 Support for Renesas on-chip MMCIF controller
1593
1594 CONFIG_SH_MMCIF_ADDR
1595 Define the base address of MMCIF registers
1596
1597 CONFIG_SH_MMCIF_CLK
1598 Define the clock frequency for MMCIF
1599
Pierre Aubertbcc302c2014-04-24 10:30:08 +02001600 CONFIG_GENERIC_MMC
1601 Enable the generic MMC driver
1602
1603 CONFIG_SUPPORT_EMMC_BOOT
1604 Enable some additional features of the eMMC boot partitions.
1605
1606 CONFIG_SUPPORT_EMMC_RPMB
1607 Enable the commands for reading, writing and programming the
1608 key for the Replay Protection Memory Block partition in eMMC.
1609
Tom Rini58a8d322013-03-14 05:32:47 +00001610- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski045d6052015-06-12 19:56:58 +02001611 CONFIG_USB_FUNCTION_DFU
Tom Rini58a8d322013-03-14 05:32:47 +00001612 This enables the USB portion of the DFU USB class
1613
1614 CONFIG_CMD_DFU
1615 This enables the command "dfu" which is used to have
1616 U-Boot create a DFU class device via USB. This command
1617 requires that the "dfu_alt_info" environment variable be
1618 set and define the alt settings to expose to the host.
1619
1620 CONFIG_DFU_MMC
1621 This enables support for exposing (e)MMC devices via DFU.
1622
Pantelis Antonioucf14d0d2013-03-14 05:32:52 +00001623 CONFIG_DFU_NAND
1624 This enables support for exposing NAND devices via DFU.
1625
Afzal Mohammede3c687a2013-09-18 01:15:24 +05301626 CONFIG_DFU_RAM
1627 This enables support for exposing RAM via DFU.
1628 Note: DFU spec refer to non-volatile memory usage, but
1629 allow usages beyond the scope of spec - here RAM usage,
1630 one that would help mostly the developer.
1631
Heiko Schochera2f831e2013-06-12 06:05:51 +02001632 CONFIG_SYS_DFU_DATA_BUF_SIZE
1633 Dfu transfer uses a buffer before writing data to the
1634 raw storage device. Make the size (in bytes) of this buffer
1635 configurable. The size of this buffer is also configurable
1636 through the "dfu_bufsiz" environment variable.
1637
Pantelis Antonioua6e788d2013-03-14 05:32:48 +00001638 CONFIG_SYS_DFU_MAX_FILE_SIZE
1639 When updating files rather than the raw storage device,
1640 we use a static buffer to copy the file into and then write
1641 the buffer once we've been given the whole file. Define
1642 this to the maximum filesize (in bytes) for the buffer.
1643 Default is 4 MiB if undefined.
1644
Heiko Schochere1ba1512014-03-18 08:09:56 +01001645 DFU_DEFAULT_POLL_TIMEOUT
1646 Poll timeout [ms], is the timeout a device can send to the
1647 host. The host must wait for this timeout before sending
1648 a subsequent DFU_GET_STATUS request to the device.
1649
1650 DFU_MANIFEST_POLL_TIMEOUT
1651 Poll timeout [ms], which the device sends to the host when
1652 entering dfuMANIFEST state. Host waits this timeout, before
1653 sending again an USB request to the device.
1654
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001655- USB Device Android Fastboot support:
Paul Kocialkowskid55acc02015-06-12 19:56:59 +02001656 CONFIG_USB_FUNCTION_FASTBOOT
1657 This enables the USB part of the fastboot gadget
1658
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001659 CONFIG_CMD_FASTBOOT
1660 This enables the command "fastboot" which enables the Android
1661 fastboot mode for the platform's USB device. Fastboot is a USB
1662 protocol for downloading images, flashing and device control
1663 used on Android devices.
1664 See doc/README.android-fastboot for more information.
1665
1666 CONFIG_ANDROID_BOOT_IMAGE
1667 This enables support for booting images which use the Android
1668 image format header.
1669
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001670 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001671 The fastboot protocol requires a large memory buffer for
1672 downloads. Define this to the starting RAM address to use for
1673 downloaded images.
1674
Paul Kocialkowskif84f0912015-07-20 12:38:22 +02001675 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior9d4471e2014-05-05 15:08:10 -05001676 The fastboot protocol requires a large memory buffer for
1677 downloads. This buffer should be as large as possible for a
1678 platform. Define this to the size available RAM for fastboot.
1679
Steve Raebfb9ba42014-08-26 11:47:28 -07001680 CONFIG_FASTBOOT_FLASH
1681 The fastboot protocol includes a "flash" command for writing
1682 the downloaded image to a non-volatile storage device. Define
1683 this to enable the "fastboot flash" command.
1684
1685 CONFIG_FASTBOOT_FLASH_MMC_DEV
1686 The fastboot "flash" command requires additional information
1687 regarding the non-volatile storage device. Define this to
1688 the eMMC device that fastboot should use to store the image.
1689
Steve Rae7d059342014-12-12 15:51:54 -08001690 CONFIG_FASTBOOT_GPT_NAME
1691 The fastboot "flash" command supports writing the downloaded
1692 image to the Protective MBR and the Primary GUID Partition
1693 Table. (Additionally, this downloaded image is post-processed
1694 to generate and write the Backup GUID Partition Table.)
1695 This occurs when the specified "partition name" on the
1696 "fastboot flash" command line matches this value.
1697 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1698
wdenkda04a8b2004-08-02 23:22:59 +00001699- Journaling Flash filesystem support:
1700 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1701 CONFIG_JFFS2_NAND_DEV
1702 Define these for a default partition on a NAND device
1703
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001704 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1705 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenkda04a8b2004-08-02 23:22:59 +00001706 Define these for a default partition on a NOR device
1707
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001708 CONFIG_SYS_JFFS_CUSTOM_PART
wdenkda04a8b2004-08-02 23:22:59 +00001709 Define this to create an own partition. You have to provide a
1710 function struct part_info* jffs2_part_info(int part_num)
1711
1712 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001713 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenkda04a8b2004-08-02 23:22:59 +00001714 to disable the command chpart. This is the default when you
1715 have not defined a custom partition
1716
Donggeun Kim8f814002011-10-24 21:15:28 +00001717- FAT(File Allocation Table) filesystem write function support:
1718 CONFIG_FAT_WRITE
Donggeun Kimb44c8ab2012-03-22 04:38:56 +00001719
1720 Define this to enable support for saving memory data as a
1721 file in FAT formatted partition.
1722
1723 This will also enable the command "fatwrite" enabling the
1724 user to write files to FAT.
Donggeun Kim8f814002011-10-24 21:15:28 +00001725
Gabe Black7f8574c2012-10-12 14:26:11 +00001726CBFS (Coreboot Filesystem) support
1727 CONFIG_CMD_CBFS
1728
1729 Define this to enable support for reading from a Coreboot
1730 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1731 and cbfsload.
1732
Siva Durga Prasad Paladugu1c4cf332014-05-26 19:18:37 +05301733- FAT(File Allocation Table) filesystem cluster size:
1734 CONFIG_FS_FAT_MAX_CLUSTSIZE
1735
1736 Define the max cluster size for fat operations else
1737 a default value of 65536 will be defined.
1738
wdenkc6097192002-11-03 00:24:07 +00001739- Keyboard Support:
Simon Glasseaba37e2015-11-11 10:05:47 -07001740 See Kconfig help for available keyboard drivers.
1741
1742 CONFIG_KEYBOARD
1743
1744 Define this to enable a custom keyboard support.
1745 This simply calls drv_keyboard_init() which must be
1746 defined in your board-specific files. This option is deprecated
1747 and is only used by novena. For new boards, use driver model
1748 instead.
wdenkc6097192002-11-03 00:24:07 +00001749
1750- Video support:
1751 CONFIG_VIDEO
1752
1753 Define this to enable video support (for output to
1754 video).
1755
1756 CONFIG_VIDEO_CT69000
1757
1758 Enable Chips & Technologies 69000 Video chip
1759
1760 CONFIG_VIDEO_SMI_LYNXEM
wdenkd3602132004-03-25 15:14:43 +00001761 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkaea86e42004-03-23 22:53:55 +00001762 video output is selected via environment 'videoout'
1763 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1764 assumed.
wdenkc6097192002-11-03 00:24:07 +00001765
wdenkd3602132004-03-25 15:14:43 +00001766 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02001767 selected via environment 'videomode'. Two different ways
wdenkaea86e42004-03-23 22:53:55 +00001768 are possible:
1769 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk05939202004-04-18 17:39:38 +00001770 Following standard modes are supported (* is default):
wdenkaea86e42004-03-23 22:53:55 +00001771
1772 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1773 -------------+---------------------------------------------
1774 8 bits | 0x301* 0x303 0x305 0x161 0x307
1775 15 bits | 0x310 0x313 0x316 0x162 0x319
1776 16 bits | 0x311 0x314 0x317 0x163 0x31A
1777 24 bits | 0x312 0x315 0x318 ? 0x31B
1778 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001779 (i.e. setenv videomode 317; saveenv; reset;)
1780
wdenkd3602132004-03-25 15:14:43 +00001781 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswileraea68562007-12-30 03:30:46 +01001782 from the bootargs. (See drivers/video/videomodes.c)
wdenkaea86e42004-03-23 22:53:55 +00001783
1784
stroeseb9c17c52003-04-04 15:53:41 +00001785 CONFIG_VIDEO_SED13806
wdenk4a5c8a72003-03-06 00:02:04 +00001786 Enable Epson SED13806 driver. This driver supports 8bpp
wdenk9dd2b882002-12-03 21:28:10 +00001787 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1788 or CONFIG_VIDEO_SED13806_16BPP
1789
Timur Tabi020edd22011-02-15 17:09:19 -06001790 CONFIG_FSL_DIU_FB
Wolfgang Denk825223d2011-09-11 21:24:09 +02001791 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi020edd22011-02-15 17:09:19 -06001792 SOCs that have a DIU should define this macro to enable DIU
1793 support, and should also define these other macros:
1794
1795 CONFIG_SYS_DIU_ADDR
1796 CONFIG_VIDEO
1797 CONFIG_CMD_BMP
1798 CONFIG_CFB_CONSOLE
1799 CONFIG_VIDEO_SW_CURSOR
1800 CONFIG_VGA_AS_SINGLE_DEVICE
1801 CONFIG_VIDEO_LOGO
1802 CONFIG_VIDEO_BMP_LOGO
1803
Timur Tabi32f709e2011-04-11 14:18:22 -05001804 The DIU driver will look for the 'video-mode' environment
1805 variable, and if defined, enable the DIU as a console during
Fabio Estevamd3ad5e52016-04-02 11:53:18 -03001806 boot. See the documentation file doc/README.video for a
Timur Tabi32f709e2011-04-11 14:18:22 -05001807 description of this variable.
Timur Tabi020edd22011-02-15 17:09:19 -06001808
wdenkc6097192002-11-03 00:24:07 +00001809- LCD Support: CONFIG_LCD
1810
1811 Define this to enable LCD support (for output to LCD
1812 display); also select one of the supported displays
1813 by defining one of these:
1814
Stelian Popf6f86652008-05-09 21:57:18 +02001815 CONFIG_ATMEL_LCD:
1816
1817 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1818
wdenkc0d54ae2003-11-25 16:55:19 +00001819 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001820
wdenkc0d54ae2003-11-25 16:55:19 +00001821 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001822
wdenkc0d54ae2003-11-25 16:55:19 +00001823 CONFIG_NEC_NL6448BC20
1824
1825 NEC NL6448BC20-08. 6.5", 640x480.
1826 Active, color, single scan.
1827
1828 CONFIG_NEC_NL6448BC33_54
wdenkc6097192002-11-03 00:24:07 +00001829
wdenkc0d54ae2003-11-25 16:55:19 +00001830 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001831 Active, color, single scan.
1832
1833 CONFIG_SHARP_16x9
1834
1835 Sharp 320x240. Active, color, single scan.
1836 It isn't 16x9, and I am not sure what it is.
1837
1838 CONFIG_SHARP_LQ64D341
1839
1840 Sharp LQ64D341 display, 640x480.
1841 Active, color, single scan.
1842
1843 CONFIG_HLD1045
1844
1845 HLD1045 display, 640x480.
1846 Active, color, single scan.
1847
1848 CONFIG_OPTREX_BW
1849
1850 Optrex CBL50840-2 NF-FW 99 22 M5
1851 or
1852 Hitachi LMG6912RPFC-00T
1853 or
1854 Hitachi SP14Q002
1855
1856 320x240. Black & white.
1857
1858 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001859 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001860
Simon Glass599a4df2012-10-17 13:24:54 +00001861 CONFIG_LCD_ALIGNMENT
1862
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001863 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass599a4df2012-10-17 13:24:54 +00001864 defined then the LCD will be aligned to this value instead.
1865 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1866 here, since it is cheaper to change data cache settings on
1867 a per-section basis.
1868
Simon Glassaf3e2802012-10-17 13:24:59 +00001869 CONFIG_CONSOLE_SCROLL_LINES
1870
1871 When the console need to be scrolled, this is the number of
1872 lines to scroll by. It defaults to 1. Increasing this makes
1873 the console jump but can help speed up operation when scrolling
1874 is slow.
Simon Glass599a4df2012-10-17 13:24:54 +00001875
Hannes Petermaiera3c8e862015-03-27 08:01:38 +01001876 CONFIG_LCD_ROTATION
1877
1878 Sometimes, for example if the display is mounted in portrait
1879 mode or even if it's mounted landscape but rotated by 180degree,
1880 we need to rotate our content of the display relative to the
1881 framebuffer, so that user can read the messages which are
1882 printed out.
1883 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1884 initialized with a given rotation from "vl_rot" out of
1885 "vidinfo_t" which is provided by the board specific code.
1886 The value for vl_rot is coded as following (matching to
1887 fbcon=rotate:<n> linux-kernel commandline):
1888 0 = no rotation respectively 0 degree
1889 1 = 90 degree rotation
1890 2 = 180 degree rotation
1891 3 = 270 degree rotation
1892
1893 If CONFIG_LCD_ROTATION is not defined, the console will be
1894 initialized with 0degree rotation.
1895
Tom Wai-Hong Tam79926a42012-09-28 15:11:16 +00001896 CONFIG_LCD_BMP_RLE8
1897
1898 Support drawing of RLE8-compressed bitmaps on the LCD.
1899
Tom Wai-Hong Tam6664f202012-12-05 14:46:40 +00001900 CONFIG_I2C_EDID
1901
1902 Enables an 'i2c edid' command which can read EDID
1903 information over I2C from an attached LCD display.
1904
wdenkeb20ad32003-09-05 23:19:14 +00001905- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenk92bbe3f2003-04-20 14:04:18 +00001906
wdenk57b2d802003-06-27 21:31:46 +00001907 If this option is set, the environment is checked for
1908 a variable "splashimage". If found, the usual display
1909 of logo, copyright and system information on the LCD
wdenk01686632004-06-30 22:59:18 +00001910 is suppressed and the BMP image at the address
wdenk57b2d802003-06-27 21:31:46 +00001911 specified in "splashimage" is loaded instead. The
1912 console is redirected to the "nulldev", too. This
1913 allows for a "silent" boot where a splash screen is
1914 loaded very quickly after power-on.
wdenk92bbe3f2003-04-20 14:04:18 +00001915
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001916 CONFIG_SPLASHIMAGE_GUARD
1917
1918 If this option is set, then U-Boot will prevent the environment
1919 variable "splashimage" from being set to a problematic address
Fabio Estevama58b4912016-03-23 12:46:12 -03001920 (see doc/README.displaying-bmps).
Nikita Kiryanov2f3e2ca2013-02-24 21:28:43 +00001921 This option is useful for targets where, due to alignment
1922 restrictions, an improperly aligned BMP image will cause a data
1923 abort. If you think you will not have problems with unaligned
1924 accesses (for example because your toolchain prevents them)
1925 there is no need to set this option.
1926
Matthias Weisser53884182009-07-09 16:07:30 +02001927 CONFIG_SPLASH_SCREEN_ALIGN
1928
1929 If this option is set the splash image can be freely positioned
1930 on the screen. Environment variable "splashpos" specifies the
1931 position as "x,y". If a positive number is given it is used as
1932 number of pixel from left/top. If a negative number is given it
1933 is used as number of pixel from right/bottom. You can also
1934 specify 'm' for centering the image.
1935
1936 Example:
1937 setenv splashpos m,m
1938 => image at center of screen
1939
1940 setenv splashpos 30,20
1941 => image at x = 30 and y = 20
1942
1943 setenv splashpos -10,m
1944 => vertically centered image
1945 at x = dspWidth - bmpWidth - 9
1946
Stefan Roesed9d97742005-09-22 09:04:17 +02001947- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1948
1949 If this option is set, additionally to standard BMP
1950 images, gzipped BMP images can be displayed via the
1951 splashscreen support or the bmp command.
1952
Anatolij Gustschin6b4e4fc2010-03-15 14:50:25 +01001953- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1954
1955 If this option is set, 8-bit RLE compressed BMP images
1956 can be displayed via the splashscreen support or the
1957 bmp command.
1958
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08001959- Do compressing for memory range:
Lei Wene4e248d2012-09-28 04:26:47 +00001960 CONFIG_CMD_ZIP
1961
1962 If this option is set, it would use zlib deflate method
1963 to compress the specified memory at its best effort.
1964
wdenk710e3502003-08-29 20:57:53 +00001965- Compression support:
Kees Cook5b06e642013-08-16 07:59:12 -07001966 CONFIG_GZIP
1967
1968 Enabled by default to support gzip compressed images.
1969
wdenk710e3502003-08-29 20:57:53 +00001970 CONFIG_BZIP2
1971
1972 If this option is set, support for bzip2 compressed
1973 images is included. If not, only uncompressed and gzip
1974 compressed images are supported.
1975
wdenk9c53f402003-10-15 23:53:47 +00001976 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02001977 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk9c53f402003-10-15 23:53:47 +00001978 be at least 4MB.
wdenk92bbe3f2003-04-20 14:04:18 +00001979
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02001980 CONFIG_LZMA
1981
1982 If this option is set, support for lzma compressed
1983 images is included.
1984
1985 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1986 requires an amount of dynamic memory that is given by the
1987 formula:
1988
1989 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1990
1991 Where lc and lp stand for, respectively, Literal context bits
1992 and Literal pos bits.
1993
1994 This value is upper-bounded by 14MB in the worst case. Anyway,
1995 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1996 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1997 a very small buffer.
1998
1999 Use the lzmainfo tool to determinate the lc and lp values and
2000 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002001 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +02002002
Kees Cook5b06e642013-08-16 07:59:12 -07002003 CONFIG_LZO
2004
2005 If this option is set, support for LZO compressed images
2006 is included.
2007
wdenk0e2bd9c2004-06-06 21:51:03 +00002008- MII/PHY support:
2009 CONFIG_PHY_ADDR
2010
2011 The address of PHY on MII bus.
2012
2013 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2014
2015 The clock frequency of the MII bus
2016
2017 CONFIG_PHY_GIGE
2018
2019 If this option is set, support for speed/duplex
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002020 detection of gigabit PHY is included.
wdenk0e2bd9c2004-06-06 21:51:03 +00002021
2022 CONFIG_PHY_RESET_DELAY
2023
2024 Some PHY like Intel LXT971A need extra delay after
2025 reset before any MII register access is possible.
2026 For such PHY, set this option to the usec delay
2027 required. (minimum 300usec for LXT971A)
2028
2029 CONFIG_PHY_CMD_DELAY (ppc4xx)
2030
2031 Some PHY like Intel LXT971A need extra delay after
2032 command issued before MII status register can be read
2033
wdenkc6097192002-11-03 00:24:07 +00002034- IP address:
2035 CONFIG_IPADDR
2036
2037 Define a default value for the IP address to use for
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002038 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002039 determined through e.g. bootp.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002040 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002041
2042- Server IP address:
2043 CONFIG_SERVERIP
2044
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002045 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002046 server to contact when using the "tftboot" command.
Wolfgang Denk26da2992011-10-26 10:21:22 +00002047 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002048
Robin Getz470a6d42009-07-21 12:15:28 -04002049 CONFIG_KEEP_SERVERADDR
2050
2051 Keeps the server's MAC address, in the env 'serveraddr'
2052 for passing to bootargs (like Linux's netconsole option)
2053
Wolfgang Denk26da2992011-10-26 10:21:22 +00002054- Gateway IP address:
2055 CONFIG_GATEWAYIP
2056
2057 Defines a default value for the IP address of the
2058 default router where packets to other networks are
2059 sent to.
2060 (Environment variable "gatewayip")
2061
2062- Subnet mask:
2063 CONFIG_NETMASK
2064
2065 Defines a default value for the subnet mask (or
2066 routing prefix) which is used to determine if an IP
2067 address belongs to the local subnet or needs to be
2068 forwarded through a router.
2069 (Environment variable "netmask")
2070
David Updegraff7280da72007-06-11 10:41:07 -05002071- Multicast TFTP Mode:
2072 CONFIG_MCAST_TFTP
2073
2074 Defines whether you want to support multicast TFTP as per
2075 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002076 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff7280da72007-06-11 10:41:07 -05002077 driver in use must provide a function: mcast() to join/leave a
2078 multicast group.
2079
wdenkc6097192002-11-03 00:24:07 +00002080- BOOTP Recovery Mode:
2081 CONFIG_BOOTP_RANDOM_DELAY
2082
2083 If you have many targets in a network that try to
2084 boot using BOOTP, you may want to avoid that all
2085 systems send out BOOTP requests at precisely the same
2086 moment (which would happen for instance at recovery
2087 from a power failure, when all systems will try to
2088 boot, thus flooding the BOOTP server. Defining
2089 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2090 inserted before sending out BOOTP requests. The
Wolfgang Denkb65aaf92007-08-06 23:21:05 +02002091 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002092
2093 1st BOOTP request: delay 0 ... 1 sec
2094 2nd BOOTP request: delay 0 ... 2 sec
2095 3rd BOOTP request: delay 0 ... 4 sec
2096 4th and following
2097 BOOTP requests: delay 0 ... 8 sec
2098
Thierry Reding8977cda2014-08-19 10:21:24 +02002099 CONFIG_BOOTP_ID_CACHE_SIZE
2100
2101 BOOTP packets are uniquely identified using a 32-bit ID. The
2102 server will copy the ID from client requests to responses and
2103 U-Boot will use this to determine if it is the destination of
2104 an incoming response. Some servers will check that addresses
2105 aren't in use before handing them out (usually using an ARP
2106 ping) and therefore take up to a few hundred milliseconds to
2107 respond. Network congestion may also influence the time it
2108 takes for a response to make it back to the client. If that
2109 time is too long, U-Boot will retransmit requests. In order
2110 to allow earlier responses to still be accepted after these
2111 retransmissions, U-Boot's BOOTP client keeps a small cache of
2112 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2113 cache. The default is to keep IDs for up to four outstanding
2114 requests. Increasing this will allow U-Boot to accept offers
2115 from a BOOTP client in networks with unusually high latency.
2116
stroesee0aadfb2003-08-28 14:17:32 +00002117- DHCP Advanced Options:
Jon Loeliger5336a762007-07-09 22:08:34 -05002118 You can fine tune the DHCP functionality by defining
2119 CONFIG_BOOTP_* symbols:
stroesee0aadfb2003-08-28 14:17:32 +00002120
Jon Loeliger5336a762007-07-09 22:08:34 -05002121 CONFIG_BOOTP_SUBNETMASK
2122 CONFIG_BOOTP_GATEWAY
2123 CONFIG_BOOTP_HOSTNAME
2124 CONFIG_BOOTP_NISDOMAIN
2125 CONFIG_BOOTP_BOOTPATH
2126 CONFIG_BOOTP_BOOTFILESIZE
2127 CONFIG_BOOTP_DNS
2128 CONFIG_BOOTP_DNS2
2129 CONFIG_BOOTP_SEND_HOSTNAME
2130 CONFIG_BOOTP_NTPSERVER
2131 CONFIG_BOOTP_TIMEOFFSET
2132 CONFIG_BOOTP_VENDOREX
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002133 CONFIG_BOOTP_MAY_FAIL
stroesee0aadfb2003-08-28 14:17:32 +00002134
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002135 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2136 environment variable, not the BOOTP server.
stroesee0aadfb2003-08-28 14:17:32 +00002137
Joe Hershberger8ca7fa02012-05-23 07:59:19 +00002138 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2139 after the configured retry count, the call will fail
2140 instead of starting over. This can be used to fail over
2141 to Link-local IP address configuration if the DHCP server
2142 is not available.
2143
stroesee0aadfb2003-08-28 14:17:32 +00002144 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2145 serverip from a DHCP server, it is possible that more
2146 than one DNS serverip is offered to the client.
2147 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2148 serverip will be stored in the additional environment
2149 variable "dnsip2". The first DNS serverip is always
2150 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger5336a762007-07-09 22:08:34 -05002151 is defined.
stroesee0aadfb2003-08-28 14:17:32 +00002152
2153 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2154 to do a dynamic update of a DNS server. To do this, they
2155 need the hostname of the DHCP requester.
Wilson Callan22bcd6e2007-07-28 10:56:13 -04002156 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger5336a762007-07-09 22:08:34 -05002157 of the "hostname" environment variable is passed as
2158 option 12 to the DHCP server.
stroesee0aadfb2003-08-28 14:17:32 +00002159
Aras Vaichas72aa3f32008-03-26 09:43:57 +11002160 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2161
2162 A 32bit value in microseconds for a delay between
2163 receiving a "DHCP Offer" and sending the "DHCP Request".
2164 This fixes a problem with certain DHCP servers that don't
2165 respond 100% of the time to a "DHCP request". E.g. On an
2166 AT91RM9200 processor running at 180MHz, this delay needed
2167 to be *at least* 15,000 usec before a Windows Server 2003
2168 DHCP server would reply 100% of the time. I recommend at
2169 least 50,000 usec to be safe. The alternative is to hope
2170 that one of the retries will be successful but note that
2171 the DHCP timeout and retry process takes a longer than
2172 this delay.
2173
Joe Hershbergerb35a3a62012-05-23 08:00:12 +00002174 - Link-local IP address negotiation:
2175 Negotiate with other link-local clients on the local network
2176 for an address that doesn't require explicit configuration.
2177 This is especially useful if a DHCP server cannot be guaranteed
2178 to exist in all environments that the device must operate.
2179
2180 See doc/README.link-local for more information.
2181
wdenk145d2c12004-04-15 21:48:45 +00002182 - CDP Options:
wdenk05939202004-04-18 17:39:38 +00002183 CONFIG_CDP_DEVICE_ID
wdenk145d2c12004-04-15 21:48:45 +00002184
2185 The device id used in CDP trigger frames.
2186
2187 CONFIG_CDP_DEVICE_ID_PREFIX
2188
2189 A two character string which is prefixed to the MAC address
2190 of the device.
2191
2192 CONFIG_CDP_PORT_ID
2193
2194 A printf format string which contains the ascii name of
2195 the port. Normally is set to "eth%d" which sets
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002196 eth0 for the first Ethernet, eth1 for the second etc.
wdenk145d2c12004-04-15 21:48:45 +00002197
2198 CONFIG_CDP_CAPABILITIES
2199
2200 A 32bit integer which indicates the device capabilities;
2201 0x00000010 for a normal host which does not forwards.
2202
2203 CONFIG_CDP_VERSION
2204
2205 An ascii string containing the version of the software.
2206
2207 CONFIG_CDP_PLATFORM
2208
2209 An ascii string containing the name of the platform.
2210
2211 CONFIG_CDP_TRIGGER
2212
2213 A 32bit integer sent on the trigger.
2214
2215 CONFIG_CDP_POWER_CONSUMPTION
2216
2217 A 16bit integer containing the power consumption of the
2218 device in .1 of milliwatts.
2219
2220 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2221
2222 A byte containing the id of the VLAN.
2223
wdenkc6097192002-11-03 00:24:07 +00002224- Status LED: CONFIG_STATUS_LED
2225
2226 Several configurations allow to display the current
2227 status using a LED. For instance, the LED will blink
2228 fast while running U-Boot code, stop blinking as
2229 soon as a reply to a BOOTP request was received, and
2230 start blinking slow once the Linux kernel is running
2231 (supported by a status LED driver in the Linux
2232 kernel). Defining CONFIG_STATUS_LED enables this
2233 feature in U-Boot.
2234
Igor Grinberg4997a9e2013-11-08 01:03:50 +02002235 Additional options:
2236
2237 CONFIG_GPIO_LED
2238 The status LED can be connected to a GPIO pin.
2239 In such cases, the gpio_led driver can be used as a
2240 status LED backend implementation. Define CONFIG_GPIO_LED
2241 to include the gpio_led driver in the U-Boot binary.
2242
Igor Grinberg203bd9f2013-11-08 01:03:52 +02002243 CONFIG_GPIO_LED_INVERTED_TABLE
2244 Some GPIO connected LEDs may have inverted polarity in which
2245 case the GPIO high value corresponds to LED off state and
2246 GPIO low value corresponds to LED on state.
2247 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2248 with a list of GPIO LEDs that have inverted polarity.
2249
wdenkc6097192002-11-03 00:24:07 +00002250- CAN Support: CONFIG_CAN_DRIVER
2251
2252 Defining CONFIG_CAN_DRIVER enables CAN driver support
2253 on those systems that support this (optional)
2254 feature, like the TQM8xxL modules.
2255
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002256- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002257
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002258 This enable the NEW i2c subsystem, and will allow you to use
2259 i2c commands at the u-boot command line (as long as you set
2260 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2261 based realtime clock chips or other i2c devices. See
2262 common/cmd_i2c.c for a description of the command line
2263 interface.
2264
2265 ported i2c driver to the new framework:
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002266 - drivers/i2c/soft_i2c.c:
2267 - activate first bus with CONFIG_SYS_I2C_SOFT define
2268 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2269 for defining speed and slave address
2270 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2271 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2272 for defining speed and slave address
2273 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2274 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2275 for defining speed and slave address
2276 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2277 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2278 for defining speed and slave address
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002279
Heiko Schocherf2850742012-10-24 13:48:22 +02002280 - drivers/i2c/fsl_i2c.c:
2281 - activate i2c driver with CONFIG_SYS_I2C_FSL
2282 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2283 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2284 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2285 bus.
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02002286 - If your board supports a second fsl i2c bus, define
Heiko Schocherf2850742012-10-24 13:48:22 +02002287 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2288 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2289 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2290 second bus.
2291
Simon Glass026fefb2012-10-30 07:28:53 +00002292 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu045acfa2013-10-11 16:23:53 +09002293 - activate this driver with CONFIG_SYS_I2C_TEGRA
2294 - This driver adds 4 i2c buses with a fix speed from
2295 100000 and the slave addr 0!
Simon Glass026fefb2012-10-30 07:28:53 +00002296
Dirk Eibach42b204f2013-04-25 02:40:01 +00002297 - drivers/i2c/ppc4xx_i2c.c
2298 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2299 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2300 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2301
trema49f40a2013-09-21 18:13:35 +02002302 - drivers/i2c/i2c_mxc.c
2303 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002304 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2305 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2306 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2307 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
trema49f40a2013-09-21 18:13:35 +02002308 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2309 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2310 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2311 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2312 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2313 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)eb943872015-09-21 22:43:38 +02002314 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2315 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002316 If those defines are not set, default value is 100000
trema49f40a2013-09-21 18:13:35 +02002317 for speed, and 0 for slave.
2318
Nobuhiro Iwamatsue94ea2f2013-09-27 16:58:30 +09002319 - drivers/i2c/rcar_i2c.c:
2320 - activate this driver with CONFIG_SYS_I2C_RCAR
2321 - This driver adds 4 i2c buses
2322
2323 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2324 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2325 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2326 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2327 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2328 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2329 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2330 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2331 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2332
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002333 - drivers/i2c/sh_i2c.c:
2334 - activate this driver with CONFIG_SYS_I2C_SH
2335 - This driver adds from 2 to 5 i2c buses
2336
2337 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2338 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2339 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2340 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2341 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2342 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2343 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2344 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2345 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2346 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2347 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2348 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002349 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu12240102013-10-29 13:33:51 +09002350
Heiko Schocherf53f2b82013-10-22 11:03:18 +02002351 - drivers/i2c/omap24xx_i2c.c
2352 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2353 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2354 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2355 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2356 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2357 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2358 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2359 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2360 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2361 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2362 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2363
Heiko Schocher465819a2013-11-08 07:30:53 +01002364 - drivers/i2c/zynq_i2c.c
2365 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2366 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2367 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2368
Naveen Krishna Ch5d5efd32013-12-06 12:12:38 +05302369 - drivers/i2c/s3c24x0_i2c.c:
2370 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2371 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2372 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2373 with a fix speed from 100000 and the slave addr 0!
2374
Dirk Eibachb9577432014-07-03 09:28:18 +02002375 - drivers/i2c/ihs_i2c.c
2376 - activate this driver with CONFIG_SYS_I2C_IHS
2377 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2378 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2379 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2380 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2381 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2382 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2383 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2384 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2385 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2386 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2387 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2388 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach9ac33852015-10-28 11:46:22 +01002389 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2390 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2391 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2392 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2393 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2394 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2395 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2396 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2397 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb9577432014-07-03 09:28:18 +02002398
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002399 additional defines:
2400
2401 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002402 Hold the number of i2c buses you want to use. If you
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002403 don't use/have i2c muxes on your i2c bus, this
2404 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2405 omit this define.
2406
2407 CONFIG_SYS_I2C_DIRECT_BUS
2408 define this, if you don't use i2c muxes on your hardware.
2409 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2410 omit this define.
2411
2412 CONFIG_SYS_I2C_MAX_HOPS
2413 define how many muxes are maximal consecutively connected
2414 on one i2c bus. If you not use i2c muxes, omit this
2415 define.
2416
2417 CONFIG_SYS_I2C_BUSES
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002418 hold a list of buses you want to use, only used if
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002419 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2420 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2421 CONFIG_SYS_NUM_I2C_BUSES = 9:
2422
2423 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2424 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2425 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2426 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2427 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2428 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2429 {1, {I2C_NULL_HOP}}, \
2430 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2431 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2432 }
2433
2434 which defines
2435 bus 0 on adapter 0 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002436 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2437 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2438 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2439 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2440 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002441 bus 6 on adapter 1 without a mux
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002442 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2443 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002444
2445 If you do not have i2c muxes on your board, omit this define.
2446
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002447- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schochere0e55bc2012-01-16 21:12:24 +00002448
2449 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2450 provides the following compelling advantages:
2451
2452 - more than one i2c adapter is usable
2453 - approved multibus support
2454 - better i2c mux support
2455
2456 ** Please consider updating your I2C driver now. **
wdenkc6097192002-11-03 00:24:07 +00002457
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002458 These enable legacy I2C serial bus commands. Defining
2459 CONFIG_HARD_I2C will include the appropriate I2C driver
2460 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002461
wdenk21136db2003-07-16 21:53:01 +00002462 This will allow you to use i2c commands at the u-boot
Jon Loeligerc1da5c92007-06-11 19:03:39 -05002463 command line (as long as you set CONFIG_CMD_I2C in
wdenkb9bbd242003-06-30 16:24:52 +00002464 CONFIG_COMMANDS) and communicate with i2c based realtime
2465 clock chips. See common/cmd_i2c.c for a description of the
wdenk4a5c8a72003-03-06 00:02:04 +00002466 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002467
Ben Warren45657152006-09-07 16:50:54 -04002468 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkb9bbd242003-06-30 16:24:52 +00002469
wdenk21136db2003-07-16 21:53:01 +00002470 There are several other quantities that must also be
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002471 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002472
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002473 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk21136db2003-07-16 21:53:01 +00002474 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002475 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002476 the CPU's i2c node address).
wdenk21136db2003-07-16 21:53:01 +00002477
Peter Tysere4d1abc2010-04-12 22:28:21 -05002478 Now, the u-boot i2c code for the mpc8xx
Stefan Roese88fbf932010-04-15 16:07:28 +02002479 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tysere4d1abc2010-04-12 22:28:21 -05002480 and so its address should therefore be cleared to 0 (See,
2481 eg, MPC823e User's Manual p.16-473). So, set
2482 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002483
Eric Millbrandt12990a42009-09-03 08:09:44 -05002484 CONFIG_SYS_I2C_INIT_MPC5XXX
2485
2486 When a board is reset during an i2c bus transfer
2487 chips might think that the current transfer is still
2488 in progress. Reset the slave devices by sending start
2489 commands until the slave device responds.
2490
wdenk21136db2003-07-16 21:53:01 +00002491 That's all that's required for CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002492
Heiko Schocher479a4cf2013-01-29 08:53:15 +01002493 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb9bbd242003-06-30 16:24:52 +00002494 then the following macros need to be defined (examples are
2495 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002496
2497 I2C_INIT
2498
wdenkb9bbd242003-06-30 16:24:52 +00002499 (Optional). Any commands necessary to enable the I2C
wdenk4a5c8a72003-03-06 00:02:04 +00002500 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002501
wdenk544e9732004-02-06 23:19:44 +00002502 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb9bbd242003-06-30 16:24:52 +00002503
wdenkc6097192002-11-03 00:24:07 +00002504 I2C_PORT
2505
wdenk4a5c8a72003-03-06 00:02:04 +00002506 (Only for MPC8260 CPU). The I/O port to use (the code
2507 assumes both bits are on the same port). Valid values
2508 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002509
2510 I2C_ACTIVE
2511
2512 The code necessary to make the I2C data line active
2513 (driven). If the data line is open collector, this
2514 define can be null.
2515
wdenkb9bbd242003-06-30 16:24:52 +00002516 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2517
wdenkc6097192002-11-03 00:24:07 +00002518 I2C_TRISTATE
2519
2520 The code necessary to make the I2C data line tri-stated
2521 (inactive). If the data line is open collector, this
2522 define can be null.
2523
wdenkb9bbd242003-06-30 16:24:52 +00002524 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2525
wdenkc6097192002-11-03 00:24:07 +00002526 I2C_READ
2527
York Sun4a598092013-04-01 11:29:11 -07002528 Code that returns true if the I2C data line is high,
2529 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002530
wdenkb9bbd242003-06-30 16:24:52 +00002531 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2532
wdenkc6097192002-11-03 00:24:07 +00002533 I2C_SDA(bit)
2534
York Sun4a598092013-04-01 11:29:11 -07002535 If <bit> is true, sets the I2C data 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_SDA(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002539 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenk544e9732004-02-06 23:19:44 +00002540 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb9bbd242003-06-30 16:24:52 +00002541
wdenkc6097192002-11-03 00:24:07 +00002542 I2C_SCL(bit)
2543
York Sun4a598092013-04-01 11:29:11 -07002544 If <bit> is true, sets the I2C clock line high. If it
2545 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002546
wdenkb9bbd242003-06-30 16:24:52 +00002547 eg: #define I2C_SCL(bit) \
wdenk2bb11052003-07-17 23:16:40 +00002548 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenk544e9732004-02-06 23:19:44 +00002549 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb9bbd242003-06-30 16:24:52 +00002550
wdenkc6097192002-11-03 00:24:07 +00002551 I2C_DELAY
2552
2553 This delay is invoked four times per clock cycle so this
2554 controls the rate of data transfer. The data rate thus
wdenkb9bbd242003-06-30 16:24:52 +00002555 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk21136db2003-07-16 21:53:01 +00002556 like:
2557
wdenkb9bbd242003-06-30 16:24:52 +00002558 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002559
Mike Frysingeree12d542010-07-21 13:38:02 -04002560 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2561
2562 If your arch supports the generic GPIO framework (asm/gpio.h),
2563 then you may alternatively define the two GPIOs that are to be
2564 used as SCL / SDA. Any of the previous I2C_xxx macros will
2565 have GPIO-based defaults assigned to them as appropriate.
2566
2567 You should define these to the GPIO value as given directly to
2568 the generic GPIO functions.
2569
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002570 CONFIG_SYS_I2C_INIT_BOARD
wdenkcc1e2562003-03-06 13:39:27 +00002571
wdenk57b2d802003-06-27 21:31:46 +00002572 When a board is reset during an i2c bus transfer
2573 chips might think that the current transfer is still
2574 in progress. On some boards it is possible to access
2575 the i2c SCLK line directly, either by using the
2576 processor pin as a GPIO or by having a second pin
2577 connected to the bus. If this option is defined a
2578 custom i2c_init_board() routine in boards/xxx/board.c
2579 is run early in the boot sequence.
wdenkcc1e2562003-03-06 13:39:27 +00002580
Richard Retanubundf0149c2010-04-12 15:08:17 -04002581 CONFIG_SYS_I2C_BOARD_LATE_INIT
2582
2583 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2584 defined a custom i2c_board_late_init() routine in
2585 boards/xxx/board.c is run AFTER the operations in i2c_init()
2586 is completed. This callpoint can be used to unreset i2c bus
2587 using CPU i2c controller register accesses for CPUs whose i2c
2588 controller provide such a method. It is called at the end of
2589 i2c_init() to allow i2c_init operations to setup the i2c bus
2590 controller on the CPU (e.g. setting bus speed & slave address).
2591
wdenk0e2bd9c2004-06-06 21:51:03 +00002592 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2593
2594 This option enables configuration of bi_iic_fast[] flags
2595 in u-boot bd_info structure based on u-boot environment
2596 variable "i2cfast". (see also i2cfast)
2597
Ben Warren45657152006-09-07 16:50:54 -04002598 CONFIG_I2C_MULTI_BUS
2599
2600 This option allows the use of multiple I2C buses, each of which
Wolfgang Denk092ae952011-10-26 10:21:21 +00002601 must have a controller. At any point in time, only one bus is
2602 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warren45657152006-09-07 16:50:54 -04002603 Note that bus numbering is zero-based.
2604
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002605 CONFIG_SYS_I2C_NOPROBES
Ben Warren45657152006-09-07 16:50:54 -04002606
2607 This option specifies a list of I2C devices that will be skipped
Wolfgang Denk092ae952011-10-26 10:21:21 +00002608 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser469cde42009-04-18 22:34:03 -05002609 is set, specify a list of bus-device pairs. Otherwise, specify
2610 a 1D array of device addresses
Ben Warren45657152006-09-07 16:50:54 -04002611
2612 e.g.
2613 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denk092ae952011-10-26 10:21:21 +00002614 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warren45657152006-09-07 16:50:54 -04002615
2616 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2617
Wolfgang Denk092ae952011-10-26 10:21:21 +00002618 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002619 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warren45657152006-09-07 16:50:54 -04002620
2621 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2622
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002623 CONFIG_SYS_SPD_BUS_NUM
Timur Tabiab347542006-11-03 19:15:00 -06002624
2625 If defined, then this indicates the I2C bus number for DDR SPD.
2626 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2627
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002628 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002629
2630 If defined, then this indicates the I2C bus number for the RTC.
2631 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2632
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002633 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese096cc9b2007-02-20 10:51:26 +01002634
2635 If defined, then this indicates the I2C bus number for the DTT.
2636 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2637
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002638 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo31856dd2008-09-09 15:13:29 -07002639
2640 If defined, specifies the I2C address of the DTT device.
2641 If not defined, then U-Boot uses predefined value for
2642 specified DTT device.
2643
Andrew Dyer58c41f92008-12-29 17:36:01 -06002644 CONFIG_SOFT_I2C_READ_REPEATED_START
2645
2646 defining this will force the i2c_read() function in
2647 the soft_i2c driver to perform an I2C repeated start
2648 between writing the address pointer and reading the
2649 data. If this define is omitted the default behaviour
2650 of doing a stop-start sequence will be used. Most I2C
2651 devices can use either method, but some require one or
2652 the other.
Timur Tabiab347542006-11-03 19:15:00 -06002653
wdenkc6097192002-11-03 00:24:07 +00002654- SPI Support: CONFIG_SPI
2655
2656 Enables SPI driver (so far only tested with
2657 SPI EEPROM, also an instance works with Crystal A/D and
2658 D/As on the SACSng board)
2659
Yoshihiro Shimoda65bd9b42011-01-31 16:50:43 +09002660 CONFIG_SH_SPI
2661
2662 Enables the driver for SPI controller on SuperH. Currently
2663 only SH7757 is supported.
2664
wdenkc6097192002-11-03 00:24:07 +00002665 CONFIG_SOFT_SPI
2666
wdenk4a5c8a72003-03-06 00:02:04 +00002667 Enables a software (bit-bang) SPI driver rather than
2668 using hardware support. This is a general purpose
2669 driver that only requires three general I/O port pins
2670 (two outputs, one input) to function. If this is
2671 defined, the board configuration must define several
2672 SPI configuration items (port pins to use, etc). For
2673 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002674
Ben Warren7efe9272008-01-16 22:37:35 -05002675 CONFIG_HARD_SPI
2676
2677 Enables a hardware SPI driver for general-purpose reads
2678 and writes. As with CONFIG_SOFT_SPI, the board configuration
2679 must define a list of chip-select function pointers.
Wolfgang Denk092ae952011-10-26 10:21:21 +00002680 Currently supported on some MPC8xxx processors. For an
Ben Warren7efe9272008-01-16 22:37:35 -05002681 example, see include/configs/mpc8349emds.h.
2682
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002683 CONFIG_MXC_SPI
2684
2685 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevamdcd342c2011-10-28 08:57:46 +00002686 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski07327a52008-04-15 14:14:25 +02002687
Heiko Schocherb77c8882014-07-14 10:22:11 +02002688 CONFIG_SYS_SPI_MXC_WAIT
2689 Timeout for waiting until spi transfer completed.
2690 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2691
Matthias Fuchsa4400872007-12-27 17:12:34 +01002692- FPGA Support: CONFIG_FPGA
wdenkc6097192002-11-03 00:24:07 +00002693
Matthias Fuchsa4400872007-12-27 17:12:34 +01002694 Enables FPGA subsystem.
2695
2696 CONFIG_FPGA_<vendor>
2697
2698 Enables support for specific chip vendors.
2699 (ALTERA, XILINX)
wdenkc6097192002-11-03 00:24:07 +00002700
Matthias Fuchsa4400872007-12-27 17:12:34 +01002701 CONFIG_FPGA_<family>
wdenkc6097192002-11-03 00:24:07 +00002702
Matthias Fuchsa4400872007-12-27 17:12:34 +01002703 Enables support for FPGA family.
2704 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2705
2706 CONFIG_FPGA_COUNT
2707
2708 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002709
Siva Durga Prasad Paladuguadc11de2014-03-14 16:35:38 +05302710 CONFIG_CMD_FPGA_LOADMK
2711
2712 Enable support for fpga loadmk command
2713
Michal Simek64c70982014-05-02 13:43:39 +02002714 CONFIG_CMD_FPGA_LOADP
2715
2716 Enable support for fpga loadp command - load partial bitstream
2717
2718 CONFIG_CMD_FPGA_LOADBP
2719
2720 Enable support for fpga loadbp command - load partial bitstream
2721 (Xilinx only)
2722
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002723 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002724
wdenk57b2d802003-06-27 21:31:46 +00002725 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002726
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002727 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002728
wdenk4a5c8a72003-03-06 00:02:04 +00002729 Enable checks on FPGA configuration interface busy
2730 status by the configuration function. This option
2731 will require a board or device specific function to
2732 be written.
wdenkc6097192002-11-03 00:24:07 +00002733
2734 CONFIG_FPGA_DELAY
2735
2736 If defined, a function that provides delays in the FPGA
2737 configuration driver.
2738
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002739 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002740 Allow Control-C to interrupt FPGA configuration
2741
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002742 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002743
wdenk4a5c8a72003-03-06 00:02:04 +00002744 Check for configuration errors during FPGA bitfile
2745 loading. For example, abort during Virtex II
2746 configuration if the INIT_B line goes low (which
2747 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002748
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002749 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002750
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002751 Maximum time to wait for the INIT_B line to de-assert
2752 after PROB_B has been de-asserted during a Virtex II
wdenk4a5c8a72003-03-06 00:02:04 +00002753 FPGA configuration sequence. The default time is 500
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002754 ms.
wdenkc6097192002-11-03 00:24:07 +00002755
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002756 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002757
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002758 Maximum time to wait for BUSY to de-assert during
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002759 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002760
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002761 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002762
wdenk4a5c8a72003-03-06 00:02:04 +00002763 Time to wait after FPGA configuration. The default is
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002764 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002765
2766- Configuration Management:
Stefan Roese141ed202014-10-22 12:13:24 +02002767 CONFIG_BUILD_TARGET
2768
2769 Some SoCs need special image types (e.g. U-Boot binary
2770 with a special header) as build targets. By defining
2771 CONFIG_BUILD_TARGET in the SoC / board header, this
2772 special image will be automatically built upon calling
2773 make / MAKEALL.
2774
wdenkc6097192002-11-03 00:24:07 +00002775 CONFIG_IDENT_STRING
2776
wdenk4a5c8a72003-03-06 00:02:04 +00002777 If defined, this string will be added to the U-Boot
2778 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002779
2780- Vendor Parameter Protection:
2781
wdenk4a5c8a72003-03-06 00:02:04 +00002782 U-Boot considers the values of the environment
2783 variables "serial#" (Board Serial Number) and
wdenkeb20ad32003-09-05 23:19:14 +00002784 "ethaddr" (Ethernet Address) to be parameters that
wdenk4a5c8a72003-03-06 00:02:04 +00002785 are set once by the board vendor / manufacturer, and
2786 protects these variables from casual modification by
2787 the user. Once set, these variables are read-only,
2788 and write or delete attempts are rejected. You can
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002789 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002790
2791 If CONFIG_ENV_OVERWRITE is #defined in your config
2792 file, the write protection for vendor parameters is
wdenkcc1e2562003-03-06 13:39:27 +00002793 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002794 these parameters.
2795
Joe Hershberger76f353e2015-05-04 14:55:14 -05002796 Alternatively, if you define _both_ an ethaddr in the
2797 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002798 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002799 which can be changed exactly ONCE by the user. [The
2800 serial# is unaffected by this, i. e. it remains
2801 read-only.]
2802
Joe Hershberger71497d02012-12-11 22:16:31 -06002803 The same can be accomplished in a more flexible way
2804 for any variable by configuring the type of access
2805 to allow for those variables in the ".flags" variable
2806 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2807
wdenkc6097192002-11-03 00:24:07 +00002808- Protected RAM:
2809 CONFIG_PRAM
2810
2811 Define this variable to enable the reservation of
2812 "protected RAM", i. e. RAM which is not overwritten
2813 by U-Boot. Define CONFIG_PRAM to hold the number of
2814 kB you want to reserve for pRAM. You can overwrite
2815 this default value by defining an environment
2816 variable "pram" to the number of kB you want to
2817 reserve. Note that the board info structure will
2818 still show the full amount of RAM. If pRAM is
2819 reserved, a new environment variable "mem" will
2820 automatically be defined to hold the amount of
2821 remaining RAM in a form that can be passed as boot
2822 argument to Linux, for instance like that:
2823
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01002824 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002825 saveenv
2826
2827 This way you can tell Linux not to use this memory,
2828 either, which results in a memory region that will
2829 not be affected by reboots.
2830
2831 *WARNING* If your board configuration uses automatic
2832 detection of the RAM size, you must make sure that
2833 this memory test is non-destructive. So far, the
2834 following board configurations are known to be
2835 "pRAM-clean":
2836
Wolfgang Denk90326762012-10-24 02:36:15 +00002837 IVMS8, IVML24, SPD8xx, TQM8xxL,
2838 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denkcd4e42e2010-10-05 22:54:53 +02002839 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002840
Gabe Blacka2f3a932012-12-02 04:55:18 +00002841- Access to physical memory region (> 4GB)
2842 Some basic support is provided for operations on memory not
2843 normally accessible to U-Boot - e.g. some architectures
2844 support access to more than 4GB of memory on 32-bit
2845 machines using physical address extension or similar.
2846 Define CONFIG_PHYSMEM to access this basic support, which
2847 currently only supports clearing the memory.
2848
wdenkc6097192002-11-03 00:24:07 +00002849- Error Recovery:
2850 CONFIG_PANIC_HANG
2851
2852 Define this variable to stop the system in case of a
2853 fatal error, so that you have to reset it manually.
2854 This is probably NOT a good idea for an embedded
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002855 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002856 automatically as fast as possible, but it may be
2857 useful during development since you can try to debug
2858 the conditions that lead to the situation.
2859
2860 CONFIG_NET_RETRY_COUNT
2861
wdenk4a5c8a72003-03-06 00:02:04 +00002862 This variable defines the number of retries for
2863 network operations like ARP, RARP, TFTP, or BOOTP
2864 before giving up the operation. If not defined, a
2865 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002866
Guennadi Liakhovetskib38c2b32008-04-03 17:04:19 +02002867 CONFIG_ARP_TIMEOUT
2868
2869 Timeout waiting for an ARP reply in milliseconds.
2870
Tetsuyuki Kobayashi147e3902012-07-03 22:25:21 +00002871 CONFIG_NFS_TIMEOUT
2872
2873 Timeout in milliseconds used in NFS protocol.
2874 If you encounter "ERROR: Cannot umount" in nfs command,
2875 try longer timeout such as
2876 #define CONFIG_NFS_TIMEOUT 10000UL
2877
wdenkc6097192002-11-03 00:24:07 +00002878- Command Interpreter:
Wolfgang Denk81352ed2006-10-28 02:28:02 +02002879 CONFIG_AUTO_COMPLETE
wdenk3902d702004-04-15 18:22:41 +00002880
2881 Enable auto completion of commands using TAB.
2882
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02002883 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002884
2885 This defines the secondary prompt string, which is
2886 printed when the command interpreter needs more input
2887 to complete a command. Usually "> ".
2888
2889 Note:
2890
wdenk57b2d802003-06-27 21:31:46 +00002891 In the current implementation, the local variables
2892 space and global environment variables space are
2893 separated. Local variables are those you define by
2894 simply typing `name=value'. To access a local
2895 variable later on, you have write `$name' or
2896 `${name}'; to execute the contents of a variable
2897 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002898
wdenk4a5c8a72003-03-06 00:02:04 +00002899 Global environment variables are those you use
2900 setenv/printenv to work with. To run a command stored
2901 in such a variable, you need to use the run command,
2902 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002903
2904 To store commands and special characters in a
2905 variable, please use double quotation marks
2906 surrounding the whole text of the variable, instead
2907 of the backslashes before semicolons and special
2908 symbols.
2909
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002910- Command Line Editing and History:
Wolfgang Denk2039a072006-07-21 11:35:21 +02002911 CONFIG_CMDLINE_EDITING
2912
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02002913 Enable editing and History functions for interactive
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002914 command line input operations
Wolfgang Denk2039a072006-07-21 11:35:21 +02002915
Marek Vasut734fb042016-01-27 04:47:55 +01002916- Command Line PS1/PS2 support:
2917 CONFIG_CMDLINE_PS_SUPPORT
2918
2919 Enable support for changing the command prompt string
2920 at run-time. Only static string is supported so far.
2921 The string is obtained from environment variables PS1
2922 and PS2.
2923
wdenkc0aa5c52003-12-06 19:49:23 +00002924- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002925 CONFIG_EXTRA_ENV_SETTINGS
2926
wdenk4a5c8a72003-03-06 00:02:04 +00002927 Define this to contain any number of null terminated
2928 strings (variable = value pairs) that will be part of
wdenkeb20ad32003-09-05 23:19:14 +00002929 the default environment compiled into the boot image.
wdenk591dda52002-11-18 00:14:45 +00002930
wdenk4a5c8a72003-03-06 00:02:04 +00002931 For example, place something like this in your
2932 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002933
2934 #define CONFIG_EXTRA_ENV_SETTINGS \
2935 "myvar1=value1\0" \
2936 "myvar2=value2\0"
2937
wdenk4a5c8a72003-03-06 00:02:04 +00002938 Warning: This method is based on knowledge about the
2939 internal format how the environment is stored by the
2940 U-Boot code. This is NOT an official, exported
2941 interface! Although it is unlikely that this format
wdenkeb20ad32003-09-05 23:19:14 +00002942 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002943 You better know what you are doing here.
2944
wdenk4a5c8a72003-03-06 00:02:04 +00002945 Note: overly (ab)use of the default environment is
2946 discouraged. Make sure to check other ways to preset
Wolfgang Denk85c25df2009-04-01 23:34:12 +02002947 the environment like the "source" command or the
wdenk4a5c8a72003-03-06 00:02:04 +00002948 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002949
Stephen Warren1465d5f2012-05-22 09:21:54 +00002950 CONFIG_ENV_VARS_UBOOT_CONFIG
2951
2952 Define this in order to add variables describing the
2953 U-Boot build configuration to the default environment.
2954 These will be named arch, cpu, board, vendor, and soc.
2955
2956 Enabling this option will cause the following to be defined:
2957
2958 - CONFIG_SYS_ARCH
2959 - CONFIG_SYS_CPU
2960 - CONFIG_SYS_BOARD
2961 - CONFIG_SYS_VENDOR
2962 - CONFIG_SYS_SOC
2963
Tom Rini4c8cc9b2012-10-24 07:28:16 +00002964 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2965
2966 Define this in order to add variables describing certain
2967 run-time determined information about the hardware to the
2968 environment. These will be named board_name, board_rev.
2969
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002970 CONFIG_DELAY_ENVIRONMENT
2971
2972 Normally the environment is loaded when the board is
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08002973 initialised so that it is available to U-Boot. This inhibits
Simon Glass6b8d5fd2012-11-30 13:01:17 +00002974 that so that the environment is not available until
2975 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2976 this is instead controlled by the value of
2977 /config/load-environment.
2978
Chris Packham2216ddb2015-06-19 20:25:59 +12002979- Parallel Flash support:
2980 CONFIG_SYS_NO_FLASH
2981
Bin Meng75574052016-02-05 19:30:11 -08002982 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham2216ddb2015-06-19 20:25:59 +12002983 flash. This option is used to disable support for parallel NOR
2984 flash. This option should be defined if the board does not have
2985 parallel flash.
2986
2987 If this option is not defined one of the generic flash drivers
2988 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2989 selected or the board must provide an implementation of the
2990 flash API (see include/flash.h).
2991
wdenkc0aa5c52003-12-06 19:49:23 +00002992- DataFlash Support:
wdenk381669a2003-06-16 23:50:08 +00002993 CONFIG_HAS_DATAFLASH
2994
wdenk57b2d802003-06-27 21:31:46 +00002995 Defining this option enables DataFlash features and
2996 allows to read/write in Dataflash via the standard
2997 commands cp, md...
wdenk381669a2003-06-16 23:50:08 +00002998
Eric Nelson97f5f8f2012-01-31 10:52:08 -07002999- Serial Flash support
3000 CONFIG_CMD_SF
3001
3002 Defining this option enables SPI flash commands
3003 'sf probe/read/write/erase/update'.
3004
3005 Usage requires an initial 'probe' to define the serial
3006 flash parameters, followed by read/write/erase/update
3007 commands.
3008
3009 The following defaults may be provided by the platform
3010 to handle the common case when only a single serial
3011 flash is present on the system.
3012
3013 CONFIG_SF_DEFAULT_BUS Bus identifier
3014 CONFIG_SF_DEFAULT_CS Chip-select
3015 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3016 CONFIG_SF_DEFAULT_SPEED in Hz
3017
Simon Glass4b5545e2012-10-08 13:16:02 +00003018 CONFIG_CMD_SF_TEST
3019
3020 Define this option to include a destructive SPI flash
3021 test ('sf test').
3022
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303023 CONFIG_SF_DUAL_FLASH Dual flash memories
3024
3025 Define this option to use dual flash support where two flash
3026 memories can be connected with a given cs line.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003027 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekid7f253b2014-01-11 15:25:04 +05303028
wdenkef893942004-02-23 16:11:30 +00003029- SystemACE Support:
3030 CONFIG_SYSTEMACE
3031
3032 Adding this option adds support for Xilinx SystemACE
3033 chips attached via some sort of local bus. The address
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003034 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003035 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenkef893942004-02-23 16:11:30 +00003036
3037 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003038 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenkef893942004-02-23 16:11:30 +00003039
3040 When SystemACE support is added, the "ace" device type
3041 becomes available to the fat commands, i.e. fatls.
3042
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003043- TFTP Fixed UDP Port:
3044 CONFIG_TFTP_PORT
3045
Wolfgang Denk227b5192005-09-24 23:25:46 +02003046 If this is defined, the environment variable tftpsrcp
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003047 is used to supply the TFTP UDP source port value.
Wolfgang Denk227b5192005-09-24 23:25:46 +02003048 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003049 number generator is used.
3050
Wolfgang Denk227b5192005-09-24 23:25:46 +02003051 Also, the environment variable tftpdstp is used to supply
3052 the TFTP UDP destination port value. If tftpdstp isn't
3053 defined, the normal port 69 is used.
3054
3055 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denke3cfce52005-09-24 22:37:32 +02003056 blindly start the TFTP transfer using the pre-configured
3057 target IP address and UDP port. This has the effect of
3058 "punching through" the (Windows XP) firewall, allowing
3059 the remainder of the TFTP transfer to proceed normally.
3060 A better solution is to properly configure the firewall,
3061 but sometimes that is not allowed.
3062
Simon Glass058bb8d2012-12-05 14:46:38 +00003063- Hashing support:
3064 CONFIG_CMD_HASH
3065
3066 This enables a generic 'hash' command which can produce
3067 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3068
3069 CONFIG_HASH_VERIFY
3070
3071 Enable the hash verify command (hash -v). This adds to code
3072 size a little.
3073
gaurav ranaef201592015-02-20 12:51:46 +05303074 CONFIG_SHA1 - This option enables support of hashing using SHA1
3075 algorithm. The hash is calculated in software.
3076 CONFIG_SHA256 - This option enables support of hashing using
3077 SHA256 algorithm. The hash is calculated in software.
3078 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3079 for SHA1/SHA256 hashing.
3080 This affects the 'hash' command and also the
3081 hash_lookup_algo() function.
3082 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3083 hardware-acceleration for SHA1/SHA256 progressive hashing.
3084 Data can be streamed in a block at a time and the hashing
3085 is performed in hardware.
Simon Glass058bb8d2012-12-05 14:46:38 +00003086
3087 Note: There is also a sha1sum command, which should perhaps
3088 be deprecated in favour of 'hash sha1'.
3089
Robert Winkler765ccf42013-07-24 17:57:06 -07003090- Freescale i.MX specific commands:
3091 CONFIG_CMD_HDMIDETECT
3092 This enables 'hdmidet' command which returns true if an
3093 HDMI monitor is detected. This command is i.MX 6 specific.
3094
3095 CONFIG_CMD_BMODE
3096 This enables the 'bmode' (bootmode) command for forcing
3097 a boot from specific media.
3098
3099 This is useful for forcing the ROM's usb downloader to
3100 activate upon a watchdog reset which is nice when iterating
3101 on U-Boot. Using the reset button or running bmode normal
3102 will set it back to normal. This command currently
3103 supports i.MX53 and i.MX6.
3104
Heiko Schocher443ca402014-01-25 07:27:13 +01003105- bootcount support:
3106 CONFIG_BOOTCOUNT_LIMIT
3107
3108 This enables the bootcounter support, see:
3109 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3110
3111 CONFIG_AT91SAM9XE
3112 enable special bootcounter support on at91sam9xe based boards.
3113 CONFIG_BLACKFIN
3114 enable special bootcounter support on blackfin based boards.
3115 CONFIG_SOC_DA8XX
3116 enable special bootcounter support on da850 based boards.
3117 CONFIG_BOOTCOUNT_RAM
3118 enable support for the bootcounter in RAM
3119 CONFIG_BOOTCOUNT_I2C
3120 enable support for the bootcounter on an i2c (like RTC) device.
3121 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3122 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3123 the bootcounter.
3124 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass35191a32013-06-13 15:10:02 -07003125
wdenkc0aa5c52003-12-06 19:49:23 +00003126- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003127 CONFIG_SHOW_BOOT_PROGRESS
3128
wdenk4a5c8a72003-03-06 00:02:04 +00003129 Defining this option allows to add some board-
3130 specific code (calling a user-provided function
3131 "show_boot_progress(int)") that enables you to show
3132 the system's boot progress on some display (for
3133 example, some LED's) on your board. At the moment,
3134 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003135
Simon Glass0fa36a42012-09-28 08:56:37 +00003136
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003137Legacy uImage format:
3138
wdenkc6097192002-11-03 00:24:07 +00003139 Arg Where When
3140 1 common/cmd_bootm.c before attempting to boot an image
wdenk544e9732004-02-06 23:19:44 +00003141 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003142 2 common/cmd_bootm.c Image header has correct magic number
wdenk544e9732004-02-06 23:19:44 +00003143 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003144 3 common/cmd_bootm.c Image header has correct checksum
wdenk544e9732004-02-06 23:19:44 +00003145 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003146 4 common/cmd_bootm.c Image data has correct checksum
3147 -4 common/cmd_bootm.c Image is for unsupported architecture
3148 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003149 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003150 6 common/cmd_bootm.c Image Type check OK
3151 -6 common/cmd_bootm.c gunzip uncompression error
3152 -7 common/cmd_bootm.c Unimplemented compression type
3153 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003154 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003155 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003156
3157 9 common/image.c Start initial ramdisk verification
3158 -10 common/image.c Ramdisk header has bad magic number
3159 -11 common/image.c Ramdisk header has bad checksum
3160 10 common/image.c Ramdisk header is OK
3161 -12 common/image.c Ramdisk data has bad checksum
3162 11 common/image.c Ramdisk data has correct checksum
3163 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003164 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003165 13 common/image.c Start multifile image verification
3166 14 common/image.c No initial ramdisk, no multifile, continue.
3167
Wolfgang Denk092ae952011-10-26 10:21:21 +00003168 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003169
Stefan Roese88fbf932010-04-15 16:07:28 +02003170 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenkd729d302004-02-27 00:07:27 +00003171 -31 post/post.c POST test failed, detected by post_output_backlog()
3172 -32 post/post.c POST test failed, detected by post_run_single()
wdenke97d3d92004-02-23 22:22:28 +00003173
Heiko Schocher633e03a2007-06-22 19:11:54 +02003174 34 common/cmd_doc.c before loading a Image from a DOC device
3175 -35 common/cmd_doc.c Bad usage of "doc" command
3176 35 common/cmd_doc.c correct usage of "doc" command
3177 -36 common/cmd_doc.c No boot device
3178 36 common/cmd_doc.c correct boot device
3179 -37 common/cmd_doc.c Unknown Chip ID on boot device
3180 37 common/cmd_doc.c correct chip ID found, device available
3181 -38 common/cmd_doc.c Read Error on boot device
3182 38 common/cmd_doc.c reading Image header from DOC device OK
3183 -39 common/cmd_doc.c Image header has bad magic number
3184 39 common/cmd_doc.c Image header has correct magic number
3185 -40 common/cmd_doc.c Error reading Image from DOC device
3186 40 common/cmd_doc.c Image header has correct magic number
3187 41 common/cmd_ide.c before loading a Image from a IDE device
3188 -42 common/cmd_ide.c Bad usage of "ide" command
3189 42 common/cmd_ide.c correct usage of "ide" command
3190 -43 common/cmd_ide.c No boot device
3191 43 common/cmd_ide.c boot device found
3192 -44 common/cmd_ide.c Device not available
3193 44 common/cmd_ide.c Device available
3194 -45 common/cmd_ide.c wrong partition selected
3195 45 common/cmd_ide.c partition selected
3196 -46 common/cmd_ide.c Unknown partition table
3197 46 common/cmd_ide.c valid partition table found
3198 -47 common/cmd_ide.c Invalid partition type
3199 47 common/cmd_ide.c correct partition type
3200 -48 common/cmd_ide.c Error reading Image Header on boot device
3201 48 common/cmd_ide.c reading Image Header from IDE device OK
3202 -49 common/cmd_ide.c Image header has bad magic number
3203 49 common/cmd_ide.c Image header has correct magic number
3204 -50 common/cmd_ide.c Image header has bad checksum
3205 50 common/cmd_ide.c Image header has correct checksum
3206 -51 common/cmd_ide.c Error reading Image from IDE device
3207 51 common/cmd_ide.c reading Image from IDE device OK
3208 52 common/cmd_nand.c before loading a Image from a NAND device
3209 -53 common/cmd_nand.c Bad usage of "nand" command
3210 53 common/cmd_nand.c correct usage of "nand" command
3211 -54 common/cmd_nand.c No boot device
3212 54 common/cmd_nand.c boot device found
3213 -55 common/cmd_nand.c Unknown Chip ID on boot device
3214 55 common/cmd_nand.c correct chip ID found, device available
3215 -56 common/cmd_nand.c Error reading Image Header on boot device
3216 56 common/cmd_nand.c reading Image Header from NAND device OK
3217 -57 common/cmd_nand.c Image header has bad magic number
3218 57 common/cmd_nand.c Image header has correct magic number
3219 -58 common/cmd_nand.c Error reading Image from NAND device
3220 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003221
Heiko Schocher633e03a2007-06-22 19:11:54 +02003222 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003223
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003224 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher633e03a2007-06-22 19:11:54 +02003225 -64 net/eth.c no Ethernet found.
3226 65 net/eth.c Ethernet found.
wdenkc6097192002-11-03 00:24:07 +00003227
Heiko Schocher633e03a2007-06-22 19:11:54 +02003228 -80 common/cmd_net.c usage wrong
Joe Hershbergerc80b41b02015-04-08 01:41:21 -05003229 80 common/cmd_net.c before calling net_loop()
3230 -81 common/cmd_net.c some error in net_loop() occurred
3231 81 common/cmd_net.c net_loop() back without error
Heiko Schocher633e03a2007-06-22 19:11:54 +02003232 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3233 82 common/cmd_net.c trying automatic boot
Wolfgang Denk85c25df2009-04-01 23:34:12 +02003234 83 common/cmd_net.c running "source" command
3235 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher633e03a2007-06-22 19:11:54 +02003236 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003237
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003238FIT uImage format:
3239
3240 Arg Where When
3241 100 common/cmd_bootm.c Kernel FIT Image has correct format
3242 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3243 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3244 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3245 102 common/cmd_bootm.c Kernel unit name specified
3246 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowicz0cd4f3d2008-03-12 10:35:46 +01003247 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003248 104 common/cmd_bootm.c Got kernel subimage node offset
3249 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3250 105 common/cmd_bootm.c Kernel subimage hash verification OK
3251 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3252 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003253 -106 common/cmd_bootm.c Kernel subimage has wrong type
3254 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003255 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3256 108 common/cmd_bootm.c Got kernel subimage data/size
3257 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3258 -109 common/cmd_bootm.c Can't get kernel subimage type
3259 -110 common/cmd_bootm.c Can't get kernel subimage comp
3260 -111 common/cmd_bootm.c Can't get kernel subimage os
3261 -112 common/cmd_bootm.c Can't get kernel subimage load address
3262 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3263
3264 120 common/image.c Start initial ramdisk verification
3265 -120 common/image.c Ramdisk FIT image has incorrect format
3266 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003267 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003268 -122 common/image.c Can't get configuration for ramdisk subimage
3269 123 common/image.c Ramdisk unit name specified
3270 -124 common/image.c Can't get ramdisk subimage node offset
3271 125 common/image.c Got ramdisk subimage node offset
3272 -125 common/image.c Ramdisk subimage hash verification failed
3273 126 common/image.c Ramdisk subimage hash verification OK
3274 -126 common/image.c Ramdisk subimage for unsupported architecture
3275 127 common/image.c Architecture check OK
3276 -127 common/image.c Can't get ramdisk subimage data/size
3277 128 common/image.c Got ramdisk subimage data/size
3278 129 common/image.c Can't get ramdisk load address
3279 -129 common/image.c Got ramdisk load address
3280
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003281 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003282 131 common/cmd_doc.c FIT image format OK
3283
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003284 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003285 141 common/cmd_ide.c FIT image format OK
3286
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003287 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003288 151 common/cmd_nand.c FIT image format OK
3289
Heiko Schocher515eb122014-05-28 11:33:33 +02003290- legacy image format:
3291 CONFIG_IMAGE_FORMAT_LEGACY
3292 enables the legacy image format support in U-Boot.
3293
3294 Default:
3295 enabled if CONFIG_FIT_SIGNATURE is not defined.
3296
3297 CONFIG_DISABLE_IMAGE_LEGACY
3298 disable the legacy image format
3299
3300 This define is introduced, as the legacy image format is
3301 enabled per default for backward compatibility.
3302
Gabe Blackd572e162012-10-25 16:31:10 +00003303- FIT image support:
Dirk Eibach88919ca2014-07-03 09:28:26 +02003304 CONFIG_FIT_DISABLE_SHA256
3305 Supporting SHA256 hashes has quite an impact on binary size.
3306 For constrained systems sha256 hash support can be disabled
3307 with this option.
3308
Simon Glasse3ee2fb2016-02-22 22:55:43 -07003309 TODO(sjg@chromium.org): Adjust this option to be positive,
3310 and move it to Kconfig
3311
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003312- Standalone program support:
3313 CONFIG_STANDALONE_LOAD_ADDR
3314
Wolfgang Denk23f78482011-10-09 21:06:34 +02003315 This option defines a board specific value for the
3316 address where standalone program gets loaded, thus
3317 overwriting the architecture dependent default
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003318 settings.
3319
3320- Frame Buffer Address:
3321 CONFIG_FB_ADDR
3322
3323 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denka71eb8e2013-01-03 00:43:59 +00003324 address for frame buffer. This is typically the case
3325 when using a graphics controller has separate video
3326 memory. U-Boot will then place the frame buffer at
3327 the given address instead of dynamically reserving it
3328 in system RAM by calling lcd_setmem(), which grabs
3329 the memory for the frame buffer depending on the
3330 configured panel size.
Wolfgang Denkd590fb12011-10-07 09:58:21 +02003331
3332 Please see board_init_f function.
3333
Detlev Zundel0ecb6112009-12-01 17:16:19 +01003334- Automatic software updates via TFTP server
3335 CONFIG_UPDATE_TFTP
3336 CONFIG_UPDATE_TFTP_CNT_MAX
3337 CONFIG_UPDATE_TFTP_MSEC_MAX
3338
3339 These options enable and control the auto-update feature;
3340 for a more detailed description refer to doc/README.update.
3341
3342- MTD Support (mtdparts command, UBI support)
3343 CONFIG_MTD_DEVICE
3344
3345 Adds the MTD device infrastructure from the Linux kernel.
3346 Needed for mtdparts command support.
3347
3348 CONFIG_MTD_PARTITIONS
3349
3350 Adds the MTD partitioning infrastructure from the Linux
3351 kernel. Needed for UBI support.
3352
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003353- UBI support
3354 CONFIG_CMD_UBI
3355
3356 Adds commands for interacting with MTD partitions formatted
3357 with the UBI flash translation layer
3358
3359 Requires also defining CONFIG_RBTREE
3360
Joe Hershberger47550fc2013-04-08 10:32:49 +00003361 CONFIG_UBI_SILENCE_MSG
3362
3363 Make the verbose messages from UBI stop printing. This leaves
3364 warnings and errors enabled.
3365
Heiko Schocherf5895d12014-06-24 10:10:04 +02003366
3367 CONFIG_MTD_UBI_WL_THRESHOLD
3368 This parameter defines the maximum difference between the highest
3369 erase counter value and the lowest erase counter value of eraseblocks
3370 of UBI devices. When this threshold is exceeded, UBI starts performing
3371 wear leveling by means of moving data from eraseblock with low erase
3372 counter to eraseblocks with high erase counter.
3373
3374 The default value should be OK for SLC NAND flashes, NOR flashes and
3375 other flashes which have eraseblock life-cycle 100000 or more.
3376 However, in case of MLC NAND flashes which typically have eraseblock
3377 life-cycle less than 10000, the threshold should be lessened (e.g.,
3378 to 128 or 256, although it does not have to be power of 2).
3379
3380 default: 4096
Simon Glass6c0be912014-10-23 18:58:54 -06003381
Heiko Schocherf5895d12014-06-24 10:10:04 +02003382 CONFIG_MTD_UBI_BEB_LIMIT
3383 This option specifies the maximum bad physical eraseblocks UBI
3384 expects on the MTD device (per 1024 eraseblocks). If the
3385 underlying flash does not admit of bad eraseblocks (e.g. NOR
3386 flash), this value is ignored.
3387
3388 NAND datasheets often specify the minimum and maximum NVM
3389 (Number of Valid Blocks) for the flashes' endurance lifetime.
3390 The maximum expected bad eraseblocks per 1024 eraseblocks
3391 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3392 which gives 20 for most NANDs (MaxNVB is basically the total
3393 count of eraseblocks on the chip).
3394
3395 To put it differently, if this value is 20, UBI will try to
3396 reserve about 1.9% of physical eraseblocks for bad blocks
3397 handling. And that will be 1.9% of eraseblocks on the entire
3398 NAND chip, not just the MTD partition UBI attaches. This means
3399 that if you have, say, a NAND flash chip admits maximum 40 bad
3400 eraseblocks, and it is split on two MTD partitions of the same
3401 size, UBI will reserve 40 eraseblocks when attaching a
3402 partition.
3403
3404 default: 20
3405
3406 CONFIG_MTD_UBI_FASTMAP
3407 Fastmap is a mechanism which allows attaching an UBI device
3408 in nearly constant time. Instead of scanning the whole MTD device it
3409 only has to locate a checkpoint (called fastmap) on the device.
3410 The on-flash fastmap contains all information needed to attach
3411 the device. Using fastmap makes only sense on large devices where
3412 attaching by scanning takes long. UBI will not automatically install
3413 a fastmap on old images, but you can set the UBI parameter
3414 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3415 that fastmap-enabled images are still usable with UBI implementations
3416 without fastmap support. On typical flash devices the whole fastmap
3417 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3418
3419 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3420 Set this parameter to enable fastmap automatically on images
3421 without a fastmap.
3422 default: 0
3423
Heiko Schocher94b66de2015-10-22 06:19:21 +02003424 CONFIG_MTD_UBI_FM_DEBUG
3425 Enable UBI fastmap debug
3426 default: 0
3427
Joe Hershberger7d80fc12013-04-08 10:32:48 +00003428- UBIFS support
3429 CONFIG_CMD_UBIFS
3430
3431 Adds commands for interacting with UBI volumes formatted as
3432 UBIFS. UBIFS is read-only in u-boot.
3433
3434 Requires UBI support as well as CONFIG_LZO
3435
Joe Hershberger47550fc2013-04-08 10:32:49 +00003436 CONFIG_UBIFS_SILENCE_MSG
3437
3438 Make the verbose messages from UBIFS stop printing. This leaves
3439 warnings and errors enabled.
3440
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003441- SPL framework
Wolfgang Denk825223d2011-09-11 21:24:09 +02003442 CONFIG_SPL
3443 Enable building of SPL globally.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003444
Tom Rini36853852012-02-14 07:29:40 +00003445 CONFIG_SPL_LDSCRIPT
3446 LDSCRIPT for linking the SPL binary.
3447
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003448 CONFIG_SPL_MAX_FOOTPRINT
3449 Maximum size in memory allocated to the SPL, BSS included.
3450 When defined, the linker checks that the actual memory
3451 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003452 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003453 must not be both defined at the same time.
3454
Tom Rini36853852012-02-14 07:29:40 +00003455 CONFIG_SPL_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003456 Maximum size of the SPL image (text, data, rodata, and
3457 linker lists sections), BSS excluded.
3458 When defined, the linker checks that the actual size does
3459 not exceed it.
Tom Rini36853852012-02-14 07:29:40 +00003460
Wolfgang Denk825223d2011-09-11 21:24:09 +02003461 CONFIG_SPL_TEXT_BASE
3462 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003463
Scott Woodc4f0d002012-09-20 19:05:12 -05003464 CONFIG_SPL_RELOC_TEXT_BASE
3465 Address to relocate to. If unspecified, this is equal to
3466 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3467
Tom Rini36853852012-02-14 07:29:40 +00003468 CONFIG_SPL_BSS_START_ADDR
3469 Link address for the BSS within the SPL binary.
3470
3471 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003472 Maximum size in memory allocated to the SPL BSS.
3473 When defined, the linker checks that the actual memory used
3474 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUDafab1482013-04-14 04:48:38 +00003475 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUDe916e052013-04-12 05:14:30 +00003476 must not be both defined at the same time.
Tom Rini36853852012-02-14 07:29:40 +00003477
3478 CONFIG_SPL_STACK
3479 Adress of the start of the stack SPL will use
3480
Albert ARIBAUD \(3ADEV\)287b0942015-03-31 11:40:50 +02003481 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3482 When defined, SPL will panic() if the image it has
3483 loaded does not have a signature.
3484 Defining this is useful when code which loads images
3485 in SPL cannot guarantee that absolutely all read errors
3486 will be caught.
3487 An example is the LPC32XX MLC NAND driver, which will
3488 consider that a completely unreadable NAND block is bad,
3489 and thus should be skipped silently.
3490
Marek Vasutbf541b22016-04-29 00:44:55 +02003491 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3492 When defined, SPL will proceed to another boot method
3493 if the image it has loaded does not have a signature.
3494
Scott Woodc4f0d002012-09-20 19:05:12 -05003495 CONFIG_SPL_RELOC_STACK
3496 Adress of the start of the stack SPL will use after
3497 relocation. If unspecified, this is equal to
3498 CONFIG_SPL_STACK.
3499
Tom Rini36853852012-02-14 07:29:40 +00003500 CONFIG_SYS_SPL_MALLOC_START
3501 Starting address of the malloc pool used in SPL.
Fabio Estevam38e1a972015-11-12 12:30:19 -02003502 When this option is set the full malloc is used in SPL and
3503 it is set up by spl_init() and before that, the simple malloc()
3504 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini36853852012-02-14 07:29:40 +00003505
3506 CONFIG_SYS_SPL_MALLOC_SIZE
3507 The size of the malloc pool used in SPL.
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003508
Tom Rini28591df2012-08-13 12:03:19 -07003509 CONFIG_SPL_FRAMEWORK
3510 Enable the SPL framework under common/. This framework
3511 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3512 NAND loading of the Linux Kernel.
3513
Tom Rinic2b76002014-03-28 12:03:39 -04003514 CONFIG_SPL_OS_BOOT
3515 Enable booting directly to an OS from SPL.
3516 See also: doc/README.falcon
3517
Tom Rinife3b0c72012-08-13 11:37:56 -07003518 CONFIG_SPL_DISPLAY_PRINT
3519 For ARM, enable an optional function to print more information
3520 about the running system.
3521
Scott Wood7c810902012-09-20 16:35:21 -05003522 CONFIG_SPL_INIT_MINIMAL
3523 Arch init code should be built for a very small image
3524
Wolfgang Denk825223d2011-09-11 21:24:09 +02003525 CONFIG_SPL_LIBCOMMON_SUPPORT
3526 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003527
Wolfgang Denk825223d2011-09-11 21:24:09 +02003528 CONFIG_SPL_LIBDISK_SUPPORT
3529 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003530
Wolfgang Denk825223d2011-09-11 21:24:09 +02003531 CONFIG_SPL_I2C_SUPPORT
3532 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003533
Wolfgang Denk825223d2011-09-11 21:24:09 +02003534 CONFIG_SPL_GPIO_SUPPORT
3535 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003536
Wolfgang Denk825223d2011-09-11 21:24:09 +02003537 CONFIG_SPL_MMC_SUPPORT
3538 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003539
Tom Rini36853852012-02-14 07:29:40 +00003540 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3541 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003542 Address and partition on the MMC to load U-Boot from
Tom Rini36853852012-02-14 07:29:40 +00003543 when the MMC is being used in raw mode.
3544
Paul Kocialkowski17675c82014-11-08 23:14:56 +01003545 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3546 Partition on the MMC to load U-Boot from when the MMC is being
3547 used in raw mode
3548
Peter Korsgaard01b542f2013-05-13 08:36:29 +00003549 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3550 Sector to load kernel uImage from when MMC is being
3551 used in raw mode (for Falcon mode)
3552
3553 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3554 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3555 Sector and number of sectors to load kernel argument
3556 parameters from when MMC is being used in raw mode
3557 (for falcon mode)
3558
Paul Kocialkowski341e8cd2014-11-08 23:14:55 +01003559 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3560 Partition on the MMC to load U-Boot from when the MMC is being
3561 used in fs mode
3562
Tom Rini36853852012-02-14 07:29:40 +00003563 CONFIG_SPL_FAT_SUPPORT
3564 Support for fs/fat/libfat.o in SPL binary
3565
Guillaume GARDET5065b712014-10-15 17:53:13 +02003566 CONFIG_SPL_EXT_SUPPORT
3567 Support for EXT filesystem in SPL binary
Tom Rini36853852012-02-14 07:29:40 +00003568
Guillaume GARDET5065b712014-10-15 17:53:13 +02003569 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3570 Filename to read to load U-Boot when reading from filesystem
3571
3572 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003573 Filename to read to load kernel uImage when reading
Guillaume GARDET5065b712014-10-15 17:53:13 +02003574 from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003575
Guillaume GARDET5065b712014-10-15 17:53:13 +02003576 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003577 Filename to read to load kernel argument parameters
Guillaume GARDET5065b712014-10-15 17:53:13 +02003578 when reading from filesystem (for Falcon mode)
Peter Korsgaard465f1f82013-05-13 08:36:27 +00003579
Scott Wood2b36fbb2012-12-06 13:33:17 +00003580 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3581 Set this for NAND SPL on PPC mpc83xx targets, so that
3582 start.S waits for the rest of the SPL to load before
3583 continuing (the hardware starts execution after just
3584 loading the first page rather than the full 4K).
3585
Prabhakar Kushwaha6e2b9a32014-04-08 19:12:31 +05303586 CONFIG_SPL_SKIP_RELOCATE
3587 Avoid SPL relocation
3588
Scott Woodc352a0c2012-09-20 19:09:07 -05003589 CONFIG_SPL_NAND_BASE
3590 Include nand_base.c in the SPL. Requires
3591 CONFIG_SPL_NAND_DRIVERS.
3592
3593 CONFIG_SPL_NAND_DRIVERS
3594 SPL uses normal NAND drivers, not minimal drivers.
3595
3596 CONFIG_SPL_NAND_ECC
3597 Include standard software ECC in the SPL
3598
Tom Rini36853852012-02-14 07:29:40 +00003599 CONFIG_SPL_NAND_SIMPLE
Scott Wood36c440e2012-09-21 18:35:27 -05003600 Support for NAND boot using simple NAND drivers that
3601 expose the cmd_ctrl() interface.
Tom Rini36853852012-02-14 07:29:40 +00003602
Tom Rini543c9f12014-03-28 12:03:36 -04003603 CONFIG_SPL_MTD_SUPPORT
3604 Support for the MTD subsystem within SPL. Useful for
3605 environment on NAND support within SPL.
3606
Heiko Schochercf000272014-10-31 08:31:00 +01003607 CONFIG_SPL_NAND_RAW_ONLY
3608 Support to boot only raw u-boot.bin images. Use this only
3609 if you need to save space.
3610
Ying Zhang9ff70262013-08-16 15:16:11 +08003611 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3612 Set for the SPL on PPC mpc8xxx targets, support for
York Sunf0626592013-09-30 09:22:09 -07003613 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhang9ff70262013-08-16 15:16:11 +08003614
Ying Zhangdfb2b152013-08-16 15:16:12 +08003615 CONFIG_SPL_COMMON_INIT_DDR
3616 Set for common ddr init with serial presence detect in
3617 SPL binary.
3618
Tom Rini36853852012-02-14 07:29:40 +00003619 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3620 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3621 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3622 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3623 CONFIG_SYS_NAND_ECCBYTES
3624 Defines the size and behavior of the NAND that SPL uses
Scott Wood36c440e2012-09-21 18:35:27 -05003625 to read U-Boot
Tom Rini36853852012-02-14 07:29:40 +00003626
Prabhakar Kushwahaafffcb02013-12-11 12:42:11 +05303627 CONFIG_SPL_NAND_BOOT
3628 Add support NAND boot
3629
Tom Rini36853852012-02-14 07:29:40 +00003630 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood36c440e2012-09-21 18:35:27 -05003631 Location in NAND to read U-Boot from
3632
3633 CONFIG_SYS_NAND_U_BOOT_DST
3634 Location in memory to load U-Boot to
3635
3636 CONFIG_SYS_NAND_U_BOOT_SIZE
3637 Size of image to load
Tom Rini36853852012-02-14 07:29:40 +00003638
3639 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood36c440e2012-09-21 18:35:27 -05003640 Entry point in loaded image to jump to
Tom Rini36853852012-02-14 07:29:40 +00003641
3642 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3643 Define this if you need to first read the OOB and then the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003644 data. This is used, for example, on davinci platforms.
Tom Rini36853852012-02-14 07:29:40 +00003645
3646 CONFIG_SPL_OMAP3_ID_NAND
3647 Support for an OMAP3-specific set of functions to return the
3648 ID and MFR of the first attached NAND chip, if present.
3649
Wolfgang Denk825223d2011-09-11 21:24:09 +02003650 CONFIG_SPL_SERIAL_SUPPORT
3651 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003652
Wolfgang Denk825223d2011-09-11 21:24:09 +02003653 CONFIG_SPL_SPI_FLASH_SUPPORT
3654 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003655
Wolfgang Denk825223d2011-09-11 21:24:09 +02003656 CONFIG_SPL_SPI_SUPPORT
3657 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck39ca08e2011-07-18 07:48:07 +00003658
Pavel Machekde997252012-08-30 22:42:11 +02003659 CONFIG_SPL_RAM_DEVICE
3660 Support for running image already present in ram, in SPL binary
3661
Wolfgang Denk825223d2011-09-11 21:24:09 +02003662 CONFIG_SPL_LIBGENERIC_SUPPORT
3663 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz74eb4ae2008-03-12 10:33:01 +01003664
Ying Zhang602f7d32013-05-20 14:07:25 +08003665 CONFIG_SPL_ENV_SUPPORT
3666 Support for the environment operating in SPL binary
3667
3668 CONFIG_SPL_NET_SUPPORT
3669 Support for the net/libnet.o in SPL binary.
3670 It conflicts with SPL env from storage medium specified by
3671 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3672
Scott Woodeb7bd972012-12-06 13:33:16 +00003673 CONFIG_SPL_PAD_TO
Benoît Thébaudeauf0180722013-04-11 09:35:49 +00003674 Image offset to which the SPL should be padded before appending
3675 the SPL payload. By default, this is defined as
3676 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3677 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3678 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Woodeb7bd972012-12-06 13:33:16 +00003679
Scott Woodf147eb72012-09-21 16:27:32 -05003680 CONFIG_SPL_TARGET
3681 Final target image containing SPL and payload. Some SPLs
3682 use an arch-specific makefile fragment instead, for
3683 example if more than one image needs to be produced.
3684
Simon Glass82d94532013-05-08 08:05:59 +00003685 CONFIG_FIT_SPL_PRINT
3686 Printing information about a FIT image adds quite a bit of
3687 code to SPL. So this is normally disabled in SPL. Use this
3688 option to re-enable it. This will affect the output of the
3689 bootm command when booting a FIT image.
3690
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003691- TPL framework
3692 CONFIG_TPL
3693 Enable building of TPL globally.
3694
3695 CONFIG_TPL_PAD_TO
3696 Image offset to which the TPL should be padded before appending
3697 the TPL payload. By default, this is defined as
Wolfgang Denkec7fbf52013-10-04 17:43:24 +02003698 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3699 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3700 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang2d2e3b62013-08-16 15:16:15 +08003701
wdenkc0aa5c52003-12-06 19:49:23 +00003702- Interrupt support (PPC):
3703
wdenk1ebf41e2004-01-02 14:00:00 +00003704 There are common interrupt_init() and timer_interrupt()
3705 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003706 for CPU specific initialization. interrupt_init_cpu()
wdenk1ebf41e2004-01-02 14:00:00 +00003707 should set decrementer_count to appropriate value. If
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003708 CPU resets decrementer automatically after interrupt
wdenk1ebf41e2004-01-02 14:00:00 +00003709 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003710 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenk1ebf41e2004-01-02 14:00:00 +00003711 specific handling. If board has watchdog / status_led
3712 / other_activity_monitor it works automatically from
3713 general timer_interrupt().
wdenkc0aa5c52003-12-06 19:49:23 +00003714
wdenkc6097192002-11-03 00:24:07 +00003715
Helmut Raigerd5a184b2011-10-20 04:19:47 +00003716Board initialization settings:
3717------------------------------
3718
3719During Initialization u-boot calls a number of board specific functions
3720to allow the preparation of board specific prerequisites, e.g. pin setup
3721before drivers are initialized. To enable these callbacks the
3722following configuration macros have to be defined. Currently this is
3723architecture specific, so please check arch/your_architecture/lib/board.c
3724typically in board_init_f() and board_init_r().
3725
3726- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3727- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3728- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3729- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003730
wdenkc6097192002-11-03 00:24:07 +00003731Configuration Settings:
3732-----------------------
3733
York Sun6c480012014-02-26 17:03:19 -08003734- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3735 Optionally it can be defined to support 64-bit memory commands.
3736
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003737- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003738 undefine this when you're short of memory.
3739
Peter Tyserdfb72b82009-01-27 18:03:12 -06003740- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3741 width of the commands listed in the 'help' command output.
3742
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003743- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003744 prompt for user input.
3745
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003746- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003747
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003748- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003749
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003750- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003751
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003752- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003753 the application (usually a Linux kernel) when it is
3754 booted
3755
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003756- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003757 List of legal baudrate settings for this board.
3758
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003759- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk57b2d802003-06-27 21:31:46 +00003760 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003761
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003762- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk57b2d802003-06-27 21:31:46 +00003763 If the board specific function
3764 extern int overwrite_console (void);
3765 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003766 serial port, else the settings in the environment are used.
3767
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003768- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk57b2d802003-06-27 21:31:46 +00003769 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003770
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003771- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003772 Enable overwrite of previous console environment settings.
3773
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003774- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003775 Begin and End addresses of the area used by the
3776 simple memory test.
3777
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003778- CONFIG_SYS_ALT_MEMTEST:
wdenk57b2d802003-06-27 21:31:46 +00003779 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003780
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003781- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5958f4a2003-09-18 09:21:33 +00003782 Scratch address used by the alternate memory test
3783 You only need to set this if address zero isn't writeable
3784
York Sun5d286cd2015-12-04 11:57:07 -08003785- CONFIG_SYS_MEM_RESERVE_SECURE
3786 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3787 is substracted from total RAM and won't be reported to OS.
3788 This memory can be used as secure memory. A variable
3789 gd->secure_ram is used to track the location. In systems
3790 the RAM base is not zero, or RAM is divided into banks,
3791 this variable needs to be recalcuated to get the address.
3792
York Sun50739372015-12-07 11:05:29 -08003793- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003794 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roesea13709f2008-03-26 10:14:11 +01003795 this specified memory area will get subtracted from the top
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003796 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roesea13709f2008-03-26 10:14:11 +01003797 fixing up gd->ram_size the Linux kernel should gets passed
3798 the now "corrected" memory size and won't touch it either.
3799 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese37f31bf2008-03-28 11:02:53 +01003800 board ports in arch/powerpc with bootwrapper support that
Stefan Roesea13709f2008-03-26 10:14:11 +01003801 recalculate the memory size from the SDRAM controller setup
Stefan Roese37f31bf2008-03-28 11:02:53 +01003802 will have to get fixed in Linux additionally.
Stefan Roesea13709f2008-03-26 10:14:11 +01003803
3804 This option can be used as a workaround for the 440EPx/GRx
3805 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3806 be touched.
3807
3808 WARNING: Please make sure that this value is a multiple of
3809 the Linux page size (normally 4k). If this is not the case,
3810 then the end address of the Linux memory will be located at a
3811 non page size aligned address and this could cause major
3812 problems.
3813
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003814- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003815 Enable temporary baudrate change while serial download
3816
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003817- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003818 Physical start address of SDRAM. _Must_ be 0 here.
3819
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003820- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003821 Physical start address of Motherboard I/O (if using a
3822 Cogent motherboard)
3823
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003824- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003825 Physical start address of Flash memory.
3826
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003827- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003828 Physical start address of boot monitor code (set by
3829 make config files to be same as the text base address
Wolfgang Denk0708bc62010-10-07 21:51:12 +02003830 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003831 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003832
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003833- CONFIG_SYS_MONITOR_LEN:
wdenk57b2d802003-06-27 21:31:46 +00003834 Size of memory reserved for monitor code, used to
3835 determine _at_compile_time_ (!) if the environment is
3836 embedded within the U-Boot image, or in a separate
3837 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003838
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003839- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003840 Size of DRAM reserved for malloc() use.
3841
Simon Glass863e4042014-07-10 22:23:28 -06003842- CONFIG_SYS_MALLOC_F_LEN
3843 Size of the malloc() pool for use before relocation. If
3844 this is defined, then a very simple malloc() implementation
3845 will become available before relocation. The address is just
3846 below the global data, and the stack is moved down to make
3847 space.
3848
3849 This feature allocates regions with increasing addresses
3850 within the region. calloc() is supported, but realloc()
3851 is not available. free() is supported but does nothing.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08003852 The memory will be freed (or in fact just forgotten) when
Simon Glass863e4042014-07-10 22:23:28 -06003853 U-Boot relocates itself.
3854
Simon Glasse997f752014-09-15 06:33:18 -06003855 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass0cc6f5c2014-07-10 22:23:31 -06003856 at present but is fairly easy to enable for other archs.
3857
Simon Glass9fa901b2014-11-10 17:16:54 -07003858- CONFIG_SYS_MALLOC_SIMPLE
3859 Provides a simple and small malloc() and calloc() for those
3860 boards which do not use the full malloc in SPL (which is
3861 enabled with CONFIG_SYS_SPL_MALLOC_START).
3862
Thierry Redingc97d9742014-12-09 22:25:22 -07003863- CONFIG_SYS_NONCACHED_MEMORY:
3864 Size of non-cached memory area. This area of memory will be
3865 typically located right below the malloc() area and mapped
3866 uncached in the MMU. This is useful for drivers that would
3867 otherwise require a lot of explicit cache maintenance. For
3868 some drivers it's also impossible to properly maintain the
3869 cache. For example if the regions that need to be flushed
3870 are not a multiple of the cache-line size, *and* padding
3871 cannot be allocated between the regions to align them (i.e.
3872 if the HW requires a contiguous array of regions, and the
3873 size of each region is not cache-aligned), then a flush of
3874 one region may result in overwriting data that hardware has
3875 written to another region in the same cache-line. This can
3876 happen for example in network drivers where descriptors for
3877 buffers are typically smaller than the CPU cache-line (e.g.
3878 16 bytes vs. 32 or 64 bytes).
3879
3880 Non-cached memory is only supported on 32-bit ARM at present.
3881
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003882- CONFIG_SYS_BOOTM_LEN:
Stefan Roese5d5ce292006-03-13 11:16:36 +01003883 Normally compressed uImages are limited to an
3884 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003885 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese5d5ce292006-03-13 11:16:36 +01003886 to adjust this setting to your needs.
3887
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003888- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003889 Maximum size of memory mapped by the startup code of
3890 the Linux kernel; all data that must be processed by
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003891 the Linux kernel (bd_info, boot arguments, FDT blob if
3892 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day832d36e2013-09-16 07:15:45 -04003893 environment variable is defined and non-zero. In such case
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02003894 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denk092ae952011-10-26 10:21:21 +00003895 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likely26396382011-03-28 09:58:43 +00003896 variable "bootm_mapsize" will override the value of
3897 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3898 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003899
John Rigbyeea8e692010-10-13 13:57:35 -06003900- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3901 Enable initrd_high functionality. If defined then the
3902 initrd_high feature is enabled and the bootm ramdisk subcommand
3903 is enabled.
3904
3905- CONFIG_SYS_BOOT_GET_CMDLINE:
3906 Enables allocating and saving kernel cmdline in space between
3907 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3908
3909- CONFIG_SYS_BOOT_GET_KBD:
3910 Enables allocating and saving a kernel copy of the bd_info in
3911 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3912
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003913- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003914 Max number of Flash memory banks
3915
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003916- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003917 Max number of sectors on a Flash chip
3918
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003919- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003920 Timeout for Flash erase operations (in ms)
3921
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003922- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003923 Timeout for Flash write operations (in ms)
3924
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003925- CONFIG_SYS_FLASH_LOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003926 Timeout for Flash set sector lock bit operation (in ms)
3927
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003928- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenkdccbda02003-07-14 22:13:32 +00003929 Timeout for Flash clear lock bits operation (in ms)
3930
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003931- CONFIG_SYS_FLASH_PROTECTION
wdenkdccbda02003-07-14 22:13:32 +00003932 If defined, hardware flash sectors protection is used
3933 instead of U-Boot software protection.
3934
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003935- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003936
3937 Enable TFTP transfers directly to flash memory;
3938 without this option such a download has to be
3939 performed in two steps: (1) download to RAM, and (2)
3940 copy from RAM to flash.
3941
3942 The two-step approach is usually more reliable, since
3943 you can check if the download worked before you erase
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003944 the flash, but in some situations (when system RAM is
3945 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003946 downloaded image) this option may be very useful.
3947
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003948- CONFIG_SYS_FLASH_CFI:
wdenk4a5c8a72003-03-06 00:02:04 +00003949 Define if the flash driver uses extra elements in the
wdenk2cefd152004-02-08 22:55:38 +00003950 common flash structure for storing flash geometry.
3951
Jean-Christophe PLAGNIOL-VILLARD8d94c232008-08-13 01:40:42 +02003952- CONFIG_FLASH_CFI_DRIVER
wdenk2cefd152004-02-08 22:55:38 +00003953 This option also enables the building of the cfi_flash driver
3954 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003955
Piotr Ziecik3e939e92008-11-17 15:57:58 +01003956- CONFIG_FLASH_CFI_MTD
3957 This option enables the building of the cfi_mtd driver
3958 in the drivers directory. The driver exports CFI flash
3959 to the MTD layer.
3960
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003961- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski183284f2008-04-03 13:36:02 +02003962 Use buffered writes to flash.
3963
3964- CONFIG_FLASH_SPANSION_S29WS_N
3965 s29ws-n MirrorBit flash has non-standard addresses for buffered
3966 write commands.
3967
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003968- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roesec443fe92005-11-22 13:20:42 +01003969 If this option is defined, the common CFI flash doesn't
3970 print it's warning upon not recognized FLASH banks. This
3971 is useful, if some of the configured banks are only
3972 optionally available.
3973
Jerry Van Barenaae73572008-03-08 13:48:01 -05003974- CONFIG_FLASH_SHOW_PROGRESS
3975 If defined (must be an integer), print out countdown
3976 digits and dots. Recommended value: 45 (9..1) for 80
3977 column displays, 15 (3..1) for 40 column displays.
3978
Stefan Roesed20cba52013-04-04 15:53:14 +02003979- CONFIG_FLASH_VERIFY
3980 If defined, the content of the flash (destination) is compared
3981 against the source after the write operation. An error message
3982 will be printed when the contents are not identical.
3983 Please note that this option is useless in nearly all cases,
3984 since such flash programming errors usually are detected earlier
3985 while unprotecting/erasing/programming. Please only enable
3986 this option if you really know what you are doing.
3987
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02003988- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003989 Defines the number of Ethernet receive buffers. On some
3990 Ethernet controllers it is recommended to set this value
stroese94ef1cf2003-06-05 15:39:44 +00003991 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3992 buffers can be full shortly after enabling the interface
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02003993 on high Ethernet traffic.
stroese94ef1cf2003-06-05 15:39:44 +00003994 Defaults to 4 if not defined.
3995
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02003996- CONFIG_ENV_MAX_ENTRIES
3997
Wolfgang Denk1136f692010-10-27 22:48:30 +02003998 Maximum number of entries in the hash table that is used
3999 internally to store the environment settings. The default
4000 setting is supposed to be generous and should work in most
4001 cases. This setting can be used to tune behaviour; see
4002 lib/hashtable.c for details.
Wolfgang Denk460a9ff2010-06-20 23:33:59 +02004003
Joe Hershberger71497d02012-12-11 22:16:31 -06004004- CONFIG_ENV_FLAGS_LIST_DEFAULT
4005- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day832d36e2013-09-16 07:15:45 -04004006 Enable validation of the values given to environment variables when
Joe Hershberger71497d02012-12-11 22:16:31 -06004007 calling env set. Variables can be restricted to only decimal,
4008 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4009 the variables can also be restricted to IP address or MAC address.
4010
4011 The format of the list is:
4012 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004013 access_attribute = [a|r|o|c]
4014 attributes = type_attribute[access_attribute]
Joe Hershberger71497d02012-12-11 22:16:31 -06004015 entry = variable_name[:attributes]
4016 list = entry[,list]
4017
4018 The type attributes are:
4019 s - String (default)
4020 d - Decimal
4021 x - Hexadecimal
4022 b - Boolean ([1yYtT|0nNfF])
4023 i - IP address
4024 m - MAC address
4025
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004026 The access attributes are:
4027 a - Any (default)
4028 r - Read-only
4029 o - Write-once
4030 c - Change-default
4031
Joe Hershberger71497d02012-12-11 22:16:31 -06004032 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4033 Define this to a list (string) to define the ".flags"
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004034 environment variable in the default or embedded environment.
Joe Hershberger71497d02012-12-11 22:16:31 -06004035
4036 - CONFIG_ENV_FLAGS_LIST_STATIC
4037 Define this to a list (string) to define validation that
4038 should be done if an entry is not found in the ".flags"
4039 environment variable. To override a setting in the static
4040 list, simply add an entry for the same variable name to the
4041 ".flags" variable.
4042
Joe Hershberger6db9fd42015-05-20 14:27:20 -05004043 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4044 regular expression. This allows multiple variables to define the same
4045 flags without explicitly listing them for each variable.
4046
Joe Hershberger6fe26c92012-12-11 22:16:34 -06004047- CONFIG_ENV_ACCESS_IGNORE_FORCE
4048 If defined, don't allow the -f switch to env set override variable
4049 access flags.
4050
Simon Glass66828322013-03-08 13:45:27 +00004051- CONFIG_SYS_GENERIC_BOARD
4052 This selects the architecture-generic board system instead of the
4053 architecture-specific board files. It is intended to move boards
4054 to this new framework over time. Defining this will disable the
4055 arch/foo/lib/board.c file and use common/board_f.c and
4056 common/board_r.c instead. To use this option your architecture
Masahiro Yamada9e4af832015-03-19 19:42:51 +09004057 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4058 If you find problems enabling this option on your board please report
4059 the problem and send patches!
Simon Glass66828322013-03-08 13:45:27 +00004060
Lokesh Vutla100c2d82013-04-17 20:49:40 +00004061- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4062 This is set by OMAP boards for the max time that reset should
4063 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004064 the value can be calculated on a given board.
Simon Glass9c9f44a2013-03-11 07:06:48 +00004065
Gabe Black3687fe42014-10-15 04:38:30 -06004066- CONFIG_USE_STDINT
4067 If stdint.h is available with your toolchain you can define this
4068 option to enable it. You can provide option 'USE_STDINT=1' when
4069 building U-Boot to enable this.
4070
wdenkc6097192002-11-03 00:24:07 +00004071The following definitions that deal with the placement and management
4072of environment data (variable area); in general, we support the
4073following configurations:
4074
Mike Frysinger63b8f122011-07-08 10:44:25 +00004075- CONFIG_BUILD_ENVCRC:
4076
4077 Builds up envcrc with the target environment so that external utils
4078 may easily extract it and embed it in final U-Boot images.
4079
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004080- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004081
4082 Define this if the environment is in flash memory.
4083
4084 a) The environment occupies one whole flash sector, which is
4085 "embedded" in the text segment with the U-Boot code. This
4086 happens usually with "bottom boot sector" or "top boot
4087 sector" type flash chips, which have several smaller
4088 sectors at the start or the end. For instance, such a
4089 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4090 such a case you would place the environment in one of the
4091 4 kB sectors - with U-Boot code before and after it. With
4092 "top boot sector" type flash chips, you would put the
4093 environment in one of the last sectors, leaving a gap
4094 between U-Boot and the environment.
4095
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004096 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004097
4098 Offset of environment data (variable area) to the
4099 beginning of flash memory; for instance, with bottom boot
4100 type flash chips the second sector can be used: the offset
4101 for this sector is given here.
4102
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004103 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004104
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004105 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004106
4107 This is just another way to specify the start address of
4108 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004109 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004110
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004111 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004112
4113 Size of the sector containing the environment.
4114
4115
4116 b) Sometimes flash chips have few, equal sized, BIG sectors.
4117 In such a case you don't want to spend a whole sector for
4118 the environment.
4119
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004120 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004121
Jean-Christophe PLAGNIOL-VILLARD53db4cd2008-09-10 22:48:04 +02004122 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004123 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004124 of this flash sector for the environment. This saves
4125 memory for the RAM copy of the environment.
4126
4127 It may also save flash memory if you decide to use this
4128 when your environment is "embedded" within U-Boot code,
4129 since then the remainder of the flash sector could be used
4130 for U-Boot code. It should be pointed out that this is
4131 STRONGLY DISCOURAGED from a robustness point of view:
4132 updating the environment in flash makes it always
4133 necessary to erase the WHOLE sector. If something goes
4134 wrong before the contents has been restored from a copy in
4135 RAM, your target system will be dead.
4136
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004137 - CONFIG_ENV_ADDR_REDUND
4138 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004139
wdenk4a5c8a72003-03-06 00:02:04 +00004140 These settings describe a second storage area used to hold
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004141 a redundant copy of the environment data, so that there is
wdenkb02744a2003-04-05 00:53:31 +00004142 a valid backup copy in case there is a power failure during
wdenk4a5c8a72003-03-06 00:02:04 +00004143 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004144
4145BE CAREFUL! Any changes to the flash layout, and some changes to the
4146source code will make it necessary to adapt <board>/u-boot.lds*
4147accordingly!
4148
4149
Jean-Christophe PLAGNIOL-VILLARDfdb79c32008-09-10 22:47:59 +02004150- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004151
4152 Define this if you have some non-volatile memory device
4153 (NVRAM, battery buffered SRAM) which you want to use for the
4154 environment.
4155
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004156 - CONFIG_ENV_ADDR:
4157 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004158
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004159 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004160 want to use for environment. It is assumed that this memory
4161 can just be read and written to, without any special
4162 provision.
4163
4164BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004165in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004166console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004167U-Boot will hang.
4168
4169Please note that even with NVRAM we still use a copy of the
4170environment in RAM: we could work on NVRAM directly, but we want to
4171keep settings there always unmodified except somebody uses "saveenv"
4172to save the current settings.
4173
4174
Jean-Christophe PLAGNIOL-VILLARDe46af642008-09-05 09:19:30 +02004175- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004176
4177 Use this if you have an EEPROM or similar serial access
4178 device and a driver for it.
4179
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004180 - CONFIG_ENV_OFFSET:
4181 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004182
4183 These two #defines specify the offset and size of the
4184 environment area within the total memory of your EEPROM.
4185
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004186 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004187 If defined, specified the chip address of the EEPROM device.
4188 The default address is zero.
4189
Christian Gmeiner4c5b7542015-02-11 15:19:31 +01004190 - CONFIG_SYS_I2C_EEPROM_BUS:
4191 If defined, specified the i2c bus of the EEPROM device.
4192
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004193 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004194 If defined, the number of bits used to address bytes in a
4195 single page in the EEPROM device. A 64 byte page, for example
4196 would require six bits.
4197
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004198 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004199 If defined, the number of milliseconds to delay between
wdenk544e9732004-02-06 23:19:44 +00004200 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004201
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004202 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004203 The length in bytes of the EEPROM memory array address. Note
4204 that this is NOT the chip address length!
4205
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004206 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk20c98a62004-04-23 20:32:05 +00004207 EEPROM chips that implement "address overflow" are ones
4208 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4209 address and the extra bits end up in the "chip address" bit
4210 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4211 byte chips.
4212
4213 Note that we consider the length of the address field to
4214 still be one byte because the extra address bits are hidden
4215 in the chip address.
4216
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004217 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004218 The size in bytes of the EEPROM device.
4219
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004220 - CONFIG_ENV_EEPROM_IS_ON_I2C
4221 define this, if you have I2C and SPI activated, and your
4222 EEPROM, which holds the environment, is on the I2C bus.
4223
4224 - CONFIG_I2C_ENV_EEPROM_BUS
4225 if you have an Environment on an EEPROM reached over
4226 I2C muxes, you can define here, how to reach this
4227 EEPROM. For example:
4228
Heiko Schocher479a4cf2013-01-29 08:53:15 +01004229 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher9bb0dd52010-01-07 08:55:40 +01004230
4231 EEPROM which holds the environment, is reached over
4232 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004233
Jean-Christophe PLAGNIOL-VILLARD2b14d2b2008-09-10 22:47:58 +02004234- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk86765902003-12-06 23:55:10 +00004235
wdenk1ebf41e2004-01-02 14:00:00 +00004236 Define this if you have a DataFlash memory device which you
wdenk86765902003-12-06 23:55:10 +00004237 want to use for the environment.
4238
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004239 - CONFIG_ENV_OFFSET:
4240 - CONFIG_ENV_ADDR:
4241 - CONFIG_ENV_SIZE:
wdenk86765902003-12-06 23:55:10 +00004242
4243 These three #defines specify the offset and size of the
4244 environment area within the total memory of your DataFlash placed
4245 at the specified address.
4246
Wu, Josh76db7bf2014-07-01 19:30:13 +08004247- CONFIG_ENV_IS_IN_SPI_FLASH:
4248
4249 Define this if you have a SPI Flash memory device which you
4250 want to use for the environment.
4251
4252 - CONFIG_ENV_OFFSET:
4253 - CONFIG_ENV_SIZE:
4254
4255 These two #defines specify the offset and size of the
4256 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4257 aligned to an erase sector boundary.
4258
4259 - CONFIG_ENV_SECT_SIZE:
4260
4261 Define the SPI flash's sector size.
4262
4263 - CONFIG_ENV_OFFSET_REDUND (optional):
4264
4265 This setting describes a second storage area of CONFIG_ENV_SIZE
4266 size used to hold a redundant copy of the environment data, so
4267 that there is a valid backup copy in case there is a power failure
4268 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4269 aligned to an erase sector boundary.
4270
4271 - CONFIG_ENV_SPI_BUS (optional):
4272 - CONFIG_ENV_SPI_CS (optional):
4273
4274 Define the SPI bus and chip select. If not defined they will be 0.
4275
4276 - CONFIG_ENV_SPI_MAX_HZ (optional):
4277
4278 Define the SPI max work clock. If not defined then use 1MHz.
4279
4280 - CONFIG_ENV_SPI_MODE (optional):
4281
4282 Define the SPI work mode. If not defined then use SPI_MODE_3.
4283
Liu Gang85bcd732012-03-08 00:33:20 +00004284- CONFIG_ENV_IS_IN_REMOTE:
4285
4286 Define this if you have a remote memory space which you
4287 want to use for the local device's environment.
4288
4289 - CONFIG_ENV_ADDR:
4290 - CONFIG_ENV_SIZE:
4291
4292 These two #defines specify the address and size of the
4293 environment area within the remote memory space. The
4294 local device can get the environment from remote memory
Liu Gang357bf5a2012-08-09 05:10:01 +00004295 space by SRIO or PCIE links.
Liu Gang85bcd732012-03-08 00:33:20 +00004296
4297BE CAREFUL! For some special cases, the local device can not use
4298"saveenv" command. For example, the local device will get the
Liu Gang357bf5a2012-08-09 05:10:01 +00004299environment stored in a remote NOR flash by SRIO or PCIE link,
4300but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang85bcd732012-03-08 00:33:20 +00004301
Jean-Christophe PLAGNIOL-VILLARDdda84dd2008-09-10 22:47:58 +02004302- CONFIG_ENV_IS_IN_NAND:
wdenk79b59372004-06-09 14:58:14 +00004303
4304 Define this if you have a NAND device which you want to use
4305 for the environment.
4306
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004307 - CONFIG_ENV_OFFSET:
4308 - CONFIG_ENV_SIZE:
wdenk79b59372004-06-09 14:58:14 +00004309
4310 These two #defines specify the offset and size of the environment
Scott Wood08239322010-09-17 14:38:37 -05004311 area within the first NAND device. CONFIG_ENV_OFFSET must be
4312 aligned to an erase block boundary.
wdenk86765902003-12-06 23:55:10 +00004313
Scott Wood08239322010-09-17 14:38:37 -05004314 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004315
Jean-Christophe PLAGNIOL-VILLARD7e1cda62008-09-10 22:48:06 +02004316 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Wood08239322010-09-17 14:38:37 -05004317 size used to hold a redundant copy of the environment data, so
4318 that there is a valid backup copy in case there is a power failure
Wolfgang Denk092ae952011-10-26 10:21:21 +00004319 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Wood08239322010-09-17 14:38:37 -05004320 aligned to an erase block boundary.
4321
4322 - CONFIG_ENV_RANGE (optional):
4323
4324 Specifies the length of the region in which the environment
4325 can be written. This should be a multiple of the NAND device's
4326 block size. Specifying a range with more erase blocks than
4327 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4328 the range to be avoided.
4329
4330 - CONFIG_ENV_OFFSET_OOB (optional):
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004331
Scott Wood08239322010-09-17 14:38:37 -05004332 Enables support for dynamically retrieving the offset of the
4333 environment from block zero's out-of-band data. The
4334 "nand env.oob" command can be used to record this offset.
4335 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4336 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuecher5d113e02006-03-20 18:02:44 +01004337
Guennadi Liakhovetskifad24442009-05-18 16:07:22 +02004338- CONFIG_NAND_ENV_DST
4339
4340 Defines address in RAM to which the nand_spl code should copy the
4341 environment. If redundant environment is used, it will be copied to
4342 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4343
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004344- CONFIG_ENV_IS_IN_UBI:
4345
4346 Define this if you have an UBI volume that you want to use for the
4347 environment. This has the benefit of wear-leveling the environment
4348 accesses, which is important on NAND.
4349
4350 - CONFIG_ENV_UBI_PART:
4351
4352 Define this to a string that is the mtd partition containing the UBI.
4353
4354 - CONFIG_ENV_UBI_VOLUME:
4355
4356 Define this to the name of the volume that you want to store the
4357 environment in.
4358
Joe Hershbergerdb14e862013-04-08 10:32:52 +00004359 - CONFIG_ENV_UBI_VOLUME_REDUND:
4360
4361 Define this to the name of another volume to store a second copy of
4362 the environment in. This will enable redundant environments in UBI.
4363 It is assumed that both volumes are in the same MTD partition.
4364
Joe Hershberger0c5faa82013-04-08 10:32:51 +00004365 - CONFIG_UBI_SILENCE_MSG
4366 - CONFIG_UBIFS_SILENCE_MSG
4367
4368 You will probably want to define these to avoid a really noisy system
4369 when storing the env in UBI.
4370
Wu, Josha7d0c872014-06-24 17:31:03 +08004371- CONFIG_ENV_IS_IN_FAT:
4372 Define this if you want to use the FAT file system for the environment.
4373
4374 - FAT_ENV_INTERFACE:
4375
4376 Define this to a string that is the name of the block device.
4377
4378 - FAT_ENV_DEV_AND_PART:
4379
4380 Define this to a string to specify the partition of the device. It can
4381 be as following:
4382
4383 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4384 - "D:P": device D partition P. Error occurs if device D has no
4385 partition table.
4386 - "D:0": device D.
4387 - "D" or "D:": device D partition 1 if device D has partition
4388 table, or the whole device D if has no partition
4389 table.
4390 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004391 If none, first valid partition in device D. If no
Wu, Josha7d0c872014-06-24 17:31:03 +08004392 partition table then means device D.
4393
4394 - FAT_ENV_FILE:
4395
4396 It's a string of the FAT file name. This file use to store the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004397 environment.
Wu, Josha7d0c872014-06-24 17:31:03 +08004398
4399 - CONFIG_FAT_WRITE:
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004400 This should be defined. Otherwise it cannot save the environment file.
Wu, Josha7d0c872014-06-24 17:31:03 +08004401
Stephen Warreneedcacd2013-06-11 15:14:00 -06004402- CONFIG_ENV_IS_IN_MMC:
4403
4404 Define this if you have an MMC device which you want to use for the
4405 environment.
4406
4407 - CONFIG_SYS_MMC_ENV_DEV:
4408
4409 Specifies which MMC device the environment is stored in.
4410
4411 - CONFIG_SYS_MMC_ENV_PART (optional):
4412
4413 Specifies which MMC partition the environment is stored in. If not
4414 set, defaults to partition 0, the user area. Common values might be
4415 1 (first MMC boot partition), 2 (second MMC boot partition).
4416
4417 - CONFIG_ENV_OFFSET:
4418 - CONFIG_ENV_SIZE:
4419
4420 These two #defines specify the offset and size of the environment
4421 area within the specified MMC device.
4422
Stephen Warren24dc2032013-06-11 15:14:02 -06004423 If offset is positive (the usual case), it is treated as relative to
4424 the start of the MMC partition. If offset is negative, it is treated
4425 as relative to the end of the MMC partition. This can be useful if
4426 your board may be fitted with different MMC devices, which have
4427 different sizes for the MMC partitions, and you always want the
4428 environment placed at the very end of the partition, to leave the
4429 maximum possible space before it, to store other data.
4430
Stephen Warreneedcacd2013-06-11 15:14:00 -06004431 These two values are in units of bytes, but must be aligned to an
4432 MMC sector boundary.
4433
4434 - CONFIG_ENV_OFFSET_REDUND (optional):
4435
4436 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4437 hold a redundant copy of the environment data. This provides a
4438 valid backup copy in case the other copy is corrupted, e.g. due
4439 to a power failure during a "saveenv" operation.
4440
Stephen Warren24dc2032013-06-11 15:14:02 -06004441 This value may also be positive or negative; this is handled in the
4442 same way as CONFIG_ENV_OFFSET.
4443
Stephen Warreneedcacd2013-06-11 15:14:00 -06004444 This value is also in units of bytes, but must also be aligned to
4445 an MMC sector boundary.
4446
4447 - CONFIG_ENV_SIZE_REDUND (optional):
4448
4449 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4450 set. If this value is set, it must be set to the same value as
4451 CONFIG_ENV_SIZE.
4452
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004453- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004454
4455 Defines offset to the initial SPI buffer area in DPRAM. The
4456 area is used at an early stage (ROM part) if the environment
4457 is configured to reside in the SPI EEPROM: We need a 520 byte
4458 scratch DPRAM area. It is used between the two initialization
4459 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4460 to be a good choice since it makes it far enough from the
4461 start of the data area as well as from the stack pointer.
4462
Bruce Adleredecc942007-11-02 13:15:42 -07004463Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004464has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denk76af2782010-07-24 21:55:43 +02004465created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004466until then to read environment variables.
4467
wdenk8dba0502003-03-31 16:34:49 +00004468The environment is protected by a CRC32 checksum. Before the monitor
4469is relocated into RAM, as a result of a bad CRC you will be working
4470with the compiled-in default environment - *silently*!!! [This is
4471necessary, because the first environment variable we need is the
4472"baudrate" setting for the console - if we have a bad CRC, we don't
4473have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004474
4475Note: once the monitor has been relocated, then it will complain if
4476the default environment is used; a new CRC is computed as soon as you
wdenk8dba0502003-03-31 16:34:49 +00004477use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004478
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004479- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk9c53f402003-10-15 23:53:47 +00004480 Echo the inverted Ethernet link state to the fault LED.
wdenk49c3f672003-10-08 22:33:00 +00004481
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004482 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenk49c3f672003-10-08 22:33:00 +00004483 also needs to be defined.
4484
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004485- CONFIG_SYS_FAULT_MII_ADDR:
wdenk9c53f402003-10-15 23:53:47 +00004486 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004487
Ron Madriddfa028a2009-02-18 14:30:44 -08004488- CONFIG_NS16550_MIN_FUNCTIONS:
4489 Define this if you desire to only have use of the NS16550_init
4490 and NS16550_putc functions for the serial driver located at
4491 drivers/serial/ns16550.c. This option is useful for saving
4492 space for already greatly restricted images, including but not
4493 limited to NAND_SPL configurations.
4494
Simon Glass28a9e332012-11-30 13:01:18 +00004495- CONFIG_DISPLAY_BOARDINFO
4496 Display information about the board that U-Boot is running on
4497 when U-Boot starts up. The board function checkboard() is called
4498 to do this.
4499
Simon Glasse8822012012-11-30 13:01:19 +00004500- CONFIG_DISPLAY_BOARDINFO_LATE
4501 Similar to the previous option, but display this information
4502 later, once stdio is running and output goes to the LCD, if
4503 present.
4504
Sascha Silbe4b9c17c2013-08-11 16:40:43 +02004505- CONFIG_BOARD_SIZE_LIMIT:
4506 Maximum size of the U-Boot image. When defined, the
4507 build system checks that the actual size does not
4508 exceed it.
4509
wdenkc6097192002-11-03 00:24:07 +00004510Low Level (hardware related) configuration options:
wdenkc8434db2003-03-26 06:55:25 +00004511---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004512
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004513- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004514 Cache Line Size of the CPU.
4515
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004516- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004517 Default address of the IMMR after system reset.
wdenk2bb11052003-07-17 23:16:40 +00004518
wdenk9c53f402003-10-15 23:53:47 +00004519 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4520 and RPXsuper) to be able to adjust the position of
4521 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004522
Timur Tabid8f341c2011-08-04 18:03:41 -05004523- CONFIG_SYS_CCSRBAR_DEFAULT:
4524 Default (power-on reset) physical address of CCSR on Freescale
4525 PowerPC SOCs.
4526
4527- CONFIG_SYS_CCSRBAR:
4528 Virtual address of CCSR. On a 32-bit build, this is typically
4529 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4530
4531 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4532 for cross-platform code that uses that macro instead.
4533
4534- CONFIG_SYS_CCSRBAR_PHYS:
4535 Physical address of CCSR. CCSR can be relocated to a new
4536 physical address, if desired. In this case, this macro should
Wolfgang Denk092ae952011-10-26 10:21:21 +00004537 be set to that address. Otherwise, it should be set to the
Timur Tabid8f341c2011-08-04 18:03:41 -05004538 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4539 is typically relocated on 36-bit builds. It is recommended
4540 that this macro be defined via the _HIGH and _LOW macros:
4541
4542 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4543 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4544
4545- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denkd590fb12011-10-07 09:58:21 +02004546 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4547 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabid8f341c2011-08-04 18:03:41 -05004548 used in assembly code, so it must not contain typecasts or
4549 integer size suffixes (e.g. "ULL").
4550
4551- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4552 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4553 used in assembly code, so it must not contain typecasts or
4554 integer size suffixes (e.g. "ULL").
4555
4556- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4557 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4558 forced to a value that ensures that CCSR is not relocated.
4559
wdenk1272e232002-11-10 22:06:23 +00004560- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004561 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk1272e232002-11-10 22:06:23 +00004562
4563 the default drive number (default value 0)
4564
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004565 CONFIG_SYS_ISA_IO_STRIDE
wdenk1272e232002-11-10 22:06:23 +00004566
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004567 defines the spacing between FDC chipset registers
wdenk1272e232002-11-10 22:06:23 +00004568 (default value 1)
4569
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004570 CONFIG_SYS_ISA_IO_OFFSET
wdenk1272e232002-11-10 22:06:23 +00004571
wdenk4a5c8a72003-03-06 00:02:04 +00004572 defines the offset of register from address. It
4573 depends on which part of the data bus is connected to
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02004574 the FDC chipset. (default value 0)
wdenk1272e232002-11-10 22:06:23 +00004575
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004576 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4577 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk4a5c8a72003-03-06 00:02:04 +00004578 default value.
wdenk1272e232002-11-10 22:06:23 +00004579
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004580 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk4a5c8a72003-03-06 00:02:04 +00004581 fdc_hw_init() is called at the beginning of the FDC
4582 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004583 source code. It is used to make hardware-dependent
wdenk4a5c8a72003-03-06 00:02:04 +00004584 initializations.
wdenk1272e232002-11-10 22:06:23 +00004585
Macpaul Lind1e49942011-04-11 20:45:32 +00004586- CONFIG_IDE_AHB:
4587 Most IDE controllers were designed to be connected with PCI
4588 interface. Only few of them were designed for AHB interface.
4589 When software is doing ATA command and data transfer to
4590 IDE devices through IDE-AHB controller, some additional
4591 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004592 is required.
Macpaul Lind1e49942011-04-11 20:45:32 +00004593
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004594- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenk07d7e6b2004-12-16 21:44:03 +00004595 DO NOT CHANGE unless you know exactly what you're
wdenkb3a4a702004-12-10 11:40:40 +00004596 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004597
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004598- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004599
wdenkeb20ad32003-09-05 23:19:14 +00004600 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004601 initial data and stack; please note that this must be
4602 writable memory that is working WITHOUT special
4603 initialization, i. e. you CANNOT use normal RAM which
4604 will become available only after programming the
4605 memory controller and running certain initialization
4606 sequences.
4607
4608 U-Boot uses the following memory types:
4609 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4610 - MPC824X: data cache
4611 - PPC4xx: data cache
4612
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004613- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004614
4615 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004616 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4617 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004618 data is located at the end of the available space
Wolfgang Denk1c2e98e2010-10-26 13:32:32 +02004619 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004620 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4621 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4622 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004623
4624 Note:
4625 On the MPC824X (or other systems that use the data
4626 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004627 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004628 point to an otherwise UNUSED address space between
4629 the top of RAM and the start of the PCI space.
4630
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004631- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004632
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004633- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004634
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004635- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004636
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004637- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004638
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004639- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004640
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004641- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004642
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004643- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004644 SDRAM timing
4645
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004646- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004647 periodic timer for refresh
4648
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004649- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004650
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004651- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4652 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4653 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4654 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004655 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4656
4657- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004658 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4659 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004660 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4661
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004662- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4663 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004664 Machine Mode Register and Memory Periodic Timer
4665 Prescaler definitions (SDRAM timing)
4666
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004667- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004668 enable I2C microcode relocation patch (MPC8xx);
4669 define relocation offset in DPRAM [DSP2]
4670
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004671- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherc8148ed2008-01-11 01:12:07 +01004672 enable SMC microcode relocation patch (MPC8xx);
4673 define relocation offset in DPRAM [SMC1]
4674
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004675- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004676 enable SPI microcode relocation patch (MPC8xx);
4677 define relocation offset in DPRAM [SCC4]
4678
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004679- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004680 Use OSCM clock mode on MBX8xx board. Be careful,
4681 wrong setting might damage your board. Read
4682 doc/README.MBX before setting this variable!
4683
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004684- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk4a5c8a72003-03-06 00:02:04 +00004685 Offset of the bootmode word in DPRAM used by post
4686 (Power On Self Tests). This definition overrides
4687 #define'd default value in commproc.h resp.
4688 cpm_8260.h.
wdenk2029f4d2002-11-21 23:11:29 +00004689
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004690- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4691 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4692 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4693 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4694 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4695 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4696 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4697 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roese88fbf932010-04-15 16:07:28 +02004698 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenkbf2f8c92003-05-22 22:52:13 +00004699
Dirk Eibach378d1ca2009-02-09 08:18:34 +01004700- CONFIG_PCI_DISABLE_PCIE:
4701 Disable PCI-Express on systems where it is supported but not
4702 required.
4703
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004704- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08004705 Only scan through and get the devices on the buses.
Andrew Sharp61d47ca2012-08-29 14:16:32 +00004706 Don't do any setup work, presumably because someone or
4707 something has already done it, and we don't need to do it
4708 a second time. Useful for platforms that are pre-booted
4709 by coreboot or similar.
4710
Gabor Juhosb4458732013-05-30 07:06:12 +00004711- CONFIG_PCI_INDIRECT_BRIDGE:
4712 Enable support for indirect PCI bridges.
4713
Kumar Gala8975d7a2010-12-30 12:09:53 -06004714- CONFIG_SYS_SRIO:
4715 Chip has SRIO or not
4716
4717- CONFIG_SRIO1:
4718 Board has SRIO 1 port available
4719
4720- CONFIG_SRIO2:
4721 Board has SRIO 2 port available
4722
Liu Gang27afb9c2013-05-07 16:30:46 +08004723- CONFIG_SRIO_PCIE_BOOT_MASTER
4724 Board can support master function for Boot from SRIO and PCIE
4725
Kumar Gala8975d7a2010-12-30 12:09:53 -06004726- CONFIG_SYS_SRIOn_MEM_VIRT:
4727 Virtual Address of SRIO port 'n' memory region
4728
4729- CONFIG_SYS_SRIOn_MEM_PHYS:
4730 Physical Address of SRIO port 'n' memory region
4731
4732- CONFIG_SYS_SRIOn_MEM_SIZE:
4733 Size of SRIO port 'n' memory region
4734
Fabio Estevamf17e8782013-04-11 09:35:34 +00004735- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4736 Defined to tell the NAND controller that the NAND chip is using
4737 a 16 bit bus.
4738 Not all NAND drivers use this symbol.
Fabio Estevam417052b2013-04-11 09:35:35 +00004739 Example of drivers that use it:
Fabio Estevamf17e8782013-04-11 09:35:34 +00004740 - drivers/mtd/nand/ndfc.c
Fabio Estevam417052b2013-04-11 09:35:35 +00004741 - drivers/mtd/nand/mxc_nand.c
Alex Watermancd6aae32011-05-19 15:08:36 -04004742
4743- CONFIG_SYS_NDFC_EBC0_CFG
4744 Sets the EBC0_CFG register for the NDFC. If not defined
4745 a default value will be used.
4746
Ben Warren45657152006-09-07 16:50:54 -04004747- CONFIG_SPD_EEPROM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004748 Get DDR timing information from an I2C EEPROM. Common
4749 with pluggable memory modules such as SODIMMs
4750
Ben Warren45657152006-09-07 16:50:54 -04004751 SPD_EEPROM_ADDRESS
4752 I2C address of the SPD EEPROM
4753
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004754- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004755 If SPD EEPROM is on an I2C bus other than the first
4756 one, specify here. Note that the value must resolve
4757 to something your driver can deal with.
Ben Warren45657152006-09-07 16:50:54 -04004758
York Sune73cc042011-06-07 09:42:16 +08004759- CONFIG_SYS_DDR_RAW_TIMING
4760 Get DDR timing information from other than SPD. Common with
4761 soldered DDR chips onboard without SPD. DDR raw timing
4762 parameters are extracted from datasheet and hard-coded into
4763 header files or board specific files.
4764
York Sunbd495cf2011-09-16 13:21:35 -07004765- CONFIG_FSL_DDR_INTERACTIVE
4766 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4767
York Sun8ced0502015-01-06 13:18:55 -08004768- CONFIG_FSL_DDR_SYNC_REFRESH
4769 Enable sync of refresh for multiple controllers.
4770
York Sunb6a35f82015-03-19 09:30:28 -07004771- CONFIG_FSL_DDR_BIST
4772 Enable built-in memory test for Freescale DDR controllers.
4773
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02004774- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004775 Only for 83xx systems. If specified, then DDR should
4776 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi054838e2006-10-31 18:44:42 -06004777
wdenk6203e402004-04-18 10:13:26 +00004778- CONFIG_ETHER_ON_FEC[12]
4779 Define to enable FEC[12] on a 8xx series processor.
4780
4781- CONFIG_FEC[12]_PHY
4782 Define to the hardcoded PHY address which corresponds
wdenk05939202004-04-18 17:39:38 +00004783 to the given FEC; i. e.
4784 #define CONFIG_FEC1_PHY 4
wdenk6203e402004-04-18 10:13:26 +00004785 means that the PHY with address 4 is connected to FEC1
4786
4787 When set to -1, means to probe for first available.
4788
4789- CONFIG_FEC[12]_PHY_NORXERR
4790 The PHY does not have a RXERR line (RMII only).
4791 (so program the FEC to ignore it).
4792
4793- CONFIG_RMII
4794 Enable RMII mode for all FECs.
4795 Note that this is a global option, we can't
4796 have one FEC in standard MII mode and another in RMII mode.
4797
wdenk20c98a62004-04-23 20:32:05 +00004798- CONFIG_CRC32_VERIFY
4799 Add a verify option to the crc32 command.
4800 The syntax is:
4801
4802 => crc32 -v <address> <count> <crc32>
4803
4804 Where address/count indicate a memory area
4805 and crc32 is the correct crc32 which the
4806 area should have.
4807
wdenk64519362004-07-11 17:40:54 +00004808- CONFIG_LOOPW
4809 Add the "loopw" memory command. This only takes effect if
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004810 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk64519362004-07-11 17:40:54 +00004811
stroesecc3af832004-12-16 18:46:55 +00004812- CONFIG_MX_CYCLIC
4813 Add the "mdc" and "mwc" memory commands. These are cyclic
4814 "md/mw" commands.
4815 Examples:
4816
wdenk07d7e6b2004-12-16 21:44:03 +00004817 => mdc.b 10 4 500
stroesecc3af832004-12-16 18:46:55 +00004818 This command will print 4 bytes (10,11,12,13) each 500 ms.
4819
wdenk07d7e6b2004-12-16 21:44:03 +00004820 => mwc.l 100 12345678 10
stroesecc3af832004-12-16 18:46:55 +00004821 This command will write 12345678 to address 100 all 10 ms.
4822
wdenk07d7e6b2004-12-16 21:44:03 +00004823 This only takes effect if the memory commands are activated
Jon Loeligerc1da5c92007-06-11 19:03:39 -05004824 globally (CONFIG_CMD_MEM).
stroesecc3af832004-12-16 18:46:55 +00004825
wdenk3d3d99f2005-04-04 12:44:11 +00004826- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Lin1cac36e2011-10-19 20:41:11 +00004827 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk302141d2010-11-27 23:30:56 +01004828 low level initializations (like setting up the memory
4829 controller) are omitted and/or U-Boot does not
4830 relocate itself into RAM.
wdenk3d3d99f2005-04-04 12:44:11 +00004831
Wolfgang Denk302141d2010-11-27 23:30:56 +01004832 Normally this variable MUST NOT be defined. The only
4833 exception is when U-Boot is loaded (to RAM) by some
4834 other boot loader or by a debugger which performs
4835 these initializations itself.
wdenk3d3d99f2005-04-04 12:44:11 +00004836
Aneesh V552a3192011-07-13 05:11:07 +00004837- CONFIG_SPL_BUILD
Magnus Lilja1ec96d82009-06-13 20:50:00 +02004838 Modifies the behaviour of start.S when compiling a loader
4839 that is executed before the actual U-Boot. E.g. when
4840 compiling a NAND SPL.
wdenk336b2bc2005-04-02 23:52:25 +00004841
Ying Zhang2d2e3b62013-08-16 15:16:15 +08004842- CONFIG_TPL_BUILD
4843 Modifies the behaviour of start.S when compiling a loader
4844 that is executed after the SPL and before the actual U-Boot.
4845 It is loaded by the SPL.
4846
Ying Zhang0d4f5442013-05-20 14:07:23 +08004847- CONFIG_SYS_MPC85XX_NO_RESETVEC
4848 Only for 85xx systems. If this variable is specified, the section
4849 .resetvec is not kept and the section .bootpg is placed in the
4850 previous 4k of the .text section.
4851
Simon Glass17dabf02013-02-24 17:33:14 +00004852- CONFIG_ARCH_MAP_SYSMEM
4853 Generally U-Boot (and in particular the md command) uses
4854 effective address. It is therefore not necessary to regard
4855 U-Boot address as virtual addresses that need to be translated
4856 to physical addresses. However, sandbox requires this, since
4857 it maintains its own little RAM buffer which contains all
4858 addressable memory. This option causes some memory accesses
4859 to be mapped through map_sysmem() / unmap_sysmem().
4860
Matthias Weisser93416c12011-03-10 21:36:32 +00004861- CONFIG_USE_ARCH_MEMCPY
4862 CONFIG_USE_ARCH_MEMSET
4863 If these options are used a optimized version of memcpy/memset will
4864 be used if available. These functions may be faster under some
4865 conditions but may increase the binary size.
4866
Simon Glassbfb59802013-02-14 04:18:54 +00004867- CONFIG_X86_RESET_VECTOR
4868 If defined, the x86 reset vector code is included. This is not
4869 needed when U-Boot is running from Coreboot.
Gabe Black14f82462012-11-27 21:08:06 +00004870
Mark Jackson52b003c2013-03-04 01:27:20 +00004871- CONFIG_SYS_MPUCLK
4872 Defines the MPU clock speed (in MHz).
4873
4874 NOTE : currently only supported on AM335x platforms.
Gabe Black76ce2492012-11-29 16:23:41 +00004875
Heiko Schocher2233e462013-11-04 14:05:00 +01004876- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4877 Enables the RTC32K OSC on AM33xx based plattforms
4878
Karicheri, Muralidharanc1dc61b2014-04-04 13:16:50 -04004879- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4880 Option to disable subpage write in NAND driver
4881 driver that uses this:
4882 drivers/mtd/nand/davinci_nand.c
4883
Timur Tabi275f4bb2011-11-22 09:21:25 -06004884Freescale QE/FMAN Firmware Support:
4885-----------------------------------
4886
4887The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4888loading of "firmware", which is encoded in the QE firmware binary format.
4889This firmware often needs to be loaded during U-Boot booting, so macros
4890are used to identify the storage device (NOR flash, SPI, etc) and the address
4891within that device.
4892
Zhao Qiang83a90842014-03-21 16:21:44 +08004893- CONFIG_SYS_FMAN_FW_ADDR
4894 The address in the storage device where the FMAN microcode is located. The
4895 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4896 is also specified.
4897
4898- CONFIG_SYS_QE_FW_ADDR
4899 The address in the storage device where the QE microcode is located. The
Timur Tabi275f4bb2011-11-22 09:21:25 -06004900 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4901 is also specified.
4902
4903- CONFIG_SYS_QE_FMAN_FW_LENGTH
4904 The maximum possible size of the firmware. The firmware binary format
4905 has a field that specifies the actual size of the firmware, but it
4906 might not be possible to read any part of the firmware unless some
4907 local storage is allocated to hold the entire firmware first.
4908
4909- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4910 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4911 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4912 virtual address in NOR flash.
4913
4914- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4915 Specifies that QE/FMAN firmware is located in NAND flash.
4916 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4917
4918- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4919 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4920 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4921
4922- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4923 Specifies that QE/FMAN firmware is located on the primary SPI
4924 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4925
Liu Gang1e084582012-03-08 00:33:18 +00004926- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4927 Specifies that QE/FMAN firmware is located in the remote (master)
4928 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gang357bf5a2012-08-09 05:10:01 +00004929 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4930 window->master inbound window->master LAW->the ucode address in
4931 master's memory space.
Timur Tabi275f4bb2011-11-22 09:21:25 -06004932
J. German Rivera8ff14b72014-06-23 15:15:55 -07004933Freescale Layerscape Management Complex Firmware Support:
4934---------------------------------------------------------
4935The Freescale Layerscape Management Complex (MC) supports the loading of
4936"firmware".
4937This firmware often needs to be loaded during U-Boot booting, so macros
4938are used to identify the storage device (NOR flash, SPI, etc) and the address
4939within that device.
4940
4941- CONFIG_FSL_MC_ENET
4942 Enable the MC driver for Layerscape SoCs.
4943
4944- CONFIG_SYS_LS_MC_FW_ADDR
4945 The address in the storage device where the firmware is located. The
4946 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4947 is also specified.
4948
4949- CONFIG_SYS_LS_MC_FW_LENGTH
4950 The maximum possible size of the firmware. The firmware binary format
4951 has a field that specifies the actual size of the firmware, but it
4952 might not be possible to read any part of the firmware unless some
4953 local storage is allocated to hold the entire firmware first.
4954
4955- CONFIG_SYS_LS_MC_FW_IN_NOR
4956 Specifies that MC firmware is located in NOR flash, mapped as
4957 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4958 virtual address in NOR flash.
4959
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304960Freescale Layerscape Debug Server Support:
4961-------------------------------------------
4962The Freescale Layerscape Debug Server Support supports the loading of
4963"Debug Server firmware" and triggering SP boot-rom.
4964This firmware often needs to be loaded during U-Boot booting.
4965
4966- CONFIG_FSL_DEBUG_SERVER
4967 Enable the Debug Server for Layerscape SoCs.
4968
4969- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
4970 Define minimum DDR size required for debug server image
4971
York Sun928b6812015-12-07 11:08:58 -08004972- CONFIG_SYS_MC_RSV_MEM_ALIGN
4973 Define alignment of reserved memory MC requires
Prabhakar Kushwaha853a9012015-06-02 10:55:52 +05304974
Paul Kocialkowski7b917022015-07-26 18:48:15 +02004975Reproducible builds
4976-------------------
4977
4978In order to achieve reproducible builds, timestamps used in the U-Boot build
4979process have to be set to a fixed value.
4980
4981This is done using the SOURCE_DATE_EPOCH environment variable.
4982SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4983option for U-Boot or an environment variable in U-Boot.
4984
4985SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4986
wdenkc6097192002-11-03 00:24:07 +00004987Building the Software:
4988======================
4989
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004990Building U-Boot has been tested in several native build environments
4991and in many different cross environments. Of course we cannot support
4992all possibly existing versions of cross development tools in all
4993(potentially obsolete) versions. In case of tool chain problems we
4994recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4995which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004996
Wolfgang Denkb240aef2008-03-26 10:40:12 +01004997If you are not using a native environment, it is assumed that you
4998have GNU cross compiling tools available in your path. In this case,
4999you must set the environment variable CROSS_COMPILE in your shell.
5000Note that no changes to the Makefile or any other source files are
5001necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005002
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005003 $ CROSS_COMPILE=ppc_4xx-
5004 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005005
Peter Tyserb06976d2009-03-13 18:54:51 -05005006Note: If you wish to generate Windows versions of the utilities in
5007 the tools directory you can use the MinGW toolchain
5008 (http://www.mingw.org). Set your HOST tools to the MinGW
5009 toolchain and execute 'make tools'. For example:
5010
5011 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5012
5013 Binaries such as tools/mkimage.exe will be created which can
5014 be executed on computers running Windows.
5015
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005016U-Boot is intended to be simple to build. After installing the
5017sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005018is done by typing:
5019
Holger Freyther7ba4e572014-08-04 09:26:05 +02005020 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005021
Holger Freyther7ba4e572014-08-04 09:26:05 +02005022where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones5a7fb6f2012-03-15 22:48:10 +00005023rations; see boards.cfg for supported names.
wdenk2f0812d2003-10-08 22:45:44 +00005024
wdenk6c59edc2004-05-03 20:45:30 +00005025Note: for some board special configuration names may exist; check if
5026 additional information is available from the board vendor; for
5027 instance, the TQM823L systems are available without (standard)
5028 or with LCD support. You can select such additional "features"
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005029 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005030
Holger Freyther7ba4e572014-08-04 09:26:05 +02005031 make TQM823L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005032 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005033
Holger Freyther7ba4e572014-08-04 09:26:05 +02005034 make TQM823L_LCD_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005035 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005036
wdenk6c59edc2004-05-03 20:45:30 +00005037 etc.
wdenkc6097192002-11-03 00:24:07 +00005038
wdenkc6097192002-11-03 00:24:07 +00005039
wdenk6c59edc2004-05-03 20:45:30 +00005040Finally, type "make all", and you should get some working U-Boot
5041images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005042
wdenk6c59edc2004-05-03 20:45:30 +00005043- "u-boot.bin" is a raw binary image
5044- "u-boot" is an image in ELF binary format
5045- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005046
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005047By default the build is performed locally and the objects are saved
5048in the source directory. One of the two methods can be used to change
5049this behavior and build U-Boot to some external directory:
5050
50511. Add O= to the make command line invocations:
5052
5053 make O=/tmp/build distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005054 make O=/tmp/build NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005055 make O=/tmp/build all
5056
Timo Ketolac8c67602014-11-06 14:39:05 +020050572. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005058
Timo Ketolac8c67602014-11-06 14:39:05 +02005059 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005060 make distclean
Holger Freyther7ba4e572014-08-04 09:26:05 +02005061 make NAME_defconfig
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005062 make all
5063
Timo Ketolac8c67602014-11-06 14:39:05 +02005064Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005065variable.
5066
wdenkc6097192002-11-03 00:24:07 +00005067
wdenk6c59edc2004-05-03 20:45:30 +00005068Please be aware that the Makefiles assume you are using GNU make, so
5069for instance on NetBSD you might need to use "gmake" instead of
5070native "make".
wdenkc6097192002-11-03 00:24:07 +00005071
wdenkc6097192002-11-03 00:24:07 +00005072
wdenk6c59edc2004-05-03 20:45:30 +00005073If the system board that you have is not listed, then you will need
5074to port U-Boot to your hardware platform. To do this, follow these
5075steps:
wdenkc6097192002-11-03 00:24:07 +00005076
Phil Sutterc77b4882015-12-25 14:41:18 +010050771. Create a new directory to hold your board specific code. Add any
wdenk6c59edc2004-05-03 20:45:30 +00005078 files you need. In your board directory, you will need at least
Phil Sutterc77b4882015-12-25 14:41:18 +01005079 the "Makefile" and a "<board>.c".
50802. Create a new configuration file "include/configs/<board>.h" for
5081 your board.
wdenk6c59edc2004-05-03 20:45:30 +000050823. If you're porting U-Boot to a new CPU, then also create a new
5083 directory to hold your CPU specific code. Add any files you need.
Holger Freyther7ba4e572014-08-04 09:26:05 +020050844. Run "make <board>_defconfig" with your new name.
wdenk6c59edc2004-05-03 20:45:30 +000050855. Type "make", and you should get a working "u-boot.srec" file
5086 to be installed on your target system.
50876. Debug and solve any problems that might arise.
5088 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005089
wdenkc6097192002-11-03 00:24:07 +00005090
wdenk6c59edc2004-05-03 20:45:30 +00005091Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5092==============================================================
wdenkc6097192002-11-03 00:24:07 +00005093
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005094If you have modified U-Boot sources (for instance added a new board
5095or support for new devices, a new CPU, etc.) you are expected to
wdenk6c59edc2004-05-03 20:45:30 +00005096provide feedback to the other developers. The feedback normally takes
5097the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005098official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005099
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005100But before you submit such a patch, please verify that your modifi-
5101cation did not break existing code. At least make sure that *ALL* of
wdenk6c59edc2004-05-03 20:45:30 +00005102the supported boards compile WITHOUT ANY compiler warnings. To do so,
5103just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005104for ALL supported system. Be warned, this will take a while. You can
5105select which (cross) compiler to use by passing a `CROSS_COMPILE'
5106environment variable to the script, i. e. to use the ELDK cross tools
5107you can type
wdenkc6097192002-11-03 00:24:07 +00005108
wdenk6c59edc2004-05-03 20:45:30 +00005109 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005110
wdenk6c59edc2004-05-03 20:45:30 +00005111or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk6c59edc2004-05-03 20:45:30 +00005113 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005114
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005115When using the MAKEALL script, the default behaviour is to build
5116U-Boot in the source directory. This location can be changed by
5117setting the BUILD_DIR environment variable. Also, for each target
5118built, the MAKEALL script saves two log files (<target>.ERR and
5119<target>.MAKEALL) in the <source dir>/LOG directory. This default
5120location can be changed by setting the MAKEALL_LOGDIR environment
5121variable. For example:
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005122
5123 export BUILD_DIR=/tmp/build
5124 export MAKEALL_LOGDIR=/tmp/log
5125 CROSS_COMPILE=ppc_8xx- MAKEALL
5126
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005127With the above settings build objects are saved in the /tmp/build,
5128log files are saved in the /tmp/log and the source tree remains clean
5129during the whole build process.
Marian Balakowiczefe063f2006-09-07 17:25:40 +02005130
5131
wdenk6c59edc2004-05-03 20:45:30 +00005132See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005133
wdenkc6097192002-11-03 00:24:07 +00005134
wdenk6c59edc2004-05-03 20:45:30 +00005135Monitor Commands - Overview:
5136============================
wdenkc6097192002-11-03 00:24:07 +00005137
wdenk6c59edc2004-05-03 20:45:30 +00005138go - start application at address 'addr'
5139run - run commands in an environment variable
5140bootm - boot application image from memory
5141bootp - boot image via network using BootP/TFTP protocol
Marek Vasutcf41a9b2012-03-14 21:52:45 +00005142bootz - boot zImage from memory
wdenk6c59edc2004-05-03 20:45:30 +00005143tftpboot- boot image via network using TFTP protocol
5144 and env variables "ipaddr" and "serverip"
5145 (and eventually "gatewayip")
Simon Glass6a398d22011-10-24 18:00:07 +00005146tftpput - upload a file via network using TFTP protocol
wdenk6c59edc2004-05-03 20:45:30 +00005147rarpboot- boot image via network using RARP/TFTP protocol
5148diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5149loads - load S-Record file over serial line
5150loadb - load binary file over serial line (kermit mode)
5151md - memory display
5152mm - memory modify (auto-incrementing)
5153nm - memory modify (constant address)
5154mw - memory write (fill)
5155cp - memory copy
5156cmp - memory compare
5157crc32 - checksum calculation
Peter Tyser469cde42009-04-18 22:34:03 -05005158i2c - I2C sub-system
wdenk6c59edc2004-05-03 20:45:30 +00005159sspi - SPI utility commands
5160base - print or set address offset
5161printenv- print environment variables
5162setenv - set environment variables
5163saveenv - save environment variables to persistent storage
5164protect - enable or disable FLASH write protection
5165erase - erase FLASH memory
5166flinfo - print FLASH memory information
Karl O. Pinc4baf03d2012-08-03 05:57:21 +00005167nand - NAND memory operations (see doc/README.nand)
wdenk6c59edc2004-05-03 20:45:30 +00005168bdinfo - print Board Info structure
5169iminfo - print header information for application image
5170coninfo - print console devices and informations
5171ide - IDE sub-system
5172loop - infinite loop on address range
wdenk64519362004-07-11 17:40:54 +00005173loopw - infinite write loop on address range
wdenk6c59edc2004-05-03 20:45:30 +00005174mtest - simple RAM test
5175icache - enable or disable instruction cache
5176dcache - enable or disable data cache
5177reset - Perform RESET of the CPU
5178echo - echo args to console
5179version - print monitor version
5180help - print online help
5181? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005182
wdenkc6097192002-11-03 00:24:07 +00005183
wdenk6c59edc2004-05-03 20:45:30 +00005184Monitor Commands - Detailed Description:
5185========================================
wdenkc6097192002-11-03 00:24:07 +00005186
wdenk6c59edc2004-05-03 20:45:30 +00005187TODO.
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk6c59edc2004-05-03 20:45:30 +00005189For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005190
5191
wdenk6c59edc2004-05-03 20:45:30 +00005192Environment Variables:
5193======================
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk6c59edc2004-05-03 20:45:30 +00005195U-Boot supports user configuration using Environment Variables which
5196can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk6c59edc2004-05-03 20:45:30 +00005198Environment Variables are set using "setenv", printed using
5199"printenv", and saved to Flash using "saveenv". Using "setenv"
5200without a value can be used to delete a variable from the
5201environment. As long as you don't save the environment you are
5202working with an in-memory copy. In case the Flash area containing the
5203environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005204
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005205Some configuration options can be set using Environment Variables.
5206
5207List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005208
wdenk6c59edc2004-05-03 20:45:30 +00005209 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005210
wdenk6c59edc2004-05-03 20:45:30 +00005211 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005212
wdenk6c59edc2004-05-03 20:45:30 +00005213 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005214
wdenk6c59edc2004-05-03 20:45:30 +00005215 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005216
wdenk6c59edc2004-05-03 20:45:30 +00005217 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005218
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005219 bootm_low - Memory range available for image processing in the bootm
5220 command can be restricted. This variable is given as
5221 a hexadecimal number and defines lowest address allowed
5222 for use by the bootm command. See also "bootm_size"
5223 environment variable. Address defined by "bootm_low" is
5224 also the base of the initial memory mapping for the Linux
Grant Likely26396382011-03-28 09:58:43 +00005225 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5226 bootm_mapsize.
5227
Wolfgang Denk092ae952011-10-26 10:21:21 +00005228 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likely26396382011-03-28 09:58:43 +00005229 This variable is given as a hexadecimal number and it
5230 defines the size of the memory region starting at base
5231 address bootm_low that is accessible by the Linux kernel
5232 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5233 as the default value if it is defined, and bootm_size is
5234 used otherwise.
Bartlomiej Siekac5648c82008-04-14 15:44:16 +02005235
5236 bootm_size - Memory range available for image processing in the bootm
5237 command can be restricted. This variable is given as
5238 a hexadecimal number and defines the size of the region
5239 allowed for use by the bootm command. See also "bootm_low"
5240 environment variable.
5241
Bartlomiej Siekae273e9f2008-10-01 15:26:31 +02005242 updatefile - Location of the software update file on a TFTP server, used
5243 by the automatic software update feature. Please refer to
5244 documentation in doc/README.update for more details.
5245
wdenk6c59edc2004-05-03 20:45:30 +00005246 autoload - if set to "no" (any string beginning with 'n'),
5247 "bootp" will just load perform a lookup of the
5248 configuration from the BOOTP server, but not try to
5249 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005250
wdenk6c59edc2004-05-03 20:45:30 +00005251 autostart - if set to "yes", an image loaded using the "bootp",
5252 "rarpboot", "tftpboot" or "diskboot" commands will
5253 be automatically started (by internally calling
5254 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005255
wdenk6c59edc2004-05-03 20:45:30 +00005256 If set to "no", a standalone image passed to the
5257 "bootm" command will be copied to the load address
5258 (and eventually uncompressed), but NOT be started.
5259 This can be used to load and uncompress arbitrary
5260 data.
wdenkc6097192002-11-03 00:24:07 +00005261
David A. Longd558a4e2011-07-09 16:40:19 -04005262 fdt_high - if set this restricts the maximum address that the
5263 flattened device tree will be copied into upon boot.
Shawn Guo0ca9e982012-01-09 21:54:08 +00005264 For example, if you have a system with 1 GB memory
5265 at physical address 0x10000000, while Linux kernel
5266 only recognizes the first 704 MB as low memory, you
5267 may need to set fdt_high as 0x3C000000 to have the
5268 device tree blob be copied to the maximum address
5269 of the 704 MB low memory, so that Linux kernel can
5270 access it during the boot procedure.
5271
David A. Longd558a4e2011-07-09 16:40:19 -04005272 If this is set to the special value 0xFFFFFFFF then
5273 the fdt will not be copied at all on boot. For this
5274 to work it must reside in writable memory, have
5275 sufficient padding on the end of it for u-boot to
5276 add the information it needs into it, and the memory
5277 must be accessible by the kernel.
5278
Simon Glassdc6fa642011-10-24 19:15:34 +00005279 fdtcontroladdr- if set this is the address of the control flattened
5280 device tree used by U-Boot when CONFIG_OF_CONTROL is
5281 defined.
5282
wdenk0e2bd9c2004-06-06 21:51:03 +00005283 i2cfast - (PPC405GP|PPC405EP only)
5284 if set to 'y' configures Linux I2C driver for fast
5285 mode (400kHZ). This environment variable is used in
5286 initialization code. So, for changes to be effective
5287 it must be saved and board must be reset.
5288
wdenk6c59edc2004-05-03 20:45:30 +00005289 initrd_high - restrict positioning of initrd images:
5290 If this variable is not set, initrd images will be
5291 copied to the highest possible address in RAM; this
5292 is usually what you want since it allows for
5293 maximum initrd size. If for some reason you want to
5294 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005295 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk6c59edc2004-05-03 20:45:30 +00005296 variable to a value of "no" or "off" or "0".
5297 Alternatively, you can set it to a maximum upper
5298 address to use (U-Boot will still check that it
5299 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005300
wdenk6c59edc2004-05-03 20:45:30 +00005301 For instance, when you have a system with 16 MB
5302 RAM, and want to reserve 4 MB from use by Linux,
5303 you can do this by adding "mem=12M" to the value of
5304 the "bootargs" variable. However, now you must make
5305 sure that the initrd image is placed in the first
5306 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk6c59edc2004-05-03 20:45:30 +00005308 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005309
wdenk6c59edc2004-05-03 20:45:30 +00005310 If you set initrd_high to 0xFFFFFFFF, this is an
5311 indication to U-Boot that all addresses are legal
5312 for the Linux kernel, including addresses in flash
5313 memory. In this case U-Boot will NOT COPY the
5314 ramdisk at all. This may be useful to reduce the
5315 boot time on your system, but requires that this
5316 feature is supported by your Linux kernel.
wdenk3f9ab982003-04-12 23:38:12 +00005317
wdenk6c59edc2004-05-03 20:45:30 +00005318 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005319
wdenk6c59edc2004-05-03 20:45:30 +00005320 loadaddr - Default load address for commands like "bootp",
5321 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005322
wdenk6c59edc2004-05-03 20:45:30 +00005323 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005324
wdenk6c59edc2004-05-03 20:45:30 +00005325 serverip - TFTP server IP address; needed for tftpboot command
wdenk6f770ed2003-05-23 23:18:21 +00005326
wdenk6c59edc2004-05-03 20:45:30 +00005327 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005328
wdenk6c59edc2004-05-03 20:45:30 +00005329 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005330
wdenk6c59edc2004-05-03 20:45:30 +00005331 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005332
Mike Frysingera23230c2011-10-02 10:01:27 +00005333 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005334
Mike Frysingera23230c2011-10-02 10:01:27 +00005335 ethact - controls which interface is currently active.
5336 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005337
Heiko Schocherc5e84052010-07-20 17:45:02 +02005338 => setenv ethact FEC
5339 => ping 192.168.0.1 # traffic sent on FEC
5340 => setenv ethact SCC
5341 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005342
Matthias Fuchs204f0ec2008-01-17 07:45:05 +01005343 ethrotate - When set to "no" U-Boot does not go through all
5344 available network interfaces.
5345 It just stays at the currently selected interface.
5346
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005347 netretry - When set to "no" each network operation will
wdenk6c59edc2004-05-03 20:45:30 +00005348 either succeed or fail without retrying.
5349 When set to "once" the network operation will
5350 fail when all the available network interfaces
5351 are tried once without success.
5352 Useful on scripts which control the retry operation
5353 themselves.
wdenkc6097192002-11-03 00:24:07 +00005354
Jean-Christophe PLAGNIOL-VILLARD1948d6c2009-01-31 09:53:39 +01005355 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDd2164ef2008-01-07 08:41:34 +01005356
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005357 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass5db3f932013-07-16 20:10:00 -07005358 changing the console to be empty. If "yes" it will be
5359 made silent. If "no" it will not be made silent. If
5360 unset, then it will be made silent if the U-Boot console
5361 is silent.
5362
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005363 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denke3cfce52005-09-24 22:37:32 +02005364 UDP source port.
5365
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005366 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk227b5192005-09-24 23:25:46 +02005367 destination port instead of the Well Know Port 69.
5368
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005369 tftpblocksize - Block size to use for TFTP transfers; if not set,
5370 we use the TFTP server's default block size
5371
5372 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5373 seconds, minimum value is 1000 = 1 second). Defines
5374 when a packet is considered to be lost so it has to
5375 be retransmitted. The default is 5000 = 5 seconds.
5376 Lowering this value may make downloads succeed
5377 faster in networks with high packet loss rates or
5378 with unreliable TFTP servers.
5379
Albert ARIBAUD \(3ADEV\)83006852015-10-12 00:02:57 +02005380 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5381 unit, minimum value = 0). Defines how many timeouts
5382 can happen during a single file transfer before that
5383 transfer is aborted. The default is 10, and 0 means
5384 'no timeouts allowed'. Increasing this value may help
5385 downloads succeed with high packet loss rates, or with
5386 unreliable TFTP servers or client hardware.
5387
Wolfgang Denkb233bd72010-01-17 23:55:53 +01005388 vlan - When set to a value < 4095 the traffic over
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005389 Ethernet is encapsulated/received over 802.1q
wdenk6c59edc2004-05-03 20:45:30 +00005390 VLAN tagged frames.
wdenk145d2c12004-04-15 21:48:45 +00005391
Alexandre Messier15971322016-02-01 17:08:57 -05005392 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5393 Unsigned value, in milliseconds. If not set, the period will
5394 be either the default (28000), or a value based on
5395 CONFIG_NET_RETRY_COUNT, if defined. This value has
5396 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5397
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005398The following image location variables contain the location of images
5399used in booting. The "Image" column gives the role of the image and is
5400not an environment variable name. The other columns are environment
5401variable names. "File Name" gives the name of the file on a TFTP
5402server, "RAM Address" gives the location in RAM the image will be
5403loaded to, and "Flash Location" gives the image's address in NOR
5404flash or offset in NAND flash.
5405
5406*Note* - these variables don't have to be defined for all boards, some
Fabio Estevambb7d4972015-04-25 18:53:10 -03005407boards currently use other variables for these purposes, and some
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005408boards use these variables for other purposes.
5409
Wolfgang Denk092ae952011-10-26 10:21:21 +00005410Image File Name RAM Address Flash Location
5411----- --------- ----------- --------------
5412u-boot u-boot u-boot_addr_r u-boot_addr
5413Linux kernel bootfile kernel_addr_r kernel_addr
5414device tree blob fdtfile fdt_addr_r fdt_addr
5415ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbse3fe08e2011-08-31 05:37:28 +00005416
wdenk6c59edc2004-05-03 20:45:30 +00005417The following environment variables may be used and automatically
5418updated by the network boot commands ("bootp" and "rarpboot"),
5419depending the information provided by your boot server:
wdenk145d2c12004-04-15 21:48:45 +00005420
wdenk6c59edc2004-05-03 20:45:30 +00005421 bootfile - see above
5422 dnsip - IP address of your Domain Name Server
5423 dnsip2 - IP address of your secondary Domain Name Server
5424 gatewayip - IP address of the Gateway (Router) to use
5425 hostname - Target hostname
5426 ipaddr - see above
5427 netmask - Subnet Mask
5428 rootpath - Pathname of the root filesystem on the NFS server
5429 serverip - see above
wdenk145d2c12004-04-15 21:48:45 +00005430
wdenk145d2c12004-04-15 21:48:45 +00005431
wdenk6c59edc2004-05-03 20:45:30 +00005432There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005433
wdenk6c59edc2004-05-03 20:45:30 +00005434 serial# - contains hardware identification information such
5435 as type string and/or serial number
5436 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005437
wdenk6c59edc2004-05-03 20:45:30 +00005438These variables can be set only once (usually during manufacturing of
5439the board). U-Boot refuses to delete or overwrite these variables
5440once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005441
5442
wdenk6c59edc2004-05-03 20:45:30 +00005443Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005444
wdenk6c59edc2004-05-03 20:45:30 +00005445 ver - Contains the U-Boot version string as printed
5446 with the "version" command. This variable is
5447 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005448
wdenkc6097192002-11-03 00:24:07 +00005449
wdenk6c59edc2004-05-03 20:45:30 +00005450Please note that changes to some configuration parameters may take
5451only effect after the next boot (yes, that's just like Windoze :-).
stroeseb9c17c52003-04-04 15:53:41 +00005452
stroeseb9c17c52003-04-04 15:53:41 +00005453
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005454Callback functions for environment variables:
5455---------------------------------------------
5456
5457For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005458when their values are changed. This functionality allows functions to
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005459be associated with arbitrary variables. On creation, overwrite, or
5460deletion, the callback will provide the opportunity for some side
5461effect to happen or for the change to be rejected.
5462
5463The callbacks are named and associated with a function using the
5464U_BOOT_ENV_CALLBACK macro in your board or driver code.
5465
5466These callbacks are associated with variables in one of two ways. The
5467static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5468in the board configuration to a string that defines a list of
5469associations. The list must be in the following format:
5470
5471 entry = variable_name[:callback_name]
5472 list = entry[,list]
5473
5474If the callback name is not specified, then the callback is deleted.
5475Spaces are also allowed anywhere in the list.
5476
5477Callbacks can also be associated by defining the ".callbacks" variable
5478with the same list format above. Any association in ".callbacks" will
5479override any association in the static list. You can define
5480CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08005481".callbacks" environment variable in the default or embedded environment.
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005482
Joe Hershberger6db9fd42015-05-20 14:27:20 -05005483If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5484regular expression. This allows multiple variables to be connected to
5485the same callback without explicitly listing them all out.
5486
Joe Hershberger60fd3ad2012-12-11 22:16:24 -06005487
wdenk6c59edc2004-05-03 20:45:30 +00005488Command Line Parsing:
5489=====================
stroeseb9c17c52003-04-04 15:53:41 +00005490
wdenk6c59edc2004-05-03 20:45:30 +00005491There are two different command line parsers available with U-Boot:
5492the old "simple" one, and the much more powerful "hush" shell:
wdenkc6097192002-11-03 00:24:07 +00005493
wdenk6c59edc2004-05-03 20:45:30 +00005494Old, simple command line parser:
5495--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005496
wdenk6c59edc2004-05-03 20:45:30 +00005497- supports environment variables (through setenv / saveenv commands)
5498- several commands on one line, separated by ';'
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005499- variable substitution using "... ${name} ..." syntax
wdenk6c59edc2004-05-03 20:45:30 +00005500- special characters ('$', ';') can be escaped by prefixing with '\',
5501 for example:
Wolfgang Denk86eb3b72005-11-20 21:40:11 +01005502 setenv bootcmd bootm \${address}
wdenk6c59edc2004-05-03 20:45:30 +00005503- You can also escape text by enclosing in single apostrophes, for example:
5504 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005505
wdenk6c59edc2004-05-03 20:45:30 +00005506Hush shell:
5507-----------
wdenkf4688a22003-05-28 08:06:31 +00005508
wdenk6c59edc2004-05-03 20:45:30 +00005509- similar to Bourne shell, with control structures like
5510 if...then...else...fi, for...do...done; while...do...done,
5511 until...do...done, ...
5512- supports environment ("global") variables (through setenv / saveenv
5513 commands) and local shell variables (through standard shell syntax
5514 "name=value"); only environment variables can be used with "run"
5515 command
wdenkf4688a22003-05-28 08:06:31 +00005516
wdenk6c59edc2004-05-03 20:45:30 +00005517General rules:
5518--------------
wdenkf4688a22003-05-28 08:06:31 +00005519
wdenk6c59edc2004-05-03 20:45:30 +00005520(1) If a command line (or an environment variable executed by a "run"
5521 command) contains several commands separated by semicolon, and
5522 one of these commands fails, then the remaining commands will be
5523 executed anyway.
wdenkf4688a22003-05-28 08:06:31 +00005524
wdenk6c59edc2004-05-03 20:45:30 +00005525(2) If you execute several variables with one call to run (i. e.
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005526 calling run with a list of variables as arguments), any failing
wdenk6c59edc2004-05-03 20:45:30 +00005527 command will cause "run" to terminate, i. e. the remaining
5528 variables are not executed.
wdenkf4688a22003-05-28 08:06:31 +00005529
wdenk6c59edc2004-05-03 20:45:30 +00005530Note for Redundant Ethernet Interfaces:
5531=======================================
wdenkf4688a22003-05-28 08:06:31 +00005532
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005533Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk6c59edc2004-05-03 20:45:30 +00005534such configurations and is capable of automatic selection of a
5535"working" interface when needed. MAC assignment works as follows:
wdenkf4688a22003-05-28 08:06:31 +00005536
wdenk6c59edc2004-05-03 20:45:30 +00005537Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5538MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5539"eth1addr" (=>eth1), "eth2addr", ...
wdenkf4688a22003-05-28 08:06:31 +00005540
wdenk6c59edc2004-05-03 20:45:30 +00005541If the network interface stores some valid MAC address (for instance
5542in SROM), this is used as default address if there is NO correspon-
5543ding setting in the environment; if the corresponding environment
5544variable is set, this overrides the settings in the card; that means:
wdenkf4688a22003-05-28 08:06:31 +00005545
wdenk6c59edc2004-05-03 20:45:30 +00005546o If the SROM has a valid MAC address, and there is no address in the
5547 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005548
wdenk6c59edc2004-05-03 20:45:30 +00005549o If there is no valid address in the SROM, and a definition in the
5550 environment exists, then the value from the environment variable is
5551 used.
wdenkc6097192002-11-03 00:24:07 +00005552
wdenk6c59edc2004-05-03 20:45:30 +00005553o If both the SROM and the environment contain a MAC address, and
5554 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005555
wdenk6c59edc2004-05-03 20:45:30 +00005556o If both the SROM and the environment contain a MAC address, and the
5557 addresses differ, the value from the environment is used and a
5558 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005559
wdenk6c59edc2004-05-03 20:45:30 +00005560o If neither SROM nor the environment contain a MAC address, an error
Joe Hershberger2dc2b5d2015-05-04 14:55:13 -05005561 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5562 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005563
Ben Warren6db991a2010-04-26 11:11:46 -07005564If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denk092ae952011-10-26 10:21:21 +00005565will be programmed into hardware as part of the initialization process. This
Ben Warren6db991a2010-04-26 11:11:46 -07005566may be skipped by setting the appropriate 'ethmacskip' environment variable.
5567The naming convention is as follows:
5568"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005569
wdenk6c59edc2004-05-03 20:45:30 +00005570Image Formats:
5571==============
wdenkc6097192002-11-03 00:24:07 +00005572
Marian Balakowicz18710b82008-03-12 12:13:13 +01005573U-Boot is capable of booting (and performing other auxiliary operations on)
5574images in two formats:
5575
5576New uImage format (FIT)
5577-----------------------
5578
5579Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5580to Flattened Device Tree). It allows the use of images with multiple
5581components (several kernels, ramdisks, etc.), with contents protected by
5582SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5583
5584
5585Old uImage format
5586-----------------
5587
5588Old image format is based on binary files which can be basically anything,
5589preceded by a special header; see the definitions in include/image.h for
5590details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk6c59edc2004-05-03 20:45:30 +00005592* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5593 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyser56b8dd12008-09-08 14:56:49 -05005594 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5595 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5596 INTEGRITY).
Wolfgang Denk83c15852006-10-24 14:21:16 +02005597* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Lin1cac36e2011-10-19 20:41:11 +00005598 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5599 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk6c59edc2004-05-03 20:45:30 +00005600* Compression Type (uncompressed, gzip, bzip2)
5601* Load Address
5602* Entry Point
5603* Image Name
5604* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk6c59edc2004-05-03 20:45:30 +00005606The header is marked by a special Magic Number, and both the header
5607and the data portions of the image are secured against corruption by
5608CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005609
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk6c59edc2004-05-03 20:45:30 +00005611Linux Support:
5612==============
wdenkc6097192002-11-03 00:24:07 +00005613
wdenk6c59edc2004-05-03 20:45:30 +00005614Although U-Boot should support any OS or standalone application
5615easily, the main focus has always been on Linux during the design of
5616U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005617
wdenk6c59edc2004-05-03 20:45:30 +00005618U-Boot includes many features that so far have been part of some
5619special "boot loader" code within the Linux kernel. Also, any
5620"initrd" images to be used are no longer part of one big Linux image;
5621instead, kernel and "initrd" are separate images. This implementation
5622serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005623
wdenk6c59edc2004-05-03 20:45:30 +00005624- the same features can be used for other OS or standalone
5625 applications (for instance: using compressed images to reduce the
5626 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005627
wdenk6c59edc2004-05-03 20:45:30 +00005628- it becomes much easier to port new Linux kernel versions because
5629 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005630
wdenk6c59edc2004-05-03 20:45:30 +00005631- the same Linux kernel image can now be used with different "initrd"
5632 images; of course this also means that different kernel images can
5633 be run with the same "initrd". This makes testing easier (you don't
5634 have to build a new "zImage.initrd" Linux image when you just
5635 change a file in your "initrd"). Also, a field-upgrade of the
5636 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005637
wdenkc6097192002-11-03 00:24:07 +00005638
wdenk6c59edc2004-05-03 20:45:30 +00005639Linux HOWTO:
5640============
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk6c59edc2004-05-03 20:45:30 +00005642Porting Linux to U-Boot based systems:
5643---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk6c59edc2004-05-03 20:45:30 +00005645U-Boot cannot save you from doing all the necessary modifications to
5646configure the Linux device drivers for use with your target hardware
5647(no, we don't intend to provide a full virtual machine interface to
5648Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005649
Stefan Roese88fbf932010-04-15 16:07:28 +02005650But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk6c59edc2004-05-03 20:45:30 +00005652Just make sure your machine specific header file (for instance
5653include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg47167572008-09-07 20:18:27 +02005654Information structure as we define in include/asm-<arch>/u-boot.h,
5655and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02005656as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005657
Simon Glassd097e592014-06-11 23:29:46 -06005658Note that U-Boot now has a driver model, a unified model for drivers.
5659If you are adding a new driver, plumb it into driver model. If there
5660is no uclass available, you are encouraged to create one. See
5661doc/driver-model.
5662
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk6c59edc2004-05-03 20:45:30 +00005664Configuring the Linux kernel:
5665-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005666
wdenk6c59edc2004-05-03 20:45:30 +00005667No specific requirements for U-Boot. Make sure you have some root
5668device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005669
wdenkc6097192002-11-03 00:24:07 +00005670
wdenk6c59edc2004-05-03 20:45:30 +00005671Building a Linux Image:
5672-----------------------
wdenkc6097192002-11-03 00:24:07 +00005673
wdenk6c59edc2004-05-03 20:45:30 +00005674With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5675not used. If you use recent kernel source, a new build target
5676"uImage" will exist which automatically builds an image usable by
5677U-Boot. Most older kernels also have support for a "pImage" target,
5678which was introduced for our predecessor project PPCBoot and uses a
5679100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005680
wdenk6c59edc2004-05-03 20:45:30 +00005681Example:
wdenkc6097192002-11-03 00:24:07 +00005682
Holger Freyther7ba4e572014-08-04 09:26:05 +02005683 make TQM850L_defconfig
wdenk6c59edc2004-05-03 20:45:30 +00005684 make oldconfig
5685 make dep
5686 make uImage
wdenkc6097192002-11-03 00:24:07 +00005687
wdenk6c59edc2004-05-03 20:45:30 +00005688The "uImage" build target uses a special tool (in 'tools/mkimage') to
5689encapsulate a compressed Linux kernel image with header information,
5690CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005691
wdenk6c59edc2004-05-03 20:45:30 +00005692* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005693
wdenk6c59edc2004-05-03 20:45:30 +00005694* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005695
wdenk6c59edc2004-05-03 20:45:30 +00005696 ${CROSS_COMPILE}-objcopy -O binary \
5697 -R .note -R .comment \
5698 -S vmlinux linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005699
wdenk6c59edc2004-05-03 20:45:30 +00005700* compress the binary image:
wdenk24ee89b2002-11-03 17:56:27 +00005701
wdenk6c59edc2004-05-03 20:45:30 +00005702 gzip -9 linux.bin
wdenk24ee89b2002-11-03 17:56:27 +00005703
wdenk6c59edc2004-05-03 20:45:30 +00005704* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005705
wdenk6c59edc2004-05-03 20:45:30 +00005706 mkimage -A ppc -O linux -T kernel -C gzip \
5707 -a 0 -e 0 -n "Linux Kernel Image" \
5708 -d linux.bin.gz uImage
wdenkc6097192002-11-03 00:24:07 +00005709
wdenkc6097192002-11-03 00:24:07 +00005710
wdenk6c59edc2004-05-03 20:45:30 +00005711The "mkimage" tool can also be used to create ramdisk images for use
5712with U-Boot, either separated from the Linux kernel image, or
5713combined into one file. "mkimage" encapsulates the images with a 64
5714byte header containing information about target architecture,
5715operating system, image type, compression method, entry points, time
5716stamp, CRC32 checksums, etc.
wdenkc6097192002-11-03 00:24:07 +00005717
wdenk6c59edc2004-05-03 20:45:30 +00005718"mkimage" can be called in two ways: to verify existing images and
5719print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005720
wdenk6c59edc2004-05-03 20:45:30 +00005721In the first form (with "-l" option) mkimage lists the information
5722contained in the header of an existing U-Boot image; this includes
5723checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005724
wdenk6c59edc2004-05-03 20:45:30 +00005725 tools/mkimage -l image
5726 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005727
wdenk6c59edc2004-05-03 20:45:30 +00005728The second form (with "-d" option) is used to build a U-Boot image
5729from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005730
wdenk6c59edc2004-05-03 20:45:30 +00005731 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5732 -n name -d data_file image
5733 -A ==> set architecture to 'arch'
5734 -O ==> set operating system to 'os'
5735 -T ==> set image type to 'type'
5736 -C ==> set compression type 'comp'
5737 -a ==> set load address to 'addr' (hex)
5738 -e ==> set entry point to 'ep' (hex)
5739 -n ==> set image name to 'name'
5740 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005741
wdenkcd914452004-05-29 16:53:29 +00005742Right now, all Linux kernels for PowerPC systems use the same load
5743address (0x00000000), but the entry point address depends on the
5744kernel version:
wdenkc6097192002-11-03 00:24:07 +00005745
wdenk6c59edc2004-05-03 20:45:30 +00005746- 2.2.x kernels have the entry point at 0x0000000C,
5747- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005748
wdenk6c59edc2004-05-03 20:45:30 +00005749So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005750
wdenk6c59edc2004-05-03 20:45:30 +00005751 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5752 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005753 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk6c59edc2004-05-03 20:45:30 +00005754 > examples/uImage.TQM850L
5755 Image Name: 2.4.4 kernel for TQM850L
5756 Created: Wed Jul 19 02:34:59 2000
5757 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5758 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5759 Load Address: 0x00000000
5760 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005761
wdenk6c59edc2004-05-03 20:45:30 +00005762To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005763
wdenk6c59edc2004-05-03 20:45:30 +00005764 -> tools/mkimage -l examples/uImage.TQM850L
5765 Image Name: 2.4.4 kernel for TQM850L
5766 Created: Wed Jul 19 02:34:59 2000
5767 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5768 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5769 Load Address: 0x00000000
5770 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005771
wdenk6c59edc2004-05-03 20:45:30 +00005772NOTE: for embedded systems where boot time is critical you can trade
5773speed for memory and install an UNCOMPRESSED image instead: this
5774needs more space in Flash, but boots much faster since it does not
5775need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005776
Stefan Roese88fbf932010-04-15 16:07:28 +02005777 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk6c59edc2004-05-03 20:45:30 +00005778 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5779 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roese88fbf932010-04-15 16:07:28 +02005780 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk6c59edc2004-05-03 20:45:30 +00005781 > examples/uImage.TQM850L-uncompressed
5782 Image Name: 2.4.4 kernel for TQM850L
5783 Created: Wed Jul 19 02:34:59 2000
5784 Image Type: PowerPC Linux Kernel Image (uncompressed)
5785 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5786 Load Address: 0x00000000
5787 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005788
wdenkc6097192002-11-03 00:24:07 +00005789
wdenk6c59edc2004-05-03 20:45:30 +00005790Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5791when your kernel is intended to use an initial ramdisk:
wdenkc6097192002-11-03 00:24:07 +00005792
wdenk6c59edc2004-05-03 20:45:30 +00005793 -> tools/mkimage -n 'Simple Ramdisk Image' \
5794 > -A ppc -O linux -T ramdisk -C gzip \
5795 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5796 Image Name: Simple Ramdisk Image
5797 Created: Wed Jan 12 14:01:50 2000
5798 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5799 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5800 Load Address: 0x00000000
5801 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005802
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005803The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5804option performs the converse operation of the mkimage's second form (the "-d"
5805option). Given an image built by mkimage, the dumpimage extracts a "data file"
5806from the image:
5807
Guilherme Maciel Ferreira40bf5632015-01-15 02:54:40 -02005808 tools/dumpimage -i image -T type -p position data_file
5809 -i ==> extract from the 'image' a specific 'data_file'
5810 -T ==> set image type to 'type'
5811 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreira51553812013-12-01 12:43:11 -07005812
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk6c59edc2004-05-03 20:45:30 +00005814Installing a Linux Image:
5815-------------------------
wdenkc6097192002-11-03 00:24:07 +00005816
wdenk6c59edc2004-05-03 20:45:30 +00005817To downloading a U-Boot image over the serial (console) interface,
5818you must convert the image to S-Record format:
wdenkc6097192002-11-03 00:24:07 +00005819
wdenk6c59edc2004-05-03 20:45:30 +00005820 objcopy -I binary -O srec examples/image examples/image.srec
wdenkc6097192002-11-03 00:24:07 +00005821
wdenk6c59edc2004-05-03 20:45:30 +00005822The 'objcopy' does not understand the information in the U-Boot
5823image header, so the resulting S-Record file will be relative to
5824address 0x00000000. To load it to a given address, you need to
5825specify the target address as 'offset' parameter with the 'loads'
5826command.
wdenkc6097192002-11-03 00:24:07 +00005827
wdenk6c59edc2004-05-03 20:45:30 +00005828Example: install the image to address 0x40100000 (which on the
5829TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk6c59edc2004-05-03 20:45:30 +00005831 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005832
wdenk6c59edc2004-05-03 20:45:30 +00005833 .......... done
5834 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk6c59edc2004-05-03 20:45:30 +00005836 => loads 40100000
5837 ## Ready for S-Record download ...
5838 ~>examples/image.srec
5839 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5840 ...
5841 15989 15990 15991 15992
5842 [file transfer complete]
5843 [connected]
5844 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005845
wdenkc6097192002-11-03 00:24:07 +00005846
wdenk6c59edc2004-05-03 20:45:30 +00005847You can check the success of the download using the 'iminfo' command;
Wolfgang Denkb240aef2008-03-26 10:40:12 +01005848this includes a checksum verification so you can be sure no data
wdenk6c59edc2004-05-03 20:45:30 +00005849corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005850
wdenk6c59edc2004-05-03 20:45:30 +00005851 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk6c59edc2004-05-03 20:45:30 +00005853 ## Checking Image at 40100000 ...
5854 Image Name: 2.2.13 for initrd on TQM850L
5855 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5856 Data Size: 335725 Bytes = 327 kB = 0 MB
5857 Load Address: 00000000
5858 Entry Point: 0000000c
5859 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005860
5861
wdenk6c59edc2004-05-03 20:45:30 +00005862Boot Linux:
5863-----------
wdenkc6097192002-11-03 00:24:07 +00005864
wdenk6c59edc2004-05-03 20:45:30 +00005865The "bootm" command is used to boot an application that is stored in
5866memory (RAM or Flash). In case of a Linux kernel image, the contents
5867of the "bootargs" environment variable is passed to the kernel as
5868parameters. You can check and modify this variable using the
5869"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005870
wdenkc6097192002-11-03 00:24:07 +00005871
wdenk6c59edc2004-05-03 20:45:30 +00005872 => printenv bootargs
5873 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005874
wdenk6c59edc2004-05-03 20:45:30 +00005875 => 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 +00005876
wdenk6c59edc2004-05-03 20:45:30 +00005877 => printenv bootargs
5878 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 +00005879
wdenk6c59edc2004-05-03 20:45:30 +00005880 => bootm 40020000
5881 ## Booting Linux kernel at 40020000 ...
5882 Image Name: 2.2.13 for NFS on TQM850L
5883 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5884 Data Size: 381681 Bytes = 372 kB = 0 MB
5885 Load Address: 00000000
5886 Entry Point: 0000000c
5887 Verifying Checksum ... OK
5888 Uncompressing Kernel Image ... OK
5889 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
5890 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5891 time_init: decrementer frequency = 187500000/60
5892 Calibrating delay loop... 49.77 BogoMIPS
5893 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5894 ...
wdenkc6097192002-11-03 00:24:07 +00005895
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02005896If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk6c59edc2004-05-03 20:45:30 +00005897the memory addresses of both the kernel and the initrd image (PPBCOOT
5898format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005899
wdenk6c59edc2004-05-03 20:45:30 +00005900 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005901
wdenk6c59edc2004-05-03 20:45:30 +00005902 ## Checking Image at 40100000 ...
5903 Image Name: 2.2.13 for initrd on TQM850L
5904 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5905 Data Size: 335725 Bytes = 327 kB = 0 MB
5906 Load Address: 00000000
5907 Entry Point: 0000000c
5908 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005909
wdenk6c59edc2004-05-03 20:45:30 +00005910 ## Checking Image at 40200000 ...
5911 Image Name: Simple Ramdisk Image
5912 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5913 Data Size: 566530 Bytes = 553 kB = 0 MB
5914 Load Address: 00000000
5915 Entry Point: 00000000
5916 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005917
wdenk6c59edc2004-05-03 20:45:30 +00005918 => bootm 40100000 40200000
5919 ## Booting Linux kernel at 40100000 ...
5920 Image Name: 2.2.13 for initrd on TQM850L
5921 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5922 Data Size: 335725 Bytes = 327 kB = 0 MB
5923 Load Address: 00000000
5924 Entry Point: 0000000c
5925 Verifying Checksum ... OK
5926 Uncompressing Kernel Image ... OK
5927 ## Loading RAMDisk Image at 40200000 ...
5928 Image Name: Simple Ramdisk Image
5929 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5930 Data Size: 566530 Bytes = 553 kB = 0 MB
5931 Load Address: 00000000
5932 Entry Point: 00000000
5933 Verifying Checksum ... OK
5934 Loading Ramdisk ... OK
5935 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
5936 Boot arguments: root=/dev/ram
5937 time_init: decrementer frequency = 187500000/60
5938 Calibrating delay loop... 49.77 BogoMIPS
5939 ...
5940 RAMDISK: Compressed image found at block 0
5941 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005942
wdenk6c59edc2004-05-03 20:45:30 +00005943 bash#
wdenkc6097192002-11-03 00:24:07 +00005944
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005945Boot Linux and pass a flat device tree:
5946-----------
5947
5948First, U-Boot must be compiled with the appropriate defines. See the section
5949titled "Linux Kernel Interface" above for a more in depth explanation. The
5950following is an example of how to start a kernel and pass an updated
5951flat device tree:
5952
5953=> print oftaddr
5954oftaddr=0x300000
5955=> print oft
5956oft=oftrees/mpc8540ads.dtb
5957=> tftp $oftaddr $oft
5958Speed: 1000, full duplex
5959Using TSEC0 device
5960TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5961Filename 'oftrees/mpc8540ads.dtb'.
5962Load address: 0x300000
5963Loading: #
5964done
5965Bytes transferred = 4106 (100a hex)
5966=> tftp $loadaddr $bootfile
5967Speed: 1000, full duplex
5968Using TSEC0 device
5969TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5970Filename 'uImage'.
5971Load address: 0x200000
5972Loading:############
5973done
5974Bytes transferred = 1029407 (fb51f hex)
5975=> print loadaddr
5976loadaddr=200000
5977=> print oftaddr
5978oftaddr=0x300000
5979=> bootm $loadaddr - $oftaddr
5980## Booting image at 00200000 ...
Wolfgang Denk018147d2006-11-27 15:32:42 +01005981 Image Name: Linux-2.6.17-dirty
5982 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5983 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005984 Load Address: 00000000
Wolfgang Denk018147d2006-11-27 15:32:42 +01005985 Entry Point: 00000000
Matthew McClintockefae4ca2006-06-28 10:41:37 -05005986 Verifying Checksum ... OK
5987 Uncompressing Kernel Image ... OK
5988Booting using flat device tree at 0x300000
5989Using MPC85xx ADS machine description
5990Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5991[snip]
5992
5993
wdenk6c59edc2004-05-03 20:45:30 +00005994More About U-Boot Image Types:
5995------------------------------
wdenkc6097192002-11-03 00:24:07 +00005996
wdenk6c59edc2004-05-03 20:45:30 +00005997U-Boot supports the following image types:
wdenkc6097192002-11-03 00:24:07 +00005998
wdenk6c59edc2004-05-03 20:45:30 +00005999 "Standalone Programs" are directly runnable in the environment
6000 provided by U-Boot; it is expected that (if they behave
6001 well) you can continue to work in U-Boot after return from
6002 the Standalone Program.
6003 "OS Kernel Images" are usually images of some Embedded OS which
6004 will take over control completely. Usually these programs
6005 will install their own set of exception handlers, device
6006 drivers, set up the MMU, etc. - this means, that you cannot
6007 expect to re-enter U-Boot except by resetting the CPU.
6008 "RAMDisk Images" are more or less just data blocks, and their
6009 parameters (address, size) are passed to an OS kernel that is
6010 being started.
6011 "Multi-File Images" contain several images, typically an OS
6012 (Linux) kernel image and one or more data images like
6013 RAMDisks. This construct is useful for instance when you want
6014 to boot over the network using BOOTP etc., where the boot
6015 server provides just a single image file, but you want to get
6016 for instance an OS kernel and a RAMDisk image.
wdenkc6097192002-11-03 00:24:07 +00006017
wdenk6c59edc2004-05-03 20:45:30 +00006018 "Multi-File Images" start with a list of image sizes, each
6019 image size (in bytes) specified by an "uint32_t" in network
6020 byte order. This list is terminated by an "(uint32_t)0".
6021 Immediately after the terminating 0 follow the images, one by
6022 one, all aligned on "uint32_t" boundaries (size rounded up to
6023 a multiple of 4 bytes).
wdenkc6097192002-11-03 00:24:07 +00006024
wdenk6c59edc2004-05-03 20:45:30 +00006025 "Firmware Images" are binary images containing firmware (like
6026 U-Boot or FPGA images) which usually will be programmed to
6027 flash memory.
wdenk4fc95692003-02-28 00:49:47 +00006028
wdenk6c59edc2004-05-03 20:45:30 +00006029 "Script files" are command sequences that will be executed by
6030 U-Boot's command interpreter; this feature is especially
6031 useful when you configure U-Boot to use a real shell (hush)
6032 as command interpreter.
wdenk4fc95692003-02-28 00:49:47 +00006033
Marek Vasutcf41a9b2012-03-14 21:52:45 +00006034Booting the Linux zImage:
6035-------------------------
6036
6037On some platforms, it's possible to boot Linux zImage. This is done
6038using the "bootz" command. The syntax of "bootz" command is the same
6039as the syntax of "bootm" command.
6040
Tom Rini45f46d12013-05-16 11:40:11 -04006041Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut28850d02012-03-18 11:47:58 +00006042kernel with raw initrd images. The syntax is slightly different, the
6043address of the initrd must be augmented by it's size, in the following
6044format: "<initrd addres>:<initrd size>".
6045
stroeseb9c17c52003-04-04 15:53:41 +00006046
wdenk6c59edc2004-05-03 20:45:30 +00006047Standalone HOWTO:
6048=================
stroeseb9c17c52003-04-04 15:53:41 +00006049
wdenk6c59edc2004-05-03 20:45:30 +00006050One of the features of U-Boot is that you can dynamically load and
6051run "standalone" applications, which can use some resources of
6052U-Boot like console I/O functions or interrupt services.
stroeseb9c17c52003-04-04 15:53:41 +00006053
wdenk6c59edc2004-05-03 20:45:30 +00006054Two simple examples are included with the sources:
wdenk4fc95692003-02-28 00:49:47 +00006055
wdenk6c59edc2004-05-03 20:45:30 +00006056"Hello World" Demo:
6057-------------------
wdenkc6097192002-11-03 00:24:07 +00006058
wdenk6c59edc2004-05-03 20:45:30 +00006059'examples/hello_world.c' contains a small "Hello World" Demo
6060application; it is automatically compiled when you build U-Boot.
6061It's configured to run at address 0x00040004, so you can play with it
6062like that:
wdenkc6097192002-11-03 00:24:07 +00006063
wdenk6c59edc2004-05-03 20:45:30 +00006064 => loads
6065 ## Ready for S-Record download ...
6066 ~>examples/hello_world.srec
6067 1 2 3 4 5 6 7 8 9 10 11 ...
6068 [file transfer complete]
6069 [connected]
6070 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006071
wdenk6c59edc2004-05-03 20:45:30 +00006072 => go 40004 Hello World! This is a test.
6073 ## Starting application at 0x00040004 ...
6074 Hello World
6075 argc = 7
6076 argv[0] = "40004"
6077 argv[1] = "Hello"
6078 argv[2] = "World!"
6079 argv[3] = "This"
6080 argv[4] = "is"
6081 argv[5] = "a"
6082 argv[6] = "test."
6083 argv[7] = "<NULL>"
6084 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006085
wdenk6c59edc2004-05-03 20:45:30 +00006086 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006087
wdenk6c59edc2004-05-03 20:45:30 +00006088Another example, which demonstrates how to register a CPM interrupt
6089handler with the U-Boot code, can be found in 'examples/timer.c'.
6090Here, a CPM timer is set up to generate an interrupt every second.
6091The interrupt service routine is trivial, just printing a '.'
6092character, but this is just a demo program. The application can be
6093controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006094
wdenk6c59edc2004-05-03 20:45:30 +00006095 ? - print current values og the CPM Timer registers
6096 b - enable interrupts and start timer
6097 e - stop timer and disable interrupts
6098 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006099
wdenk6c59edc2004-05-03 20:45:30 +00006100 => loads
6101 ## Ready for S-Record download ...
6102 ~>examples/timer.srec
6103 1 2 3 4 5 6 7 8 9 10 11 ...
6104 [file transfer complete]
6105 [connected]
6106 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006107
wdenk6c59edc2004-05-03 20:45:30 +00006108 => go 40004
6109 ## Starting application at 0x00040004 ...
6110 TIMERS=0xfff00980
6111 Using timer 1
6112 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006113
wdenk6c59edc2004-05-03 20:45:30 +00006114Hit 'b':
6115 [q, b, e, ?] Set interval 1000000 us
6116 Enabling timer
6117Hit '?':
6118 [q, b, e, ?] ........
6119 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6120Hit '?':
6121 [q, b, e, ?] .
6122 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6123Hit '?':
6124 [q, b, e, ?] .
6125 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6126Hit '?':
6127 [q, b, e, ?] .
6128 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6129Hit 'e':
6130 [q, b, e, ?] ...Stopping timer
6131Hit 'q':
6132 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006133
wdenkc6097192002-11-03 00:24:07 +00006134
wdenk6c59edc2004-05-03 20:45:30 +00006135Minicom warning:
6136================
wdenkc6097192002-11-03 00:24:07 +00006137
wdenk6c59edc2004-05-03 20:45:30 +00006138Over time, many people have reported problems when trying to use the
6139"minicom" terminal emulation program for serial download. I (wd)
6140consider minicom to be broken, and recommend not to use it. Under
6141Unix, I recommend to use C-Kermit for general purpose use (and
6142especially for kermit binary protocol download ("loadb" command), and
Karl O. Pinca0189bb2012-10-01 05:11:56 +00006143use "cu" for S-Record download ("loads" command). See
6144http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6145for help with kermit.
6146
wdenkc6097192002-11-03 00:24:07 +00006147
wdenk6c59edc2004-05-03 20:45:30 +00006148Nevertheless, if you absolutely want to use it try adding this
6149configuration to your "File transfer protocols" section:
wdenkc6097192002-11-03 00:24:07 +00006150
wdenk6c59edc2004-05-03 20:45:30 +00006151 Name Program Name U/D FullScr IO-Red. Multi
6152 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6153 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk8dba0502003-03-31 16:34:49 +00006154
wdenk8dba0502003-03-31 16:34:49 +00006155
wdenk6c59edc2004-05-03 20:45:30 +00006156NetBSD Notes:
6157=============
wdenkc6097192002-11-03 00:24:07 +00006158
wdenk6c59edc2004-05-03 20:45:30 +00006159Starting at version 0.9.2, U-Boot supports NetBSD both as host
6160(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenk88e72a32003-06-19 23:04:19 +00006161
wdenk6c59edc2004-05-03 20:45:30 +00006162Building requires a cross environment; it is known to work on
6163NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6164need gmake since the Makefiles are not compatible with BSD make).
6165Note that the cross-powerpc package does not install include files;
6166attempting to build U-Boot will fail because <machine/ansi.h> is
6167missing. This file has to be installed and patched manually:
wdenk88e72a32003-06-19 23:04:19 +00006168
wdenk6c59edc2004-05-03 20:45:30 +00006169 # cd /usr/pkg/cross/powerpc-netbsd/include
6170 # mkdir powerpc
6171 # ln -s powerpc machine
6172 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6173 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenk88e72a32003-06-19 23:04:19 +00006174
wdenk6c59edc2004-05-03 20:45:30 +00006175Native builds *don't* work due to incompatibilities between native
6176and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006177
wdenk6c59edc2004-05-03 20:45:30 +00006178Booting assumes that (the first part of) the image booted is a
6179stage-2 loader which in turn loads and then invokes the kernel
6180proper. Loader sources will eventually appear in the NetBSD source
6181tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenkd0245fc2005-04-13 10:02:42 +00006182meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006183
wdenkc6097192002-11-03 00:24:07 +00006184
wdenk6c59edc2004-05-03 20:45:30 +00006185Implementation Internals:
6186=========================
wdenkc6097192002-11-03 00:24:07 +00006187
wdenk6c59edc2004-05-03 20:45:30 +00006188The following is not intended to be a complete description of every
6189implementation detail. However, it should help to understand the
6190inner workings of U-Boot and make it easier to port it to custom
6191hardware.
wdenkc6097192002-11-03 00:24:07 +00006192
wdenkc6097192002-11-03 00:24:07 +00006193
wdenk6c59edc2004-05-03 20:45:30 +00006194Initial Stack, Global Data:
6195---------------------------
wdenkc6097192002-11-03 00:24:07 +00006196
wdenk6c59edc2004-05-03 20:45:30 +00006197The implementation of U-Boot is complicated by the fact that U-Boot
6198starts running out of ROM (flash memory), usually without access to
6199system RAM (because the memory controller is not initialized yet).
6200This means that we don't have writable Data or BSS segments, and BSS
6201is not initialized as zero. To be able to get a C environment working
6202at all, we have to allocate at least a minimal stack. Implementation
6203options for this are defined and restricted by the CPU used: Some CPU
6204models provide on-chip memory (like the IMMR area on MPC8xx and
6205MPC826x processors), on others (parts of) the data cache can be
6206locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006207
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006208 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006209 U-Boot mailing list:
wdenkc6097192002-11-03 00:24:07 +00006210
wdenk6c59edc2004-05-03 20:45:30 +00006211 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6212 From: "Chris Hallinan" <clh@net1plus.com>
6213 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6214 ...
wdenkc6097192002-11-03 00:24:07 +00006215
wdenk6c59edc2004-05-03 20:45:30 +00006216 Correct me if I'm wrong, folks, but the way I understand it
6217 is this: Using DCACHE as initial RAM for Stack, etc, does not
6218 require any physical RAM backing up the cache. The cleverness
6219 is that the cache is being used as a temporary supply of
6220 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006221 beyond the scope of this list to explain the details, but you
wdenk6c59edc2004-05-03 20:45:30 +00006222 can see how this works by studying the cache architecture and
6223 operation in the architecture and processor-specific manuals.
wdenkc6097192002-11-03 00:24:07 +00006224
wdenk6c59edc2004-05-03 20:45:30 +00006225 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6226 is another option for the system designer to use as an
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006227 initial stack/RAM area prior to SDRAM being available. Either
wdenk6c59edc2004-05-03 20:45:30 +00006228 option should work for you. Using CS 4 should be fine if your
6229 board designers haven't used it for something that would
6230 cause you grief during the initial boot! It is frequently not
6231 used.
wdenkc6097192002-11-03 00:24:07 +00006232
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006233 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk6c59edc2004-05-03 20:45:30 +00006234 with your processor/board/system design. The default value
6235 you will find in any recent u-boot distribution in
Stefan Roese3e1f1b32005-08-01 16:49:12 +02006236 walnut.h should work for you. I'd set it to a value larger
wdenk6c59edc2004-05-03 20:45:30 +00006237 than your SDRAM module. If you have a 64MB SDRAM module, set
6238 it above 400_0000. Just make sure your board has no resources
6239 that are supposed to respond to that address! That code in
6240 start.S has been around a while and should work as is when
6241 you get the config right.
wdenk4a5c8a72003-03-06 00:02:04 +00006242
wdenk6c59edc2004-05-03 20:45:30 +00006243 -Chris Hallinan
6244 DS4.COM, Inc.
wdenk4a5c8a72003-03-06 00:02:04 +00006245
wdenk6c59edc2004-05-03 20:45:30 +00006246It is essential to remember this, since it has some impact on the C
6247code for the initialization procedures:
wdenk4a5c8a72003-03-06 00:02:04 +00006248
wdenk6c59edc2004-05-03 20:45:30 +00006249* Initialized global data (data segment) is read-only. Do not attempt
6250 to write it.
wdenk4a5c8a72003-03-06 00:02:04 +00006251
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006252* Do not use any uninitialized global data (or implicitly initialized
wdenk6c59edc2004-05-03 20:45:30 +00006253 as zero data - BSS segment) at all - this is undefined, initiali-
6254 zation is performed later (when relocating to RAM).
wdenk4a5c8a72003-03-06 00:02:04 +00006255
wdenk6c59edc2004-05-03 20:45:30 +00006256* Stack space is very limited. Avoid big data buffers or things like
6257 that.
wdenk4a5c8a72003-03-06 00:02:04 +00006258
wdenk6c59edc2004-05-03 20:45:30 +00006259Having only the stack as writable memory limits means we cannot use
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006260normal global data to share information between the code. But it
wdenk6c59edc2004-05-03 20:45:30 +00006261turned out that the implementation of U-Boot can be greatly
6262simplified by making a global data structure (gd_t) available to all
6263functions. We could pass a pointer to this data as argument to _all_
6264functions, but this would bloat the code. Instead we use a feature of
6265the GCC compiler (Global Register Variables) to share the data: we
6266place a pointer (gd) to the global data into a register which we
6267reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006268
wdenk6c59edc2004-05-03 20:45:30 +00006269When choosing a register for such a purpose we are restricted by the
6270relevant (E)ABI specifications for the current architecture, and by
6271GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006272
wdenk6c59edc2004-05-03 20:45:30 +00006273For PowerPC, the following registers have specific use:
6274 R1: stack pointer
Wolfgang Denk69c09642008-02-14 22:43:22 +01006275 R2: reserved for system use
wdenk6c59edc2004-05-03 20:45:30 +00006276 R3-R4: parameter passing and return values
6277 R5-R10: parameter passing
6278 R13: small data area pointer
6279 R30: GOT pointer
6280 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006281
Joakim Tjernlund693c0c12010-01-19 14:41:58 +01006282 (U-Boot also uses R12 as internal GOT pointer. r12
6283 is a volatile register so r12 needs to be reset when
6284 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006285
Wolfgang Denk69c09642008-02-14 22:43:22 +01006286 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006287
wdenk6c59edc2004-05-03 20:45:30 +00006288 Note: on PPC, we could use a static initializer (since the
6289 address of the global data structure is known at compile time),
6290 but it turned out that reserving a register results in somewhat
6291 smaller code - although the code savings are not that big (on
6292 average for all boards 752 bytes for the whole U-Boot image,
6293 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006294
Robin Getz2773d5f2009-08-17 15:23:02 +00006295On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger60f09302008-02-04 19:26:54 -05006296 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6297
Robin Getz2773d5f2009-08-17 15:23:02 +00006298 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger60f09302008-02-04 19:26:54 -05006299
wdenk6c59edc2004-05-03 20:45:30 +00006300On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006301
wdenk6c59edc2004-05-03 20:45:30 +00006302 R0: function argument word/integer result
6303 R1-R3: function argument word
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006304 R9: platform specific
6305 R10: stack limit (used only if stack checking is enabled)
wdenk6c59edc2004-05-03 20:45:30 +00006306 R11: argument (frame) pointer
6307 R12: temporary workspace
6308 R13: stack pointer
6309 R14: link register
6310 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006311
Jeroen Hofsteea556aca2013-09-21 14:04:42 +02006312 ==> U-Boot will use R9 to hold a pointer to the global data
6313
6314 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006315
Thomas Chou8fa38582010-05-21 11:08:03 +08006316On Nios II, the ABI is documented here:
6317 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6318
6319 ==> U-Boot will use gp to hold a pointer to the global data
6320
6321 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6322 to access small data sections, so gp is free.
6323
Macpaul Lin1cac36e2011-10-19 20:41:11 +00006324On NDS32, the following registers are used:
6325
6326 R0-R1: argument/return
6327 R2-R5: argument
6328 R15: temporary register for assembler
6329 R16: trampoline register
6330 R28: frame pointer (FP)
6331 R29: global pointer (GP)
6332 R30: link register (LP)
6333 R31: stack pointer (SP)
6334 PC: program counter (PC)
6335
6336 ==> U-Boot will use R10 to hold a pointer to the global data
6337
Wolfgang Denk6405a152006-03-31 18:32:53 +02006338NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6339or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006340
wdenk6c59edc2004-05-03 20:45:30 +00006341Memory Management:
6342------------------
wdenkc6097192002-11-03 00:24:07 +00006343
wdenk6c59edc2004-05-03 20:45:30 +00006344U-Boot runs in system state and uses physical addresses, i.e. the
6345MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006346
wdenk6c59edc2004-05-03 20:45:30 +00006347The available memory is mapped to fixed addresses using the memory
6348controller. In this process, a contiguous block is formed for each
6349memory type (Flash, SDRAM, SRAM), even when it consists of several
6350physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006351
wdenk6c59edc2004-05-03 20:45:30 +00006352U-Boot is installed in the first 128 kB of the first Flash bank (on
6353TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6354booting and sizing and initializing DRAM, the code relocates itself
6355to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD03836942008-10-16 15:01:15 +02006356memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk6c59edc2004-05-03 20:45:30 +00006357configuration setting]. Below that, a structure with global Board
6358Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006359
wdenk6c59edc2004-05-03 20:45:30 +00006360Additionally, some exception handler code is copied to the low 8 kB
6361of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006362
wdenk6c59edc2004-05-03 20:45:30 +00006363So a typical memory configuration with 16 MB of DRAM could look like
6364this:
wdenkc6097192002-11-03 00:24:07 +00006365
wdenk6c59edc2004-05-03 20:45:30 +00006366 0x0000 0000 Exception Vector code
6367 :
6368 0x0000 1FFF
6369 0x0000 2000 Free for Application Use
6370 :
6371 :
wdenkc6097192002-11-03 00:24:07 +00006372
wdenk6c59edc2004-05-03 20:45:30 +00006373 :
6374 :
6375 0x00FB FF20 Monitor Stack (Growing downward)
6376 0x00FB FFAC Board Info Data and permanent copy of global data
6377 0x00FC 0000 Malloc Arena
6378 :
6379 0x00FD FFFF
6380 0x00FE 0000 RAM Copy of Monitor Code
6381 ... eventually: LCD or video framebuffer
6382 ... eventually: pRAM (Protected RAM - unchanged by reset)
6383 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006384
wdenkc6097192002-11-03 00:24:07 +00006385
wdenk6c59edc2004-05-03 20:45:30 +00006386System Initialization:
6387----------------------
wdenkc6097192002-11-03 00:24:07 +00006388
wdenk6c59edc2004-05-03 20:45:30 +00006389In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswilerabd8dcb2008-07-09 08:17:15 +02006390(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006391configuration for CS0# this is a mirror of the on board Flash memory.
wdenk6c59edc2004-05-03 20:45:30 +00006392To be able to re-map memory U-Boot then jumps to its link address.
6393To be able to implement the initialization code in C, a (small!)
6394initial stack is set up in the internal Dual Ported RAM (in case CPUs
6395which provide such a feature like MPC8xx or MPC8260), or in a locked
6396part of the data cache. After that, U-Boot initializes the CPU core,
6397the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006398
wdenk6c59edc2004-05-03 20:45:30 +00006399Next, all (potentially) available memory banks are mapped using a
6400preliminary mapping. For example, we put them on 512 MB boundaries
6401(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6402on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6403programmed for SDRAM access. Using the temporary configuration, a
6404simple memory test is run that determines the size of the SDRAM
6405banks.
wdenkc6097192002-11-03 00:24:07 +00006406
wdenk6c59edc2004-05-03 20:45:30 +00006407When there is more than one SDRAM bank, and the banks are of
6408different size, the largest is mapped first. For equal size, the first
6409bank (CS2#) is mapped first. The first mapping is always for address
64100x00000000, with any additional banks following immediately to create
6411contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006412
wdenk6c59edc2004-05-03 20:45:30 +00006413Then, the monitor installs itself at the upper end of the SDRAM area
6414and allocates memory for use by malloc() and for the global Board
6415Info data; also, the exception vector code is copied to the low RAM
6416pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006417
wdenk6c59edc2004-05-03 20:45:30 +00006418Only after this relocation will you have a "normal" C environment;
6419until that you are restricted in several ways, mostly because you are
6420running from ROM, and because the code will have to be relocated to a
6421new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006422
wdenkc6097192002-11-03 00:24:07 +00006423
wdenk6c59edc2004-05-03 20:45:30 +00006424U-Boot Porting Guide:
6425----------------------
wdenkc6097192002-11-03 00:24:07 +00006426
wdenk6c59edc2004-05-03 20:45:30 +00006427[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6428list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006429
wdenkc6097192002-11-03 00:24:07 +00006430
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006431int main(int argc, char *argv[])
wdenk6c59edc2004-05-03 20:45:30 +00006432{
6433 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006434
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006435 signal(SIGALRM, no_more_time);
6436 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006437
wdenk6c59edc2004-05-03 20:45:30 +00006438 if (available_money > available_manpower) {
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006439 Pay consultant to port U-Boot;
wdenk6c59edc2004-05-03 20:45:30 +00006440 return 0;
6441 }
wdenkc6097192002-11-03 00:24:07 +00006442
wdenk6c59edc2004-05-03 20:45:30 +00006443 Download latest U-Boot source;
wdenk34b613e2002-12-17 01:51:00 +00006444
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006445 Subscribe to u-boot mailing list;
wdenkc6097192002-11-03 00:24:07 +00006446
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006447 if (clueless)
6448 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006449
wdenk6c59edc2004-05-03 20:45:30 +00006450 while (learning) {
6451 Read the README file in the top level directory;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006452 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6453 Read applicable doc/*.README;
wdenk6c59edc2004-05-03 20:45:30 +00006454 Read the source, Luke;
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006455 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk6c59edc2004-05-03 20:45:30 +00006456 }
wdenkc6097192002-11-03 00:24:07 +00006457
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006458 if (available_money > toLocalCurrency ($2500))
6459 Buy a BDI3000;
6460 else
wdenk6c59edc2004-05-03 20:45:30 +00006461 Add a lot of aggravation and time;
wdenkc6097192002-11-03 00:24:07 +00006462
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006463 if (a similar board exists) { /* hopefully... */
6464 cp -a board/<similar> board/<myboard>
6465 cp include/configs/<similar>.h include/configs/<myboard>.h
6466 } else {
6467 Create your own board support subdirectory;
6468 Create your own board include/configs/<myboard>.h file;
6469 }
6470 Edit new board/<myboard> files
6471 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006472
Jerry Van Barenba0687c2009-07-15 20:42:59 -04006473 while (!accepted) {
6474 while (!running) {
6475 do {
6476 Add / modify source code;
6477 } until (compiles);
6478 Debug;
6479 if (clueless)
6480 email("Hi, I am having problems...");
6481 }
6482 Send patch file to the U-Boot email list;
6483 if (reasonable critiques)
6484 Incorporate improvements from email list code review;
6485 else
6486 Defend code as written;
wdenk634d2f72004-04-15 23:14:49 +00006487 }
wdenkc6097192002-11-03 00:24:07 +00006488
wdenk6c59edc2004-05-03 20:45:30 +00006489 return 0;
6490}
wdenkc6097192002-11-03 00:24:07 +00006491
wdenk6c59edc2004-05-03 20:45:30 +00006492void no_more_time (int sig)
6493{
6494 hire_a_guru();
6495}
wdenkc6097192002-11-03 00:24:07 +00006496
wdenkc6097192002-11-03 00:24:07 +00006497
wdenk6c59edc2004-05-03 20:45:30 +00006498Coding Standards:
6499-----------------
wdenkc6097192002-11-03 00:24:07 +00006500
wdenk6c59edc2004-05-03 20:45:30 +00006501All contributions to U-Boot should conform to the Linux kernel
Detlev Zundelaa63d482006-09-01 15:39:02 +02006502coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006503"scripts/Lindent" in your Linux kernel source directory.
Detlev Zundelaa63d482006-09-01 15:39:02 +02006504
6505Source files originating from a different project (for example the
6506MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahler03f930c2015-01-04 18:56:50 -08006507reformatted to ease subsequent migration to newer versions of those
Detlev Zundelaa63d482006-09-01 15:39:02 +02006508sources.
wdenkc6097192002-11-03 00:24:07 +00006509
Detlev Zundelaa63d482006-09-01 15:39:02 +02006510Please note that U-Boot is implemented in C (and to some small parts in
6511Assembler); no C++ is used, so please do not use C++ style comments (//)
6512in your code.
wdenkad276f22004-01-04 16:28:35 +00006513
wdenk6c59edc2004-05-03 20:45:30 +00006514Please also stick to the following formatting rules:
6515- remove any trailing white space
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006516- use TAB characters for indentation and vertical alignment, not spaces
wdenk6c59edc2004-05-03 20:45:30 +00006517- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006518- do not add more than 2 consecutive empty lines to source files
wdenk6c59edc2004-05-03 20:45:30 +00006519- do not add trailing empty lines to source files
wdenkc6097192002-11-03 00:24:07 +00006520
wdenk6c59edc2004-05-03 20:45:30 +00006521Submissions which do not conform to the standards may be returned
6522with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006523
wdenkc6097192002-11-03 00:24:07 +00006524
wdenk6c59edc2004-05-03 20:45:30 +00006525Submitting Patches:
6526-------------------
wdenkc6097192002-11-03 00:24:07 +00006527
wdenk6c59edc2004-05-03 20:45:30 +00006528Since the number of patches for U-Boot is growing, we need to
6529establish some rules. Submissions which do not conform to these rules
6530may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006531
Magnus Liljaf3b287b2008-08-06 19:32:33 +02006532Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006533
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006534Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6535see http://lists.denx.de/mailman/listinfo/u-boot
6536
wdenk6c59edc2004-05-03 20:45:30 +00006537When you send a patch, please include the following information with
6538it:
wdenkc6097192002-11-03 00:24:07 +00006539
wdenk6c59edc2004-05-03 20:45:30 +00006540* For bug fixes: a description of the bug and how your patch fixes
6541 this bug. Please try to include a way of demonstrating that the
6542 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006543
wdenk6c59edc2004-05-03 20:45:30 +00006544* For new features: a description of the feature and your
6545 implementation.
wdenkc6097192002-11-03 00:24:07 +00006546
wdenk6c59edc2004-05-03 20:45:30 +00006547* A CHANGELOG entry as plaintext (separate from the patch)
wdenkc6097192002-11-03 00:24:07 +00006548
Robert P. J. Day076ed9b2015-12-19 07:16:10 -05006549* For major contributions, add a MAINTAINERS file with your
6550 information and associated file and directory references.
wdenkc6097192002-11-03 00:24:07 +00006551
Albert ARIBAUD48e910f2013-09-11 15:52:51 +02006552* When you add support for a new board, don't forget to add a
6553 maintainer e-mail address to the boards.cfg file, too.
wdenkc6097192002-11-03 00:24:07 +00006554
wdenk6c59edc2004-05-03 20:45:30 +00006555* If your patch adds new configuration options, don't forget to
6556 document these in the README file.
wdenkc6097192002-11-03 00:24:07 +00006557
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006558* The patch itself. If you are using git (which is *strongly*
6559 recommended) you can easily generate the patch using the
Wolfgang Denk20bd2a62011-07-27 10:59:55 +00006560 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006561 the U-Boot mailing list, you will avoid most of the common problems
6562 with some other mail clients.
wdenkca9bc762003-07-15 07:45:49 +00006563
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006564 If you cannot use git, use "diff -purN OLD NEW". If your version of
6565 diff does not support these options, then get the latest version of
6566 GNU diff.
wdenkc6097192002-11-03 00:24:07 +00006567
Wolfgang Denkb240aef2008-03-26 10:40:12 +01006568 The current directory when running this command shall be the parent
6569 directory of the U-Boot source tree (i. e. please make sure that
6570 your patch includes sufficient directory information for the
6571 affected files).
6572
6573 We prefer patches as plain text. MIME attachments are discouraged,
6574 and compressed attachments must not be used.
wdenk88e72a32003-06-19 23:04:19 +00006575
wdenk6c59edc2004-05-03 20:45:30 +00006576* If one logical set of modifications affects or creates several
6577 files, all these changes shall be submitted in a SINGLE patch file.
wdenk57b2d802003-06-27 21:31:46 +00006578
wdenk6c59edc2004-05-03 20:45:30 +00006579* Changesets that contain different, unrelated modifications shall be
6580 submitted as SEPARATE patches, one patch per changeset.
wdenk88e72a32003-06-19 23:04:19 +00006581
wdenkc6097192002-11-03 00:24:07 +00006582
wdenk6c59edc2004-05-03 20:45:30 +00006583Notes:
wdenkc6097192002-11-03 00:24:07 +00006584
wdenk6c59edc2004-05-03 20:45:30 +00006585* Before sending the patch, run the MAKEALL script on your patched
6586 source tree and make sure that no errors or warnings are reported
6587 for any of the boards.
6588
6589* Keep your modifications to the necessary minimum: A patch
6590 containing several unrelated changes or arbitrary reformats will be
6591 returned with a request to re-formatting / split it.
wdenkc6097192002-11-03 00:24:07 +00006592
wdenk6c59edc2004-05-03 20:45:30 +00006593* If you modify existing code, make sure that your new code does not
6594 add to the memory footprint of the code ;-) Small is beautiful!
6595 When adding new features, these should compile conditionally only
6596 (using #ifdef), and the resulting code with the new feature
6597 disabled must not need more memory than the old code without your
6598 modification.
wdenkcbc49a52005-05-03 14:12:25 +00006599
Wolfgang Denk290ae6b2008-12-30 22:56:11 +01006600* Remember that there is a size limit of 100 kB per message on the
6601 u-boot mailing list. Bigger patches will be moderated. If they are
6602 reasonable and not too big, they will be acknowledged. But patches
6603 bigger than the size limit should be avoided.