blob: 5ac2d445679b90c69a88e581014e27e119394022 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-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 Denkeca3aeb2013-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
wdenke86e5a02004-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. Day7207b362015-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. Day7207b362015-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. Dayadb9d852012-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. Day7207b362015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-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 Denk218ca722008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day7207b362015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-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 Ziswiler11ccc332008-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 Lilja0d28f342008-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:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000115
116
wdenk93f19cc2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Weber360d8832010-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.
wdenk93f19cc2002-12-17 17:55:09 +0000126
Thomas Weber360d8832010-09-28 08:06:25 +0200127Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-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
wdenk93f19cc2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tyser8d321b82010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /blackfin Files generic to Analog Devices Blackfin architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500143 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000144 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500145 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400146 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200147 /powerpc Files generic to PowerPC architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500148 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sh Files generic to SH architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500150 /sparc Files generic to SPARC architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400151 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-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. Day7207b362015-12-19 07:16:10 -0500155/configs Board default configuration files
Peter Tyser8d321b82010-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. Day33c77312013-09-15 18:34:15 -0400159/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-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. Day7207b362015-12-19 07:16:10 -0500163/lib Library routines generic to all architectures
164/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500165/net Networking code
166/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500167/scripts Various build scripts and Makefiles
168/test Various unit test files
Peter Tyser8d321b82010-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200186 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000187
Robert P. J. Day7207b362015-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 Freytherab584d62014-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 Freytherab584d62014-08-04 09:26:05 +0200204 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000205
Robert P. J. Day7207b362015-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 Glass75b3c3a2014-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 Teki6b1978f2014-08-31 21:19:43 +0530218See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600219
220
Simon Glassdb910352015-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. Day7207b362015-12-19 07:16:10 -0500225SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700226
Robert P. J. Day7207b362015-12-19 07:16:10 -0500227Note: "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.
234
235Execution 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 Glassdb910352015-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
wdenk7f6c2cb2002-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 Phillips26281142007-08-10 13:28:25 -0500320- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000321
Kim Phillips26281142007-08-10 13:28:25 -0500322- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200323
324- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-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 Ziswiler11ccc332008-07-09 08:17:15 +0200345 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000346 a "rotator" |\-/|\-/
347
Lei Wencf946c62011-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 Ziswiler11ccc332008-07-09 08:17:15 +0200353- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000354 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
355 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000356 e.g. if there is no 32KHz
357 reference PIT/RTC clock
wdenk66ca92a2004-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
wdenk66ca92a2004-09-28 17:59:53 +0000361- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200362 CONFIG_SYS_8xx_CPUCLK_MIN
363 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000364 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000365 See doc/README.MPC866
366
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200367 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000368
wdenkba56f622004-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200374 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000375
Heiko Schocher506f3912009-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 Gala66412c62011-02-18 05:40:54 -0600381- 85xx CPU Options:
York Sunffd06e02012-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 Gala66412c62011-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 Gala8f290842011-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 Kushwahaafa6b552012-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 Wood33eee332012-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 Kushwaha74fa22e2013-04-16 13:27:44 +0530428 CONFIG_A003399_NOR_WORKAROUND
429 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800430 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530431
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530432 CONFIG_A008044_WORKAROUND
433 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800434 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530435
Scott Wood33eee332012-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 Jain64501c62013-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 Jain765b0bd2013-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 Jain64501c62013-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 Jain765b0bd2013-04-04 09:31:54 +0530453 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
454 This value denotes start offset of DSP CCSR space.
455
Priyanka Jainb1359912013-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 Bansalfb4a2402014-03-18 23:40:26 +0530461 CONFIG_SYS_CPC_REINIT_F
462 This CONFIG is defined when the CPC is configured as SRAM at the
463 time of U-boot entry and is required to be re-initialized.
464
Tang Yuantianaade2002014-04-17 15:33:46 +0800465 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800466 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800467 supported, core will start to execute uboot when wakes up.
468
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000469- Generic CPU options:
York Sun2a1680e2014-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 Schwierzeck6cb461b2012-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 Sun5614e712013-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 Sun34e026f2014-03-27 17:54:47 -0700502 CONFIG_SYS_FSL_DDRC_GEN4
503 Freescale DDR4 controller.
504
York Sun9ac4ffb2013-09-30 14:20:51 -0700505 CONFIG_SYS_FSL_DDRC_ARM_GEN3
506 Freescale DDR3 controller for ARM-based SoCs.
507
York Sun5614e712013-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 Sun34e026f2014-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 Sun5614e712013-09-30 09:22:09 -0700529
Prabhakar Kushwaha1b4175d2014-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 Kushwaha690e4252014-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 Kushwaha89ad7be2014-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 Sun4e5b1bd2014-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 Sun6b9e3092014-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 Sun6b1e1252014-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 Sun1d71efb2014-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 Kushwaha44937212015-11-09 16:42:07 +0530571 CONFIG_SYS_FSL_HAS_DP_DDR
572 Defines the SoC has DP-DDR used for DPAA.
573
Ruchika Gupta028dbb82014-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 Klotzbuecher0b953ff2006-03-24 15:28:02 +0100580- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200581 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-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-VILLARD6d0f6bc2008-10-16 15:01:15 +0200587 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200588
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100589 Defines the Monahans turbo mode to oscillator
590 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200591 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100592 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200593
Daniel Schwierzeck92bbd642011-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 Rieschb67d8812012-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 V5356f542012-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 Warrenc5d47522013-03-04 13:29:40 +0000640 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000641 CONFIG_ARM_ERRATA_742230
642 CONFIG_ARM_ERRATA_743622
643 CONFIG_ARM_ERRATA_751472
Nitin Gargb7588e32014-04-02 08:55:02 -0500644 CONFIG_ARM_ERRATA_761320
Ian Campbelle392b922015-09-29 10:27:09 +0100645 CONFIG_ARM_ERRATA_773022
646 CONFIG_ARM_ERRATA_774769
647 CONFIG_ARM_ERRATA_794072
Stephen Warren06785872013-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 Sun207774b2015-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 Menonc616a0d2015-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 Menon5902f4c2015-03-09 17:12:01 -0500666 CONFIG_ARM_ERRATA_430973
Nishanth Menonb45c48a2015-03-09 17:12:00 -0500667 CONFIG_ARM_ERRATA_454179
Nishanth Menon9b4d65f2015-03-09 17:12:02 -0500668 CONFIG_ARM_ERRATA_621766
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500669 CONFIG_ARM_ERRATA_798870
Nishanth Menona615d0b2015-07-27 16:26:05 -0500670 CONFIG_ARM_ERRATA_801819
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500671
Stephen Warren73c38932015-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
wdenk5da627a2003-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 Denk218ca722008-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
wdenk5da627a2003-10-09 20:09:04 +0000693 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
694
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800695 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-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 Barenfec6d9e2008-06-03 20:34:45 -0400699 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200700
701 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-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 Phillips3bb342f2007-08-10 14:34:14 -0500708 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400709
Marcel Ziswilerb55ae402009-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 Denkf57f70a2005-10-13 01:45:54 +0200714 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600715 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200716
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200717 boards with QUICC Engines require OF_QE to set UCC MAC
718 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500719
Kumar Gala4e253132006-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
wdenk6705d812004-08-02 23:22:59 +0000724
Simon Glassc654b512014-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 McClintock02677682006-06-28 10:41:37 -0500732 CONFIG_OF_BOOT_CPU
733
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200734 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500735 param header, the default value is zero if undefined.
736
Heiko Schocher3887c3f2009-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 Grinberg7eb29392011-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 Giger0b2f4ec2008-11-03 22:13:47 +0100756- vxWorks boot parameters:
757
758 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700759 environments variables: bootdev, bootfile, ipaddr, netmask,
760 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100761 It loads the vxWorks image pointed bootfile.
762
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100763 Note: If a "bootargs" environment is defined, it will overwride
764 the defaults discussed just above.
765
Aneesh V2c451f72011-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 V93bc2192011-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
wdenk6705d812004-08-02 23:22:59 +0000777- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200778 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000779
780 Define this if you want support for Amba PrimeCell PL010 UARTs.
781
Andreas Engel48d01922008-09-08 14:30:53 +0200782 CONFIG_PL011_SERIAL
wdenk6705d812004-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, Muralidharand57dee52014-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
wdenk6705d812004-08-02 23:22:59 +0000801
wdenkc6097192002-11-03 00:24:07 +0000802- Console Interface:
wdenk43d96162003-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 Denkc53043b2011-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)
wdenkba56f622004-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)
wdenkba56f622004-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 Glass39f615e2015-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 Glass39f615e2015-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 Glass39f615e2015-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
wdenka6c7ad22002-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 Ziswiler11ccc332008-07-09 08:17:15 +0200841 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000842 the logo
843
Pali Rohár33a35bb2012-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
wdenk43d96162003-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
wdenkd4ca31c2004-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.
wdenka3ad8e22003-10-19 23:22:11 +0000856
Heiko Schocher45ae2542013-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-VILLARD6d0f6bc2008-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 Schocherc92fac92009-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 Schocher2b3f12c2009-02-10 09:31:47 +0100871 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-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 Russ9558b482011-09-01 00:48:27 +0000876- Pre-Console Buffer:
Wolfgang Denk4cf26092011-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 Denk6feff892011-10-09 21:06:34 +0200884 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200885 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000886
Hans de Goedea8552c72015-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 Denk4cf26092011-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 Russ9558b482011-09-01 00:48:27 +0000892
Sonny Rao046a37b2011-11-02 09:52:08 +0000893- Safe printf() functions
894 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
895 the printf() functions. These are defined in
896 include/vsprintf.h and include snprintf(), vsnprintf() and
897 so on. Code size increase is approximately 300-500 bytes.
898 If this option is not given then these functions will
899 silently discard their buffer size argument - this means
900 you are not getting any overflow checking in this case.
901
wdenkc6097192002-11-03 00:24:07 +0000902- Boot Delay: CONFIG_BOOTDELAY - in seconds
903 Delay before automatically booting the default image;
904 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000905 set to -2 to autoboot with no delay and not check for abort
906 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000907
908 See doc/README.autoboot for these options that
909 work with CONFIG_BOOTDELAY. None are required.
910 CONFIG_BOOT_RETRY_TIME
911 CONFIG_BOOT_RETRY_MIN
912 CONFIG_AUTOBOOT_KEYED
913 CONFIG_AUTOBOOT_PROMPT
914 CONFIG_AUTOBOOT_DELAY_STR
915 CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +0000916 CONFIG_ZERO_BOOTDELAY_CHECK
917 CONFIG_RESET_TO_RETRY
918
919- Autoboot Command:
920 CONFIG_BOOTCOMMAND
921 Only needed when CONFIG_BOOTDELAY is enabled;
922 define a command string that is automatically executed
923 when no character is read on the console interface
924 within "Boot Delay" after reset.
925
926 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000927 This can be used to pass arguments to the bootm
928 command. The value of CONFIG_BOOTARGS goes into the
929 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000930
931 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000932 The value of these goes into the environment as
933 "ramboot" and "nfsboot" respectively, and can be used
934 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200935 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000936
Heiko Schochereda0ba32013-11-04 14:04:59 +0100937- Bootcount:
938 CONFIG_BOOTCOUNT_LIMIT
939 Implements a mechanism for detecting a repeating reboot
940 cycle, see:
941 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
942
943 CONFIG_BOOTCOUNT_ENV
944 If no softreset save registers are found on the hardware
945 "bootcount" is stored in the environment. To prevent a
946 saveenv on all reboots, the environment variable
947 "upgrade_available" is used. If "upgrade_available" is
948 0, "bootcount" is always 0, if "upgrade_available" is
949 1 "bootcount" is incremented in the environment.
950 So the Userspace Applikation must set the "upgrade_available"
951 and "bootcount" variable to 0, if a boot was successfully.
952
wdenkc6097192002-11-03 00:24:07 +0000953- Pre-Boot Commands:
954 CONFIG_PREBOOT
955
956 When this option is #defined, the existence of the
957 environment variable "preboot" will be checked
958 immediately before starting the CONFIG_BOOTDELAY
959 countdown and/or running the auto-boot command resp.
960 entering interactive mode.
961
962 This feature is especially useful when "preboot" is
963 automatically generated or modified. For an example
964 see the LWMON board specific code: here "preboot" is
965 modified when the user holds down a certain
966 combination of keys on the (special) keyboard when
967 booting the systems
968
969- Serial Download Echo Mode:
970 CONFIG_LOADS_ECHO
971 If defined to 1, all characters received during a
972 serial download (using the "loads" command) are
973 echoed back. This might be needed by some terminal
974 emulations (like "cu"), but may as well just take
975 time on others. This setting #define's the initial
976 value of the "loads_echo" environment variable.
977
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500978- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000979 CONFIG_KGDB_BAUDRATE
980 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200981 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000982
983- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500984 Monitor commands can be included or excluded
985 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000986 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500987 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000988
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500989 The default command configuration includes all commands
990 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000991
Marek Vasutb401b732014-03-05 19:58:39 +0100992 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500993 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500994 CONFIG_CMD_BDI bdinfo
995 CONFIG_CMD_BEDBUG * Include BedBug Debugger
996 CONFIG_CMD_BMP * BMP support
997 CONFIG_CMD_BSP * Board specific commands
998 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400999 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001000 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001001 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001003 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001004 CONFIG_CMD_DATE * support for RTC, date/time...
1005 CONFIG_CMD_DHCP * DHCP support
1006 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001007 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1008 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1009 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1010 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001011 CONFIG_CMD_DTT * Digital Therm and Thermostat
1012 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001013 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001014 CONFIG_CMD_EEPROM * EEPROM read/write support
1015 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001016 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001017 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001018 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001019 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001020 CONFIG_CMD_EXT2 * ext2 command support
1021 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001022 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1023 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001024 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001025 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001026 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001027 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001028 CONFIG_CMD_FLASH flinfo, erase, protect
1029 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001030 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001031 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001032 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001033 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001034 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001035 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1036 CONFIG_CMD_I2C * I2C serial bus support
1037 CONFIG_CMD_IDE * IDE harddisk support
1038 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001039 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001040 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001041 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001042 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001043 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001044 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001045 CONFIG_CMD_IRQ * irqinfo
1046 CONFIG_CMD_ITEST Integer/string test of 2 values
1047 CONFIG_CMD_JFFS2 * JFFS2 Support
1048 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001049 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001050 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1051 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001052 CONFIG_CMD_LOADB loadb
1053 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001054 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001055 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001056 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001057 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001058 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001059 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001060 CONFIG_CMD_MISC Misc functions like sleep etc
1061 CONFIG_CMD_MMC * MMC memory mapped support
1062 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001063 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001064 CONFIG_CMD_NAND * NAND support
1065 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001066 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001067 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001068 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069 CONFIG_CMD_PCI * pciinfo
1070 CONFIG_CMD_PCMCIA * PCMCIA support
1071 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1072 host
1073 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001074 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001075 CONFIG_CMD_REGINFO * Register dump
1076 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001077 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001078 CONFIG_CMD_SAVES * save S record dump
1079 CONFIG_CMD_SCSI * SCSI Support
1080 CONFIG_CMD_SDRAM * print SDRAM configuration information
1081 (requires CONFIG_CMD_I2C)
1082 CONFIG_CMD_SETGETDCR Support for DCR Register access
1083 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001084 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001085 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001086 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001087 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001088 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001089 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001090 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001091 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001092 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1093 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001094 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001095 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001096 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001097 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001098 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001099
1100 EXAMPLE: If you want all functions except of network
1101 support you can write:
1102
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001103 #include "config_cmd_all.h"
1104 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001105
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001106 Other Commands:
1107 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001108
1109 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001110 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001111 what you (and your U-Boot users) are doing. Data
1112 cache cannot be enabled on systems like the 8xx or
1113 8260 (where accesses to the IMMR region must be
1114 uncached), and it cannot be disabled on all other
1115 systems where we (mis-) use the data cache to hold an
1116 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001117
1118
1119 XXX - this list needs to get updated!
1120
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001121- Regular expression support:
1122 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001123 If this variable is defined, U-Boot is linked against
1124 the SLRE (Super Light Regular Expression) library,
1125 which adds regex support to some commands, as for
1126 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001127
Simon Glass45ba8072011-10-15 05:48:20 +00001128- Device tree:
1129 CONFIG_OF_CONTROL
1130 If this variable is defined, U-Boot will use a device tree
1131 to configure its devices, instead of relying on statically
1132 compiled #defines in the board file. This option is
1133 experimental and only available on a few boards. The device
1134 tree is available in the global data as gd->fdt_blob.
1135
Simon Glass2c0f79e2011-10-24 19:15:31 +00001136 U-Boot needs to get its device tree from somewhere. This can
1137 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001138
1139 CONFIG_OF_EMBED
1140 If this variable is defined, U-Boot will embed a device tree
1141 binary in its image. This device tree file should be in the
1142 board directory and called <soc>-<board>.dts. The binary file
1143 is then picked up in board_init_f() and made available through
1144 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001145
Simon Glass2c0f79e2011-10-24 19:15:31 +00001146 CONFIG_OF_SEPARATE
1147 If this variable is defined, U-Boot will build a device tree
1148 binary. It will be called u-boot.dtb. Architecture-specific
1149 code will locate it at run-time. Generally this works by:
1150
1151 cat u-boot.bin u-boot.dtb >image.bin
1152
1153 and in fact, U-Boot does this for you, creating a file called
1154 u-boot-dtb.bin which is useful in the common case. You can
1155 still use the individual files if you need something more
1156 exotic.
1157
wdenkc6097192002-11-03 00:24:07 +00001158- Watchdog:
1159 CONFIG_WATCHDOG
1160 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001161 support for the SoC. There must be support in the SoC
1162 specific code for a watchdog. For the 8xx and 8260
1163 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1164 register. When supported for a specific SoC is
1165 available, then no further board specific code should
1166 be needed to use it.
1167
1168 CONFIG_HW_WATCHDOG
1169 When using a watchdog circuitry external to the used
1170 SoC, then define this variable and provide board
1171 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001172
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001173 CONFIG_AT91_HW_WDT_TIMEOUT
1174 specify the timeout in seconds. default 2 seconds.
1175
stroesec1551ea2003-04-04 15:53:41 +00001176- U-Boot Version:
1177 CONFIG_VERSION_VARIABLE
1178 If this variable is defined, an environment variable
1179 named "ver" is created by U-Boot showing the U-Boot
1180 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e512012-08-13 15:01:14 +02001181 Any change to this variable will be reverted at the
1182 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001183
wdenkc6097192002-11-03 00:24:07 +00001184- Real-Time Clock:
1185
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001186 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001187 has to be selected, too. Define exactly one of the
1188 following options:
1189
1190 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1191 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001192 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001193 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001194 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001195 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001196 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001197 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001198 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001199 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001200 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001201 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001202 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1203 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001204
wdenkb37c7e52003-06-30 16:24:52 +00001205 Note that if the RTC uses I2C, then the I2C interface
1206 must also be configured. See I2C Support, below.
1207
Peter Tysere92739d2008-12-17 16:36:21 -06001208- GPIO Support:
1209 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001210
Chris Packham5dec49c2010-12-19 10:12:13 +00001211 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1212 chip-ngpio pairs that tell the PCA953X driver the number of
1213 pins supported by a particular chip.
1214
Peter Tysere92739d2008-12-17 16:36:21 -06001215 Note that if the GPIO device uses I2C, then the I2C interface
1216 must also be configured. See I2C Support, below.
1217
Simon Glassaa532332014-06-11 23:29:41 -06001218- I/O tracing:
1219 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1220 accesses and can checksum them or write a list of them out
1221 to memory. See the 'iotrace' command for details. This is
1222 useful for testing device drivers since it can confirm that
1223 the driver behaves the same way before and after a code
1224 change. Currently this is supported on sandbox and arm. To
1225 add support for your architecture, add '#include <iotrace.h>'
1226 to the bottom of arch/<arch>/include/asm/io.h and test.
1227
1228 Example output from the 'iotrace stats' command is below.
1229 Note that if the trace buffer is exhausted, the checksum will
1230 still continue to operate.
1231
1232 iotrace is enabled
1233 Start: 10000000 (buffer start address)
1234 Size: 00010000 (buffer size)
1235 Offset: 00000120 (current buffer offset)
1236 Output: 10000120 (start + offset)
1237 Count: 00000018 (number of trace records)
1238 CRC32: 9526fb66 (CRC32 of all trace records)
1239
wdenkc6097192002-11-03 00:24:07 +00001240- Timestamp Support:
1241
wdenk43d96162003-03-06 00:02:04 +00001242 When CONFIG_TIMESTAMP is selected, the timestamp
1243 (date and time) of an image is printed by image
1244 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001245 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001246
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001247- Partition Labels (disklabels) Supported:
1248 Zero or more of the following:
1249 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1250 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1251 Intel architecture, USB sticks, etc.
1252 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1253 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1254 bootloader. Note 2TB partition limit; see
1255 disk/part_efi.c
1256 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001257
Wolfgang Denk218ca722008-03-26 10:40:12 +01001258 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1259 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001260 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001261
1262- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001263 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1264 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001265
wdenk4d13cba2004-03-14 14:09:05 +00001266 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1267 be performed by calling the function
1268 ide_set_reset(int reset)
1269 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001270
1271- ATAPI Support:
1272 CONFIG_ATAPI
1273
1274 Set this to enable ATAPI support.
1275
wdenkc40b2952004-03-13 23:29:43 +00001276- LBA48 Support
1277 CONFIG_LBA48
1278
1279 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001280 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001281 Whithout these , LBA48 support uses 32bit variables and will 'only'
1282 support disks up to 2.1TB.
1283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001284 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001285 When enabled, makes the IDE subsystem use 64bit sector addresses.
1286 Default is 32bit.
1287
wdenkc6097192002-11-03 00:24:07 +00001288- SCSI Support:
1289 At the moment only there is only support for the
1290 SYM53C8XX SCSI controller; define
1291 CONFIG_SCSI_SYM53C8XX to enable it.
1292
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001293 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1294 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1295 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001296 maximum numbers of LUNs, SCSI ID's and target
1297 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001298 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001299
Wolfgang Denk93e14592013-10-04 17:43:24 +02001300 The environment variable 'scsidevs' is set to the number of
1301 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001302
wdenkc6097192002-11-03 00:24:07 +00001303- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001304 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001305 Support for Intel 8254x/8257x gigabit chips.
1306
1307 CONFIG_E1000_SPI
1308 Utility code for direct access to the SPI bus on Intel 8257x.
1309 This does not do anything useful unless you set at least one
1310 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1311
1312 CONFIG_E1000_SPI_GENERIC
1313 Allow generic access to the SPI bus on the Intel 8257x, for
1314 example with the "sspi" command.
1315
1316 CONFIG_CMD_E1000
1317 Management command for E1000 devices. When used on devices
1318 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001319
wdenkc6097192002-11-03 00:24:07 +00001320 CONFIG_EEPRO100
1321 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001322 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001323 write routine for first time initialisation.
1324
1325 CONFIG_TULIP
1326 Support for Digital 2114x chips.
1327 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1328 modem chip initialisation (KS8761/QS6611).
1329
1330 CONFIG_NATSEMI
1331 Support for National dp83815 chips.
1332
1333 CONFIG_NS8382X
1334 Support for National dp8382[01] gigabit chips.
1335
wdenk45219c42003-05-12 21:50:16 +00001336- NETWORK Support (other):
1337
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001338 CONFIG_DRIVER_AT91EMAC
1339 Support for AT91RM9200 EMAC.
1340
1341 CONFIG_RMII
1342 Define this to use reduced MII inteface
1343
1344 CONFIG_DRIVER_AT91EMAC_QUIET
1345 If this defined, the driver is quiet.
1346 The driver doen't show link status messages.
1347
Rob Herringefdd7312011-12-15 11:15:49 +00001348 CONFIG_CALXEDA_XGMAC
1349 Support for the Calxeda XGMAC device
1350
Ashok3bb46d22012-10-15 06:20:47 +00001351 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001352 Support for SMSC's LAN91C96 chips.
1353
1354 CONFIG_LAN91C96_BASE
1355 Define this to hold the physical address
1356 of the LAN91C96's I/O space
1357
1358 CONFIG_LAN91C96_USE_32_BIT
1359 Define this to enable 32 bit addressing
1360
Ashok3bb46d22012-10-15 06:20:47 +00001361 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001362 Support for SMSC's LAN91C111 chip
1363
1364 CONFIG_SMC91111_BASE
1365 Define this to hold the physical address
1366 of the device (I/O space)
1367
1368 CONFIG_SMC_USE_32_BIT
1369 Define this if data bus is 32 bits
1370
1371 CONFIG_SMC_USE_IOFUNCS
1372 Define this to use i/o functions instead of macros
1373 (some hardware wont work with macros)
1374
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001375 CONFIG_DRIVER_TI_EMAC
1376 Support for davinci emac
1377
1378 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1379 Define this if you have more then 3 PHYs.
1380
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001381 CONFIG_FTGMAC100
1382 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1383
1384 CONFIG_FTGMAC100_EGIGA
1385 Define this to use GE link update with gigabit PHY.
1386 Define this if FTGMAC100 is connected to gigabit PHY.
1387 If your system has 10/100 PHY only, it might not occur
1388 wrong behavior. Because PHY usually return timeout or
1389 useless data when polling gigabit status and gigabit
1390 control registers. This behavior won't affect the
1391 correctnessof 10/100 link speed update.
1392
Mike Rapoportc2fff332009-11-11 10:03:03 +02001393 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001394 Support for SMSC's LAN911x and LAN921x chips
1395
Mike Rapoportc2fff332009-11-11 10:03:03 +02001396 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001397 Define this to hold the physical address
1398 of the device (I/O space)
1399
Mike Rapoportc2fff332009-11-11 10:03:03 +02001400 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001401 Define this if data bus is 32 bits
1402
Mike Rapoportc2fff332009-11-11 10:03:03 +02001403 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001404 Define this if data bus is 16 bits. If your processor
1405 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001406 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001407
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001408 CONFIG_SH_ETHER
1409 Support for Renesas on-chip Ethernet controller
1410
1411 CONFIG_SH_ETHER_USE_PORT
1412 Define the number of ports to be used
1413
1414 CONFIG_SH_ETHER_PHY_ADDR
1415 Define the ETH PHY's address
1416
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001417 CONFIG_SH_ETHER_CACHE_WRITEBACK
1418 If this option is set, the driver enables cache flush.
1419
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001420- PWM Support:
1421 CONFIG_PWM_IMX
1422 Support for PWM modul on the imx6.
1423
Vadim Bendebury5e124722011-10-17 08:36:14 +00001424- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001425 CONFIG_TPM
1426 Support TPM devices.
1427
Christophe Ricard0766ad22015-10-06 22:54:41 +02001428 CONFIG_TPM_TIS_INFINEON
1429 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001430 per system is supported at this time.
1431
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001432 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1433 Define the burst count bytes upper limit
1434
Dirk Eibachc01939c2013-06-26 15:55:15 +02001435 CONFIG_TPM_ATMEL_TWI
1436 Support for Atmel TWI TPM device. Requires I2C support.
1437
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001438 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001439 Support for generic parallel port TPM devices. Only one device
1440 per system is supported at this time.
1441
1442 CONFIG_TPM_TIS_BASE_ADDRESS
1443 Base address where the generic TPM device is mapped
1444 to. Contemporary x86 systems usually map it at
1445 0xfed40000.
1446
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001447 CONFIG_CMD_TPM
1448 Add tpm monitor functions.
1449 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1450 provides monitor access to authorized functions.
1451
1452 CONFIG_TPM
1453 Define this to enable the TPM support library which provides
1454 functional interfaces to some TPM commands.
1455 Requires support for a TPM device.
1456
1457 CONFIG_TPM_AUTH_SESSIONS
1458 Define this to enable authorized functions in the TPM library.
1459 Requires CONFIG_TPM and CONFIG_SHA1.
1460
wdenkc6097192002-11-03 00:24:07 +00001461- USB Support:
1462 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001463 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001464 CONFIG_USB_UHCI to enable it.
1465 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001466 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001467 storage devices.
1468 Note:
1469 Supported are USB Keyboards and USB Floppy drives
1470 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001471 MPC5200 USB requires additional defines:
1472 CONFIG_USB_CLOCK
1473 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001474 CONFIG_PSC3_USB
1475 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001476 CONFIG_USB_CONFIG
1477 for differential drivers: 0x00001000
1478 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001479 for differential drivers on PSC3: 0x00000100
1480 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001481 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001482 May be defined to allow interrupt polling
1483 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001484
Simon Glass9ab4ce22012-02-27 10:52:47 +00001485 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1486 txfilltuning field in the EHCI controller on reset.
1487
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001488 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1489 HW module registers.
1490
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001491- USB Device:
1492 Define the below if you wish to use the USB console.
1493 Once firmware is rebuilt from a serial console issue the
1494 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001495 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001496 it has found a new device. The environment variable usbtty
1497 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001498 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001499 Common Device Class Abstract Control Model serial device.
1500 If you select usbtty = gserial you should be able to enumerate
1501 a Linux host by
1502 # modprobe usbserial vendor=0xVendorID product=0xProductID
1503 else if using cdc_acm, simply setting the environment
1504 variable usbtty to be cdc_acm should suffice. The following
1505 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001506
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001507 CONFIG_USB_DEVICE
1508 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001509
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001510 CONFIG_USB_TTY
1511 Define this to have a tty type of device available to
1512 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001513
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301514 CONFIG_USBD_HS
1515 Define this to enable the high speed support for usb
1516 device and usbtty. If this feature is enabled, a routine
1517 int is_usbd_high_speed(void)
1518 also needs to be defined by the driver to dynamically poll
1519 whether the enumeration has succeded at high speed or full
1520 speed.
1521
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001522 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001523 Define this if you want stdin, stdout &/or stderr to
1524 be set to usbtty.
1525
1526 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001527 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001528 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001529 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001530
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001531 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001532 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001533 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001534
Wolfgang Denk386eda02006-06-14 18:14:56 +02001535 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001536 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001537 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001538 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1539 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1540 should pretend to be a Linux device to it's target host.
1541
1542 CONFIG_USBD_MANUFACTURER
1543 Define this string as the name of your company for
1544 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001545
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001546 CONFIG_USBD_PRODUCT_NAME
1547 Define this string as the name of your product
1548 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1549
1550 CONFIG_USBD_VENDORID
1551 Define this as your assigned Vendor ID from the USB
1552 Implementors Forum. This *must* be a genuine Vendor ID
1553 to avoid polluting the USB namespace.
1554 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001555
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001556 CONFIG_USBD_PRODUCTID
1557 Define this as the unique Product ID
1558 for your device
1559 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001560
Igor Grinbergd70a5602011-12-12 12:08:35 +02001561- ULPI Layer Support:
1562 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1563 the generic ULPI layer. The generic layer accesses the ULPI PHY
1564 via the platform viewport, so you need both the genric layer and
1565 the viewport enabled. Currently only Chipidea/ARC based
1566 viewport is supported.
1567 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1568 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001569 If your ULPI phy needs a different reference clock than the
1570 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1571 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001572
1573- MMC Support:
1574 The MMC controller on the Intel PXA is supported. To
1575 enable this define CONFIG_MMC. The MMC can be
1576 accessed from the boot prompt by mapping the device
1577 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001578 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1579 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001580
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001581 CONFIG_SH_MMCIF
1582 Support for Renesas on-chip MMCIF controller
1583
1584 CONFIG_SH_MMCIF_ADDR
1585 Define the base address of MMCIF registers
1586
1587 CONFIG_SH_MMCIF_CLK
1588 Define the clock frequency for MMCIF
1589
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001590 CONFIG_GENERIC_MMC
1591 Enable the generic MMC driver
1592
1593 CONFIG_SUPPORT_EMMC_BOOT
1594 Enable some additional features of the eMMC boot partitions.
1595
1596 CONFIG_SUPPORT_EMMC_RPMB
1597 Enable the commands for reading, writing and programming the
1598 key for the Replay Protection Memory Block partition in eMMC.
1599
Tom Rinib3ba6e92013-03-14 05:32:47 +00001600- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001601 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001602 This enables the USB portion of the DFU USB class
1603
1604 CONFIG_CMD_DFU
1605 This enables the command "dfu" which is used to have
1606 U-Boot create a DFU class device via USB. This command
1607 requires that the "dfu_alt_info" environment variable be
1608 set and define the alt settings to expose to the host.
1609
1610 CONFIG_DFU_MMC
1611 This enables support for exposing (e)MMC devices via DFU.
1612
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001613 CONFIG_DFU_NAND
1614 This enables support for exposing NAND devices via DFU.
1615
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301616 CONFIG_DFU_RAM
1617 This enables support for exposing RAM via DFU.
1618 Note: DFU spec refer to non-volatile memory usage, but
1619 allow usages beyond the scope of spec - here RAM usage,
1620 one that would help mostly the developer.
1621
Heiko Schochere7e75c72013-06-12 06:05:51 +02001622 CONFIG_SYS_DFU_DATA_BUF_SIZE
1623 Dfu transfer uses a buffer before writing data to the
1624 raw storage device. Make the size (in bytes) of this buffer
1625 configurable. The size of this buffer is also configurable
1626 through the "dfu_bufsiz" environment variable.
1627
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001628 CONFIG_SYS_DFU_MAX_FILE_SIZE
1629 When updating files rather than the raw storage device,
1630 we use a static buffer to copy the file into and then write
1631 the buffer once we've been given the whole file. Define
1632 this to the maximum filesize (in bytes) for the buffer.
1633 Default is 4 MiB if undefined.
1634
Heiko Schocher001a8312014-03-18 08:09:56 +01001635 DFU_DEFAULT_POLL_TIMEOUT
1636 Poll timeout [ms], is the timeout a device can send to the
1637 host. The host must wait for this timeout before sending
1638 a subsequent DFU_GET_STATUS request to the device.
1639
1640 DFU_MANIFEST_POLL_TIMEOUT
1641 Poll timeout [ms], which the device sends to the host when
1642 entering dfuMANIFEST state. Host waits this timeout, before
1643 sending again an USB request to the device.
1644
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001645- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001646 CONFIG_USB_FUNCTION_FASTBOOT
1647 This enables the USB part of the fastboot gadget
1648
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001649 CONFIG_CMD_FASTBOOT
1650 This enables the command "fastboot" which enables the Android
1651 fastboot mode for the platform's USB device. Fastboot is a USB
1652 protocol for downloading images, flashing and device control
1653 used on Android devices.
1654 See doc/README.android-fastboot for more information.
1655
1656 CONFIG_ANDROID_BOOT_IMAGE
1657 This enables support for booting images which use the Android
1658 image format header.
1659
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001660 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001661 The fastboot protocol requires a large memory buffer for
1662 downloads. Define this to the starting RAM address to use for
1663 downloaded images.
1664
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001665 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001666 The fastboot protocol requires a large memory buffer for
1667 downloads. This buffer should be as large as possible for a
1668 platform. Define this to the size available RAM for fastboot.
1669
Steve Raed1b5ed02014-08-26 11:47:28 -07001670 CONFIG_FASTBOOT_FLASH
1671 The fastboot protocol includes a "flash" command for writing
1672 the downloaded image to a non-volatile storage device. Define
1673 this to enable the "fastboot flash" command.
1674
1675 CONFIG_FASTBOOT_FLASH_MMC_DEV
1676 The fastboot "flash" command requires additional information
1677 regarding the non-volatile storage device. Define this to
1678 the eMMC device that fastboot should use to store the image.
1679
Steve Rae0ff7e582014-12-12 15:51:54 -08001680 CONFIG_FASTBOOT_GPT_NAME
1681 The fastboot "flash" command supports writing the downloaded
1682 image to the Protective MBR and the Primary GUID Partition
1683 Table. (Additionally, this downloaded image is post-processed
1684 to generate and write the Backup GUID Partition Table.)
1685 This occurs when the specified "partition name" on the
1686 "fastboot flash" command line matches this value.
1687 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1688
wdenk6705d812004-08-02 23:22:59 +00001689- Journaling Flash filesystem support:
1690 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1691 CONFIG_JFFS2_NAND_DEV
1692 Define these for a default partition on a NAND device
1693
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001694 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1695 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001696 Define these for a default partition on a NOR device
1697
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001698 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001699 Define this to create an own partition. You have to provide a
1700 function struct part_info* jffs2_part_info(int part_num)
1701
1702 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001703 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001704 to disable the command chpart. This is the default when you
1705 have not defined a custom partition
1706
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001707- FAT(File Allocation Table) filesystem write function support:
1708 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001709
1710 Define this to enable support for saving memory data as a
1711 file in FAT formatted partition.
1712
1713 This will also enable the command "fatwrite" enabling the
1714 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001715
Gabe Black84cd9322012-10-12 14:26:11 +00001716CBFS (Coreboot Filesystem) support
1717 CONFIG_CMD_CBFS
1718
1719 Define this to enable support for reading from a Coreboot
1720 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1721 and cbfsload.
1722
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301723- FAT(File Allocation Table) filesystem cluster size:
1724 CONFIG_FS_FAT_MAX_CLUSTSIZE
1725
1726 Define the max cluster size for fat operations else
1727 a default value of 65536 will be defined.
1728
wdenkc6097192002-11-03 00:24:07 +00001729- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001730 See Kconfig help for available keyboard drivers.
1731
1732 CONFIG_KEYBOARD
1733
1734 Define this to enable a custom keyboard support.
1735 This simply calls drv_keyboard_init() which must be
1736 defined in your board-specific files. This option is deprecated
1737 and is only used by novena. For new boards, use driver model
1738 instead.
wdenkc6097192002-11-03 00:24:07 +00001739
1740- Video support:
1741 CONFIG_VIDEO
1742
1743 Define this to enable video support (for output to
1744 video).
1745
1746 CONFIG_VIDEO_CT69000
1747
1748 Enable Chips & Technologies 69000 Video chip
1749
1750 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001751 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001752 video output is selected via environment 'videoout'
1753 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1754 assumed.
wdenkc6097192002-11-03 00:24:07 +00001755
wdenkb79a11c2004-03-25 15:14:43 +00001756 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001757 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001758 are possible:
1759 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001760 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001761
1762 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1763 -------------+---------------------------------------------
1764 8 bits | 0x301* 0x303 0x305 0x161 0x307
1765 15 bits | 0x310 0x313 0x316 0x162 0x319
1766 16 bits | 0x311 0x314 0x317 0x163 0x31A
1767 24 bits | 0x312 0x315 0x318 ? 0x31B
1768 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001769 (i.e. setenv videomode 317; saveenv; reset;)
1770
wdenkb79a11c2004-03-25 15:14:43 +00001771 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001772 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001773
1774
stroesec1551ea2003-04-04 15:53:41 +00001775 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001776 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001777 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1778 or CONFIG_VIDEO_SED13806_16BPP
1779
Timur Tabi7d3053f2011-02-15 17:09:19 -06001780 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001781 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001782 SOCs that have a DIU should define this macro to enable DIU
1783 support, and should also define these other macros:
1784
1785 CONFIG_SYS_DIU_ADDR
1786 CONFIG_VIDEO
1787 CONFIG_CMD_BMP
1788 CONFIG_CFB_CONSOLE
1789 CONFIG_VIDEO_SW_CURSOR
1790 CONFIG_VGA_AS_SINGLE_DEVICE
1791 CONFIG_VIDEO_LOGO
1792 CONFIG_VIDEO_BMP_LOGO
1793
Timur Tabiba8e76b2011-04-11 14:18:22 -05001794 The DIU driver will look for the 'video-mode' environment
1795 variable, and if defined, enable the DIU as a console during
1796 boot. See the documentation file README.video for a
1797 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001798
wdenkc6097192002-11-03 00:24:07 +00001799- LCD Support: CONFIG_LCD
1800
1801 Define this to enable LCD support (for output to LCD
1802 display); also select one of the supported displays
1803 by defining one of these:
1804
Stelian Pop39cf4802008-05-09 21:57:18 +02001805 CONFIG_ATMEL_LCD:
1806
1807 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1808
wdenkfd3103b2003-11-25 16:55:19 +00001809 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001810
wdenkfd3103b2003-11-25 16:55:19 +00001811 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001812
wdenkfd3103b2003-11-25 16:55:19 +00001813 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001814
wdenkfd3103b2003-11-25 16:55:19 +00001815 NEC NL6448BC20-08. 6.5", 640x480.
1816 Active, color, single scan.
1817
1818 CONFIG_NEC_NL6448BC33_54
1819
1820 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001821 Active, color, single scan.
1822
1823 CONFIG_SHARP_16x9
1824
1825 Sharp 320x240. Active, color, single scan.
1826 It isn't 16x9, and I am not sure what it is.
1827
1828 CONFIG_SHARP_LQ64D341
1829
1830 Sharp LQ64D341 display, 640x480.
1831 Active, color, single scan.
1832
1833 CONFIG_HLD1045
1834
1835 HLD1045 display, 640x480.
1836 Active, color, single scan.
1837
1838 CONFIG_OPTREX_BW
1839
1840 Optrex CBL50840-2 NF-FW 99 22 M5
1841 or
1842 Hitachi LMG6912RPFC-00T
1843 or
1844 Hitachi SP14Q002
1845
1846 320x240. Black & white.
1847
1848 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001849 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001850
Simon Glass676d3192012-10-17 13:24:54 +00001851 CONFIG_LCD_ALIGNMENT
1852
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001853 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001854 defined then the LCD will be aligned to this value instead.
1855 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1856 here, since it is cheaper to change data cache settings on
1857 a per-section basis.
1858
Simon Glass0d89efe2012-10-17 13:24:59 +00001859 CONFIG_CONSOLE_SCROLL_LINES
1860
1861 When the console need to be scrolled, this is the number of
1862 lines to scroll by. It defaults to 1. Increasing this makes
1863 the console jump but can help speed up operation when scrolling
1864 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001865
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001866 CONFIG_LCD_ROTATION
1867
1868 Sometimes, for example if the display is mounted in portrait
1869 mode or even if it's mounted landscape but rotated by 180degree,
1870 we need to rotate our content of the display relative to the
1871 framebuffer, so that user can read the messages which are
1872 printed out.
1873 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1874 initialized with a given rotation from "vl_rot" out of
1875 "vidinfo_t" which is provided by the board specific code.
1876 The value for vl_rot is coded as following (matching to
1877 fbcon=rotate:<n> linux-kernel commandline):
1878 0 = no rotation respectively 0 degree
1879 1 = 90 degree rotation
1880 2 = 180 degree rotation
1881 3 = 270 degree rotation
1882
1883 If CONFIG_LCD_ROTATION is not defined, the console will be
1884 initialized with 0degree rotation.
1885
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001886 CONFIG_LCD_BMP_RLE8
1887
1888 Support drawing of RLE8-compressed bitmaps on the LCD.
1889
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001890 CONFIG_I2C_EDID
1891
1892 Enables an 'i2c edid' command which can read EDID
1893 information over I2C from an attached LCD display.
1894
wdenk7152b1d2003-09-05 23:19:14 +00001895- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001896
wdenk8bde7f72003-06-27 21:31:46 +00001897 If this option is set, the environment is checked for
1898 a variable "splashimage". If found, the usual display
1899 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001900 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001901 specified in "splashimage" is loaded instead. The
1902 console is redirected to the "nulldev", too. This
1903 allows for a "silent" boot where a splash screen is
1904 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001905
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001906 CONFIG_SPLASHIMAGE_GUARD
1907
1908 If this option is set, then U-Boot will prevent the environment
1909 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001910 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001911 This option is useful for targets where, due to alignment
1912 restrictions, an improperly aligned BMP image will cause a data
1913 abort. If you think you will not have problems with unaligned
1914 accesses (for example because your toolchain prevents them)
1915 there is no need to set this option.
1916
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001917 CONFIG_SPLASH_SCREEN_ALIGN
1918
1919 If this option is set the splash image can be freely positioned
1920 on the screen. Environment variable "splashpos" specifies the
1921 position as "x,y". If a positive number is given it is used as
1922 number of pixel from left/top. If a negative number is given it
1923 is used as number of pixel from right/bottom. You can also
1924 specify 'm' for centering the image.
1925
1926 Example:
1927 setenv splashpos m,m
1928 => image at center of screen
1929
1930 setenv splashpos 30,20
1931 => image at x = 30 and y = 20
1932
1933 setenv splashpos -10,m
1934 => vertically centered image
1935 at x = dspWidth - bmpWidth - 9
1936
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001937- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1938
1939 If this option is set, additionally to standard BMP
1940 images, gzipped BMP images can be displayed via the
1941 splashscreen support or the bmp command.
1942
Anatolij Gustschind5011762010-03-15 14:50:25 +01001943- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1944
1945 If this option is set, 8-bit RLE compressed BMP images
1946 can be displayed via the splashscreen support or the
1947 bmp command.
1948
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001949- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00001950 CONFIG_CMD_ZIP
1951
1952 If this option is set, it would use zlib deflate method
1953 to compress the specified memory at its best effort.
1954
wdenkc29fdfc2003-08-29 20:57:53 +00001955- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001956 CONFIG_GZIP
1957
1958 Enabled by default to support gzip compressed images.
1959
wdenkc29fdfc2003-08-29 20:57:53 +00001960 CONFIG_BZIP2
1961
1962 If this option is set, support for bzip2 compressed
1963 images is included. If not, only uncompressed and gzip
1964 compressed images are supported.
1965
wdenk42d1f032003-10-15 23:53:47 +00001966 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001967 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001968 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001969
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001970 CONFIG_LZMA
1971
1972 If this option is set, support for lzma compressed
1973 images is included.
1974
1975 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1976 requires an amount of dynamic memory that is given by the
1977 formula:
1978
1979 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1980
1981 Where lc and lp stand for, respectively, Literal context bits
1982 and Literal pos bits.
1983
1984 This value is upper-bounded by 14MB in the worst case. Anyway,
1985 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1986 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1987 a very small buffer.
1988
1989 Use the lzmainfo tool to determinate the lc and lp values and
1990 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001991 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001992
Kees Cook8ef70472013-08-16 07:59:12 -07001993 CONFIG_LZO
1994
1995 If this option is set, support for LZO compressed images
1996 is included.
1997
wdenk17ea1172004-06-06 21:51:03 +00001998- MII/PHY support:
1999 CONFIG_PHY_ADDR
2000
2001 The address of PHY on MII bus.
2002
2003 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2004
2005 The clock frequency of the MII bus
2006
2007 CONFIG_PHY_GIGE
2008
2009 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002010 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002011
2012 CONFIG_PHY_RESET_DELAY
2013
2014 Some PHY like Intel LXT971A need extra delay after
2015 reset before any MII register access is possible.
2016 For such PHY, set this option to the usec delay
2017 required. (minimum 300usec for LXT971A)
2018
2019 CONFIG_PHY_CMD_DELAY (ppc4xx)
2020
2021 Some PHY like Intel LXT971A need extra delay after
2022 command issued before MII status register can be read
2023
wdenkc6097192002-11-03 00:24:07 +00002024- IP address:
2025 CONFIG_IPADDR
2026
2027 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002028 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002029 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002030 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002031
2032- Server IP address:
2033 CONFIG_SERVERIP
2034
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002035 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002036 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002037 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002038
Robin Getz97cfe862009-07-21 12:15:28 -04002039 CONFIG_KEEP_SERVERADDR
2040
2041 Keeps the server's MAC address, in the env 'serveraddr'
2042 for passing to bootargs (like Linux's netconsole option)
2043
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002044- Gateway IP address:
2045 CONFIG_GATEWAYIP
2046
2047 Defines a default value for the IP address of the
2048 default router where packets to other networks are
2049 sent to.
2050 (Environment variable "gatewayip")
2051
2052- Subnet mask:
2053 CONFIG_NETMASK
2054
2055 Defines a default value for the subnet mask (or
2056 routing prefix) which is used to determine if an IP
2057 address belongs to the local subnet or needs to be
2058 forwarded through a router.
2059 (Environment variable "netmask")
2060
David Updegraff53a5c422007-06-11 10:41:07 -05002061- Multicast TFTP Mode:
2062 CONFIG_MCAST_TFTP
2063
2064 Defines whether you want to support multicast TFTP as per
2065 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002066 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002067 driver in use must provide a function: mcast() to join/leave a
2068 multicast group.
2069
wdenkc6097192002-11-03 00:24:07 +00002070- BOOTP Recovery Mode:
2071 CONFIG_BOOTP_RANDOM_DELAY
2072
2073 If you have many targets in a network that try to
2074 boot using BOOTP, you may want to avoid that all
2075 systems send out BOOTP requests at precisely the same
2076 moment (which would happen for instance at recovery
2077 from a power failure, when all systems will try to
2078 boot, thus flooding the BOOTP server. Defining
2079 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2080 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002081 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002082
2083 1st BOOTP request: delay 0 ... 1 sec
2084 2nd BOOTP request: delay 0 ... 2 sec
2085 3rd BOOTP request: delay 0 ... 4 sec
2086 4th and following
2087 BOOTP requests: delay 0 ... 8 sec
2088
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002089 CONFIG_BOOTP_ID_CACHE_SIZE
2090
2091 BOOTP packets are uniquely identified using a 32-bit ID. The
2092 server will copy the ID from client requests to responses and
2093 U-Boot will use this to determine if it is the destination of
2094 an incoming response. Some servers will check that addresses
2095 aren't in use before handing them out (usually using an ARP
2096 ping) and therefore take up to a few hundred milliseconds to
2097 respond. Network congestion may also influence the time it
2098 takes for a response to make it back to the client. If that
2099 time is too long, U-Boot will retransmit requests. In order
2100 to allow earlier responses to still be accepted after these
2101 retransmissions, U-Boot's BOOTP client keeps a small cache of
2102 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2103 cache. The default is to keep IDs for up to four outstanding
2104 requests. Increasing this will allow U-Boot to accept offers
2105 from a BOOTP client in networks with unusually high latency.
2106
stroesefe389a82003-08-28 14:17:32 +00002107- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002108 You can fine tune the DHCP functionality by defining
2109 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002110
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002111 CONFIG_BOOTP_SUBNETMASK
2112 CONFIG_BOOTP_GATEWAY
2113 CONFIG_BOOTP_HOSTNAME
2114 CONFIG_BOOTP_NISDOMAIN
2115 CONFIG_BOOTP_BOOTPATH
2116 CONFIG_BOOTP_BOOTFILESIZE
2117 CONFIG_BOOTP_DNS
2118 CONFIG_BOOTP_DNS2
2119 CONFIG_BOOTP_SEND_HOSTNAME
2120 CONFIG_BOOTP_NTPSERVER
2121 CONFIG_BOOTP_TIMEOFFSET
2122 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002123 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002124
Wilson Callan5d110f02007-07-28 10:56:13 -04002125 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2126 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002127
Joe Hershberger2c00e092012-05-23 07:59:19 +00002128 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2129 after the configured retry count, the call will fail
2130 instead of starting over. This can be used to fail over
2131 to Link-local IP address configuration if the DHCP server
2132 is not available.
2133
stroesefe389a82003-08-28 14:17:32 +00002134 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2135 serverip from a DHCP server, it is possible that more
2136 than one DNS serverip is offered to the client.
2137 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2138 serverip will be stored in the additional environment
2139 variable "dnsip2". The first DNS serverip is always
2140 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002141 is defined.
stroesefe389a82003-08-28 14:17:32 +00002142
2143 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2144 to do a dynamic update of a DNS server. To do this, they
2145 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002146 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002147 of the "hostname" environment variable is passed as
2148 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002149
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002150 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2151
2152 A 32bit value in microseconds for a delay between
2153 receiving a "DHCP Offer" and sending the "DHCP Request".
2154 This fixes a problem with certain DHCP servers that don't
2155 respond 100% of the time to a "DHCP request". E.g. On an
2156 AT91RM9200 processor running at 180MHz, this delay needed
2157 to be *at least* 15,000 usec before a Windows Server 2003
2158 DHCP server would reply 100% of the time. I recommend at
2159 least 50,000 usec to be safe. The alternative is to hope
2160 that one of the retries will be successful but note that
2161 the DHCP timeout and retry process takes a longer than
2162 this delay.
2163
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002164 - Link-local IP address negotiation:
2165 Negotiate with other link-local clients on the local network
2166 for an address that doesn't require explicit configuration.
2167 This is especially useful if a DHCP server cannot be guaranteed
2168 to exist in all environments that the device must operate.
2169
2170 See doc/README.link-local for more information.
2171
wdenka3d991b2004-04-15 21:48:45 +00002172 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002173 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002174
2175 The device id used in CDP trigger frames.
2176
2177 CONFIG_CDP_DEVICE_ID_PREFIX
2178
2179 A two character string which is prefixed to the MAC address
2180 of the device.
2181
2182 CONFIG_CDP_PORT_ID
2183
2184 A printf format string which contains the ascii name of
2185 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002186 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002187
2188 CONFIG_CDP_CAPABILITIES
2189
2190 A 32bit integer which indicates the device capabilities;
2191 0x00000010 for a normal host which does not forwards.
2192
2193 CONFIG_CDP_VERSION
2194
2195 An ascii string containing the version of the software.
2196
2197 CONFIG_CDP_PLATFORM
2198
2199 An ascii string containing the name of the platform.
2200
2201 CONFIG_CDP_TRIGGER
2202
2203 A 32bit integer sent on the trigger.
2204
2205 CONFIG_CDP_POWER_CONSUMPTION
2206
2207 A 16bit integer containing the power consumption of the
2208 device in .1 of milliwatts.
2209
2210 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2211
2212 A byte containing the id of the VLAN.
2213
wdenkc6097192002-11-03 00:24:07 +00002214- Status LED: CONFIG_STATUS_LED
2215
2216 Several configurations allow to display the current
2217 status using a LED. For instance, the LED will blink
2218 fast while running U-Boot code, stop blinking as
2219 soon as a reply to a BOOTP request was received, and
2220 start blinking slow once the Linux kernel is running
2221 (supported by a status LED driver in the Linux
2222 kernel). Defining CONFIG_STATUS_LED enables this
2223 feature in U-Boot.
2224
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002225 Additional options:
2226
2227 CONFIG_GPIO_LED
2228 The status LED can be connected to a GPIO pin.
2229 In such cases, the gpio_led driver can be used as a
2230 status LED backend implementation. Define CONFIG_GPIO_LED
2231 to include the gpio_led driver in the U-Boot binary.
2232
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002233 CONFIG_GPIO_LED_INVERTED_TABLE
2234 Some GPIO connected LEDs may have inverted polarity in which
2235 case the GPIO high value corresponds to LED off state and
2236 GPIO low value corresponds to LED on state.
2237 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2238 with a list of GPIO LEDs that have inverted polarity.
2239
wdenkc6097192002-11-03 00:24:07 +00002240- CAN Support: CONFIG_CAN_DRIVER
2241
2242 Defining CONFIG_CAN_DRIVER enables CAN driver support
2243 on those systems that support this (optional)
2244 feature, like the TQM8xxL modules.
2245
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002246- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002247
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002248 This enable the NEW i2c subsystem, and will allow you to use
2249 i2c commands at the u-boot command line (as long as you set
2250 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2251 based realtime clock chips or other i2c devices. See
2252 common/cmd_i2c.c for a description of the command line
2253 interface.
2254
2255 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002256 - drivers/i2c/soft_i2c.c:
2257 - activate first bus with CONFIG_SYS_I2C_SOFT define
2258 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2259 for defining speed and slave address
2260 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2261 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2262 for defining speed and slave address
2263 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2264 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2265 for defining speed and slave address
2266 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2267 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2268 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002269
Heiko Schocher00f792e2012-10-24 13:48:22 +02002270 - drivers/i2c/fsl_i2c.c:
2271 - activate i2c driver with CONFIG_SYS_I2C_FSL
2272 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2273 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2274 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2275 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002276 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002277 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2278 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2279 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2280 second bus.
2281
Simon Glass1f2ba722012-10-30 07:28:53 +00002282 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002283 - activate this driver with CONFIG_SYS_I2C_TEGRA
2284 - This driver adds 4 i2c buses with a fix speed from
2285 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002286
Dirk Eibach880540d2013-04-25 02:40:01 +00002287 - drivers/i2c/ppc4xx_i2c.c
2288 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2289 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2290 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2291
tremfac96402013-09-21 18:13:35 +02002292 - drivers/i2c/i2c_mxc.c
2293 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002294 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2295 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2296 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2297 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002298 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2299 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2300 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2301 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2302 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2303 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002304 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2305 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002306 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002307 for speed, and 0 for slave.
2308
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002309 - drivers/i2c/rcar_i2c.c:
2310 - activate this driver with CONFIG_SYS_I2C_RCAR
2311 - This driver adds 4 i2c buses
2312
2313 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2314 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2315 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2316 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2317 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2318 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2319 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2320 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2321 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2322
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002323 - drivers/i2c/sh_i2c.c:
2324 - activate this driver with CONFIG_SYS_I2C_SH
2325 - This driver adds from 2 to 5 i2c buses
2326
2327 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2328 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2329 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2330 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2331 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2332 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2333 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2334 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2335 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2336 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2337 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2338 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002339 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002340
Heiko Schocher6789e842013-10-22 11:03:18 +02002341 - drivers/i2c/omap24xx_i2c.c
2342 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2343 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2344 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2345 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2346 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2347 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2348 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2349 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2350 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2351 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2352 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2353
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002354 - drivers/i2c/zynq_i2c.c
2355 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2356 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2357 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2358
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302359 - drivers/i2c/s3c24x0_i2c.c:
2360 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2361 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2362 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2363 with a fix speed from 100000 and the slave addr 0!
2364
Dirk Eibachb46226b2014-07-03 09:28:18 +02002365 - drivers/i2c/ihs_i2c.c
2366 - activate this driver with CONFIG_SYS_I2C_IHS
2367 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2368 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2369 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2370 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2371 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2372 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2373 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2374 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2375 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2376 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2377 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2378 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002379 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2380 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2381 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2382 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2383 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2384 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2385 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2386 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2387 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002388
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002389 additional defines:
2390
2391 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002392 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002393 don't use/have i2c muxes on your i2c bus, this
2394 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2395 omit this define.
2396
2397 CONFIG_SYS_I2C_DIRECT_BUS
2398 define this, if you don't use i2c muxes on your hardware.
2399 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2400 omit this define.
2401
2402 CONFIG_SYS_I2C_MAX_HOPS
2403 define how many muxes are maximal consecutively connected
2404 on one i2c bus. If you not use i2c muxes, omit this
2405 define.
2406
2407 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002408 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002409 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2410 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2411 CONFIG_SYS_NUM_I2C_BUSES = 9:
2412
2413 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2414 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2415 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2416 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2417 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2418 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2419 {1, {I2C_NULL_HOP}}, \
2420 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2421 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2422 }
2423
2424 which defines
2425 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002426 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2427 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2428 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2429 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2430 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002431 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002432 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2433 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002434
2435 If you do not have i2c muxes on your board, omit this define.
2436
Heiko Schocherea818db2013-01-29 08:53:15 +01002437- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002438
2439 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2440 provides the following compelling advantages:
2441
2442 - more than one i2c adapter is usable
2443 - approved multibus support
2444 - better i2c mux support
2445
2446 ** Please consider updating your I2C driver now. **
2447
Heiko Schocherea818db2013-01-29 08:53:15 +01002448 These enable legacy I2C serial bus commands. Defining
2449 CONFIG_HARD_I2C will include the appropriate I2C driver
2450 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002451
wdenk945af8d2003-07-16 21:53:01 +00002452 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002453 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002454 CONFIG_COMMANDS) and communicate with i2c based realtime
2455 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002456 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002457
Ben Warrenbb99ad62006-09-07 16:50:54 -04002458 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002459
wdenk945af8d2003-07-16 21:53:01 +00002460 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002461 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002462
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002463 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002464 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002465 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002466 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002467
Peter Tyser8d321b82010-04-12 22:28:21 -05002468 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002469 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002470 and so its address should therefore be cleared to 0 (See,
2471 eg, MPC823e User's Manual p.16-473). So, set
2472 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002473
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002474 CONFIG_SYS_I2C_INIT_MPC5XXX
2475
2476 When a board is reset during an i2c bus transfer
2477 chips might think that the current transfer is still
2478 in progress. Reset the slave devices by sending start
2479 commands until the slave device responds.
2480
wdenk945af8d2003-07-16 21:53:01 +00002481 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002482
Heiko Schocherea818db2013-01-29 08:53:15 +01002483 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002484 then the following macros need to be defined (examples are
2485 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002486
2487 I2C_INIT
2488
wdenkb37c7e52003-06-30 16:24:52 +00002489 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002490 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002491
wdenkba56f622004-02-06 23:19:44 +00002492 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002493
wdenkc6097192002-11-03 00:24:07 +00002494 I2C_PORT
2495
wdenk43d96162003-03-06 00:02:04 +00002496 (Only for MPC8260 CPU). The I/O port to use (the code
2497 assumes both bits are on the same port). Valid values
2498 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002499
2500 I2C_ACTIVE
2501
2502 The code necessary to make the I2C data line active
2503 (driven). If the data line is open collector, this
2504 define can be null.
2505
wdenkb37c7e52003-06-30 16:24:52 +00002506 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2507
wdenkc6097192002-11-03 00:24:07 +00002508 I2C_TRISTATE
2509
2510 The code necessary to make the I2C data line tri-stated
2511 (inactive). If the data line is open collector, this
2512 define can be null.
2513
wdenkb37c7e52003-06-30 16:24:52 +00002514 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2515
wdenkc6097192002-11-03 00:24:07 +00002516 I2C_READ
2517
York Sun472d5462013-04-01 11:29:11 -07002518 Code that returns true if the I2C data line is high,
2519 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002520
wdenkb37c7e52003-06-30 16:24:52 +00002521 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2522
wdenkc6097192002-11-03 00:24:07 +00002523 I2C_SDA(bit)
2524
York Sun472d5462013-04-01 11:29:11 -07002525 If <bit> is true, sets the I2C data line high. If it
2526 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002527
wdenkb37c7e52003-06-30 16:24:52 +00002528 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002529 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002530 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002531
wdenkc6097192002-11-03 00:24:07 +00002532 I2C_SCL(bit)
2533
York Sun472d5462013-04-01 11:29:11 -07002534 If <bit> is true, sets the I2C clock line high. If it
2535 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002536
wdenkb37c7e52003-06-30 16:24:52 +00002537 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002538 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002539 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002540
wdenkc6097192002-11-03 00:24:07 +00002541 I2C_DELAY
2542
2543 This delay is invoked four times per clock cycle so this
2544 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002545 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002546 like:
2547
wdenkb37c7e52003-06-30 16:24:52 +00002548 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002549
Mike Frysinger793b5722010-07-21 13:38:02 -04002550 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2551
2552 If your arch supports the generic GPIO framework (asm/gpio.h),
2553 then you may alternatively define the two GPIOs that are to be
2554 used as SCL / SDA. Any of the previous I2C_xxx macros will
2555 have GPIO-based defaults assigned to them as appropriate.
2556
2557 You should define these to the GPIO value as given directly to
2558 the generic GPIO functions.
2559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002560 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002561
wdenk8bde7f72003-06-27 21:31:46 +00002562 When a board is reset during an i2c bus transfer
2563 chips might think that the current transfer is still
2564 in progress. On some boards it is possible to access
2565 the i2c SCLK line directly, either by using the
2566 processor pin as a GPIO or by having a second pin
2567 connected to the bus. If this option is defined a
2568 custom i2c_init_board() routine in boards/xxx/board.c
2569 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002570
Richard Retanubun26a33502010-04-12 15:08:17 -04002571 CONFIG_SYS_I2C_BOARD_LATE_INIT
2572
2573 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2574 defined a custom i2c_board_late_init() routine in
2575 boards/xxx/board.c is run AFTER the operations in i2c_init()
2576 is completed. This callpoint can be used to unreset i2c bus
2577 using CPU i2c controller register accesses for CPUs whose i2c
2578 controller provide such a method. It is called at the end of
2579 i2c_init() to allow i2c_init operations to setup the i2c bus
2580 controller on the CPU (e.g. setting bus speed & slave address).
2581
wdenk17ea1172004-06-06 21:51:03 +00002582 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2583
2584 This option enables configuration of bi_iic_fast[] flags
2585 in u-boot bd_info structure based on u-boot environment
2586 variable "i2cfast". (see also i2cfast)
2587
Ben Warrenbb99ad62006-09-07 16:50:54 -04002588 CONFIG_I2C_MULTI_BUS
2589
2590 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002591 must have a controller. At any point in time, only one bus is
2592 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002593 Note that bus numbering is zero-based.
2594
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002595 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002596
2597 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002598 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002599 is set, specify a list of bus-device pairs. Otherwise, specify
2600 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002601
2602 e.g.
2603 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002604 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002605
2606 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2607
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002608 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002609 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002610
2611 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2612
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002613 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002614
2615 If defined, then this indicates the I2C bus number for DDR SPD.
2616 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2617
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002618 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002619
2620 If defined, then this indicates the I2C bus number for the RTC.
2621 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2622
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002623 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002624
2625 If defined, then this indicates the I2C bus number for the DTT.
2626 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2627
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002628 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002629
2630 If defined, specifies the I2C address of the DTT device.
2631 If not defined, then U-Boot uses predefined value for
2632 specified DTT device.
2633
Andrew Dyer2ac69852008-12-29 17:36:01 -06002634 CONFIG_SOFT_I2C_READ_REPEATED_START
2635
2636 defining this will force the i2c_read() function in
2637 the soft_i2c driver to perform an I2C repeated start
2638 between writing the address pointer and reading the
2639 data. If this define is omitted the default behaviour
2640 of doing a stop-start sequence will be used. Most I2C
2641 devices can use either method, but some require one or
2642 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002643
wdenkc6097192002-11-03 00:24:07 +00002644- SPI Support: CONFIG_SPI
2645
2646 Enables SPI driver (so far only tested with
2647 SPI EEPROM, also an instance works with Crystal A/D and
2648 D/As on the SACSng board)
2649
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002650 CONFIG_SH_SPI
2651
2652 Enables the driver for SPI controller on SuperH. Currently
2653 only SH7757 is supported.
2654
wdenkc6097192002-11-03 00:24:07 +00002655 CONFIG_SOFT_SPI
2656
wdenk43d96162003-03-06 00:02:04 +00002657 Enables a software (bit-bang) SPI driver rather than
2658 using hardware support. This is a general purpose
2659 driver that only requires three general I/O port pins
2660 (two outputs, one input) to function. If this is
2661 defined, the board configuration must define several
2662 SPI configuration items (port pins to use, etc). For
2663 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002664
Ben Warren04a9e112008-01-16 22:37:35 -05002665 CONFIG_HARD_SPI
2666
2667 Enables a hardware SPI driver for general-purpose reads
2668 and writes. As with CONFIG_SOFT_SPI, the board configuration
2669 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002670 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002671 example, see include/configs/mpc8349emds.h.
2672
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002673 CONFIG_MXC_SPI
2674
2675 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002676 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002677
Heiko Schocherf659b572014-07-14 10:22:11 +02002678 CONFIG_SYS_SPI_MXC_WAIT
2679 Timeout for waiting until spi transfer completed.
2680 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2681
Matthias Fuchs01335022007-12-27 17:12:34 +01002682- FPGA Support: CONFIG_FPGA
2683
2684 Enables FPGA subsystem.
2685
2686 CONFIG_FPGA_<vendor>
2687
2688 Enables support for specific chip vendors.
2689 (ALTERA, XILINX)
2690
2691 CONFIG_FPGA_<family>
2692
2693 Enables support for FPGA family.
2694 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2695
2696 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002697
wdenk43d96162003-03-06 00:02:04 +00002698 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002699
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302700 CONFIG_CMD_FPGA_LOADMK
2701
2702 Enable support for fpga loadmk command
2703
Michal Simek67193862014-05-02 13:43:39 +02002704 CONFIG_CMD_FPGA_LOADP
2705
2706 Enable support for fpga loadp command - load partial bitstream
2707
2708 CONFIG_CMD_FPGA_LOADBP
2709
2710 Enable support for fpga loadbp command - load partial bitstream
2711 (Xilinx only)
2712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002713 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002714
wdenk8bde7f72003-06-27 21:31:46 +00002715 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002716
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002717 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002718
wdenk43d96162003-03-06 00:02:04 +00002719 Enable checks on FPGA configuration interface busy
2720 status by the configuration function. This option
2721 will require a board or device specific function to
2722 be written.
wdenkc6097192002-11-03 00:24:07 +00002723
2724 CONFIG_FPGA_DELAY
2725
2726 If defined, a function that provides delays in the FPGA
2727 configuration driver.
2728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002729 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002730 Allow Control-C to interrupt FPGA configuration
2731
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002732 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002733
wdenk43d96162003-03-06 00:02:04 +00002734 Check for configuration errors during FPGA bitfile
2735 loading. For example, abort during Virtex II
2736 configuration if the INIT_B line goes low (which
2737 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002739 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002740
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002741 Maximum time to wait for the INIT_B line to de-assert
2742 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002743 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002744 ms.
wdenkc6097192002-11-03 00:24:07 +00002745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002746 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002747
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002748 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002749 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002750
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002751 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002752
wdenk43d96162003-03-06 00:02:04 +00002753 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002754 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002755
2756- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002757 CONFIG_BUILD_TARGET
2758
2759 Some SoCs need special image types (e.g. U-Boot binary
2760 with a special header) as build targets. By defining
2761 CONFIG_BUILD_TARGET in the SoC / board header, this
2762 special image will be automatically built upon calling
2763 make / MAKEALL.
2764
wdenkc6097192002-11-03 00:24:07 +00002765 CONFIG_IDENT_STRING
2766
wdenk43d96162003-03-06 00:02:04 +00002767 If defined, this string will be added to the U-Boot
2768 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002769
2770- Vendor Parameter Protection:
2771
wdenk43d96162003-03-06 00:02:04 +00002772 U-Boot considers the values of the environment
2773 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002774 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002775 are set once by the board vendor / manufacturer, and
2776 protects these variables from casual modification by
2777 the user. Once set, these variables are read-only,
2778 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002779 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002780
2781 If CONFIG_ENV_OVERWRITE is #defined in your config
2782 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002783 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002784 these parameters.
2785
Joe Hershberger92ac5202015-05-04 14:55:14 -05002786 Alternatively, if you define _both_ an ethaddr in the
2787 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002788 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002789 which can be changed exactly ONCE by the user. [The
2790 serial# is unaffected by this, i. e. it remains
2791 read-only.]
2792
Joe Hershberger25980902012-12-11 22:16:31 -06002793 The same can be accomplished in a more flexible way
2794 for any variable by configuring the type of access
2795 to allow for those variables in the ".flags" variable
2796 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2797
wdenkc6097192002-11-03 00:24:07 +00002798- Protected RAM:
2799 CONFIG_PRAM
2800
2801 Define this variable to enable the reservation of
2802 "protected RAM", i. e. RAM which is not overwritten
2803 by U-Boot. Define CONFIG_PRAM to hold the number of
2804 kB you want to reserve for pRAM. You can overwrite
2805 this default value by defining an environment
2806 variable "pram" to the number of kB you want to
2807 reserve. Note that the board info structure will
2808 still show the full amount of RAM. If pRAM is
2809 reserved, a new environment variable "mem" will
2810 automatically be defined to hold the amount of
2811 remaining RAM in a form that can be passed as boot
2812 argument to Linux, for instance like that:
2813
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002814 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002815 saveenv
2816
2817 This way you can tell Linux not to use this memory,
2818 either, which results in a memory region that will
2819 not be affected by reboots.
2820
2821 *WARNING* If your board configuration uses automatic
2822 detection of the RAM size, you must make sure that
2823 this memory test is non-destructive. So far, the
2824 following board configurations are known to be
2825 "pRAM-clean":
2826
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002827 IVMS8, IVML24, SPD8xx, TQM8xxL,
2828 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002829 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002830
Gabe Black40fef042012-12-02 04:55:18 +00002831- Access to physical memory region (> 4GB)
2832 Some basic support is provided for operations on memory not
2833 normally accessible to U-Boot - e.g. some architectures
2834 support access to more than 4GB of memory on 32-bit
2835 machines using physical address extension or similar.
2836 Define CONFIG_PHYSMEM to access this basic support, which
2837 currently only supports clearing the memory.
2838
wdenkc6097192002-11-03 00:24:07 +00002839- Error Recovery:
2840 CONFIG_PANIC_HANG
2841
2842 Define this variable to stop the system in case of a
2843 fatal error, so that you have to reset it manually.
2844 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002845 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002846 automatically as fast as possible, but it may be
2847 useful during development since you can try to debug
2848 the conditions that lead to the situation.
2849
2850 CONFIG_NET_RETRY_COUNT
2851
wdenk43d96162003-03-06 00:02:04 +00002852 This variable defines the number of retries for
2853 network operations like ARP, RARP, TFTP, or BOOTP
2854 before giving up the operation. If not defined, a
2855 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002856
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002857 CONFIG_ARP_TIMEOUT
2858
2859 Timeout waiting for an ARP reply in milliseconds.
2860
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002861 CONFIG_NFS_TIMEOUT
2862
2863 Timeout in milliseconds used in NFS protocol.
2864 If you encounter "ERROR: Cannot umount" in nfs command,
2865 try longer timeout such as
2866 #define CONFIG_NFS_TIMEOUT 10000UL
2867
wdenkc6097192002-11-03 00:24:07 +00002868- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002869 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002870
2871 Enable auto completion of commands using TAB.
2872
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002873 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002874
2875 This defines the secondary prompt string, which is
2876 printed when the command interpreter needs more input
2877 to complete a command. Usually "> ".
2878
2879 Note:
2880
wdenk8bde7f72003-06-27 21:31:46 +00002881 In the current implementation, the local variables
2882 space and global environment variables space are
2883 separated. Local variables are those you define by
2884 simply typing `name=value'. To access a local
2885 variable later on, you have write `$name' or
2886 `${name}'; to execute the contents of a variable
2887 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002888
wdenk43d96162003-03-06 00:02:04 +00002889 Global environment variables are those you use
2890 setenv/printenv to work with. To run a command stored
2891 in such a variable, you need to use the run command,
2892 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002893
2894 To store commands and special characters in a
2895 variable, please use double quotation marks
2896 surrounding the whole text of the variable, instead
2897 of the backslashes before semicolons and special
2898 symbols.
2899
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002900- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002901 CONFIG_CMDLINE_EDITING
2902
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002903 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002904 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002905
wdenka8c7c702003-12-06 19:49:23 +00002906- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002907 CONFIG_EXTRA_ENV_SETTINGS
2908
wdenk43d96162003-03-06 00:02:04 +00002909 Define this to contain any number of null terminated
2910 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002911 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002912
wdenk43d96162003-03-06 00:02:04 +00002913 For example, place something like this in your
2914 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002915
2916 #define CONFIG_EXTRA_ENV_SETTINGS \
2917 "myvar1=value1\0" \
2918 "myvar2=value2\0"
2919
wdenk43d96162003-03-06 00:02:04 +00002920 Warning: This method is based on knowledge about the
2921 internal format how the environment is stored by the
2922 U-Boot code. This is NOT an official, exported
2923 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002924 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002925 You better know what you are doing here.
2926
wdenk43d96162003-03-06 00:02:04 +00002927 Note: overly (ab)use of the default environment is
2928 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002929 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002930 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002931
Stephen Warren5e724ca2012-05-22 09:21:54 +00002932 CONFIG_ENV_VARS_UBOOT_CONFIG
2933
2934 Define this in order to add variables describing the
2935 U-Boot build configuration to the default environment.
2936 These will be named arch, cpu, board, vendor, and soc.
2937
2938 Enabling this option will cause the following to be defined:
2939
2940 - CONFIG_SYS_ARCH
2941 - CONFIG_SYS_CPU
2942 - CONFIG_SYS_BOARD
2943 - CONFIG_SYS_VENDOR
2944 - CONFIG_SYS_SOC
2945
Tom Rini7e27f892012-10-24 07:28:16 +00002946 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2947
2948 Define this in order to add variables describing certain
2949 run-time determined information about the hardware to the
2950 environment. These will be named board_name, board_rev.
2951
Simon Glass06fd8532012-11-30 13:01:17 +00002952 CONFIG_DELAY_ENVIRONMENT
2953
2954 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002955 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002956 that so that the environment is not available until
2957 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2958 this is instead controlled by the value of
2959 /config/load-environment.
2960
Chris Packham3b10cf12015-06-19 20:25:59 +12002961- Parallel Flash support:
2962 CONFIG_SYS_NO_FLASH
2963
2964 Traditionally U-boot was run on systems with parallel NOR
2965 flash. This option is used to disable support for parallel NOR
2966 flash. This option should be defined if the board does not have
2967 parallel flash.
2968
2969 If this option is not defined one of the generic flash drivers
2970 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2971 selected or the board must provide an implementation of the
2972 flash API (see include/flash.h).
2973
wdenka8c7c702003-12-06 19:49:23 +00002974- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002975 CONFIG_HAS_DATAFLASH
2976
wdenk8bde7f72003-06-27 21:31:46 +00002977 Defining this option enables DataFlash features and
2978 allows to read/write in Dataflash via the standard
2979 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002980
Eric Nelsonf61ec452012-01-31 10:52:08 -07002981- Serial Flash support
2982 CONFIG_CMD_SF
2983
2984 Defining this option enables SPI flash commands
2985 'sf probe/read/write/erase/update'.
2986
2987 Usage requires an initial 'probe' to define the serial
2988 flash parameters, followed by read/write/erase/update
2989 commands.
2990
2991 The following defaults may be provided by the platform
2992 to handle the common case when only a single serial
2993 flash is present on the system.
2994
2995 CONFIG_SF_DEFAULT_BUS Bus identifier
2996 CONFIG_SF_DEFAULT_CS Chip-select
2997 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2998 CONFIG_SF_DEFAULT_SPEED in Hz
2999
Simon Glass24007272012-10-08 13:16:02 +00003000 CONFIG_CMD_SF_TEST
3001
3002 Define this option to include a destructive SPI flash
3003 test ('sf test').
3004
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303005 CONFIG_SF_DUAL_FLASH Dual flash memories
3006
3007 Define this option to use dual flash support where two flash
3008 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003009 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303010
wdenk3f85ce22004-02-23 16:11:30 +00003011- SystemACE Support:
3012 CONFIG_SYSTEMACE
3013
3014 Adding this option adds support for Xilinx SystemACE
3015 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003016 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003017 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003018
3019 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003020 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003021
3022 When SystemACE support is added, the "ace" device type
3023 becomes available to the fat commands, i.e. fatls.
3024
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003025- TFTP Fixed UDP Port:
3026 CONFIG_TFTP_PORT
3027
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003028 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003029 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003030 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003031 number generator is used.
3032
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003033 Also, the environment variable tftpdstp is used to supply
3034 the TFTP UDP destination port value. If tftpdstp isn't
3035 defined, the normal port 69 is used.
3036
3037 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003038 blindly start the TFTP transfer using the pre-configured
3039 target IP address and UDP port. This has the effect of
3040 "punching through" the (Windows XP) firewall, allowing
3041 the remainder of the TFTP transfer to proceed normally.
3042 A better solution is to properly configure the firewall,
3043 but sometimes that is not allowed.
3044
Simon Glassbf36c5d2012-12-05 14:46:38 +00003045- Hashing support:
3046 CONFIG_CMD_HASH
3047
3048 This enables a generic 'hash' command which can produce
3049 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3050
3051 CONFIG_HASH_VERIFY
3052
3053 Enable the hash verify command (hash -v). This adds to code
3054 size a little.
3055
gaurav rana94e3c8c2015-02-20 12:51:46 +05303056 CONFIG_SHA1 - This option enables support of hashing using SHA1
3057 algorithm. The hash is calculated in software.
3058 CONFIG_SHA256 - This option enables support of hashing using
3059 SHA256 algorithm. The hash is calculated in software.
3060 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3061 for SHA1/SHA256 hashing.
3062 This affects the 'hash' command and also the
3063 hash_lookup_algo() function.
3064 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3065 hardware-acceleration for SHA1/SHA256 progressive hashing.
3066 Data can be streamed in a block at a time and the hashing
3067 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00003068
3069 Note: There is also a sha1sum command, which should perhaps
3070 be deprecated in favour of 'hash sha1'.
3071
Robert Winklera11f1872013-07-24 17:57:06 -07003072- Freescale i.MX specific commands:
3073 CONFIG_CMD_HDMIDETECT
3074 This enables 'hdmidet' command which returns true if an
3075 HDMI monitor is detected. This command is i.MX 6 specific.
3076
3077 CONFIG_CMD_BMODE
3078 This enables the 'bmode' (bootmode) command for forcing
3079 a boot from specific media.
3080
3081 This is useful for forcing the ROM's usb downloader to
3082 activate upon a watchdog reset which is nice when iterating
3083 on U-Boot. Using the reset button or running bmode normal
3084 will set it back to normal. This command currently
3085 supports i.MX53 and i.MX6.
3086
Simon Glass19c402a2013-06-13 15:10:02 -07003087- Signing support:
3088 CONFIG_RSA
3089
3090 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003091 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003092
Ruchika Guptac937ff62015-01-23 16:01:54 +05303093 The Modular Exponentiation algorithm in RSA is implemented using
3094 driver model. So CONFIG_DM needs to be enabled by default for this
3095 library to function.
3096
Simon Glass19c402a2013-06-13 15:10:02 -07003097 The signing part is build into mkimage regardless of this
Ruchika Guptac937ff62015-01-23 16:01:54 +05303098 option. The software based modular exponentiation is built into
3099 mkimage irrespective of this option.
Simon Glass19c402a2013-06-13 15:10:02 -07003100
Heiko Schocher9e50c402014-01-25 07:27:13 +01003101- bootcount support:
3102 CONFIG_BOOTCOUNT_LIMIT
3103
3104 This enables the bootcounter support, see:
3105 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3106
3107 CONFIG_AT91SAM9XE
3108 enable special bootcounter support on at91sam9xe based boards.
3109 CONFIG_BLACKFIN
3110 enable special bootcounter support on blackfin based boards.
3111 CONFIG_SOC_DA8XX
3112 enable special bootcounter support on da850 based boards.
3113 CONFIG_BOOTCOUNT_RAM
3114 enable support for the bootcounter in RAM
3115 CONFIG_BOOTCOUNT_I2C
3116 enable support for the bootcounter on an i2c (like RTC) device.
3117 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3118 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3119 the bootcounter.
3120 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003121
wdenka8c7c702003-12-06 19:49:23 +00003122- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003123 CONFIG_SHOW_BOOT_PROGRESS
3124
wdenk43d96162003-03-06 00:02:04 +00003125 Defining this option allows to add some board-
3126 specific code (calling a user-provided function
3127 "show_boot_progress(int)") that enables you to show
3128 the system's boot progress on some display (for
3129 example, some LED's) on your board. At the moment,
3130 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003131
Simon Glass94fd1312012-09-28 08:56:37 +00003132
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003133Legacy uImage format:
3134
wdenkc6097192002-11-03 00:24:07 +00003135 Arg Where When
3136 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003137 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003138 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003139 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003140 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003141 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003142 4 common/cmd_bootm.c Image data has correct checksum
3143 -4 common/cmd_bootm.c Image is for unsupported architecture
3144 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003145 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003146 6 common/cmd_bootm.c Image Type check OK
3147 -6 common/cmd_bootm.c gunzip uncompression error
3148 -7 common/cmd_bootm.c Unimplemented compression type
3149 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003150 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003151 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003152
3153 9 common/image.c Start initial ramdisk verification
3154 -10 common/image.c Ramdisk header has bad magic number
3155 -11 common/image.c Ramdisk header has bad checksum
3156 10 common/image.c Ramdisk header is OK
3157 -12 common/image.c Ramdisk data has bad checksum
3158 11 common/image.c Ramdisk data has correct checksum
3159 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003160 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003161 13 common/image.c Start multifile image verification
3162 14 common/image.c No initial ramdisk, no multifile, continue.
3163
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003164 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003165
Stefan Roesea47a12b2010-04-15 16:07:28 +02003166 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd542004-02-27 00:07:27 +00003167 -31 post/post.c POST test failed, detected by post_output_backlog()
3168 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003169
Heiko Schocher566a4942007-06-22 19:11:54 +02003170 34 common/cmd_doc.c before loading a Image from a DOC device
3171 -35 common/cmd_doc.c Bad usage of "doc" command
3172 35 common/cmd_doc.c correct usage of "doc" command
3173 -36 common/cmd_doc.c No boot device
3174 36 common/cmd_doc.c correct boot device
3175 -37 common/cmd_doc.c Unknown Chip ID on boot device
3176 37 common/cmd_doc.c correct chip ID found, device available
3177 -38 common/cmd_doc.c Read Error on boot device
3178 38 common/cmd_doc.c reading Image header from DOC device OK
3179 -39 common/cmd_doc.c Image header has bad magic number
3180 39 common/cmd_doc.c Image header has correct magic number
3181 -40 common/cmd_doc.c Error reading Image from DOC device
3182 40 common/cmd_doc.c Image header has correct magic number
3183 41 common/cmd_ide.c before loading a Image from a IDE device
3184 -42 common/cmd_ide.c Bad usage of "ide" command
3185 42 common/cmd_ide.c correct usage of "ide" command
3186 -43 common/cmd_ide.c No boot device
3187 43 common/cmd_ide.c boot device found
3188 -44 common/cmd_ide.c Device not available
3189 44 common/cmd_ide.c Device available
3190 -45 common/cmd_ide.c wrong partition selected
3191 45 common/cmd_ide.c partition selected
3192 -46 common/cmd_ide.c Unknown partition table
3193 46 common/cmd_ide.c valid partition table found
3194 -47 common/cmd_ide.c Invalid partition type
3195 47 common/cmd_ide.c correct partition type
3196 -48 common/cmd_ide.c Error reading Image Header on boot device
3197 48 common/cmd_ide.c reading Image Header from IDE device OK
3198 -49 common/cmd_ide.c Image header has bad magic number
3199 49 common/cmd_ide.c Image header has correct magic number
3200 -50 common/cmd_ide.c Image header has bad checksum
3201 50 common/cmd_ide.c Image header has correct checksum
3202 -51 common/cmd_ide.c Error reading Image from IDE device
3203 51 common/cmd_ide.c reading Image from IDE device OK
3204 52 common/cmd_nand.c before loading a Image from a NAND device
3205 -53 common/cmd_nand.c Bad usage of "nand" command
3206 53 common/cmd_nand.c correct usage of "nand" command
3207 -54 common/cmd_nand.c No boot device
3208 54 common/cmd_nand.c boot device found
3209 -55 common/cmd_nand.c Unknown Chip ID on boot device
3210 55 common/cmd_nand.c correct chip ID found, device available
3211 -56 common/cmd_nand.c Error reading Image Header on boot device
3212 56 common/cmd_nand.c reading Image Header from NAND device OK
3213 -57 common/cmd_nand.c Image header has bad magic number
3214 57 common/cmd_nand.c Image header has correct magic number
3215 -58 common/cmd_nand.c Error reading Image from NAND device
3216 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003217
Heiko Schocher566a4942007-06-22 19:11:54 +02003218 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003219
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003220 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003221 -64 net/eth.c no Ethernet found.
3222 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003223
Heiko Schocher566a4942007-06-22 19:11:54 +02003224 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05003225 80 common/cmd_net.c before calling net_loop()
3226 -81 common/cmd_net.c some error in net_loop() occurred
3227 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02003228 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3229 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003230 83 common/cmd_net.c running "source" command
3231 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003232 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003233
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003234FIT uImage format:
3235
3236 Arg Where When
3237 100 common/cmd_bootm.c Kernel FIT Image has correct format
3238 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3239 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3240 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3241 102 common/cmd_bootm.c Kernel unit name specified
3242 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003243 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003244 104 common/cmd_bootm.c Got kernel subimage node offset
3245 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3246 105 common/cmd_bootm.c Kernel subimage hash verification OK
3247 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3248 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003249 -106 common/cmd_bootm.c Kernel subimage has wrong type
3250 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003251 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3252 108 common/cmd_bootm.c Got kernel subimage data/size
3253 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3254 -109 common/cmd_bootm.c Can't get kernel subimage type
3255 -110 common/cmd_bootm.c Can't get kernel subimage comp
3256 -111 common/cmd_bootm.c Can't get kernel subimage os
3257 -112 common/cmd_bootm.c Can't get kernel subimage load address
3258 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3259
3260 120 common/image.c Start initial ramdisk verification
3261 -120 common/image.c Ramdisk FIT image has incorrect format
3262 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003263 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003264 -122 common/image.c Can't get configuration for ramdisk subimage
3265 123 common/image.c Ramdisk unit name specified
3266 -124 common/image.c Can't get ramdisk subimage node offset
3267 125 common/image.c Got ramdisk subimage node offset
3268 -125 common/image.c Ramdisk subimage hash verification failed
3269 126 common/image.c Ramdisk subimage hash verification OK
3270 -126 common/image.c Ramdisk subimage for unsupported architecture
3271 127 common/image.c Architecture check OK
3272 -127 common/image.c Can't get ramdisk subimage data/size
3273 128 common/image.c Got ramdisk subimage data/size
3274 129 common/image.c Can't get ramdisk load address
3275 -129 common/image.c Got ramdisk load address
3276
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003277 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003278 131 common/cmd_doc.c FIT image format OK
3279
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003280 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003281 141 common/cmd_ide.c FIT image format OK
3282
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003283 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003284 151 common/cmd_nand.c FIT image format OK
3285
Heiko Schocher21d29f72014-05-28 11:33:33 +02003286- legacy image format:
3287 CONFIG_IMAGE_FORMAT_LEGACY
3288 enables the legacy image format support in U-Boot.
3289
3290 Default:
3291 enabled if CONFIG_FIT_SIGNATURE is not defined.
3292
3293 CONFIG_DISABLE_IMAGE_LEGACY
3294 disable the legacy image format
3295
3296 This define is introduced, as the legacy image format is
3297 enabled per default for backward compatibility.
3298
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003299- FIT image support:
3300 CONFIG_FIT
3301 Enable support for the FIT uImage format.
3302
3303 CONFIG_FIT_BEST_MATCH
3304 When no configuration is explicitly selected, default to the
3305 one whose fdt's compatibility field best matches that of
3306 U-Boot itself. A match is considered "best" if it matches the
3307 most specific compatibility entry of U-Boot's fdt's root node.
3308 The order of entries in the configuration's fdt is ignored.
3309
Simon Glass3e569a62013-06-13 15:10:00 -07003310 CONFIG_FIT_SIGNATURE
3311 This option enables signature verification of FIT uImages,
gaurav rana94e3c8c2015-02-20 12:51:46 +05303312 using a hash signed and verified using RSA. If
3313 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3314 hashing is available using hardware, RSA library will use it.
3315 See doc/uImage.FIT/signature.txt for more details.
Simon Glass3e569a62013-06-13 15:10:00 -07003316
Heiko Schocher21d29f72014-05-28 11:33:33 +02003317 WARNING: When relying on signed FIT images with required
3318 signature check the legacy image format is default
3319 disabled. If a board need legacy image format support
3320 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3321
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003322 CONFIG_FIT_DISABLE_SHA256
3323 Supporting SHA256 hashes has quite an impact on binary size.
3324 For constrained systems sha256 hash support can be disabled
3325 with this option.
3326
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003327- Standalone program support:
3328 CONFIG_STANDALONE_LOAD_ADDR
3329
Wolfgang Denk6feff892011-10-09 21:06:34 +02003330 This option defines a board specific value for the
3331 address where standalone program gets loaded, thus
3332 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003333 settings.
3334
3335- Frame Buffer Address:
3336 CONFIG_FB_ADDR
3337
3338 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003339 address for frame buffer. This is typically the case
3340 when using a graphics controller has separate video
3341 memory. U-Boot will then place the frame buffer at
3342 the given address instead of dynamically reserving it
3343 in system RAM by calling lcd_setmem(), which grabs
3344 the memory for the frame buffer depending on the
3345 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003346
3347 Please see board_init_f function.
3348
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003349- Automatic software updates via TFTP server
3350 CONFIG_UPDATE_TFTP
3351 CONFIG_UPDATE_TFTP_CNT_MAX
3352 CONFIG_UPDATE_TFTP_MSEC_MAX
3353
3354 These options enable and control the auto-update feature;
3355 for a more detailed description refer to doc/README.update.
3356
3357- MTD Support (mtdparts command, UBI support)
3358 CONFIG_MTD_DEVICE
3359
3360 Adds the MTD device infrastructure from the Linux kernel.
3361 Needed for mtdparts command support.
3362
3363 CONFIG_MTD_PARTITIONS
3364
3365 Adds the MTD partitioning infrastructure from the Linux
3366 kernel. Needed for UBI support.
3367
Joe Hershberger70c219c2013-04-08 10:32:48 +00003368- UBI support
3369 CONFIG_CMD_UBI
3370
3371 Adds commands for interacting with MTD partitions formatted
3372 with the UBI flash translation layer
3373
3374 Requires also defining CONFIG_RBTREE
3375
Joe Hershberger147162d2013-04-08 10:32:49 +00003376 CONFIG_UBI_SILENCE_MSG
3377
3378 Make the verbose messages from UBI stop printing. This leaves
3379 warnings and errors enabled.
3380
Heiko Schocherff94bc42014-06-24 10:10:04 +02003381
3382 CONFIG_MTD_UBI_WL_THRESHOLD
3383 This parameter defines the maximum difference between the highest
3384 erase counter value and the lowest erase counter value of eraseblocks
3385 of UBI devices. When this threshold is exceeded, UBI starts performing
3386 wear leveling by means of moving data from eraseblock with low erase
3387 counter to eraseblocks with high erase counter.
3388
3389 The default value should be OK for SLC NAND flashes, NOR flashes and
3390 other flashes which have eraseblock life-cycle 100000 or more.
3391 However, in case of MLC NAND flashes which typically have eraseblock
3392 life-cycle less than 10000, the threshold should be lessened (e.g.,
3393 to 128 or 256, although it does not have to be power of 2).
3394
3395 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003396
Heiko Schocherff94bc42014-06-24 10:10:04 +02003397 CONFIG_MTD_UBI_BEB_LIMIT
3398 This option specifies the maximum bad physical eraseblocks UBI
3399 expects on the MTD device (per 1024 eraseblocks). If the
3400 underlying flash does not admit of bad eraseblocks (e.g. NOR
3401 flash), this value is ignored.
3402
3403 NAND datasheets often specify the minimum and maximum NVM
3404 (Number of Valid Blocks) for the flashes' endurance lifetime.
3405 The maximum expected bad eraseblocks per 1024 eraseblocks
3406 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3407 which gives 20 for most NANDs (MaxNVB is basically the total
3408 count of eraseblocks on the chip).
3409
3410 To put it differently, if this value is 20, UBI will try to
3411 reserve about 1.9% of physical eraseblocks for bad blocks
3412 handling. And that will be 1.9% of eraseblocks on the entire
3413 NAND chip, not just the MTD partition UBI attaches. This means
3414 that if you have, say, a NAND flash chip admits maximum 40 bad
3415 eraseblocks, and it is split on two MTD partitions of the same
3416 size, UBI will reserve 40 eraseblocks when attaching a
3417 partition.
3418
3419 default: 20
3420
3421 CONFIG_MTD_UBI_FASTMAP
3422 Fastmap is a mechanism which allows attaching an UBI device
3423 in nearly constant time. Instead of scanning the whole MTD device it
3424 only has to locate a checkpoint (called fastmap) on the device.
3425 The on-flash fastmap contains all information needed to attach
3426 the device. Using fastmap makes only sense on large devices where
3427 attaching by scanning takes long. UBI will not automatically install
3428 a fastmap on old images, but you can set the UBI parameter
3429 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3430 that fastmap-enabled images are still usable with UBI implementations
3431 without fastmap support. On typical flash devices the whole fastmap
3432 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3433
3434 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3435 Set this parameter to enable fastmap automatically on images
3436 without a fastmap.
3437 default: 0
3438
Heiko Schocher0195a7b2015-10-22 06:19:21 +02003439 CONFIG_MTD_UBI_FM_DEBUG
3440 Enable UBI fastmap debug
3441 default: 0
3442
Joe Hershberger70c219c2013-04-08 10:32:48 +00003443- UBIFS support
3444 CONFIG_CMD_UBIFS
3445
3446 Adds commands for interacting with UBI volumes formatted as
3447 UBIFS. UBIFS is read-only in u-boot.
3448
3449 Requires UBI support as well as CONFIG_LZO
3450
Joe Hershberger147162d2013-04-08 10:32:49 +00003451 CONFIG_UBIFS_SILENCE_MSG
3452
3453 Make the verbose messages from UBIFS stop printing. This leaves
3454 warnings and errors enabled.
3455
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003456- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003457 CONFIG_SPL
3458 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003459
Tom Rini95579792012-02-14 07:29:40 +00003460 CONFIG_SPL_LDSCRIPT
3461 LDSCRIPT for linking the SPL binary.
3462
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003463 CONFIG_SPL_MAX_FOOTPRINT
3464 Maximum size in memory allocated to the SPL, BSS included.
3465 When defined, the linker checks that the actual memory
3466 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003467 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003468 must not be both defined at the same time.
3469
Tom Rini95579792012-02-14 07:29:40 +00003470 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003471 Maximum size of the SPL image (text, data, rodata, and
3472 linker lists sections), BSS excluded.
3473 When defined, the linker checks that the actual size does
3474 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003475
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003476 CONFIG_SPL_TEXT_BASE
3477 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003478
Scott Wood94a45bb2012-09-20 19:05:12 -05003479 CONFIG_SPL_RELOC_TEXT_BASE
3480 Address to relocate to. If unspecified, this is equal to
3481 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3482
Tom Rini95579792012-02-14 07:29:40 +00003483 CONFIG_SPL_BSS_START_ADDR
3484 Link address for the BSS within the SPL binary.
3485
3486 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003487 Maximum size in memory allocated to the SPL BSS.
3488 When defined, the linker checks that the actual memory used
3489 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003490 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003491 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003492
3493 CONFIG_SPL_STACK
3494 Adress of the start of the stack SPL will use
3495
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02003496 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3497 When defined, SPL will panic() if the image it has
3498 loaded does not have a signature.
3499 Defining this is useful when code which loads images
3500 in SPL cannot guarantee that absolutely all read errors
3501 will be caught.
3502 An example is the LPC32XX MLC NAND driver, which will
3503 consider that a completely unreadable NAND block is bad,
3504 and thus should be skipped silently.
3505
Scott Wood94a45bb2012-09-20 19:05:12 -05003506 CONFIG_SPL_RELOC_STACK
3507 Adress of the start of the stack SPL will use after
3508 relocation. If unspecified, this is equal to
3509 CONFIG_SPL_STACK.
3510
Tom Rini95579792012-02-14 07:29:40 +00003511 CONFIG_SYS_SPL_MALLOC_START
3512 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02003513 When this option is set the full malloc is used in SPL and
3514 it is set up by spl_init() and before that, the simple malloc()
3515 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00003516
3517 CONFIG_SYS_SPL_MALLOC_SIZE
3518 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003519
Tom Rini47f7bca2012-08-13 12:03:19 -07003520 CONFIG_SPL_FRAMEWORK
3521 Enable the SPL framework under common/. This framework
3522 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3523 NAND loading of the Linux Kernel.
3524
Tom Rini9607faf2014-03-28 12:03:39 -04003525 CONFIG_SPL_OS_BOOT
3526 Enable booting directly to an OS from SPL.
3527 See also: doc/README.falcon
3528
Tom Rini861a86f2012-08-13 11:37:56 -07003529 CONFIG_SPL_DISPLAY_PRINT
3530 For ARM, enable an optional function to print more information
3531 about the running system.
3532
Scott Wood4b919722012-09-20 16:35:21 -05003533 CONFIG_SPL_INIT_MINIMAL
3534 Arch init code should be built for a very small image
3535
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003536 CONFIG_SPL_LIBCOMMON_SUPPORT
3537 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003538
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003539 CONFIG_SPL_LIBDISK_SUPPORT
3540 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003541
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003542 CONFIG_SPL_I2C_SUPPORT
3543 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003544
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003545 CONFIG_SPL_GPIO_SUPPORT
3546 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003547
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003548 CONFIG_SPL_MMC_SUPPORT
3549 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003550
Tom Rini95579792012-02-14 07:29:40 +00003551 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3552 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003553 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003554 when the MMC is being used in raw mode.
3555
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003556 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3557 Partition on the MMC to load U-Boot from when the MMC is being
3558 used in raw mode
3559
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003560 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3561 Sector to load kernel uImage from when MMC is being
3562 used in raw mode (for Falcon mode)
3563
3564 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3565 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3566 Sector and number of sectors to load kernel argument
3567 parameters from when MMC is being used in raw mode
3568 (for falcon mode)
3569
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003570 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3571 Partition on the MMC to load U-Boot from when the MMC is being
3572 used in fs mode
3573
Tom Rini95579792012-02-14 07:29:40 +00003574 CONFIG_SPL_FAT_SUPPORT
3575 Support for fs/fat/libfat.o in SPL binary
3576
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003577 CONFIG_SPL_EXT_SUPPORT
3578 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003579
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003580 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3581 Filename to read to load U-Boot when reading from filesystem
3582
3583 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003584 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003585 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003586
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003587 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003588 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003589 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003590
Scott Wood06f60ae2012-12-06 13:33:17 +00003591 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3592 Set this for NAND SPL on PPC mpc83xx targets, so that
3593 start.S waits for the rest of the SPL to load before
3594 continuing (the hardware starts execution after just
3595 loading the first page rather than the full 4K).
3596
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303597 CONFIG_SPL_SKIP_RELOCATE
3598 Avoid SPL relocation
3599
Scott Wood6f2f01b2012-09-20 19:09:07 -05003600 CONFIG_SPL_NAND_BASE
3601 Include nand_base.c in the SPL. Requires
3602 CONFIG_SPL_NAND_DRIVERS.
3603
3604 CONFIG_SPL_NAND_DRIVERS
3605 SPL uses normal NAND drivers, not minimal drivers.
3606
3607 CONFIG_SPL_NAND_ECC
3608 Include standard software ECC in the SPL
3609
Tom Rini95579792012-02-14 07:29:40 +00003610 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003611 Support for NAND boot using simple NAND drivers that
3612 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003613
Tom Rini6dd3b562014-03-28 12:03:36 -04003614 CONFIG_SPL_MTD_SUPPORT
3615 Support for the MTD subsystem within SPL. Useful for
3616 environment on NAND support within SPL.
3617
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003618 CONFIG_SPL_NAND_RAW_ONLY
3619 Support to boot only raw u-boot.bin images. Use this only
3620 if you need to save space.
3621
Ying Zhangbb0dc102013-08-16 15:16:11 +08003622 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3623 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003624 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003625
Ying Zhang7c8eea52013-08-16 15:16:12 +08003626 CONFIG_SPL_COMMON_INIT_DDR
3627 Set for common ddr init with serial presence detect in
3628 SPL binary.
3629
Tom Rini95579792012-02-14 07:29:40 +00003630 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3631 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3632 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3633 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3634 CONFIG_SYS_NAND_ECCBYTES
3635 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003636 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003637
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303638 CONFIG_SPL_NAND_BOOT
3639 Add support NAND boot
3640
Tom Rini95579792012-02-14 07:29:40 +00003641 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003642 Location in NAND to read U-Boot from
3643
3644 CONFIG_SYS_NAND_U_BOOT_DST
3645 Location in memory to load U-Boot to
3646
3647 CONFIG_SYS_NAND_U_BOOT_SIZE
3648 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003649
3650 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003651 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003652
3653 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3654 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003655 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003656
3657 CONFIG_SPL_OMAP3_ID_NAND
3658 Support for an OMAP3-specific set of functions to return the
3659 ID and MFR of the first attached NAND chip, if present.
3660
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003661 CONFIG_SPL_SERIAL_SUPPORT
3662 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003663
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003664 CONFIG_SPL_SPI_FLASH_SUPPORT
3665 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003666
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003667 CONFIG_SPL_SPI_SUPPORT
3668 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003669
Pavel Machekc57b9532012-08-30 22:42:11 +02003670 CONFIG_SPL_RAM_DEVICE
3671 Support for running image already present in ram, in SPL binary
3672
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003673 CONFIG_SPL_LIBGENERIC_SUPPORT
3674 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003675
Ying Zhangba1bee42013-05-20 14:07:25 +08003676 CONFIG_SPL_ENV_SUPPORT
3677 Support for the environment operating in SPL binary
3678
3679 CONFIG_SPL_NET_SUPPORT
3680 Support for the net/libnet.o in SPL binary.
3681 It conflicts with SPL env from storage medium specified by
3682 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3683
Scott Wood74752ba2012-12-06 13:33:16 +00003684 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003685 Image offset to which the SPL should be padded before appending
3686 the SPL payload. By default, this is defined as
3687 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3688 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3689 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003690
Scott Woodca2fca22012-09-21 16:27:32 -05003691 CONFIG_SPL_TARGET
3692 Final target image containing SPL and payload. Some SPLs
3693 use an arch-specific makefile fragment instead, for
3694 example if more than one image needs to be produced.
3695
Simon Glass87ebee32013-05-08 08:05:59 +00003696 CONFIG_FIT_SPL_PRINT
3697 Printing information about a FIT image adds quite a bit of
3698 code to SPL. So this is normally disabled in SPL. Use this
3699 option to re-enable it. This will affect the output of the
3700 bootm command when booting a FIT image.
3701
Ying Zhang3aa29de2013-08-16 15:16:15 +08003702- TPL framework
3703 CONFIG_TPL
3704 Enable building of TPL globally.
3705
3706 CONFIG_TPL_PAD_TO
3707 Image offset to which the TPL should be padded before appending
3708 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003709 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3710 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3711 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003712
wdenkc6097192002-11-03 00:24:07 +00003713Modem Support:
3714--------------
3715
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003716[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003717
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003718- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003719 CONFIG_MODEM_SUPPORT
3720
3721- RTS/CTS Flow control enable:
3722 CONFIG_HWFLOW
3723
3724- Modem debug support:
3725 CONFIG_MODEM_SUPPORT_DEBUG
3726
wdenk43d96162003-03-06 00:02:04 +00003727 Enables debugging stuff (char screen[1024], dbg())
3728 for modem support. Useful only with BDI2000.
wdenkc6097192002-11-03 00:24:07 +00003729
wdenka8c7c702003-12-06 19:49:23 +00003730- Interrupt support (PPC):
3731
wdenkd4ca31c2004-01-02 14:00:00 +00003732 There are common interrupt_init() and timer_interrupt()
3733 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003734 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003735 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003736 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003737 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003738 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003739 specific handling. If board has watchdog / status_led
3740 / other_activity_monitor it works automatically from
3741 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003742
wdenkc6097192002-11-03 00:24:07 +00003743- General:
3744
wdenk43d96162003-03-06 00:02:04 +00003745 In the target system modem support is enabled when a
3746 specific key (key combination) is pressed during
3747 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003748 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003749 board_init(). Currently key_pressed() is a dummy
3750 function, returning 1 and thus enabling modem
3751 initialization.
wdenkc6097192002-11-03 00:24:07 +00003752
wdenk43d96162003-03-06 00:02:04 +00003753 If there are no modem init strings in the
3754 environment, U-Boot proceed to autoboot; the
3755 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003756 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003757
3758 See also: doc/README.Modem
3759
Helmut Raiger9660e442011-10-20 04:19:47 +00003760Board initialization settings:
3761------------------------------
3762
3763During Initialization u-boot calls a number of board specific functions
3764to allow the preparation of board specific prerequisites, e.g. pin setup
3765before drivers are initialized. To enable these callbacks the
3766following configuration macros have to be defined. Currently this is
3767architecture specific, so please check arch/your_architecture/lib/board.c
3768typically in board_init_f() and board_init_r().
3769
3770- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3771- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3772- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3773- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003774
wdenkc6097192002-11-03 00:24:07 +00003775Configuration Settings:
3776-----------------------
3777
York Sun4d1fd7f2014-02-26 17:03:19 -08003778- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3779 Optionally it can be defined to support 64-bit memory commands.
3780
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003781- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003782 undefine this when you're short of memory.
3783
Peter Tyser2fb26042009-01-27 18:03:12 -06003784- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3785 width of the commands listed in the 'help' command output.
3786
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003787- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003788 prompt for user input.
3789
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003790- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003791
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003792- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003793
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003794- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003796- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003797 the application (usually a Linux kernel) when it is
3798 booted
3799
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003800- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003801 List of legal baudrate settings for this board.
3802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003803- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003804 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003805
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003806- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003807 If the board specific function
3808 extern int overwrite_console (void);
3809 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003810 serial port, else the settings in the environment are used.
3811
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003812- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003813 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003814
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003815- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003816 Enable overwrite of previous console environment settings.
3817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003818- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003819 Begin and End addresses of the area used by the
3820 simple memory test.
3821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003822- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003823 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003824
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003825- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003826 Scratch address used by the alternate memory test
3827 You only need to set this if address zero isn't writeable
3828
York Sune8149522015-12-04 11:57:07 -08003829- CONFIG_SYS_MEM_RESERVE_SECURE
3830 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3831 is substracted from total RAM and won't be reported to OS.
3832 This memory can be used as secure memory. A variable
3833 gd->secure_ram is used to track the location. In systems
3834 the RAM base is not zero, or RAM is divided into banks,
3835 this variable needs to be recalcuated to get the address.
3836
York Sunaabd7dd2015-12-07 11:05:29 -08003837- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003838 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003839 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003840 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003841 fixing up gd->ram_size the Linux kernel should gets passed
3842 the now "corrected" memory size and won't touch it either.
3843 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003844 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003845 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003846 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003847
3848 This option can be used as a workaround for the 440EPx/GRx
3849 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3850 be touched.
3851
3852 WARNING: Please make sure that this value is a multiple of
3853 the Linux page size (normally 4k). If this is not the case,
3854 then the end address of the Linux memory will be located at a
3855 non page size aligned address and this could cause major
3856 problems.
3857
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003858- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003859 Enable temporary baudrate change while serial download
3860
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003861- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003862 Physical start address of SDRAM. _Must_ be 0 here.
3863
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003864- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003865 Physical start address of Motherboard I/O (if using a
3866 Cogent motherboard)
3867
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003868- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003869 Physical start address of Flash memory.
3870
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003871- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003872 Physical start address of boot monitor code (set by
3873 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003874 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003875 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003876
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003877- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003878 Size of memory reserved for monitor code, used to
3879 determine _at_compile_time_ (!) if the environment is
3880 embedded within the U-Boot image, or in a separate
3881 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003882
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003883- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003884 Size of DRAM reserved for malloc() use.
3885
Simon Glassd59476b2014-07-10 22:23:28 -06003886- CONFIG_SYS_MALLOC_F_LEN
3887 Size of the malloc() pool for use before relocation. If
3888 this is defined, then a very simple malloc() implementation
3889 will become available before relocation. The address is just
3890 below the global data, and the stack is moved down to make
3891 space.
3892
3893 This feature allocates regions with increasing addresses
3894 within the region. calloc() is supported, but realloc()
3895 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003896 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003897 U-Boot relocates itself.
3898
Simon Glasse7b14e92014-09-15 06:33:18 -06003899 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06003900 at present but is fairly easy to enable for other archs.
3901
Simon Glass38687ae2014-11-10 17:16:54 -07003902- CONFIG_SYS_MALLOC_SIMPLE
3903 Provides a simple and small malloc() and calloc() for those
3904 boards which do not use the full malloc in SPL (which is
3905 enabled with CONFIG_SYS_SPL_MALLOC_START).
3906
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003907- CONFIG_SYS_NONCACHED_MEMORY:
3908 Size of non-cached memory area. This area of memory will be
3909 typically located right below the malloc() area and mapped
3910 uncached in the MMU. This is useful for drivers that would
3911 otherwise require a lot of explicit cache maintenance. For
3912 some drivers it's also impossible to properly maintain the
3913 cache. For example if the regions that need to be flushed
3914 are not a multiple of the cache-line size, *and* padding
3915 cannot be allocated between the regions to align them (i.e.
3916 if the HW requires a contiguous array of regions, and the
3917 size of each region is not cache-aligned), then a flush of
3918 one region may result in overwriting data that hardware has
3919 written to another region in the same cache-line. This can
3920 happen for example in network drivers where descriptors for
3921 buffers are typically smaller than the CPU cache-line (e.g.
3922 16 bytes vs. 32 or 64 bytes).
3923
3924 Non-cached memory is only supported on 32-bit ARM at present.
3925
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003926- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003927 Normally compressed uImages are limited to an
3928 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003929 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003930 to adjust this setting to your needs.
3931
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003932- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003933 Maximum size of memory mapped by the startup code of
3934 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003935 the Linux kernel (bd_info, boot arguments, FDT blob if
3936 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003937 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003938 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003939 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003940 variable "bootm_mapsize" will override the value of
3941 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3942 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003943
John Rigbyfca43cc2010-10-13 13:57:35 -06003944- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3945 Enable initrd_high functionality. If defined then the
3946 initrd_high feature is enabled and the bootm ramdisk subcommand
3947 is enabled.
3948
3949- CONFIG_SYS_BOOT_GET_CMDLINE:
3950 Enables allocating and saving kernel cmdline in space between
3951 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3952
3953- CONFIG_SYS_BOOT_GET_KBD:
3954 Enables allocating and saving a kernel copy of the bd_info in
3955 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3956
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003957- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003958 Max number of Flash memory banks
3959
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003960- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003961 Max number of sectors on a Flash chip
3962
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003963- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003964 Timeout for Flash erase operations (in ms)
3965
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003966- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003967 Timeout for Flash write operations (in ms)
3968
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003969- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003970 Timeout for Flash set sector lock bit operation (in ms)
3971
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003972- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003973 Timeout for Flash clear lock bits operation (in ms)
3974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003975- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003976 If defined, hardware flash sectors protection is used
3977 instead of U-Boot software protection.
3978
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003979- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003980
3981 Enable TFTP transfers directly to flash memory;
3982 without this option such a download has to be
3983 performed in two steps: (1) download to RAM, and (2)
3984 copy from RAM to flash.
3985
3986 The two-step approach is usually more reliable, since
3987 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003988 the flash, but in some situations (when system RAM is
3989 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003990 downloaded image) this option may be very useful.
3991
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003992- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003993 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003994 common flash structure for storing flash geometry.
3995
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003996- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003997 This option also enables the building of the cfi_flash driver
3998 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003999
Piotr Ziecik91809ed2008-11-17 15:57:58 +01004000- CONFIG_FLASH_CFI_MTD
4001 This option enables the building of the cfi_mtd driver
4002 in the drivers directory. The driver exports CFI flash
4003 to the MTD layer.
4004
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004005- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004006 Use buffered writes to flash.
4007
4008- CONFIG_FLASH_SPANSION_S29WS_N
4009 s29ws-n MirrorBit flash has non-standard addresses for buffered
4010 write commands.
4011
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004012- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004013 If this option is defined, the common CFI flash doesn't
4014 print it's warning upon not recognized FLASH banks. This
4015 is useful, if some of the configured banks are only
4016 optionally available.
4017
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004018- CONFIG_FLASH_SHOW_PROGRESS
4019 If defined (must be an integer), print out countdown
4020 digits and dots. Recommended value: 45 (9..1) for 80
4021 column displays, 15 (3..1) for 40 column displays.
4022
Stefan Roese352ef3f2013-04-04 15:53:14 +02004023- CONFIG_FLASH_VERIFY
4024 If defined, the content of the flash (destination) is compared
4025 against the source after the write operation. An error message
4026 will be printed when the contents are not identical.
4027 Please note that this option is useless in nearly all cases,
4028 since such flash programming errors usually are detected earlier
4029 while unprotecting/erasing/programming. Please only enable
4030 this option if you really know what you are doing.
4031
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004032- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004033 Defines the number of Ethernet receive buffers. On some
4034 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004035 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4036 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004037 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004038 Defaults to 4 if not defined.
4039
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004040- CONFIG_ENV_MAX_ENTRIES
4041
Wolfgang Denk071bc922010-10-27 22:48:30 +02004042 Maximum number of entries in the hash table that is used
4043 internally to store the environment settings. The default
4044 setting is supposed to be generous and should work in most
4045 cases. This setting can be used to tune behaviour; see
4046 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004047
Joe Hershberger25980902012-12-11 22:16:31 -06004048- CONFIG_ENV_FLAGS_LIST_DEFAULT
4049- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004050 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004051 calling env set. Variables can be restricted to only decimal,
4052 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4053 the variables can also be restricted to IP address or MAC address.
4054
4055 The format of the list is:
4056 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004057 access_attribute = [a|r|o|c]
4058 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004059 entry = variable_name[:attributes]
4060 list = entry[,list]
4061
4062 The type attributes are:
4063 s - String (default)
4064 d - Decimal
4065 x - Hexadecimal
4066 b - Boolean ([1yYtT|0nNfF])
4067 i - IP address
4068 m - MAC address
4069
Joe Hershberger267541f2012-12-11 22:16:34 -06004070 The access attributes are:
4071 a - Any (default)
4072 r - Read-only
4073 o - Write-once
4074 c - Change-default
4075
Joe Hershberger25980902012-12-11 22:16:31 -06004076 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4077 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004078 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004079
4080 - CONFIG_ENV_FLAGS_LIST_STATIC
4081 Define this to a list (string) to define validation that
4082 should be done if an entry is not found in the ".flags"
4083 environment variable. To override a setting in the static
4084 list, simply add an entry for the same variable name to the
4085 ".flags" variable.
4086
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004087 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4088 regular expression. This allows multiple variables to define the same
4089 flags without explicitly listing them for each variable.
4090
Joe Hershberger267541f2012-12-11 22:16:34 -06004091- CONFIG_ENV_ACCESS_IGNORE_FORCE
4092 If defined, don't allow the -f switch to env set override variable
4093 access flags.
4094
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004095- CONFIG_SYS_GENERIC_BOARD
4096 This selects the architecture-generic board system instead of the
4097 architecture-specific board files. It is intended to move boards
4098 to this new framework over time. Defining this will disable the
4099 arch/foo/lib/board.c file and use common/board_f.c and
4100 common/board_r.c instead. To use this option your architecture
Masahiro Yamada0a12e682015-03-19 19:42:51 +09004101 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4102 If you find problems enabling this option on your board please report
4103 the problem and send patches!
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004104
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004105- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4106 This is set by OMAP boards for the max time that reset should
4107 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004108 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004109
Gabe Black0d296cc2014-10-15 04:38:30 -06004110- CONFIG_USE_STDINT
4111 If stdint.h is available with your toolchain you can define this
4112 option to enable it. You can provide option 'USE_STDINT=1' when
4113 building U-Boot to enable this.
4114
wdenkc6097192002-11-03 00:24:07 +00004115The following definitions that deal with the placement and management
4116of environment data (variable area); in general, we support the
4117following configurations:
4118
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004119- CONFIG_BUILD_ENVCRC:
4120
4121 Builds up envcrc with the target environment so that external utils
4122 may easily extract it and embed it in final U-Boot images.
4123
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004124- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004125
4126 Define this if the environment is in flash memory.
4127
4128 a) The environment occupies one whole flash sector, which is
4129 "embedded" in the text segment with the U-Boot code. This
4130 happens usually with "bottom boot sector" or "top boot
4131 sector" type flash chips, which have several smaller
4132 sectors at the start or the end. For instance, such a
4133 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4134 such a case you would place the environment in one of the
4135 4 kB sectors - with U-Boot code before and after it. With
4136 "top boot sector" type flash chips, you would put the
4137 environment in one of the last sectors, leaving a gap
4138 between U-Boot and the environment.
4139
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004140 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004141
4142 Offset of environment data (variable area) to the
4143 beginning of flash memory; for instance, with bottom boot
4144 type flash chips the second sector can be used: the offset
4145 for this sector is given here.
4146
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004147 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004148
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004149 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004150
4151 This is just another way to specify the start address of
4152 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004153 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004154
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004155 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004156
4157 Size of the sector containing the environment.
4158
4159
4160 b) Sometimes flash chips have few, equal sized, BIG sectors.
4161 In such a case you don't want to spend a whole sector for
4162 the environment.
4163
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004164 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004165
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004166 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004167 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004168 of this flash sector for the environment. This saves
4169 memory for the RAM copy of the environment.
4170
4171 It may also save flash memory if you decide to use this
4172 when your environment is "embedded" within U-Boot code,
4173 since then the remainder of the flash sector could be used
4174 for U-Boot code. It should be pointed out that this is
4175 STRONGLY DISCOURAGED from a robustness point of view:
4176 updating the environment in flash makes it always
4177 necessary to erase the WHOLE sector. If something goes
4178 wrong before the contents has been restored from a copy in
4179 RAM, your target system will be dead.
4180
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004181 - CONFIG_ENV_ADDR_REDUND
4182 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004183
wdenk43d96162003-03-06 00:02:04 +00004184 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004185 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004186 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004187 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004188
4189BE CAREFUL! Any changes to the flash layout, and some changes to the
4190source code will make it necessary to adapt <board>/u-boot.lds*
4191accordingly!
4192
4193
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004194- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004195
4196 Define this if you have some non-volatile memory device
4197 (NVRAM, battery buffered SRAM) which you want to use for the
4198 environment.
4199
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004200 - CONFIG_ENV_ADDR:
4201 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004202
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004203 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004204 want to use for environment. It is assumed that this memory
4205 can just be read and written to, without any special
4206 provision.
4207
4208BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004209in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004210console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004211U-Boot will hang.
4212
4213Please note that even with NVRAM we still use a copy of the
4214environment in RAM: we could work on NVRAM directly, but we want to
4215keep settings there always unmodified except somebody uses "saveenv"
4216to save the current settings.
4217
4218
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004219- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004220
4221 Use this if you have an EEPROM or similar serial access
4222 device and a driver for it.
4223
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004224 - CONFIG_ENV_OFFSET:
4225 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004226
4227 These two #defines specify the offset and size of the
4228 environment area within the total memory of your EEPROM.
4229
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004230 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004231 If defined, specified the chip address of the EEPROM device.
4232 The default address is zero.
4233
Christian Gmeiner189d2572015-02-11 15:19:31 +01004234 - CONFIG_SYS_I2C_EEPROM_BUS:
4235 If defined, specified the i2c bus of the EEPROM device.
4236
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004237 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004238 If defined, the number of bits used to address bytes in a
4239 single page in the EEPROM device. A 64 byte page, for example
4240 would require six bits.
4241
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004242 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004243 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004244 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004246 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004247 The length in bytes of the EEPROM memory array address. Note
4248 that this is NOT the chip address length!
4249
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004250 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004251 EEPROM chips that implement "address overflow" are ones
4252 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4253 address and the extra bits end up in the "chip address" bit
4254 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4255 byte chips.
4256
4257 Note that we consider the length of the address field to
4258 still be one byte because the extra address bits are hidden
4259 in the chip address.
4260
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004261 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004262 The size in bytes of the EEPROM device.
4263
Heiko Schocher548738b2010-01-07 08:55:40 +01004264 - CONFIG_ENV_EEPROM_IS_ON_I2C
4265 define this, if you have I2C and SPI activated, and your
4266 EEPROM, which holds the environment, is on the I2C bus.
4267
4268 - CONFIG_I2C_ENV_EEPROM_BUS
4269 if you have an Environment on an EEPROM reached over
4270 I2C muxes, you can define here, how to reach this
4271 EEPROM. For example:
4272
Heiko Schocherea818db2013-01-29 08:53:15 +01004273 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004274
4275 EEPROM which holds the environment, is reached over
4276 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004277
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004278- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004279
wdenkd4ca31c2004-01-02 14:00:00 +00004280 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004281 want to use for the environment.
4282
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004283 - CONFIG_ENV_OFFSET:
4284 - CONFIG_ENV_ADDR:
4285 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004286
4287 These three #defines specify the offset and size of the
4288 environment area within the total memory of your DataFlash placed
4289 at the specified address.
4290
Wu, Joshbd83b592014-07-01 19:30:13 +08004291- CONFIG_ENV_IS_IN_SPI_FLASH:
4292
4293 Define this if you have a SPI Flash memory device which you
4294 want to use for the environment.
4295
4296 - CONFIG_ENV_OFFSET:
4297 - CONFIG_ENV_SIZE:
4298
4299 These two #defines specify the offset and size of the
4300 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4301 aligned to an erase sector boundary.
4302
4303 - CONFIG_ENV_SECT_SIZE:
4304
4305 Define the SPI flash's sector size.
4306
4307 - CONFIG_ENV_OFFSET_REDUND (optional):
4308
4309 This setting describes a second storage area of CONFIG_ENV_SIZE
4310 size used to hold a redundant copy of the environment data, so
4311 that there is a valid backup copy in case there is a power failure
4312 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4313 aligned to an erase sector boundary.
4314
4315 - CONFIG_ENV_SPI_BUS (optional):
4316 - CONFIG_ENV_SPI_CS (optional):
4317
4318 Define the SPI bus and chip select. If not defined they will be 0.
4319
4320 - CONFIG_ENV_SPI_MAX_HZ (optional):
4321
4322 Define the SPI max work clock. If not defined then use 1MHz.
4323
4324 - CONFIG_ENV_SPI_MODE (optional):
4325
4326 Define the SPI work mode. If not defined then use SPI_MODE_3.
4327
Liu Gang0a85a9e2012-03-08 00:33:20 +00004328- CONFIG_ENV_IS_IN_REMOTE:
4329
4330 Define this if you have a remote memory space which you
4331 want to use for the local device's environment.
4332
4333 - CONFIG_ENV_ADDR:
4334 - CONFIG_ENV_SIZE:
4335
4336 These two #defines specify the address and size of the
4337 environment area within the remote memory space. The
4338 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004339 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004340
4341BE CAREFUL! For some special cases, the local device can not use
4342"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004343environment stored in a remote NOR flash by SRIO or PCIE link,
4344but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004345
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004346- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004347
4348 Define this if you have a NAND device which you want to use
4349 for the environment.
4350
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004351 - CONFIG_ENV_OFFSET:
4352 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004353
4354 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004355 area within the first NAND device. CONFIG_ENV_OFFSET must be
4356 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004357
Scott Woodfdd813d2010-09-17 14:38:37 -05004358 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004359
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004360 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004361 size used to hold a redundant copy of the environment data, so
4362 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004363 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004364 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004365
Scott Woodfdd813d2010-09-17 14:38:37 -05004366 - CONFIG_ENV_RANGE (optional):
4367
4368 Specifies the length of the region in which the environment
4369 can be written. This should be a multiple of the NAND device's
4370 block size. Specifying a range with more erase blocks than
4371 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4372 the range to be avoided.
4373
4374 - CONFIG_ENV_OFFSET_OOB (optional):
4375
4376 Enables support for dynamically retrieving the offset of the
4377 environment from block zero's out-of-band data. The
4378 "nand env.oob" command can be used to record this offset.
4379 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4380 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004381
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004382- CONFIG_NAND_ENV_DST
4383
4384 Defines address in RAM to which the nand_spl code should copy the
4385 environment. If redundant environment is used, it will be copied to
4386 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4387
Joe Hershberger2b744332013-04-08 10:32:51 +00004388- CONFIG_ENV_IS_IN_UBI:
4389
4390 Define this if you have an UBI volume that you want to use for the
4391 environment. This has the benefit of wear-leveling the environment
4392 accesses, which is important on NAND.
4393
4394 - CONFIG_ENV_UBI_PART:
4395
4396 Define this to a string that is the mtd partition containing the UBI.
4397
4398 - CONFIG_ENV_UBI_VOLUME:
4399
4400 Define this to the name of the volume that you want to store the
4401 environment in.
4402
Joe Hershberger785881f2013-04-08 10:32:52 +00004403 - CONFIG_ENV_UBI_VOLUME_REDUND:
4404
4405 Define this to the name of another volume to store a second copy of
4406 the environment in. This will enable redundant environments in UBI.
4407 It is assumed that both volumes are in the same MTD partition.
4408
Joe Hershberger2b744332013-04-08 10:32:51 +00004409 - CONFIG_UBI_SILENCE_MSG
4410 - CONFIG_UBIFS_SILENCE_MSG
4411
4412 You will probably want to define these to avoid a really noisy system
4413 when storing the env in UBI.
4414
Wu, Joshd1db76f2014-06-24 17:31:03 +08004415- CONFIG_ENV_IS_IN_FAT:
4416 Define this if you want to use the FAT file system for the environment.
4417
4418 - FAT_ENV_INTERFACE:
4419
4420 Define this to a string that is the name of the block device.
4421
4422 - FAT_ENV_DEV_AND_PART:
4423
4424 Define this to a string to specify the partition of the device. It can
4425 be as following:
4426
4427 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4428 - "D:P": device D partition P. Error occurs if device D has no
4429 partition table.
4430 - "D:0": device D.
4431 - "D" or "D:": device D partition 1 if device D has partition
4432 table, or the whole device D if has no partition
4433 table.
4434 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004435 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004436 partition table then means device D.
4437
4438 - FAT_ENV_FILE:
4439
4440 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004441 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004442
4443 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004444 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004445
Stephen Warren06e4ae52013-06-11 15:14:00 -06004446- CONFIG_ENV_IS_IN_MMC:
4447
4448 Define this if you have an MMC device which you want to use for the
4449 environment.
4450
4451 - CONFIG_SYS_MMC_ENV_DEV:
4452
4453 Specifies which MMC device the environment is stored in.
4454
4455 - CONFIG_SYS_MMC_ENV_PART (optional):
4456
4457 Specifies which MMC partition the environment is stored in. If not
4458 set, defaults to partition 0, the user area. Common values might be
4459 1 (first MMC boot partition), 2 (second MMC boot partition).
4460
4461 - CONFIG_ENV_OFFSET:
4462 - CONFIG_ENV_SIZE:
4463
4464 These two #defines specify the offset and size of the environment
4465 area within the specified MMC device.
4466
Stephen Warren5c088ee2013-06-11 15:14:02 -06004467 If offset is positive (the usual case), it is treated as relative to
4468 the start of the MMC partition. If offset is negative, it is treated
4469 as relative to the end of the MMC partition. This can be useful if
4470 your board may be fitted with different MMC devices, which have
4471 different sizes for the MMC partitions, and you always want the
4472 environment placed at the very end of the partition, to leave the
4473 maximum possible space before it, to store other data.
4474
Stephen Warren06e4ae52013-06-11 15:14:00 -06004475 These two values are in units of bytes, but must be aligned to an
4476 MMC sector boundary.
4477
4478 - CONFIG_ENV_OFFSET_REDUND (optional):
4479
4480 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4481 hold a redundant copy of the environment data. This provides a
4482 valid backup copy in case the other copy is corrupted, e.g. due
4483 to a power failure during a "saveenv" operation.
4484
Stephen Warren5c088ee2013-06-11 15:14:02 -06004485 This value may also be positive or negative; this is handled in the
4486 same way as CONFIG_ENV_OFFSET.
4487
Stephen Warren06e4ae52013-06-11 15:14:00 -06004488 This value is also in units of bytes, but must also be aligned to
4489 an MMC sector boundary.
4490
4491 - CONFIG_ENV_SIZE_REDUND (optional):
4492
4493 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4494 set. If this value is set, it must be set to the same value as
4495 CONFIG_ENV_SIZE.
4496
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004497- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004498
4499 Defines offset to the initial SPI buffer area in DPRAM. The
4500 area is used at an early stage (ROM part) if the environment
4501 is configured to reside in the SPI EEPROM: We need a 520 byte
4502 scratch DPRAM area. It is used between the two initialization
4503 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4504 to be a good choice since it makes it far enough from the
4505 start of the data area as well as from the stack pointer.
4506
Bruce Adlere881cb52007-11-02 13:15:42 -07004507Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004508has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004509created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004510until then to read environment variables.
4511
wdenk85ec0bc2003-03-31 16:34:49 +00004512The environment is protected by a CRC32 checksum. Before the monitor
4513is relocated into RAM, as a result of a bad CRC you will be working
4514with the compiled-in default environment - *silently*!!! [This is
4515necessary, because the first environment variable we need is the
4516"baudrate" setting for the console - if we have a bad CRC, we don't
4517have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004518
4519Note: once the monitor has been relocated, then it will complain if
4520the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004521use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004522
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004523- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004524 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004525
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004526 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004527 also needs to be defined.
4528
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004529- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004530 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004531
Ron Madridf5675aa2009-02-18 14:30:44 -08004532- CONFIG_NS16550_MIN_FUNCTIONS:
4533 Define this if you desire to only have use of the NS16550_init
4534 and NS16550_putc functions for the serial driver located at
4535 drivers/serial/ns16550.c. This option is useful for saving
4536 space for already greatly restricted images, including but not
4537 limited to NAND_SPL configurations.
4538
Simon Glassb2b92f52012-11-30 13:01:18 +00004539- CONFIG_DISPLAY_BOARDINFO
4540 Display information about the board that U-Boot is running on
4541 when U-Boot starts up. The board function checkboard() is called
4542 to do this.
4543
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004544- CONFIG_DISPLAY_BOARDINFO_LATE
4545 Similar to the previous option, but display this information
4546 later, once stdio is running and output goes to the LCD, if
4547 present.
4548
Sascha Silbefeb85802013-08-11 16:40:43 +02004549- CONFIG_BOARD_SIZE_LIMIT:
4550 Maximum size of the U-Boot image. When defined, the
4551 build system checks that the actual size does not
4552 exceed it.
4553
wdenkc6097192002-11-03 00:24:07 +00004554Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004555---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004556
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004557- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004558 Cache Line Size of the CPU.
4559
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004560- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004561 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004562
wdenk42d1f032003-10-15 23:53:47 +00004563 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4564 and RPXsuper) to be able to adjust the position of
4565 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004566
Timur Tabie46fedf2011-08-04 18:03:41 -05004567- CONFIG_SYS_CCSRBAR_DEFAULT:
4568 Default (power-on reset) physical address of CCSR on Freescale
4569 PowerPC SOCs.
4570
4571- CONFIG_SYS_CCSRBAR:
4572 Virtual address of CCSR. On a 32-bit build, this is typically
4573 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4574
4575 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4576 for cross-platform code that uses that macro instead.
4577
4578- CONFIG_SYS_CCSRBAR_PHYS:
4579 Physical address of CCSR. CCSR can be relocated to a new
4580 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004581 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004582 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4583 is typically relocated on 36-bit builds. It is recommended
4584 that this macro be defined via the _HIGH and _LOW macros:
4585
4586 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4587 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4588
4589- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004590 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4591 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004592 used in assembly code, so it must not contain typecasts or
4593 integer size suffixes (e.g. "ULL").
4594
4595- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4596 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4597 used in assembly code, so it must not contain typecasts or
4598 integer size suffixes (e.g. "ULL").
4599
4600- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4601 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4602 forced to a value that ensures that CCSR is not relocated.
4603
wdenk7f6c2cb2002-11-10 22:06:23 +00004604- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004605 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004606
4607 the default drive number (default value 0)
4608
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004609 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004610
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004611 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004612 (default value 1)
4613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004614 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004615
wdenk43d96162003-03-06 00:02:04 +00004616 defines the offset of register from address. It
4617 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004618 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004619
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004620 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4621 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004622 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004624 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004625 fdc_hw_init() is called at the beginning of the FDC
4626 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004627 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004628 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004629
Macpaul Lin0abddf82011-04-11 20:45:32 +00004630- CONFIG_IDE_AHB:
4631 Most IDE controllers were designed to be connected with PCI
4632 interface. Only few of them were designed for AHB interface.
4633 When software is doing ATA command and data transfer to
4634 IDE devices through IDE-AHB controller, some additional
4635 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004636 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004637
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004638- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004639 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004640 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004641
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004642- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004643
wdenk7152b1d2003-09-05 23:19:14 +00004644 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004645 initial data and stack; please note that this must be
4646 writable memory that is working WITHOUT special
4647 initialization, i. e. you CANNOT use normal RAM which
4648 will become available only after programming the
4649 memory controller and running certain initialization
4650 sequences.
4651
4652 U-Boot uses the following memory types:
4653 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4654 - MPC824X: data cache
4655 - PPC4xx: data cache
4656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004657- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004658
4659 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004660 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4661 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004662 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004663 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004664 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4665 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4666 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004667
4668 Note:
4669 On the MPC824X (or other systems that use the data
4670 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004671 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004672 point to an otherwise UNUSED address space between
4673 the top of RAM and the start of the PCI space.
4674
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004675- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004676
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004677- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004678
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004679- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004681- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004683- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004684
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004685- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004686
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004687- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004688 SDRAM timing
4689
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004690- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004691 periodic timer for refresh
4692
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004693- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004694
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004695- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4696 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4697 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4698 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004699 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4700
4701- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004702 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4703 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004704 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4705
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004706- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4707 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004708 Machine Mode Register and Memory Periodic Timer
4709 Prescaler definitions (SDRAM timing)
4710
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004711- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004712 enable I2C microcode relocation patch (MPC8xx);
4713 define relocation offset in DPRAM [DSP2]
4714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004715- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004716 enable SMC microcode relocation patch (MPC8xx);
4717 define relocation offset in DPRAM [SMC1]
4718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004719- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004720 enable SPI microcode relocation patch (MPC8xx);
4721 define relocation offset in DPRAM [SCC4]
4722
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004723- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004724 Use OSCM clock mode on MBX8xx board. Be careful,
4725 wrong setting might damage your board. Read
4726 doc/README.MBX before setting this variable!
4727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004728- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004729 Offset of the bootmode word in DPRAM used by post
4730 (Power On Self Tests). This definition overrides
4731 #define'd default value in commproc.h resp.
4732 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004733
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004734- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4735 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4736 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4737 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4738 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4739 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4740 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4741 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004742 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004743
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004744- CONFIG_PCI_DISABLE_PCIE:
4745 Disable PCI-Express on systems where it is supported but not
4746 required.
4747
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004748- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004749 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004750 Don't do any setup work, presumably because someone or
4751 something has already done it, and we don't need to do it
4752 a second time. Useful for platforms that are pre-booted
4753 by coreboot or similar.
4754
Gabor Juhos842033e2013-05-30 07:06:12 +00004755- CONFIG_PCI_INDIRECT_BRIDGE:
4756 Enable support for indirect PCI bridges.
4757
Kumar Galaa09b9b62010-12-30 12:09:53 -06004758- CONFIG_SYS_SRIO:
4759 Chip has SRIO or not
4760
4761- CONFIG_SRIO1:
4762 Board has SRIO 1 port available
4763
4764- CONFIG_SRIO2:
4765 Board has SRIO 2 port available
4766
Liu Gangc8b28152013-05-07 16:30:46 +08004767- CONFIG_SRIO_PCIE_BOOT_MASTER
4768 Board can support master function for Boot from SRIO and PCIE
4769
Kumar Galaa09b9b62010-12-30 12:09:53 -06004770- CONFIG_SYS_SRIOn_MEM_VIRT:
4771 Virtual Address of SRIO port 'n' memory region
4772
4773- CONFIG_SYS_SRIOn_MEM_PHYS:
4774 Physical Address of SRIO port 'n' memory region
4775
4776- CONFIG_SYS_SRIOn_MEM_SIZE:
4777 Size of SRIO port 'n' memory region
4778
Fabio Estevam66bd1842013-04-11 09:35:34 +00004779- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4780 Defined to tell the NAND controller that the NAND chip is using
4781 a 16 bit bus.
4782 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004783 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004784 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004785 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004786
4787- CONFIG_SYS_NDFC_EBC0_CFG
4788 Sets the EBC0_CFG register for the NDFC. If not defined
4789 a default value will be used.
4790
Ben Warrenbb99ad62006-09-07 16:50:54 -04004791- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004792 Get DDR timing information from an I2C EEPROM. Common
4793 with pluggable memory modules such as SODIMMs
4794
Ben Warrenbb99ad62006-09-07 16:50:54 -04004795 SPD_EEPROM_ADDRESS
4796 I2C address of the SPD EEPROM
4797
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004798- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004799 If SPD EEPROM is on an I2C bus other than the first
4800 one, specify here. Note that the value must resolve
4801 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004802
York Sun1b3e3c42011-06-07 09:42:16 +08004803- CONFIG_SYS_DDR_RAW_TIMING
4804 Get DDR timing information from other than SPD. Common with
4805 soldered DDR chips onboard without SPD. DDR raw timing
4806 parameters are extracted from datasheet and hard-coded into
4807 header files or board specific files.
4808
York Sun6f5e1dc2011-09-16 13:21:35 -07004809- CONFIG_FSL_DDR_INTERACTIVE
4810 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4811
York Sune32d59a2015-01-06 13:18:55 -08004812- CONFIG_FSL_DDR_SYNC_REFRESH
4813 Enable sync of refresh for multiple controllers.
4814
York Sun4516ff82015-03-19 09:30:28 -07004815- CONFIG_FSL_DDR_BIST
4816 Enable built-in memory test for Freescale DDR controllers.
4817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004818- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004819 Only for 83xx systems. If specified, then DDR should
4820 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004821
wdenkc26e4542004-04-18 10:13:26 +00004822- CONFIG_ETHER_ON_FEC[12]
4823 Define to enable FEC[12] on a 8xx series processor.
4824
4825- CONFIG_FEC[12]_PHY
4826 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004827 to the given FEC; i. e.
4828 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004829 means that the PHY with address 4 is connected to FEC1
4830
4831 When set to -1, means to probe for first available.
4832
4833- CONFIG_FEC[12]_PHY_NORXERR
4834 The PHY does not have a RXERR line (RMII only).
4835 (so program the FEC to ignore it).
4836
4837- CONFIG_RMII
4838 Enable RMII mode for all FECs.
4839 Note that this is a global option, we can't
4840 have one FEC in standard MII mode and another in RMII mode.
4841
wdenk5cf91d62004-04-23 20:32:05 +00004842- CONFIG_CRC32_VERIFY
4843 Add a verify option to the crc32 command.
4844 The syntax is:
4845
4846 => crc32 -v <address> <count> <crc32>
4847
4848 Where address/count indicate a memory area
4849 and crc32 is the correct crc32 which the
4850 area should have.
4851
wdenk56523f12004-07-11 17:40:54 +00004852- CONFIG_LOOPW
4853 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004854 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004855
stroese7b466642004-12-16 18:46:55 +00004856- CONFIG_MX_CYCLIC
4857 Add the "mdc" and "mwc" memory commands. These are cyclic
4858 "md/mw" commands.
4859 Examples:
4860
wdenkefe2a4d2004-12-16 21:44:03 +00004861 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004862 This command will print 4 bytes (10,11,12,13) each 500 ms.
4863
wdenkefe2a4d2004-12-16 21:44:03 +00004864 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004865 This command will write 12345678 to address 100 all 10 ms.
4866
wdenkefe2a4d2004-12-16 21:44:03 +00004867 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004868 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004869
wdenk8aa1a2d2005-04-04 12:44:11 +00004870- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004871 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004872 low level initializations (like setting up the memory
4873 controller) are omitted and/or U-Boot does not
4874 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004875
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004876 Normally this variable MUST NOT be defined. The only
4877 exception is when U-Boot is loaded (to RAM) by some
4878 other boot loader or by a debugger which performs
4879 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004880
Aneesh V401bb302011-07-13 05:11:07 +00004881- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004882 Modifies the behaviour of start.S when compiling a loader
4883 that is executed before the actual U-Boot. E.g. when
4884 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004885
Ying Zhang3aa29de2013-08-16 15:16:15 +08004886- CONFIG_TPL_BUILD
4887 Modifies the behaviour of start.S when compiling a loader
4888 that is executed after the SPL and before the actual U-Boot.
4889 It is loaded by the SPL.
4890
Ying Zhang5df572f2013-05-20 14:07:23 +08004891- CONFIG_SYS_MPC85XX_NO_RESETVEC
4892 Only for 85xx systems. If this variable is specified, the section
4893 .resetvec is not kept and the section .bootpg is placed in the
4894 previous 4k of the .text section.
4895
Simon Glass4213fc22013-02-24 17:33:14 +00004896- CONFIG_ARCH_MAP_SYSMEM
4897 Generally U-Boot (and in particular the md command) uses
4898 effective address. It is therefore not necessary to regard
4899 U-Boot address as virtual addresses that need to be translated
4900 to physical addresses. However, sandbox requires this, since
4901 it maintains its own little RAM buffer which contains all
4902 addressable memory. This option causes some memory accesses
4903 to be mapped through map_sysmem() / unmap_sysmem().
4904
Matthias Weisserd8834a12011-03-10 21:36:32 +00004905- CONFIG_USE_ARCH_MEMCPY
4906 CONFIG_USE_ARCH_MEMSET
4907 If these options are used a optimized version of memcpy/memset will
4908 be used if available. These functions may be faster under some
4909 conditions but may increase the binary size.
4910
Simon Glass588a13f2013-02-14 04:18:54 +00004911- CONFIG_X86_RESET_VECTOR
4912 If defined, the x86 reset vector code is included. This is not
4913 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004914
Mark Jacksonfc337052013-03-04 01:27:20 +00004915- CONFIG_SYS_MPUCLK
4916 Defines the MPU clock speed (in MHz).
4917
4918 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004919
Heiko Schocher16678eb2013-11-04 14:05:00 +01004920- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4921 Enables the RTC32K OSC on AM33xx based plattforms
4922
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004923- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4924 Option to disable subpage write in NAND driver
4925 driver that uses this:
4926 drivers/mtd/nand/davinci_nand.c
4927
Timur Tabif2717b42011-11-22 09:21:25 -06004928Freescale QE/FMAN Firmware Support:
4929-----------------------------------
4930
4931The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4932loading of "firmware", which is encoded in the QE firmware binary format.
4933This firmware often needs to be loaded during U-Boot booting, so macros
4934are used to identify the storage device (NOR flash, SPI, etc) and the address
4935within that device.
4936
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004937- CONFIG_SYS_FMAN_FW_ADDR
4938 The address in the storage device where the FMAN microcode is located. The
4939 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4940 is also specified.
4941
4942- CONFIG_SYS_QE_FW_ADDR
4943 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004944 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4945 is also specified.
4946
4947- CONFIG_SYS_QE_FMAN_FW_LENGTH
4948 The maximum possible size of the firmware. The firmware binary format
4949 has a field that specifies the actual size of the firmware, but it
4950 might not be possible to read any part of the firmware unless some
4951 local storage is allocated to hold the entire firmware first.
4952
4953- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4954 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4955 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4956 virtual address in NOR flash.
4957
4958- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4959 Specifies that QE/FMAN firmware is located in NAND flash.
4960 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4961
4962- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4963 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4964 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4965
4966- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4967 Specifies that QE/FMAN firmware is located on the primary SPI
4968 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4969
Liu Gang292dc6c2012-03-08 00:33:18 +00004970- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4971 Specifies that QE/FMAN firmware is located in the remote (master)
4972 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004973 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4974 window->master inbound window->master LAW->the ucode address in
4975 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004976
J. German Riverab940ca62014-06-23 15:15:55 -07004977Freescale Layerscape Management Complex Firmware Support:
4978---------------------------------------------------------
4979The Freescale Layerscape Management Complex (MC) supports the loading of
4980"firmware".
4981This firmware often needs to be loaded during U-Boot booting, so macros
4982are used to identify the storage device (NOR flash, SPI, etc) and the address
4983within that device.
4984
4985- CONFIG_FSL_MC_ENET
4986 Enable the MC driver for Layerscape SoCs.
4987
4988- CONFIG_SYS_LS_MC_FW_ADDR
4989 The address in the storage device where the firmware is located. The
4990 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4991 is also specified.
4992
4993- CONFIG_SYS_LS_MC_FW_LENGTH
4994 The maximum possible size of the firmware. The firmware binary format
4995 has a field that specifies the actual size of the firmware, but it
4996 might not be possible to read any part of the firmware unless some
4997 local storage is allocated to hold the entire firmware first.
4998
4999- CONFIG_SYS_LS_MC_FW_IN_NOR
5000 Specifies that MC firmware is located in NOR flash, mapped as
5001 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
5002 virtual address in NOR flash.
5003
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05305004Freescale Layerscape Debug Server Support:
5005-------------------------------------------
5006The Freescale Layerscape Debug Server Support supports the loading of
5007"Debug Server firmware" and triggering SP boot-rom.
5008This firmware often needs to be loaded during U-Boot booting.
5009
5010- CONFIG_FSL_DEBUG_SERVER
5011 Enable the Debug Server for Layerscape SoCs.
5012
5013- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
5014 Define minimum DDR size required for debug server image
5015
York Sunc0492142015-12-07 11:08:58 -08005016- CONFIG_SYS_MC_RSV_MEM_ALIGN
5017 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05305018
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02005019Reproducible builds
5020-------------------
5021
5022In order to achieve reproducible builds, timestamps used in the U-Boot build
5023process have to be set to a fixed value.
5024
5025This is done using the SOURCE_DATE_EPOCH environment variable.
5026SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
5027option for U-Boot or an environment variable in U-Boot.
5028
5029SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
5030
wdenkc6097192002-11-03 00:24:07 +00005031Building the Software:
5032======================
5033
Wolfgang Denk218ca722008-03-26 10:40:12 +01005034Building U-Boot has been tested in several native build environments
5035and in many different cross environments. Of course we cannot support
5036all possibly existing versions of cross development tools in all
5037(potentially obsolete) versions. In case of tool chain problems we
5038recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5039which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005040
Wolfgang Denk218ca722008-03-26 10:40:12 +01005041If you are not using a native environment, it is assumed that you
5042have GNU cross compiling tools available in your path. In this case,
5043you must set the environment variable CROSS_COMPILE in your shell.
5044Note that no changes to the Makefile or any other source files are
5045necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005046
Wolfgang Denk218ca722008-03-26 10:40:12 +01005047 $ CROSS_COMPILE=ppc_4xx-
5048 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005049
Peter Tyser2f8d3962009-03-13 18:54:51 -05005050Note: If you wish to generate Windows versions of the utilities in
5051 the tools directory you can use the MinGW toolchain
5052 (http://www.mingw.org). Set your HOST tools to the MinGW
5053 toolchain and execute 'make tools'. For example:
5054
5055 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5056
5057 Binaries such as tools/mkimage.exe will be created which can
5058 be executed on computers running Windows.
5059
Wolfgang Denk218ca722008-03-26 10:40:12 +01005060U-Boot is intended to be simple to build. After installing the
5061sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005062is done by typing:
5063
Holger Freytherab584d62014-08-04 09:26:05 +02005064 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005065
Holger Freytherab584d62014-08-04 09:26:05 +02005066where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005067rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005068
wdenk2729af92004-05-03 20:45:30 +00005069Note: for some board special configuration names may exist; check if
5070 additional information is available from the board vendor; for
5071 instance, the TQM823L systems are available without (standard)
5072 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005073 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005074
Holger Freytherab584d62014-08-04 09:26:05 +02005075 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005076 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005077
Holger Freytherab584d62014-08-04 09:26:05 +02005078 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005079 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005080
wdenk2729af92004-05-03 20:45:30 +00005081 etc.
wdenkc6097192002-11-03 00:24:07 +00005082
wdenkc6097192002-11-03 00:24:07 +00005083
wdenk2729af92004-05-03 20:45:30 +00005084Finally, type "make all", and you should get some working U-Boot
5085images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005086
wdenk2729af92004-05-03 20:45:30 +00005087- "u-boot.bin" is a raw binary image
5088- "u-boot" is an image in ELF binary format
5089- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005090
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005091By default the build is performed locally and the objects are saved
5092in the source directory. One of the two methods can be used to change
5093this behavior and build U-Boot to some external directory:
5094
50951. Add O= to the make command line invocations:
5096
5097 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005098 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005099 make O=/tmp/build all
5100
Timo Ketolaadbba992014-11-06 14:39:05 +020051012. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005102
Timo Ketolaadbba992014-11-06 14:39:05 +02005103 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005104 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005105 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005106 make all
5107
Timo Ketolaadbba992014-11-06 14:39:05 +02005108Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005109variable.
5110
wdenkc6097192002-11-03 00:24:07 +00005111
wdenk2729af92004-05-03 20:45:30 +00005112Please be aware that the Makefiles assume you are using GNU make, so
5113for instance on NetBSD you might need to use "gmake" instead of
5114native "make".
wdenkc6097192002-11-03 00:24:07 +00005115
wdenkc6097192002-11-03 00:24:07 +00005116
wdenk2729af92004-05-03 20:45:30 +00005117If the system board that you have is not listed, then you will need
5118to port U-Boot to your hardware platform. To do this, follow these
5119steps:
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk2729af92004-05-03 20:45:30 +000051211. Add a new configuration option for your board to the toplevel
Michael Jones4d675ae2012-03-15 22:48:10 +00005122 "boards.cfg" file, using the existing entries as examples.
5123 Follow the instructions there to keep the boards in order.
wdenk2729af92004-05-03 20:45:30 +000051242. Create a new directory to hold your board specific code. Add any
5125 files you need. In your board directory, you will need at least
5126 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
51273. Create a new configuration file "include/configs/<board>.h" for
5128 your board
51293. If you're porting U-Boot to a new CPU, then also create a new
5130 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020051314. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000051325. Type "make", and you should get a working "u-boot.srec" file
5133 to be installed on your target system.
51346. Debug and solve any problems that might arise.
5135 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005136
wdenkc6097192002-11-03 00:24:07 +00005137
wdenk2729af92004-05-03 20:45:30 +00005138Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5139==============================================================
wdenkc6097192002-11-03 00:24:07 +00005140
Wolfgang Denk218ca722008-03-26 10:40:12 +01005141If you have modified U-Boot sources (for instance added a new board
5142or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005143provide feedback to the other developers. The feedback normally takes
5144the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005145official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005146
Wolfgang Denk218ca722008-03-26 10:40:12 +01005147But before you submit such a patch, please verify that your modifi-
5148cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005149the supported boards compile WITHOUT ANY compiler warnings. To do so,
5150just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005151for ALL supported system. Be warned, this will take a while. You can
5152select which (cross) compiler to use by passing a `CROSS_COMPILE'
5153environment variable to the script, i. e. to use the ELDK cross tools
5154you can type
wdenkc6097192002-11-03 00:24:07 +00005155
wdenk2729af92004-05-03 20:45:30 +00005156 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005157
wdenk2729af92004-05-03 20:45:30 +00005158or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005159
wdenk2729af92004-05-03 20:45:30 +00005160 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005161
Wolfgang Denk218ca722008-03-26 10:40:12 +01005162When using the MAKEALL script, the default behaviour is to build
5163U-Boot in the source directory. This location can be changed by
5164setting the BUILD_DIR environment variable. Also, for each target
5165built, the MAKEALL script saves two log files (<target>.ERR and
5166<target>.MAKEALL) in the <source dir>/LOG directory. This default
5167location can be changed by setting the MAKEALL_LOGDIR environment
5168variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005169
5170 export BUILD_DIR=/tmp/build
5171 export MAKEALL_LOGDIR=/tmp/log
5172 CROSS_COMPILE=ppc_8xx- MAKEALL
5173
Wolfgang Denk218ca722008-03-26 10:40:12 +01005174With the above settings build objects are saved in the /tmp/build,
5175log files are saved in the /tmp/log and the source tree remains clean
5176during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005177
5178
wdenk2729af92004-05-03 20:45:30 +00005179See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005180
wdenkc6097192002-11-03 00:24:07 +00005181
wdenk2729af92004-05-03 20:45:30 +00005182Monitor Commands - Overview:
5183============================
wdenkc6097192002-11-03 00:24:07 +00005184
wdenk2729af92004-05-03 20:45:30 +00005185go - start application at address 'addr'
5186run - run commands in an environment variable
5187bootm - boot application image from memory
5188bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005189bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005190tftpboot- boot image via network using TFTP protocol
5191 and env variables "ipaddr" and "serverip"
5192 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005193tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005194rarpboot- boot image via network using RARP/TFTP protocol
5195diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5196loads - load S-Record file over serial line
5197loadb - load binary file over serial line (kermit mode)
5198md - memory display
5199mm - memory modify (auto-incrementing)
5200nm - memory modify (constant address)
5201mw - memory write (fill)
5202cp - memory copy
5203cmp - memory compare
5204crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005205i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005206sspi - SPI utility commands
5207base - print or set address offset
5208printenv- print environment variables
5209setenv - set environment variables
5210saveenv - save environment variables to persistent storage
5211protect - enable or disable FLASH write protection
5212erase - erase FLASH memory
5213flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005214nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005215bdinfo - print Board Info structure
5216iminfo - print header information for application image
5217coninfo - print console devices and informations
5218ide - IDE sub-system
5219loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005220loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005221mtest - simple RAM test
5222icache - enable or disable instruction cache
5223dcache - enable or disable data cache
5224reset - Perform RESET of the CPU
5225echo - echo args to console
5226version - print monitor version
5227help - print online help
5228? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005229
wdenkc6097192002-11-03 00:24:07 +00005230
wdenk2729af92004-05-03 20:45:30 +00005231Monitor Commands - Detailed Description:
5232========================================
wdenkc6097192002-11-03 00:24:07 +00005233
wdenk2729af92004-05-03 20:45:30 +00005234TODO.
wdenkc6097192002-11-03 00:24:07 +00005235
wdenk2729af92004-05-03 20:45:30 +00005236For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005237
5238
wdenk2729af92004-05-03 20:45:30 +00005239Environment Variables:
5240======================
wdenkc6097192002-11-03 00:24:07 +00005241
wdenk2729af92004-05-03 20:45:30 +00005242U-Boot supports user configuration using Environment Variables which
5243can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005244
wdenk2729af92004-05-03 20:45:30 +00005245Environment Variables are set using "setenv", printed using
5246"printenv", and saved to Flash using "saveenv". Using "setenv"
5247without a value can be used to delete a variable from the
5248environment. As long as you don't save the environment you are
5249working with an in-memory copy. In case the Flash area containing the
5250environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005251
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005252Some configuration options can be set using Environment Variables.
5253
5254List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005255
wdenk2729af92004-05-03 20:45:30 +00005256 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005257
wdenk2729af92004-05-03 20:45:30 +00005258 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005259
wdenk2729af92004-05-03 20:45:30 +00005260 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005261
wdenk2729af92004-05-03 20:45:30 +00005262 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005263
wdenk2729af92004-05-03 20:45:30 +00005264 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005265
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005266 bootm_low - Memory range available for image processing in the bootm
5267 command can be restricted. This variable is given as
5268 a hexadecimal number and defines lowest address allowed
5269 for use by the bootm command. See also "bootm_size"
5270 environment variable. Address defined by "bootm_low" is
5271 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005272 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5273 bootm_mapsize.
5274
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005275 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005276 This variable is given as a hexadecimal number and it
5277 defines the size of the memory region starting at base
5278 address bootm_low that is accessible by the Linux kernel
5279 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5280 as the default value if it is defined, and bootm_size is
5281 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005282
5283 bootm_size - Memory range available for image processing in the bootm
5284 command can be restricted. This variable is given as
5285 a hexadecimal number and defines the size of the region
5286 allowed for use by the bootm command. See also "bootm_low"
5287 environment variable.
5288
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005289 updatefile - Location of the software update file on a TFTP server, used
5290 by the automatic software update feature. Please refer to
5291 documentation in doc/README.update for more details.
5292
wdenk2729af92004-05-03 20:45:30 +00005293 autoload - if set to "no" (any string beginning with 'n'),
5294 "bootp" will just load perform a lookup of the
5295 configuration from the BOOTP server, but not try to
5296 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005297
wdenk2729af92004-05-03 20:45:30 +00005298 autostart - if set to "yes", an image loaded using the "bootp",
5299 "rarpboot", "tftpboot" or "diskboot" commands will
5300 be automatically started (by internally calling
5301 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk2729af92004-05-03 20:45:30 +00005303 If set to "no", a standalone image passed to the
5304 "bootm" command will be copied to the load address
5305 (and eventually uncompressed), but NOT be started.
5306 This can be used to load and uncompress arbitrary
5307 data.
wdenkc6097192002-11-03 00:24:07 +00005308
David A. Longa28afca2011-07-09 16:40:19 -04005309 fdt_high - if set this restricts the maximum address that the
5310 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005311 For example, if you have a system with 1 GB memory
5312 at physical address 0x10000000, while Linux kernel
5313 only recognizes the first 704 MB as low memory, you
5314 may need to set fdt_high as 0x3C000000 to have the
5315 device tree blob be copied to the maximum address
5316 of the 704 MB low memory, so that Linux kernel can
5317 access it during the boot procedure.
5318
David A. Longa28afca2011-07-09 16:40:19 -04005319 If this is set to the special value 0xFFFFFFFF then
5320 the fdt will not be copied at all on boot. For this
5321 to work it must reside in writable memory, have
5322 sufficient padding on the end of it for u-boot to
5323 add the information it needs into it, and the memory
5324 must be accessible by the kernel.
5325
Simon Glasseea63e02011-10-24 19:15:34 +00005326 fdtcontroladdr- if set this is the address of the control flattened
5327 device tree used by U-Boot when CONFIG_OF_CONTROL is
5328 defined.
5329
wdenk17ea1172004-06-06 21:51:03 +00005330 i2cfast - (PPC405GP|PPC405EP only)
5331 if set to 'y' configures Linux I2C driver for fast
5332 mode (400kHZ). This environment variable is used in
5333 initialization code. So, for changes to be effective
5334 it must be saved and board must be reset.
5335
wdenk2729af92004-05-03 20:45:30 +00005336 initrd_high - restrict positioning of initrd images:
5337 If this variable is not set, initrd images will be
5338 copied to the highest possible address in RAM; this
5339 is usually what you want since it allows for
5340 maximum initrd size. If for some reason you want to
5341 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005342 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005343 variable to a value of "no" or "off" or "0".
5344 Alternatively, you can set it to a maximum upper
5345 address to use (U-Boot will still check that it
5346 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005347
wdenk2729af92004-05-03 20:45:30 +00005348 For instance, when you have a system with 16 MB
5349 RAM, and want to reserve 4 MB from use by Linux,
5350 you can do this by adding "mem=12M" to the value of
5351 the "bootargs" variable. However, now you must make
5352 sure that the initrd image is placed in the first
5353 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005354
wdenk2729af92004-05-03 20:45:30 +00005355 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005356
wdenk2729af92004-05-03 20:45:30 +00005357 If you set initrd_high to 0xFFFFFFFF, this is an
5358 indication to U-Boot that all addresses are legal
5359 for the Linux kernel, including addresses in flash
5360 memory. In this case U-Boot will NOT COPY the
5361 ramdisk at all. This may be useful to reduce the
5362 boot time on your system, but requires that this
5363 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005364
wdenk2729af92004-05-03 20:45:30 +00005365 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005366
wdenk2729af92004-05-03 20:45:30 +00005367 loadaddr - Default load address for commands like "bootp",
5368 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005369
wdenk2729af92004-05-03 20:45:30 +00005370 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005371
wdenk2729af92004-05-03 20:45:30 +00005372 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005373
wdenk2729af92004-05-03 20:45:30 +00005374 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005375
wdenk2729af92004-05-03 20:45:30 +00005376 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005377
wdenk2729af92004-05-03 20:45:30 +00005378 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005379
Mike Frysingere2a53452011-10-02 10:01:27 +00005380 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005381
Mike Frysingere2a53452011-10-02 10:01:27 +00005382 ethact - controls which interface is currently active.
5383 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005384
Heiko Schocher48690d82010-07-20 17:45:02 +02005385 => setenv ethact FEC
5386 => ping 192.168.0.1 # traffic sent on FEC
5387 => setenv ethact SCC
5388 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005389
Matthias Fuchse1692572008-01-17 07:45:05 +01005390 ethrotate - When set to "no" U-Boot does not go through all
5391 available network interfaces.
5392 It just stays at the currently selected interface.
5393
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005394 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005395 either succeed or fail without retrying.
5396 When set to "once" the network operation will
5397 fail when all the available network interfaces
5398 are tried once without success.
5399 Useful on scripts which control the retry operation
5400 themselves.
wdenkc6097192002-11-03 00:24:07 +00005401
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005402 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005403
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005404 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005405 changing the console to be empty. If "yes" it will be
5406 made silent. If "no" it will not be made silent. If
5407 unset, then it will be made silent if the U-Boot console
5408 is silent.
5409
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005410 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005411 UDP source port.
5412
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005413 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005414 destination port instead of the Well Know Port 69.
5415
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005416 tftpblocksize - Block size to use for TFTP transfers; if not set,
5417 we use the TFTP server's default block size
5418
5419 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5420 seconds, minimum value is 1000 = 1 second). Defines
5421 when a packet is considered to be lost so it has to
5422 be retransmitted. The default is 5000 = 5 seconds.
5423 Lowering this value may make downloads succeed
5424 faster in networks with high packet loss rates or
5425 with unreliable TFTP servers.
5426
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005427 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5428 unit, minimum value = 0). Defines how many timeouts
5429 can happen during a single file transfer before that
5430 transfer is aborted. The default is 10, and 0 means
5431 'no timeouts allowed'. Increasing this value may help
5432 downloads succeed with high packet loss rates, or with
5433 unreliable TFTP servers or client hardware.
5434
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005435 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005436 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005437 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005438
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005439The following image location variables contain the location of images
5440used in booting. The "Image" column gives the role of the image and is
5441not an environment variable name. The other columns are environment
5442variable names. "File Name" gives the name of the file on a TFTP
5443server, "RAM Address" gives the location in RAM the image will be
5444loaded to, and "Flash Location" gives the image's address in NOR
5445flash or offset in NAND flash.
5446
5447*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03005448boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005449boards use these variables for other purposes.
5450
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005451Image File Name RAM Address Flash Location
5452----- --------- ----------- --------------
5453u-boot u-boot u-boot_addr_r u-boot_addr
5454Linux kernel bootfile kernel_addr_r kernel_addr
5455device tree blob fdtfile fdt_addr_r fdt_addr
5456ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005457
wdenk2729af92004-05-03 20:45:30 +00005458The following environment variables may be used and automatically
5459updated by the network boot commands ("bootp" and "rarpboot"),
5460depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005461
wdenk2729af92004-05-03 20:45:30 +00005462 bootfile - see above
5463 dnsip - IP address of your Domain Name Server
5464 dnsip2 - IP address of your secondary Domain Name Server
5465 gatewayip - IP address of the Gateway (Router) to use
5466 hostname - Target hostname
5467 ipaddr - see above
5468 netmask - Subnet Mask
5469 rootpath - Pathname of the root filesystem on the NFS server
5470 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005471
wdenka3d991b2004-04-15 21:48:45 +00005472
wdenk2729af92004-05-03 20:45:30 +00005473There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005474
wdenk2729af92004-05-03 20:45:30 +00005475 serial# - contains hardware identification information such
5476 as type string and/or serial number
5477 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005478
wdenk2729af92004-05-03 20:45:30 +00005479These variables can be set only once (usually during manufacturing of
5480the board). U-Boot refuses to delete or overwrite these variables
5481once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005482
5483
wdenk2729af92004-05-03 20:45:30 +00005484Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005485
wdenk2729af92004-05-03 20:45:30 +00005486 ver - Contains the U-Boot version string as printed
5487 with the "version" command. This variable is
5488 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005489
wdenkc6097192002-11-03 00:24:07 +00005490
wdenk2729af92004-05-03 20:45:30 +00005491Please note that changes to some configuration parameters may take
5492only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005493
stroesec1551ea2003-04-04 15:53:41 +00005494
Joe Hershberger170ab112012-12-11 22:16:24 -06005495Callback functions for environment variables:
5496---------------------------------------------
5497
5498For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005499when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005500be associated with arbitrary variables. On creation, overwrite, or
5501deletion, the callback will provide the opportunity for some side
5502effect to happen or for the change to be rejected.
5503
5504The callbacks are named and associated with a function using the
5505U_BOOT_ENV_CALLBACK macro in your board or driver code.
5506
5507These callbacks are associated with variables in one of two ways. The
5508static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5509in the board configuration to a string that defines a list of
5510associations. The list must be in the following format:
5511
5512 entry = variable_name[:callback_name]
5513 list = entry[,list]
5514
5515If the callback name is not specified, then the callback is deleted.
5516Spaces are also allowed anywhere in the list.
5517
5518Callbacks can also be associated by defining the ".callbacks" variable
5519with the same list format above. Any association in ".callbacks" will
5520override any association in the static list. You can define
5521CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005522".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005523
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05005524If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5525regular expression. This allows multiple variables to be connected to
5526the same callback without explicitly listing them all out.
5527
Joe Hershberger170ab112012-12-11 22:16:24 -06005528
wdenk2729af92004-05-03 20:45:30 +00005529Command Line Parsing:
5530=====================
stroesec1551ea2003-04-04 15:53:41 +00005531
wdenk2729af92004-05-03 20:45:30 +00005532There are two different command line parsers available with U-Boot:
5533the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005534
wdenk2729af92004-05-03 20:45:30 +00005535Old, simple command line parser:
5536--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005537
wdenk2729af92004-05-03 20:45:30 +00005538- supports environment variables (through setenv / saveenv commands)
5539- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005540- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005541- special characters ('$', ';') can be escaped by prefixing with '\',
5542 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005543 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005544- You can also escape text by enclosing in single apostrophes, for example:
5545 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005546
wdenk2729af92004-05-03 20:45:30 +00005547Hush shell:
5548-----------
wdenkf07771c2003-05-28 08:06:31 +00005549
wdenk2729af92004-05-03 20:45:30 +00005550- similar to Bourne shell, with control structures like
5551 if...then...else...fi, for...do...done; while...do...done,
5552 until...do...done, ...
5553- supports environment ("global") variables (through setenv / saveenv
5554 commands) and local shell variables (through standard shell syntax
5555 "name=value"); only environment variables can be used with "run"
5556 command
wdenkf07771c2003-05-28 08:06:31 +00005557
wdenk2729af92004-05-03 20:45:30 +00005558General rules:
5559--------------
wdenkf07771c2003-05-28 08:06:31 +00005560
wdenk2729af92004-05-03 20:45:30 +00005561(1) If a command line (or an environment variable executed by a "run"
5562 command) contains several commands separated by semicolon, and
5563 one of these commands fails, then the remaining commands will be
5564 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005565
wdenk2729af92004-05-03 20:45:30 +00005566(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005567 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005568 command will cause "run" to terminate, i. e. the remaining
5569 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005570
wdenk2729af92004-05-03 20:45:30 +00005571Note for Redundant Ethernet Interfaces:
5572=======================================
wdenkf07771c2003-05-28 08:06:31 +00005573
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005574Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005575such configurations and is capable of automatic selection of a
5576"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005577
wdenk2729af92004-05-03 20:45:30 +00005578Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5579MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5580"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005581
wdenk2729af92004-05-03 20:45:30 +00005582If the network interface stores some valid MAC address (for instance
5583in SROM), this is used as default address if there is NO correspon-
5584ding setting in the environment; if the corresponding environment
5585variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005586
wdenk2729af92004-05-03 20:45:30 +00005587o If the SROM has a valid MAC address, and there is no address in the
5588 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005589
wdenk2729af92004-05-03 20:45:30 +00005590o If there is no valid address in the SROM, and a definition in the
5591 environment exists, then the value from the environment variable is
5592 used.
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594o If both the SROM and the environment contain a MAC address, and
5595 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk2729af92004-05-03 20:45:30 +00005597o If both the SROM and the environment contain a MAC address, and the
5598 addresses differ, the value from the environment is used and a
5599 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk2729af92004-05-03 20:45:30 +00005601o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05005602 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5603 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005604
Ben Warrenecee9322010-04-26 11:11:46 -07005605If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005606will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005607may be skipped by setting the appropriate 'ethmacskip' environment variable.
5608The naming convention is as follows:
5609"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk2729af92004-05-03 20:45:30 +00005611Image Formats:
5612==============
wdenkc6097192002-11-03 00:24:07 +00005613
Marian Balakowicz3310c542008-03-12 12:13:13 +01005614U-Boot is capable of booting (and performing other auxiliary operations on)
5615images in two formats:
5616
5617New uImage format (FIT)
5618-----------------------
5619
5620Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5621to Flattened Device Tree). It allows the use of images with multiple
5622components (several kernels, ramdisks, etc.), with contents protected by
5623SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5624
5625
5626Old uImage format
5627-----------------
5628
5629Old image format is based on binary files which can be basically anything,
5630preceded by a special header; see the definitions in include/image.h for
5631details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005632
wdenk2729af92004-05-03 20:45:30 +00005633* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5634 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005635 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5636 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5637 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005638* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005639 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5640 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005641* Compression Type (uncompressed, gzip, bzip2)
5642* Load Address
5643* Entry Point
5644* Image Name
5645* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005646
wdenk2729af92004-05-03 20:45:30 +00005647The header is marked by a special Magic Number, and both the header
5648and the data portions of the image are secured against corruption by
5649CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005650
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652Linux Support:
5653==============
wdenkc6097192002-11-03 00:24:07 +00005654
wdenk2729af92004-05-03 20:45:30 +00005655Although U-Boot should support any OS or standalone application
5656easily, the main focus has always been on Linux during the design of
5657U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk2729af92004-05-03 20:45:30 +00005659U-Boot includes many features that so far have been part of some
5660special "boot loader" code within the Linux kernel. Also, any
5661"initrd" images to be used are no longer part of one big Linux image;
5662instead, kernel and "initrd" are separate images. This implementation
5663serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005664
wdenk2729af92004-05-03 20:45:30 +00005665- the same features can be used for other OS or standalone
5666 applications (for instance: using compressed images to reduce the
5667 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005668
wdenk2729af92004-05-03 20:45:30 +00005669- it becomes much easier to port new Linux kernel versions because
5670 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk2729af92004-05-03 20:45:30 +00005672- the same Linux kernel image can now be used with different "initrd"
5673 images; of course this also means that different kernel images can
5674 be run with the same "initrd". This makes testing easier (you don't
5675 have to build a new "zImage.initrd" Linux image when you just
5676 change a file in your "initrd"). Also, a field-upgrade of the
5677 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005678
wdenkc6097192002-11-03 00:24:07 +00005679
wdenk2729af92004-05-03 20:45:30 +00005680Linux HOWTO:
5681============
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk2729af92004-05-03 20:45:30 +00005683Porting Linux to U-Boot based systems:
5684---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk2729af92004-05-03 20:45:30 +00005686U-Boot cannot save you from doing all the necessary modifications to
5687configure the Linux device drivers for use with your target hardware
5688(no, we don't intend to provide a full virtual machine interface to
5689Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005690
Stefan Roesea47a12b2010-04-15 16:07:28 +02005691But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005692
wdenk2729af92004-05-03 20:45:30 +00005693Just make sure your machine specific header file (for instance
5694include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005695Information structure as we define in include/asm-<arch>/u-boot.h,
5696and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005697as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005698
Simon Glass2eb31b12014-06-11 23:29:46 -06005699Note that U-Boot now has a driver model, a unified model for drivers.
5700If you are adding a new driver, plumb it into driver model. If there
5701is no uclass available, you are encouraged to create one. See
5702doc/driver-model.
5703
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk2729af92004-05-03 20:45:30 +00005705Configuring the Linux kernel:
5706-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005707
wdenk2729af92004-05-03 20:45:30 +00005708No specific requirements for U-Boot. Make sure you have some root
5709device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005710
wdenkc6097192002-11-03 00:24:07 +00005711
wdenk2729af92004-05-03 20:45:30 +00005712Building a Linux Image:
5713-----------------------
wdenkc6097192002-11-03 00:24:07 +00005714
wdenk2729af92004-05-03 20:45:30 +00005715With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5716not used. If you use recent kernel source, a new build target
5717"uImage" will exist which automatically builds an image usable by
5718U-Boot. Most older kernels also have support for a "pImage" target,
5719which was introduced for our predecessor project PPCBoot and uses a
5720100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005721
wdenk2729af92004-05-03 20:45:30 +00005722Example:
wdenkc6097192002-11-03 00:24:07 +00005723
Holger Freytherab584d62014-08-04 09:26:05 +02005724 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005725 make oldconfig
5726 make dep
5727 make uImage
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk2729af92004-05-03 20:45:30 +00005729The "uImage" build target uses a special tool (in 'tools/mkimage') to
5730encapsulate a compressed Linux kernel image with header information,
5731CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005732
wdenk2729af92004-05-03 20:45:30 +00005733* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005734
wdenk2729af92004-05-03 20:45:30 +00005735* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005736
wdenk2729af92004-05-03 20:45:30 +00005737 ${CROSS_COMPILE}-objcopy -O binary \
5738 -R .note -R .comment \
5739 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005740
wdenk2729af92004-05-03 20:45:30 +00005741* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005742
wdenk2729af92004-05-03 20:45:30 +00005743 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk2729af92004-05-03 20:45:30 +00005745* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005746
wdenk2729af92004-05-03 20:45:30 +00005747 mkimage -A ppc -O linux -T kernel -C gzip \
5748 -a 0 -e 0 -n "Linux Kernel Image" \
5749 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005750
wdenk24ee89b2002-11-03 17:56:27 +00005751
wdenk2729af92004-05-03 20:45:30 +00005752The "mkimage" tool can also be used to create ramdisk images for use
5753with U-Boot, either separated from the Linux kernel image, or
5754combined into one file. "mkimage" encapsulates the images with a 64
5755byte header containing information about target architecture,
5756operating system, image type, compression method, entry points, time
5757stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005758
wdenk2729af92004-05-03 20:45:30 +00005759"mkimage" can be called in two ways: to verify existing images and
5760print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005761
wdenk2729af92004-05-03 20:45:30 +00005762In the first form (with "-l" option) mkimage lists the information
5763contained in the header of an existing U-Boot image; this includes
5764checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005765
wdenk2729af92004-05-03 20:45:30 +00005766 tools/mkimage -l image
5767 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005768
wdenk2729af92004-05-03 20:45:30 +00005769The second form (with "-d" option) is used to build a U-Boot image
5770from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005771
wdenk2729af92004-05-03 20:45:30 +00005772 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5773 -n name -d data_file image
5774 -A ==> set architecture to 'arch'
5775 -O ==> set operating system to 'os'
5776 -T ==> set image type to 'type'
5777 -C ==> set compression type 'comp'
5778 -a ==> set load address to 'addr' (hex)
5779 -e ==> set entry point to 'ep' (hex)
5780 -n ==> set image name to 'name'
5781 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005782
wdenk69459792004-05-29 16:53:29 +00005783Right now, all Linux kernels for PowerPC systems use the same load
5784address (0x00000000), but the entry point address depends on the
5785kernel version:
wdenkc6097192002-11-03 00:24:07 +00005786
wdenk2729af92004-05-03 20:45:30 +00005787- 2.2.x kernels have the entry point at 0x0000000C,
5788- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005789
wdenk2729af92004-05-03 20:45:30 +00005790So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005791
wdenk2729af92004-05-03 20:45:30 +00005792 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5793 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005794 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005795 > examples/uImage.TQM850L
5796 Image Name: 2.4.4 kernel for TQM850L
5797 Created: Wed Jul 19 02:34:59 2000
5798 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5799 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5800 Load Address: 0x00000000
5801 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005802
wdenk2729af92004-05-03 20:45:30 +00005803To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005804
wdenk2729af92004-05-03 20:45:30 +00005805 -> tools/mkimage -l examples/uImage.TQM850L
5806 Image Name: 2.4.4 kernel for TQM850L
5807 Created: Wed Jul 19 02:34:59 2000
5808 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5809 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5810 Load Address: 0x00000000
5811 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005812
wdenk2729af92004-05-03 20:45:30 +00005813NOTE: for embedded systems where boot time is critical you can trade
5814speed for memory and install an UNCOMPRESSED image instead: this
5815needs more space in Flash, but boots much faster since it does not
5816need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005817
Stefan Roesea47a12b2010-04-15 16:07:28 +02005818 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005819 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5820 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005821 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005822 > examples/uImage.TQM850L-uncompressed
5823 Image Name: 2.4.4 kernel for TQM850L
5824 Created: Wed Jul 19 02:34:59 2000
5825 Image Type: PowerPC Linux Kernel Image (uncompressed)
5826 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5827 Load Address: 0x00000000
5828 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005829
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk2729af92004-05-03 20:45:30 +00005831Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5832when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005833
wdenk2729af92004-05-03 20:45:30 +00005834 -> tools/mkimage -n 'Simple Ramdisk Image' \
5835 > -A ppc -O linux -T ramdisk -C gzip \
5836 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5837 Image Name: Simple Ramdisk Image
5838 Created: Wed Jan 12 14:01:50 2000
5839 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5840 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5841 Load Address: 0x00000000
5842 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005843
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005844The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5845option performs the converse operation of the mkimage's second form (the "-d"
5846option). Given an image built by mkimage, the dumpimage extracts a "data file"
5847from the image:
5848
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005849 tools/dumpimage -i image -T type -p position data_file
5850 -i ==> extract from the 'image' a specific 'data_file'
5851 -T ==> set image type to 'type'
5852 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005853
wdenkdb01a2e2004-04-15 23:14:49 +00005854
wdenk2729af92004-05-03 20:45:30 +00005855Installing a Linux Image:
5856-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005857
wdenk2729af92004-05-03 20:45:30 +00005858To downloading a U-Boot image over the serial (console) interface,
5859you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005860
wdenk2729af92004-05-03 20:45:30 +00005861 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005862
wdenk2729af92004-05-03 20:45:30 +00005863The 'objcopy' does not understand the information in the U-Boot
5864image header, so the resulting S-Record file will be relative to
5865address 0x00000000. To load it to a given address, you need to
5866specify the target address as 'offset' parameter with the 'loads'
5867command.
wdenkc6097192002-11-03 00:24:07 +00005868
wdenk2729af92004-05-03 20:45:30 +00005869Example: install the image to address 0x40100000 (which on the
5870TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005871
wdenk2729af92004-05-03 20:45:30 +00005872 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005873
wdenk2729af92004-05-03 20:45:30 +00005874 .......... done
5875 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005876
wdenk2729af92004-05-03 20:45:30 +00005877 => loads 40100000
5878 ## Ready for S-Record download ...
5879 ~>examples/image.srec
5880 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5881 ...
5882 15989 15990 15991 15992
5883 [file transfer complete]
5884 [connected]
5885 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005886
5887
wdenk2729af92004-05-03 20:45:30 +00005888You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005889this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005890corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005891
wdenk2729af92004-05-03 20:45:30 +00005892 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005893
wdenk2729af92004-05-03 20:45:30 +00005894 ## Checking Image at 40100000 ...
5895 Image Name: 2.2.13 for initrd on TQM850L
5896 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5897 Data Size: 335725 Bytes = 327 kB = 0 MB
5898 Load Address: 00000000
5899 Entry Point: 0000000c
5900 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005901
5902
wdenk2729af92004-05-03 20:45:30 +00005903Boot Linux:
5904-----------
wdenkc6097192002-11-03 00:24:07 +00005905
wdenk2729af92004-05-03 20:45:30 +00005906The "bootm" command is used to boot an application that is stored in
5907memory (RAM or Flash). In case of a Linux kernel image, the contents
5908of the "bootargs" environment variable is passed to the kernel as
5909parameters. You can check and modify this variable using the
5910"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005911
5912
wdenk2729af92004-05-03 20:45:30 +00005913 => printenv bootargs
5914 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005915
wdenk2729af92004-05-03 20:45:30 +00005916 => 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 +00005917
wdenk2729af92004-05-03 20:45:30 +00005918 => printenv bootargs
5919 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 +00005920
wdenk2729af92004-05-03 20:45:30 +00005921 => bootm 40020000
5922 ## Booting Linux kernel at 40020000 ...
5923 Image Name: 2.2.13 for NFS on TQM850L
5924 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5925 Data Size: 381681 Bytes = 372 kB = 0 MB
5926 Load Address: 00000000
5927 Entry Point: 0000000c
5928 Verifying Checksum ... OK
5929 Uncompressing Kernel Image ... OK
5930 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
5931 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5932 time_init: decrementer frequency = 187500000/60
5933 Calibrating delay loop... 49.77 BogoMIPS
5934 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5935 ...
wdenkc6097192002-11-03 00:24:07 +00005936
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005937If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005938the memory addresses of both the kernel and the initrd image (PPBCOOT
5939format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005940
wdenk2729af92004-05-03 20:45:30 +00005941 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005942
wdenk2729af92004-05-03 20:45:30 +00005943 ## Checking Image at 40100000 ...
5944 Image Name: 2.2.13 for initrd on TQM850L
5945 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5946 Data Size: 335725 Bytes = 327 kB = 0 MB
5947 Load Address: 00000000
5948 Entry Point: 0000000c
5949 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005950
wdenk2729af92004-05-03 20:45:30 +00005951 ## Checking Image at 40200000 ...
5952 Image Name: Simple Ramdisk Image
5953 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5954 Data Size: 566530 Bytes = 553 kB = 0 MB
5955 Load Address: 00000000
5956 Entry Point: 00000000
5957 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005958
wdenk2729af92004-05-03 20:45:30 +00005959 => bootm 40100000 40200000
5960 ## Booting Linux kernel at 40100000 ...
5961 Image Name: 2.2.13 for initrd on TQM850L
5962 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5963 Data Size: 335725 Bytes = 327 kB = 0 MB
5964 Load Address: 00000000
5965 Entry Point: 0000000c
5966 Verifying Checksum ... OK
5967 Uncompressing Kernel Image ... OK
5968 ## Loading RAMDisk Image at 40200000 ...
5969 Image Name: Simple Ramdisk Image
5970 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5971 Data Size: 566530 Bytes = 553 kB = 0 MB
5972 Load Address: 00000000
5973 Entry Point: 00000000
5974 Verifying Checksum ... OK
5975 Loading Ramdisk ... OK
5976 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
5977 Boot arguments: root=/dev/ram
5978 time_init: decrementer frequency = 187500000/60
5979 Calibrating delay loop... 49.77 BogoMIPS
5980 ...
5981 RAMDISK: Compressed image found at block 0
5982 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005983
wdenk2729af92004-05-03 20:45:30 +00005984 bash#
wdenkc6097192002-11-03 00:24:07 +00005985
Matthew McClintock02677682006-06-28 10:41:37 -05005986Boot Linux and pass a flat device tree:
5987-----------
5988
5989First, U-Boot must be compiled with the appropriate defines. See the section
5990titled "Linux Kernel Interface" above for a more in depth explanation. The
5991following is an example of how to start a kernel and pass an updated
5992flat device tree:
5993
5994=> print oftaddr
5995oftaddr=0x300000
5996=> print oft
5997oft=oftrees/mpc8540ads.dtb
5998=> tftp $oftaddr $oft
5999Speed: 1000, full duplex
6000Using TSEC0 device
6001TFTP from server 192.168.1.1; our IP address is 192.168.1.101
6002Filename 'oftrees/mpc8540ads.dtb'.
6003Load address: 0x300000
6004Loading: #
6005done
6006Bytes transferred = 4106 (100a hex)
6007=> tftp $loadaddr $bootfile
6008Speed: 1000, full duplex
6009Using TSEC0 device
6010TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6011Filename 'uImage'.
6012Load address: 0x200000
6013Loading:############
6014done
6015Bytes transferred = 1029407 (fb51f hex)
6016=> print loadaddr
6017loadaddr=200000
6018=> print oftaddr
6019oftaddr=0x300000
6020=> bootm $loadaddr - $oftaddr
6021## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006022 Image Name: Linux-2.6.17-dirty
6023 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6024 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006025 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006026 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006027 Verifying Checksum ... OK
6028 Uncompressing Kernel Image ... OK
6029Booting using flat device tree at 0x300000
6030Using MPC85xx ADS machine description
6031Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6032[snip]
6033
6034
wdenk2729af92004-05-03 20:45:30 +00006035More About U-Boot Image Types:
6036------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006037
wdenk2729af92004-05-03 20:45:30 +00006038U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006039
wdenk2729af92004-05-03 20:45:30 +00006040 "Standalone Programs" are directly runnable in the environment
6041 provided by U-Boot; it is expected that (if they behave
6042 well) you can continue to work in U-Boot after return from
6043 the Standalone Program.
6044 "OS Kernel Images" are usually images of some Embedded OS which
6045 will take over control completely. Usually these programs
6046 will install their own set of exception handlers, device
6047 drivers, set up the MMU, etc. - this means, that you cannot
6048 expect to re-enter U-Boot except by resetting the CPU.
6049 "RAMDisk Images" are more or less just data blocks, and their
6050 parameters (address, size) are passed to an OS kernel that is
6051 being started.
6052 "Multi-File Images" contain several images, typically an OS
6053 (Linux) kernel image and one or more data images like
6054 RAMDisks. This construct is useful for instance when you want
6055 to boot over the network using BOOTP etc., where the boot
6056 server provides just a single image file, but you want to get
6057 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006058
wdenk2729af92004-05-03 20:45:30 +00006059 "Multi-File Images" start with a list of image sizes, each
6060 image size (in bytes) specified by an "uint32_t" in network
6061 byte order. This list is terminated by an "(uint32_t)0".
6062 Immediately after the terminating 0 follow the images, one by
6063 one, all aligned on "uint32_t" boundaries (size rounded up to
6064 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006065
wdenk2729af92004-05-03 20:45:30 +00006066 "Firmware Images" are binary images containing firmware (like
6067 U-Boot or FPGA images) which usually will be programmed to
6068 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006069
wdenk2729af92004-05-03 20:45:30 +00006070 "Script files" are command sequences that will be executed by
6071 U-Boot's command interpreter; this feature is especially
6072 useful when you configure U-Boot to use a real shell (hush)
6073 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006074
Marek Vasut44f074c2012-03-14 21:52:45 +00006075Booting the Linux zImage:
6076-------------------------
6077
6078On some platforms, it's possible to boot Linux zImage. This is done
6079using the "bootz" command. The syntax of "bootz" command is the same
6080as the syntax of "bootm" command.
6081
Tom Rini8ac28562013-05-16 11:40:11 -04006082Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006083kernel with raw initrd images. The syntax is slightly different, the
6084address of the initrd must be augmented by it's size, in the following
6085format: "<initrd addres>:<initrd size>".
6086
wdenkc6097192002-11-03 00:24:07 +00006087
wdenk2729af92004-05-03 20:45:30 +00006088Standalone HOWTO:
6089=================
wdenkc6097192002-11-03 00:24:07 +00006090
wdenk2729af92004-05-03 20:45:30 +00006091One of the features of U-Boot is that you can dynamically load and
6092run "standalone" applications, which can use some resources of
6093U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006094
wdenk2729af92004-05-03 20:45:30 +00006095Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006096
wdenk2729af92004-05-03 20:45:30 +00006097"Hello World" Demo:
6098-------------------
wdenkc6097192002-11-03 00:24:07 +00006099
wdenk2729af92004-05-03 20:45:30 +00006100'examples/hello_world.c' contains a small "Hello World" Demo
6101application; it is automatically compiled when you build U-Boot.
6102It's configured to run at address 0x00040004, so you can play with it
6103like that:
wdenkc6097192002-11-03 00:24:07 +00006104
wdenk2729af92004-05-03 20:45:30 +00006105 => loads
6106 ## Ready for S-Record download ...
6107 ~>examples/hello_world.srec
6108 1 2 3 4 5 6 7 8 9 10 11 ...
6109 [file transfer complete]
6110 [connected]
6111 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006112
wdenk2729af92004-05-03 20:45:30 +00006113 => go 40004 Hello World! This is a test.
6114 ## Starting application at 0x00040004 ...
6115 Hello World
6116 argc = 7
6117 argv[0] = "40004"
6118 argv[1] = "Hello"
6119 argv[2] = "World!"
6120 argv[3] = "This"
6121 argv[4] = "is"
6122 argv[5] = "a"
6123 argv[6] = "test."
6124 argv[7] = "<NULL>"
6125 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006126
wdenk2729af92004-05-03 20:45:30 +00006127 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006128
wdenk2729af92004-05-03 20:45:30 +00006129Another example, which demonstrates how to register a CPM interrupt
6130handler with the U-Boot code, can be found in 'examples/timer.c'.
6131Here, a CPM timer is set up to generate an interrupt every second.
6132The interrupt service routine is trivial, just printing a '.'
6133character, but this is just a demo program. The application can be
6134controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006135
wdenk2729af92004-05-03 20:45:30 +00006136 ? - print current values og the CPM Timer registers
6137 b - enable interrupts and start timer
6138 e - stop timer and disable interrupts
6139 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006140
wdenk2729af92004-05-03 20:45:30 +00006141 => loads
6142 ## Ready for S-Record download ...
6143 ~>examples/timer.srec
6144 1 2 3 4 5 6 7 8 9 10 11 ...
6145 [file transfer complete]
6146 [connected]
6147 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006148
wdenk2729af92004-05-03 20:45:30 +00006149 => go 40004
6150 ## Starting application at 0x00040004 ...
6151 TIMERS=0xfff00980
6152 Using timer 1
6153 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006154
wdenk2729af92004-05-03 20:45:30 +00006155Hit 'b':
6156 [q, b, e, ?] Set interval 1000000 us
6157 Enabling timer
6158Hit '?':
6159 [q, b, e, ?] ........
6160 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6161Hit '?':
6162 [q, b, e, ?] .
6163 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6164Hit '?':
6165 [q, b, e, ?] .
6166 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6167Hit '?':
6168 [q, b, e, ?] .
6169 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6170Hit 'e':
6171 [q, b, e, ?] ...Stopping timer
6172Hit 'q':
6173 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006174
6175
wdenk2729af92004-05-03 20:45:30 +00006176Minicom warning:
6177================
wdenk85ec0bc2003-03-31 16:34:49 +00006178
wdenk2729af92004-05-03 20:45:30 +00006179Over time, many people have reported problems when trying to use the
6180"minicom" terminal emulation program for serial download. I (wd)
6181consider minicom to be broken, and recommend not to use it. Under
6182Unix, I recommend to use C-Kermit for general purpose use (and
6183especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006184use "cu" for S-Record download ("loads" command). See
6185http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6186for help with kermit.
6187
wdenk85ec0bc2003-03-31 16:34:49 +00006188
wdenk2729af92004-05-03 20:45:30 +00006189Nevertheless, if you absolutely want to use it try adding this
6190configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006191
wdenk2729af92004-05-03 20:45:30 +00006192 Name Program Name U/D FullScr IO-Red. Multi
6193 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6194 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006195
6196
wdenk2729af92004-05-03 20:45:30 +00006197NetBSD Notes:
6198=============
wdenkc6097192002-11-03 00:24:07 +00006199
wdenk2729af92004-05-03 20:45:30 +00006200Starting at version 0.9.2, U-Boot supports NetBSD both as host
6201(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006202
wdenk2729af92004-05-03 20:45:30 +00006203Building requires a cross environment; it is known to work on
6204NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6205need gmake since the Makefiles are not compatible with BSD make).
6206Note that the cross-powerpc package does not install include files;
6207attempting to build U-Boot will fail because <machine/ansi.h> is
6208missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006209
wdenk2729af92004-05-03 20:45:30 +00006210 # cd /usr/pkg/cross/powerpc-netbsd/include
6211 # mkdir powerpc
6212 # ln -s powerpc machine
6213 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6214 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006215
wdenk2729af92004-05-03 20:45:30 +00006216Native builds *don't* work due to incompatibilities between native
6217and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006218
wdenk2729af92004-05-03 20:45:30 +00006219Booting assumes that (the first part of) the image booted is a
6220stage-2 loader which in turn loads and then invokes the kernel
6221proper. Loader sources will eventually appear in the NetBSD source
6222tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006223meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006224
6225
wdenk2729af92004-05-03 20:45:30 +00006226Implementation Internals:
6227=========================
wdenkc6097192002-11-03 00:24:07 +00006228
wdenk2729af92004-05-03 20:45:30 +00006229The following is not intended to be a complete description of every
6230implementation detail. However, it should help to understand the
6231inner workings of U-Boot and make it easier to port it to custom
6232hardware.
wdenkc6097192002-11-03 00:24:07 +00006233
6234
wdenk2729af92004-05-03 20:45:30 +00006235Initial Stack, Global Data:
6236---------------------------
wdenkc6097192002-11-03 00:24:07 +00006237
wdenk2729af92004-05-03 20:45:30 +00006238The implementation of U-Boot is complicated by the fact that U-Boot
6239starts running out of ROM (flash memory), usually without access to
6240system RAM (because the memory controller is not initialized yet).
6241This means that we don't have writable Data or BSS segments, and BSS
6242is not initialized as zero. To be able to get a C environment working
6243at all, we have to allocate at least a minimal stack. Implementation
6244options for this are defined and restricted by the CPU used: Some CPU
6245models provide on-chip memory (like the IMMR area on MPC8xx and
6246MPC826x processors), on others (parts of) the data cache can be
6247locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006248
Wolfgang Denk218ca722008-03-26 10:40:12 +01006249 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006250 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006251
wdenk2729af92004-05-03 20:45:30 +00006252 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6253 From: "Chris Hallinan" <clh@net1plus.com>
6254 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6255 ...
wdenk43d96162003-03-06 00:02:04 +00006256
wdenk2729af92004-05-03 20:45:30 +00006257 Correct me if I'm wrong, folks, but the way I understand it
6258 is this: Using DCACHE as initial RAM for Stack, etc, does not
6259 require any physical RAM backing up the cache. The cleverness
6260 is that the cache is being used as a temporary supply of
6261 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006262 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006263 can see how this works by studying the cache architecture and
6264 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006265
wdenk2729af92004-05-03 20:45:30 +00006266 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6267 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006268 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006269 option should work for you. Using CS 4 should be fine if your
6270 board designers haven't used it for something that would
6271 cause you grief during the initial boot! It is frequently not
6272 used.
wdenk43d96162003-03-06 00:02:04 +00006273
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006274 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006275 with your processor/board/system design. The default value
6276 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006277 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006278 than your SDRAM module. If you have a 64MB SDRAM module, set
6279 it above 400_0000. Just make sure your board has no resources
6280 that are supposed to respond to that address! That code in
6281 start.S has been around a while and should work as is when
6282 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006283
wdenk2729af92004-05-03 20:45:30 +00006284 -Chris Hallinan
6285 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006286
wdenk2729af92004-05-03 20:45:30 +00006287It is essential to remember this, since it has some impact on the C
6288code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006289
wdenk2729af92004-05-03 20:45:30 +00006290* Initialized global data (data segment) is read-only. Do not attempt
6291 to write it.
wdenkc6097192002-11-03 00:24:07 +00006292
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006293* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006294 as zero data - BSS segment) at all - this is undefined, initiali-
6295 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006296
wdenk2729af92004-05-03 20:45:30 +00006297* Stack space is very limited. Avoid big data buffers or things like
6298 that.
wdenkc6097192002-11-03 00:24:07 +00006299
wdenk2729af92004-05-03 20:45:30 +00006300Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006301normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006302turned out that the implementation of U-Boot can be greatly
6303simplified by making a global data structure (gd_t) available to all
6304functions. We could pass a pointer to this data as argument to _all_
6305functions, but this would bloat the code. Instead we use a feature of
6306the GCC compiler (Global Register Variables) to share the data: we
6307place a pointer (gd) to the global data into a register which we
6308reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006309
wdenk2729af92004-05-03 20:45:30 +00006310When choosing a register for such a purpose we are restricted by the
6311relevant (E)ABI specifications for the current architecture, and by
6312GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006313
wdenk2729af92004-05-03 20:45:30 +00006314For PowerPC, the following registers have specific use:
6315 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006316 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006317 R3-R4: parameter passing and return values
6318 R5-R10: parameter passing
6319 R13: small data area pointer
6320 R30: GOT pointer
6321 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006322
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006323 (U-Boot also uses R12 as internal GOT pointer. r12
6324 is a volatile register so r12 needs to be reset when
6325 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006326
Wolfgang Denke7670f62008-02-14 22:43:22 +01006327 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006328
wdenk2729af92004-05-03 20:45:30 +00006329 Note: on PPC, we could use a static initializer (since the
6330 address of the global data structure is known at compile time),
6331 but it turned out that reserving a register results in somewhat
6332 smaller code - although the code savings are not that big (on
6333 average for all boards 752 bytes for the whole U-Boot image,
6334 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006335
Robin Getzc4db3352009-08-17 15:23:02 +00006336On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006337 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6338
Robin Getzc4db3352009-08-17 15:23:02 +00006339 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006340
wdenk2729af92004-05-03 20:45:30 +00006341On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006342
wdenk2729af92004-05-03 20:45:30 +00006343 R0: function argument word/integer result
6344 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006345 R9: platform specific
6346 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006347 R11: argument (frame) pointer
6348 R12: temporary workspace
6349 R13: stack pointer
6350 R14: link register
6351 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006352
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006353 ==> U-Boot will use R9 to hold a pointer to the global data
6354
6355 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006356
Thomas Chou0df01fd32010-05-21 11:08:03 +08006357On Nios II, the ABI is documented here:
6358 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6359
6360 ==> U-Boot will use gp to hold a pointer to the global data
6361
6362 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6363 to access small data sections, so gp is free.
6364
Macpaul Linafc1ce82011-10-19 20:41:11 +00006365On NDS32, the following registers are used:
6366
6367 R0-R1: argument/return
6368 R2-R5: argument
6369 R15: temporary register for assembler
6370 R16: trampoline register
6371 R28: frame pointer (FP)
6372 R29: global pointer (GP)
6373 R30: link register (LP)
6374 R31: stack pointer (SP)
6375 PC: program counter (PC)
6376
6377 ==> U-Boot will use R10 to hold a pointer to the global data
6378
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006379NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6380or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006381
wdenk2729af92004-05-03 20:45:30 +00006382Memory Management:
6383------------------
wdenkc6097192002-11-03 00:24:07 +00006384
wdenk2729af92004-05-03 20:45:30 +00006385U-Boot runs in system state and uses physical addresses, i.e. the
6386MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006387
wdenk2729af92004-05-03 20:45:30 +00006388The available memory is mapped to fixed addresses using the memory
6389controller. In this process, a contiguous block is formed for each
6390memory type (Flash, SDRAM, SRAM), even when it consists of several
6391physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006392
wdenk2729af92004-05-03 20:45:30 +00006393U-Boot is installed in the first 128 kB of the first Flash bank (on
6394TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6395booting and sizing and initializing DRAM, the code relocates itself
6396to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006397memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006398configuration setting]. Below that, a structure with global Board
6399Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006400
wdenk2729af92004-05-03 20:45:30 +00006401Additionally, some exception handler code is copied to the low 8 kB
6402of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006403
wdenk2729af92004-05-03 20:45:30 +00006404So a typical memory configuration with 16 MB of DRAM could look like
6405this:
wdenkc6097192002-11-03 00:24:07 +00006406
wdenk2729af92004-05-03 20:45:30 +00006407 0x0000 0000 Exception Vector code
6408 :
6409 0x0000 1FFF
6410 0x0000 2000 Free for Application Use
6411 :
6412 :
wdenkc6097192002-11-03 00:24:07 +00006413
wdenk2729af92004-05-03 20:45:30 +00006414 :
6415 :
6416 0x00FB FF20 Monitor Stack (Growing downward)
6417 0x00FB FFAC Board Info Data and permanent copy of global data
6418 0x00FC 0000 Malloc Arena
6419 :
6420 0x00FD FFFF
6421 0x00FE 0000 RAM Copy of Monitor Code
6422 ... eventually: LCD or video framebuffer
6423 ... eventually: pRAM (Protected RAM - unchanged by reset)
6424 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006425
6426
wdenk2729af92004-05-03 20:45:30 +00006427System Initialization:
6428----------------------
wdenkc6097192002-11-03 00:24:07 +00006429
wdenk2729af92004-05-03 20:45:30 +00006430In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006431(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006432configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006433To be able to re-map memory U-Boot then jumps to its link address.
6434To be able to implement the initialization code in C, a (small!)
6435initial stack is set up in the internal Dual Ported RAM (in case CPUs
6436which provide such a feature like MPC8xx or MPC8260), or in a locked
6437part of the data cache. After that, U-Boot initializes the CPU core,
6438the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006439
wdenk2729af92004-05-03 20:45:30 +00006440Next, all (potentially) available memory banks are mapped using a
6441preliminary mapping. For example, we put them on 512 MB boundaries
6442(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6443on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6444programmed for SDRAM access. Using the temporary configuration, a
6445simple memory test is run that determines the size of the SDRAM
6446banks.
wdenkc6097192002-11-03 00:24:07 +00006447
wdenk2729af92004-05-03 20:45:30 +00006448When there is more than one SDRAM bank, and the banks are of
6449different size, the largest is mapped first. For equal size, the first
6450bank (CS2#) is mapped first. The first mapping is always for address
64510x00000000, with any additional banks following immediately to create
6452contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006453
wdenk2729af92004-05-03 20:45:30 +00006454Then, the monitor installs itself at the upper end of the SDRAM area
6455and allocates memory for use by malloc() and for the global Board
6456Info data; also, the exception vector code is copied to the low RAM
6457pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006458
wdenk2729af92004-05-03 20:45:30 +00006459Only after this relocation will you have a "normal" C environment;
6460until that you are restricted in several ways, mostly because you are
6461running from ROM, and because the code will have to be relocated to a
6462new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006463
6464
wdenk2729af92004-05-03 20:45:30 +00006465U-Boot Porting Guide:
6466----------------------
wdenkc6097192002-11-03 00:24:07 +00006467
wdenk2729af92004-05-03 20:45:30 +00006468[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6469list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006470
6471
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006472int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006473{
6474 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006475
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006476 signal(SIGALRM, no_more_time);
6477 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006478
wdenk2729af92004-05-03 20:45:30 +00006479 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006480 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006481 return 0;
6482 }
6483
wdenk2729af92004-05-03 20:45:30 +00006484 Download latest U-Boot source;
6485
Wolfgang Denk06682362008-12-30 22:56:11 +01006486 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006487
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006488 if (clueless)
6489 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006490
wdenk2729af92004-05-03 20:45:30 +00006491 while (learning) {
6492 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006493 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6494 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006495 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006496 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006497 }
wdenkc6097192002-11-03 00:24:07 +00006498
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006499 if (available_money > toLocalCurrency ($2500))
6500 Buy a BDI3000;
6501 else
wdenk2729af92004-05-03 20:45:30 +00006502 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006503
6504 if (a similar board exists) { /* hopefully... */
6505 cp -a board/<similar> board/<myboard>
6506 cp include/configs/<similar>.h include/configs/<myboard>.h
6507 } else {
6508 Create your own board support subdirectory;
6509 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006510 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006511 Edit new board/<myboard> files
6512 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006513
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006514 while (!accepted) {
6515 while (!running) {
6516 do {
6517 Add / modify source code;
6518 } until (compiles);
6519 Debug;
6520 if (clueless)
6521 email("Hi, I am having problems...");
6522 }
6523 Send patch file to the U-Boot email list;
6524 if (reasonable critiques)
6525 Incorporate improvements from email list code review;
6526 else
6527 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006528 }
wdenkc6097192002-11-03 00:24:07 +00006529
wdenk2729af92004-05-03 20:45:30 +00006530 return 0;
6531}
6532
6533void no_more_time (int sig)
6534{
6535 hire_a_guru();
6536}
wdenkc6097192002-11-03 00:24:07 +00006537
6538
wdenk2729af92004-05-03 20:45:30 +00006539Coding Standards:
6540-----------------
wdenkc6097192002-11-03 00:24:07 +00006541
wdenk2729af92004-05-03 20:45:30 +00006542All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006543coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006544"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006545
Detlev Zundel2c051652006-09-01 15:39:02 +02006546Source files originating from a different project (for example the
6547MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006548reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006549sources.
6550
6551Please note that U-Boot is implemented in C (and to some small parts in
6552Assembler); no C++ is used, so please do not use C++ style comments (//)
6553in your code.
wdenk2729af92004-05-03 20:45:30 +00006554
6555Please also stick to the following formatting rules:
6556- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006557- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006558- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006559- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006560- do not add trailing empty lines to source files
6561
6562Submissions which do not conform to the standards may be returned
6563with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006564
6565
wdenk2729af92004-05-03 20:45:30 +00006566Submitting Patches:
6567-------------------
wdenkc6097192002-11-03 00:24:07 +00006568
wdenk2729af92004-05-03 20:45:30 +00006569Since the number of patches for U-Boot is growing, we need to
6570establish some rules. Submissions which do not conform to these rules
6571may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006572
Magnus Lilja0d28f342008-08-06 19:32:33 +02006573Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006574
Wolfgang Denk06682362008-12-30 22:56:11 +01006575Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6576see http://lists.denx.de/mailman/listinfo/u-boot
6577
wdenk2729af92004-05-03 20:45:30 +00006578When you send a patch, please include the following information with
6579it:
wdenkc6097192002-11-03 00:24:07 +00006580
wdenk2729af92004-05-03 20:45:30 +00006581* For bug fixes: a description of the bug and how your patch fixes
6582 this bug. Please try to include a way of demonstrating that the
6583 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006584
wdenk2729af92004-05-03 20:45:30 +00006585* For new features: a description of the feature and your
6586 implementation.
wdenkc6097192002-11-03 00:24:07 +00006587
wdenk2729af92004-05-03 20:45:30 +00006588* A CHANGELOG entry as plaintext (separate from the patch)
6589
Robert P. J. Day7207b362015-12-19 07:16:10 -05006590* For major contributions, add a MAINTAINERS file with your
6591 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00006592
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006593* When you add support for a new board, don't forget to add a
6594 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006595
6596* If your patch adds new configuration options, don't forget to
6597 document these in the README file.
6598
Wolfgang Denk218ca722008-03-26 10:40:12 +01006599* The patch itself. If you are using git (which is *strongly*
6600 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006601 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006602 the U-Boot mailing list, you will avoid most of the common problems
6603 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006604
Wolfgang Denk218ca722008-03-26 10:40:12 +01006605 If you cannot use git, use "diff -purN OLD NEW". If your version of
6606 diff does not support these options, then get the latest version of
6607 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006608
Wolfgang Denk218ca722008-03-26 10:40:12 +01006609 The current directory when running this command shall be the parent
6610 directory of the U-Boot source tree (i. e. please make sure that
6611 your patch includes sufficient directory information for the
6612 affected files).
6613
6614 We prefer patches as plain text. MIME attachments are discouraged,
6615 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006616
6617* If one logical set of modifications affects or creates several
6618 files, all these changes shall be submitted in a SINGLE patch file.
6619
6620* Changesets that contain different, unrelated modifications shall be
6621 submitted as SEPARATE patches, one patch per changeset.
6622
6623
6624Notes:
6625
6626* Before sending the patch, run the MAKEALL script on your patched
6627 source tree and make sure that no errors or warnings are reported
6628 for any of the boards.
6629
6630* Keep your modifications to the necessary minimum: A patch
6631 containing several unrelated changes or arbitrary reformats will be
6632 returned with a request to re-formatting / split it.
6633
6634* If you modify existing code, make sure that your new code does not
6635 add to the memory footprint of the code ;-) Small is beautiful!
6636 When adding new features, these should compile conditionally only
6637 (using #ifdef), and the resulting code with the new feature
6638 disabled must not need more memory than the old code without your
6639 modification.
wdenk90dc6702005-05-03 14:12:25 +00006640
Wolfgang Denk06682362008-12-30 22:56:11 +01006641* Remember that there is a size limit of 100 kB per message on the
6642 u-boot mailing list. Bigger patches will be moderated. If they are
6643 reasonable and not too big, they will be acknowledged. But patches
6644 bigger than the size limit should be avoided.