blob: 83d2874851cf2e9aba97d01c007644e50c9f3509 [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
Bin Menga1875592016-02-05 19:30:11 -0800463 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530464
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
wdenkc6097192002-11-03 00:24:07 +0000893- Boot Delay: CONFIG_BOOTDELAY - in seconds
894 Delay before automatically booting the default image;
895 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000896 set to -2 to autoboot with no delay and not check for abort
897 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000898
899 See doc/README.autoboot for these options that
900 work with CONFIG_BOOTDELAY. None are required.
901 CONFIG_BOOT_RETRY_TIME
902 CONFIG_BOOT_RETRY_MIN
903 CONFIG_AUTOBOOT_KEYED
904 CONFIG_AUTOBOOT_PROMPT
905 CONFIG_AUTOBOOT_DELAY_STR
906 CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +0000907 CONFIG_ZERO_BOOTDELAY_CHECK
908 CONFIG_RESET_TO_RETRY
909
910- Autoboot Command:
911 CONFIG_BOOTCOMMAND
912 Only needed when CONFIG_BOOTDELAY is enabled;
913 define a command string that is automatically executed
914 when no character is read on the console interface
915 within "Boot Delay" after reset.
916
917 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000918 This can be used to pass arguments to the bootm
919 command. The value of CONFIG_BOOTARGS goes into the
920 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000921
922 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000923 The value of these goes into the environment as
924 "ramboot" and "nfsboot" respectively, and can be used
925 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200926 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000927
Heiko Schochereda0ba32013-11-04 14:04:59 +0100928- Bootcount:
929 CONFIG_BOOTCOUNT_LIMIT
930 Implements a mechanism for detecting a repeating reboot
931 cycle, see:
932 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
933
934 CONFIG_BOOTCOUNT_ENV
935 If no softreset save registers are found on the hardware
936 "bootcount" is stored in the environment. To prevent a
937 saveenv on all reboots, the environment variable
938 "upgrade_available" is used. If "upgrade_available" is
939 0, "bootcount" is always 0, if "upgrade_available" is
940 1 "bootcount" is incremented in the environment.
941 So the Userspace Applikation must set the "upgrade_available"
942 and "bootcount" variable to 0, if a boot was successfully.
943
wdenkc6097192002-11-03 00:24:07 +0000944- Pre-Boot Commands:
945 CONFIG_PREBOOT
946
947 When this option is #defined, the existence of the
948 environment variable "preboot" will be checked
949 immediately before starting the CONFIG_BOOTDELAY
950 countdown and/or running the auto-boot command resp.
951 entering interactive mode.
952
953 This feature is especially useful when "preboot" is
954 automatically generated or modified. For an example
955 see the LWMON board specific code: here "preboot" is
956 modified when the user holds down a certain
957 combination of keys on the (special) keyboard when
958 booting the systems
959
960- Serial Download Echo Mode:
961 CONFIG_LOADS_ECHO
962 If defined to 1, all characters received during a
963 serial download (using the "loads" command) are
964 echoed back. This might be needed by some terminal
965 emulations (like "cu"), but may as well just take
966 time on others. This setting #define's the initial
967 value of the "loads_echo" environment variable.
968
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500969- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000970 CONFIG_KGDB_BAUDRATE
971 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200972 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000973
974- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500975 Monitor commands can be included or excluded
976 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000977 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500978 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000979
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500980 The default command configuration includes all commands
981 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000982
Marek Vasutb401b732014-03-05 19:58:39 +0100983 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500984 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500985 CONFIG_CMD_BDI bdinfo
986 CONFIG_CMD_BEDBUG * Include BedBug Debugger
987 CONFIG_CMD_BMP * BMP support
988 CONFIG_CMD_BSP * Board specific commands
989 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400990 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500991 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800992 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500993 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500994 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500995 CONFIG_CMD_DATE * support for RTC, date/time...
996 CONFIG_CMD_DHCP * DHCP support
997 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600998 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
999 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1000 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1001 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 CONFIG_CMD_DTT * Digital Therm and Thermostat
1003 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001004 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001005 CONFIG_CMD_EEPROM * EEPROM read/write support
1006 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001007 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001008 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001009 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001010 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001011 CONFIG_CMD_EXT2 * ext2 command support
1012 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001013 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1014 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001015 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001016 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001017 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001018 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001019 CONFIG_CMD_FLASH flinfo, erase, protect
1020 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001021 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001022 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001023 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001024 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001025 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001026 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1027 CONFIG_CMD_I2C * I2C serial bus support
1028 CONFIG_CMD_IDE * IDE harddisk support
1029 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001030 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001031 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001032 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001033 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001034 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001035 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001036 CONFIG_CMD_IRQ * irqinfo
1037 CONFIG_CMD_ITEST Integer/string test of 2 values
1038 CONFIG_CMD_JFFS2 * JFFS2 Support
1039 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001040 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001041 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1042 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001043 CONFIG_CMD_LOADB loadb
1044 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001045 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001046 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001047 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001048 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001049 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001050 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001051 CONFIG_CMD_MISC Misc functions like sleep etc
1052 CONFIG_CMD_MMC * MMC memory mapped support
1053 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001054 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001055 CONFIG_CMD_NAND * NAND support
1056 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001057 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001058 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001059 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001060 CONFIG_CMD_PCI * pciinfo
1061 CONFIG_CMD_PCMCIA * PCMCIA support
1062 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1063 host
1064 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001065 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001066 CONFIG_CMD_REGINFO * Register dump
1067 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001068 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069 CONFIG_CMD_SAVES * save S record dump
1070 CONFIG_CMD_SCSI * SCSI Support
1071 CONFIG_CMD_SDRAM * print SDRAM configuration information
1072 (requires CONFIG_CMD_I2C)
1073 CONFIG_CMD_SETGETDCR Support for DCR Register access
1074 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001075 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001076 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001077 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001078 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001079 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001080 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001081 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001082 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001083 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1084 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001085 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001086 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001087 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001088 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001089 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001090
1091 EXAMPLE: If you want all functions except of network
1092 support you can write:
1093
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001094 #include "config_cmd_all.h"
1095 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001096
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001097 Other Commands:
1098 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001099
1100 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001101 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001102 what you (and your U-Boot users) are doing. Data
1103 cache cannot be enabled on systems like the 8xx or
1104 8260 (where accesses to the IMMR region must be
1105 uncached), and it cannot be disabled on all other
1106 systems where we (mis-) use the data cache to hold an
1107 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001108
1109
1110 XXX - this list needs to get updated!
1111
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001112- Regular expression support:
1113 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001114 If this variable is defined, U-Boot is linked against
1115 the SLRE (Super Light Regular Expression) library,
1116 which adds regex support to some commands, as for
1117 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001118
Simon Glass45ba8072011-10-15 05:48:20 +00001119- Device tree:
1120 CONFIG_OF_CONTROL
1121 If this variable is defined, U-Boot will use a device tree
1122 to configure its devices, instead of relying on statically
1123 compiled #defines in the board file. This option is
1124 experimental and only available on a few boards. The device
1125 tree is available in the global data as gd->fdt_blob.
1126
Simon Glass2c0f79e2011-10-24 19:15:31 +00001127 U-Boot needs to get its device tree from somewhere. This can
1128 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001129
1130 CONFIG_OF_EMBED
1131 If this variable is defined, U-Boot will embed a device tree
1132 binary in its image. This device tree file should be in the
1133 board directory and called <soc>-<board>.dts. The binary file
1134 is then picked up in board_init_f() and made available through
1135 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001136
Simon Glass2c0f79e2011-10-24 19:15:31 +00001137 CONFIG_OF_SEPARATE
1138 If this variable is defined, U-Boot will build a device tree
1139 binary. It will be called u-boot.dtb. Architecture-specific
1140 code will locate it at run-time. Generally this works by:
1141
1142 cat u-boot.bin u-boot.dtb >image.bin
1143
1144 and in fact, U-Boot does this for you, creating a file called
1145 u-boot-dtb.bin which is useful in the common case. You can
1146 still use the individual files if you need something more
1147 exotic.
1148
wdenkc6097192002-11-03 00:24:07 +00001149- Watchdog:
1150 CONFIG_WATCHDOG
1151 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001152 support for the SoC. There must be support in the SoC
1153 specific code for a watchdog. For the 8xx and 8260
1154 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1155 register. When supported for a specific SoC is
1156 available, then no further board specific code should
1157 be needed to use it.
1158
1159 CONFIG_HW_WATCHDOG
1160 When using a watchdog circuitry external to the used
1161 SoC, then define this variable and provide board
1162 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001163
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001164 CONFIG_AT91_HW_WDT_TIMEOUT
1165 specify the timeout in seconds. default 2 seconds.
1166
stroesec1551ea2003-04-04 15:53:41 +00001167- U-Boot Version:
1168 CONFIG_VERSION_VARIABLE
1169 If this variable is defined, an environment variable
1170 named "ver" is created by U-Boot showing the U-Boot
1171 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001172 Any change to this variable will be reverted at the
1173 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001174
wdenkc6097192002-11-03 00:24:07 +00001175- Real-Time Clock:
1176
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001177 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001178 has to be selected, too. Define exactly one of the
1179 following options:
1180
1181 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1182 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001183 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001184 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001185 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001186 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001187 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001188 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001189 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001190 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001191 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001192 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001193 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1194 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001195
wdenkb37c7e52003-06-30 16:24:52 +00001196 Note that if the RTC uses I2C, then the I2C interface
1197 must also be configured. See I2C Support, below.
1198
Peter Tysere92739d2008-12-17 16:36:21 -06001199- GPIO Support:
1200 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001201
Chris Packham5dec49c2010-12-19 10:12:13 +00001202 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1203 chip-ngpio pairs that tell the PCA953X driver the number of
1204 pins supported by a particular chip.
1205
Peter Tysere92739d2008-12-17 16:36:21 -06001206 Note that if the GPIO device uses I2C, then the I2C interface
1207 must also be configured. See I2C Support, below.
1208
Simon Glassaa532332014-06-11 23:29:41 -06001209- I/O tracing:
1210 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1211 accesses and can checksum them or write a list of them out
1212 to memory. See the 'iotrace' command for details. This is
1213 useful for testing device drivers since it can confirm that
1214 the driver behaves the same way before and after a code
1215 change. Currently this is supported on sandbox and arm. To
1216 add support for your architecture, add '#include <iotrace.h>'
1217 to the bottom of arch/<arch>/include/asm/io.h and test.
1218
1219 Example output from the 'iotrace stats' command is below.
1220 Note that if the trace buffer is exhausted, the checksum will
1221 still continue to operate.
1222
1223 iotrace is enabled
1224 Start: 10000000 (buffer start address)
1225 Size: 00010000 (buffer size)
1226 Offset: 00000120 (current buffer offset)
1227 Output: 10000120 (start + offset)
1228 Count: 00000018 (number of trace records)
1229 CRC32: 9526fb66 (CRC32 of all trace records)
1230
wdenkc6097192002-11-03 00:24:07 +00001231- Timestamp Support:
1232
wdenk43d96162003-03-06 00:02:04 +00001233 When CONFIG_TIMESTAMP is selected, the timestamp
1234 (date and time) of an image is printed by image
1235 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001236 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001237
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001238- Partition Labels (disklabels) Supported:
1239 Zero or more of the following:
1240 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1241 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1242 Intel architecture, USB sticks, etc.
1243 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1244 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1245 bootloader. Note 2TB partition limit; see
1246 disk/part_efi.c
1247 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001248
Wolfgang Denk218ca722008-03-26 10:40:12 +01001249 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1250 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001251 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001252
1253- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001254 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1255 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001256
wdenk4d13cba2004-03-14 14:09:05 +00001257 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1258 be performed by calling the function
1259 ide_set_reset(int reset)
1260 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001261
1262- ATAPI Support:
1263 CONFIG_ATAPI
1264
1265 Set this to enable ATAPI support.
1266
wdenkc40b2952004-03-13 23:29:43 +00001267- LBA48 Support
1268 CONFIG_LBA48
1269
1270 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001271 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001272 Whithout these , LBA48 support uses 32bit variables and will 'only'
1273 support disks up to 2.1TB.
1274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001275 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001276 When enabled, makes the IDE subsystem use 64bit sector addresses.
1277 Default is 32bit.
1278
wdenkc6097192002-11-03 00:24:07 +00001279- SCSI Support:
1280 At the moment only there is only support for the
1281 SYM53C8XX SCSI controller; define
1282 CONFIG_SCSI_SYM53C8XX to enable it.
1283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001284 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1285 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1286 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001287 maximum numbers of LUNs, SCSI ID's and target
1288 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001289 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001290
Wolfgang Denk93e14592013-10-04 17:43:24 +02001291 The environment variable 'scsidevs' is set to the number of
1292 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001293
wdenkc6097192002-11-03 00:24:07 +00001294- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001295 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001296 Support for Intel 8254x/8257x gigabit chips.
1297
1298 CONFIG_E1000_SPI
1299 Utility code for direct access to the SPI bus on Intel 8257x.
1300 This does not do anything useful unless you set at least one
1301 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1302
1303 CONFIG_E1000_SPI_GENERIC
1304 Allow generic access to the SPI bus on the Intel 8257x, for
1305 example with the "sspi" command.
1306
1307 CONFIG_CMD_E1000
1308 Management command for E1000 devices. When used on devices
1309 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001310
wdenkc6097192002-11-03 00:24:07 +00001311 CONFIG_EEPRO100
1312 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001313 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001314 write routine for first time initialisation.
1315
1316 CONFIG_TULIP
1317 Support for Digital 2114x chips.
1318 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1319 modem chip initialisation (KS8761/QS6611).
1320
1321 CONFIG_NATSEMI
1322 Support for National dp83815 chips.
1323
1324 CONFIG_NS8382X
1325 Support for National dp8382[01] gigabit chips.
1326
wdenk45219c42003-05-12 21:50:16 +00001327- NETWORK Support (other):
1328
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001329 CONFIG_DRIVER_AT91EMAC
1330 Support for AT91RM9200 EMAC.
1331
1332 CONFIG_RMII
1333 Define this to use reduced MII inteface
1334
1335 CONFIG_DRIVER_AT91EMAC_QUIET
1336 If this defined, the driver is quiet.
1337 The driver doen't show link status messages.
1338
Rob Herringefdd7312011-12-15 11:15:49 +00001339 CONFIG_CALXEDA_XGMAC
1340 Support for the Calxeda XGMAC device
1341
Ashok3bb46d22012-10-15 06:20:47 +00001342 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001343 Support for SMSC's LAN91C96 chips.
1344
1345 CONFIG_LAN91C96_BASE
1346 Define this to hold the physical address
1347 of the LAN91C96's I/O space
1348
1349 CONFIG_LAN91C96_USE_32_BIT
1350 Define this to enable 32 bit addressing
1351
Ashok3bb46d22012-10-15 06:20:47 +00001352 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001353 Support for SMSC's LAN91C111 chip
1354
1355 CONFIG_SMC91111_BASE
1356 Define this to hold the physical address
1357 of the device (I/O space)
1358
1359 CONFIG_SMC_USE_32_BIT
1360 Define this if data bus is 32 bits
1361
1362 CONFIG_SMC_USE_IOFUNCS
1363 Define this to use i/o functions instead of macros
1364 (some hardware wont work with macros)
1365
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001366 CONFIG_DRIVER_TI_EMAC
1367 Support for davinci emac
1368
1369 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1370 Define this if you have more then 3 PHYs.
1371
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001372 CONFIG_FTGMAC100
1373 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1374
1375 CONFIG_FTGMAC100_EGIGA
1376 Define this to use GE link update with gigabit PHY.
1377 Define this if FTGMAC100 is connected to gigabit PHY.
1378 If your system has 10/100 PHY only, it might not occur
1379 wrong behavior. Because PHY usually return timeout or
1380 useless data when polling gigabit status and gigabit
1381 control registers. This behavior won't affect the
1382 correctnessof 10/100 link speed update.
1383
Mike Rapoportc2fff332009-11-11 10:03:03 +02001384 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001385 Support for SMSC's LAN911x and LAN921x chips
1386
Mike Rapoportc2fff332009-11-11 10:03:03 +02001387 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001388 Define this to hold the physical address
1389 of the device (I/O space)
1390
Mike Rapoportc2fff332009-11-11 10:03:03 +02001391 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001392 Define this if data bus is 32 bits
1393
Mike Rapoportc2fff332009-11-11 10:03:03 +02001394 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001395 Define this if data bus is 16 bits. If your processor
1396 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001397 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001398
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001399 CONFIG_SH_ETHER
1400 Support for Renesas on-chip Ethernet controller
1401
1402 CONFIG_SH_ETHER_USE_PORT
1403 Define the number of ports to be used
1404
1405 CONFIG_SH_ETHER_PHY_ADDR
1406 Define the ETH PHY's address
1407
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001408 CONFIG_SH_ETHER_CACHE_WRITEBACK
1409 If this option is set, the driver enables cache flush.
1410
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001411- PWM Support:
1412 CONFIG_PWM_IMX
1413 Support for PWM modul on the imx6.
1414
Vadim Bendebury5e124722011-10-17 08:36:14 +00001415- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001416 CONFIG_TPM
1417 Support TPM devices.
1418
Christophe Ricard0766ad22015-10-06 22:54:41 +02001419 CONFIG_TPM_TIS_INFINEON
1420 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001421 per system is supported at this time.
1422
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001423 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1424 Define the burst count bytes upper limit
1425
Christophe Ricard3aa74082016-01-21 23:27:13 +01001426 CONFIG_TPM_ST33ZP24
1427 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1428
1429 CONFIG_TPM_ST33ZP24_I2C
1430 Support for STMicroelectronics ST33ZP24 I2C devices.
1431 Requires TPM_ST33ZP24 and I2C.
1432
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001433 CONFIG_TPM_ST33ZP24_SPI
1434 Support for STMicroelectronics ST33ZP24 SPI devices.
1435 Requires TPM_ST33ZP24 and SPI.
1436
Dirk Eibachc01939c2013-06-26 15:55:15 +02001437 CONFIG_TPM_ATMEL_TWI
1438 Support for Atmel TWI TPM device. Requires I2C support.
1439
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001440 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001441 Support for generic parallel port TPM devices. Only one device
1442 per system is supported at this time.
1443
1444 CONFIG_TPM_TIS_BASE_ADDRESS
1445 Base address where the generic TPM device is mapped
1446 to. Contemporary x86 systems usually map it at
1447 0xfed40000.
1448
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001449 CONFIG_CMD_TPM
1450 Add tpm monitor functions.
1451 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1452 provides monitor access to authorized functions.
1453
1454 CONFIG_TPM
1455 Define this to enable the TPM support library which provides
1456 functional interfaces to some TPM commands.
1457 Requires support for a TPM device.
1458
1459 CONFIG_TPM_AUTH_SESSIONS
1460 Define this to enable authorized functions in the TPM library.
1461 Requires CONFIG_TPM and CONFIG_SHA1.
1462
wdenkc6097192002-11-03 00:24:07 +00001463- USB Support:
1464 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001465 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001466 CONFIG_USB_UHCI to enable it.
1467 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001468 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001469 storage devices.
1470 Note:
1471 Supported are USB Keyboards and USB Floppy drives
1472 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001473 MPC5200 USB requires additional defines:
1474 CONFIG_USB_CLOCK
1475 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001476 CONFIG_PSC3_USB
1477 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001478 CONFIG_USB_CONFIG
1479 for differential drivers: 0x00001000
1480 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001481 for differential drivers on PSC3: 0x00000100
1482 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001483 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001484 May be defined to allow interrupt polling
1485 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001486
Simon Glass9ab4ce22012-02-27 10:52:47 +00001487 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1488 txfilltuning field in the EHCI controller on reset.
1489
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001490 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1491 HW module registers.
1492
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001493- USB Device:
1494 Define the below if you wish to use the USB console.
1495 Once firmware is rebuilt from a serial console issue the
1496 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001497 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001498 it has found a new device. The environment variable usbtty
1499 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001500 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001501 Common Device Class Abstract Control Model serial device.
1502 If you select usbtty = gserial you should be able to enumerate
1503 a Linux host by
1504 # modprobe usbserial vendor=0xVendorID product=0xProductID
1505 else if using cdc_acm, simply setting the environment
1506 variable usbtty to be cdc_acm should suffice. The following
1507 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001508
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001509 CONFIG_USB_DEVICE
1510 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001511
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001512 CONFIG_USB_TTY
1513 Define this to have a tty type of device available to
1514 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001515
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301516 CONFIG_USBD_HS
1517 Define this to enable the high speed support for usb
1518 device and usbtty. If this feature is enabled, a routine
1519 int is_usbd_high_speed(void)
1520 also needs to be defined by the driver to dynamically poll
1521 whether the enumeration has succeded at high speed or full
1522 speed.
1523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001524 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001525 Define this if you want stdin, stdout &/or stderr to
1526 be set to usbtty.
1527
1528 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001529 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001530 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001531 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001532
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001533 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001534 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001535 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001536
Wolfgang Denk386eda02006-06-14 18:14:56 +02001537 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001538 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001539 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001540 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1541 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1542 should pretend to be a Linux device to it's target host.
1543
1544 CONFIG_USBD_MANUFACTURER
1545 Define this string as the name of your company for
1546 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001547
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001548 CONFIG_USBD_PRODUCT_NAME
1549 Define this string as the name of your product
1550 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1551
1552 CONFIG_USBD_VENDORID
1553 Define this as your assigned Vendor ID from the USB
1554 Implementors Forum. This *must* be a genuine Vendor ID
1555 to avoid polluting the USB namespace.
1556 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001557
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001558 CONFIG_USBD_PRODUCTID
1559 Define this as the unique Product ID
1560 for your device
1561 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001562
Igor Grinbergd70a5602011-12-12 12:08:35 +02001563- ULPI Layer Support:
1564 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1565 the generic ULPI layer. The generic layer accesses the ULPI PHY
1566 via the platform viewport, so you need both the genric layer and
1567 the viewport enabled. Currently only Chipidea/ARC based
1568 viewport is supported.
1569 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1570 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001571 If your ULPI phy needs a different reference clock than the
1572 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1573 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001574
1575- MMC Support:
1576 The MMC controller on the Intel PXA is supported. To
1577 enable this define CONFIG_MMC. The MMC can be
1578 accessed from the boot prompt by mapping the device
1579 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001580 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1581 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001582
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001583 CONFIG_SH_MMCIF
1584 Support for Renesas on-chip MMCIF controller
1585
1586 CONFIG_SH_MMCIF_ADDR
1587 Define the base address of MMCIF registers
1588
1589 CONFIG_SH_MMCIF_CLK
1590 Define the clock frequency for MMCIF
1591
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001592 CONFIG_GENERIC_MMC
1593 Enable the generic MMC driver
1594
1595 CONFIG_SUPPORT_EMMC_BOOT
1596 Enable some additional features of the eMMC boot partitions.
1597
1598 CONFIG_SUPPORT_EMMC_RPMB
1599 Enable the commands for reading, writing and programming the
1600 key for the Replay Protection Memory Block partition in eMMC.
1601
Tom Rinib3ba6e92013-03-14 05:32:47 +00001602- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001603 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001604 This enables the USB portion of the DFU USB class
1605
1606 CONFIG_CMD_DFU
1607 This enables the command "dfu" which is used to have
1608 U-Boot create a DFU class device via USB. This command
1609 requires that the "dfu_alt_info" environment variable be
1610 set and define the alt settings to expose to the host.
1611
1612 CONFIG_DFU_MMC
1613 This enables support for exposing (e)MMC devices via DFU.
1614
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001615 CONFIG_DFU_NAND
1616 This enables support for exposing NAND devices via DFU.
1617
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301618 CONFIG_DFU_RAM
1619 This enables support for exposing RAM via DFU.
1620 Note: DFU spec refer to non-volatile memory usage, but
1621 allow usages beyond the scope of spec - here RAM usage,
1622 one that would help mostly the developer.
1623
Heiko Schochere7e75c72013-06-12 06:05:51 +02001624 CONFIG_SYS_DFU_DATA_BUF_SIZE
1625 Dfu transfer uses a buffer before writing data to the
1626 raw storage device. Make the size (in bytes) of this buffer
1627 configurable. The size of this buffer is also configurable
1628 through the "dfu_bufsiz" environment variable.
1629
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001630 CONFIG_SYS_DFU_MAX_FILE_SIZE
1631 When updating files rather than the raw storage device,
1632 we use a static buffer to copy the file into and then write
1633 the buffer once we've been given the whole file. Define
1634 this to the maximum filesize (in bytes) for the buffer.
1635 Default is 4 MiB if undefined.
1636
Heiko Schocher001a8312014-03-18 08:09:56 +01001637 DFU_DEFAULT_POLL_TIMEOUT
1638 Poll timeout [ms], is the timeout a device can send to the
1639 host. The host must wait for this timeout before sending
1640 a subsequent DFU_GET_STATUS request to the device.
1641
1642 DFU_MANIFEST_POLL_TIMEOUT
1643 Poll timeout [ms], which the device sends to the host when
1644 entering dfuMANIFEST state. Host waits this timeout, before
1645 sending again an USB request to the device.
1646
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001647- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001648 CONFIG_USB_FUNCTION_FASTBOOT
1649 This enables the USB part of the fastboot gadget
1650
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001651 CONFIG_CMD_FASTBOOT
1652 This enables the command "fastboot" which enables the Android
1653 fastboot mode for the platform's USB device. Fastboot is a USB
1654 protocol for downloading images, flashing and device control
1655 used on Android devices.
1656 See doc/README.android-fastboot for more information.
1657
1658 CONFIG_ANDROID_BOOT_IMAGE
1659 This enables support for booting images which use the Android
1660 image format header.
1661
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001662 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001663 The fastboot protocol requires a large memory buffer for
1664 downloads. Define this to the starting RAM address to use for
1665 downloaded images.
1666
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001667 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001668 The fastboot protocol requires a large memory buffer for
1669 downloads. This buffer should be as large as possible for a
1670 platform. Define this to the size available RAM for fastboot.
1671
Steve Raed1b5ed02014-08-26 11:47:28 -07001672 CONFIG_FASTBOOT_FLASH
1673 The fastboot protocol includes a "flash" command for writing
1674 the downloaded image to a non-volatile storage device. Define
1675 this to enable the "fastboot flash" command.
1676
1677 CONFIG_FASTBOOT_FLASH_MMC_DEV
1678 The fastboot "flash" command requires additional information
1679 regarding the non-volatile storage device. Define this to
1680 the eMMC device that fastboot should use to store the image.
1681
Steve Rae0ff7e582014-12-12 15:51:54 -08001682 CONFIG_FASTBOOT_GPT_NAME
1683 The fastboot "flash" command supports writing the downloaded
1684 image to the Protective MBR and the Primary GUID Partition
1685 Table. (Additionally, this downloaded image is post-processed
1686 to generate and write the Backup GUID Partition Table.)
1687 This occurs when the specified "partition name" on the
1688 "fastboot flash" command line matches this value.
1689 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1690
wdenk6705d812004-08-02 23:22:59 +00001691- Journaling Flash filesystem support:
1692 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1693 CONFIG_JFFS2_NAND_DEV
1694 Define these for a default partition on a NAND device
1695
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001696 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1697 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001698 Define these for a default partition on a NOR device
1699
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001700 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001701 Define this to create an own partition. You have to provide a
1702 function struct part_info* jffs2_part_info(int part_num)
1703
1704 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001705 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001706 to disable the command chpart. This is the default when you
1707 have not defined a custom partition
1708
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001709- FAT(File Allocation Table) filesystem write function support:
1710 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001711
1712 Define this to enable support for saving memory data as a
1713 file in FAT formatted partition.
1714
1715 This will also enable the command "fatwrite" enabling the
1716 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001717
Gabe Black84cd9322012-10-12 14:26:11 +00001718CBFS (Coreboot Filesystem) support
1719 CONFIG_CMD_CBFS
1720
1721 Define this to enable support for reading from a Coreboot
1722 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1723 and cbfsload.
1724
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301725- FAT(File Allocation Table) filesystem cluster size:
1726 CONFIG_FS_FAT_MAX_CLUSTSIZE
1727
1728 Define the max cluster size for fat operations else
1729 a default value of 65536 will be defined.
1730
wdenkc6097192002-11-03 00:24:07 +00001731- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001732 See Kconfig help for available keyboard drivers.
1733
1734 CONFIG_KEYBOARD
1735
1736 Define this to enable a custom keyboard support.
1737 This simply calls drv_keyboard_init() which must be
1738 defined in your board-specific files. This option is deprecated
1739 and is only used by novena. For new boards, use driver model
1740 instead.
wdenkc6097192002-11-03 00:24:07 +00001741
1742- Video support:
1743 CONFIG_VIDEO
1744
1745 Define this to enable video support (for output to
1746 video).
1747
1748 CONFIG_VIDEO_CT69000
1749
1750 Enable Chips & Technologies 69000 Video chip
1751
1752 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001753 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001754 video output is selected via environment 'videoout'
1755 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1756 assumed.
wdenkc6097192002-11-03 00:24:07 +00001757
wdenkb79a11c2004-03-25 15:14:43 +00001758 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001759 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001760 are possible:
1761 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001762 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001763
1764 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1765 -------------+---------------------------------------------
1766 8 bits | 0x301* 0x303 0x305 0x161 0x307
1767 15 bits | 0x310 0x313 0x316 0x162 0x319
1768 16 bits | 0x311 0x314 0x317 0x163 0x31A
1769 24 bits | 0x312 0x315 0x318 ? 0x31B
1770 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001771 (i.e. setenv videomode 317; saveenv; reset;)
1772
wdenkb79a11c2004-03-25 15:14:43 +00001773 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001774 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001775
1776
stroesec1551ea2003-04-04 15:53:41 +00001777 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001778 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001779 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1780 or CONFIG_VIDEO_SED13806_16BPP
1781
Timur Tabi7d3053f2011-02-15 17:09:19 -06001782 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001783 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001784 SOCs that have a DIU should define this macro to enable DIU
1785 support, and should also define these other macros:
1786
1787 CONFIG_SYS_DIU_ADDR
1788 CONFIG_VIDEO
1789 CONFIG_CMD_BMP
1790 CONFIG_CFB_CONSOLE
1791 CONFIG_VIDEO_SW_CURSOR
1792 CONFIG_VGA_AS_SINGLE_DEVICE
1793 CONFIG_VIDEO_LOGO
1794 CONFIG_VIDEO_BMP_LOGO
1795
Timur Tabiba8e76b2011-04-11 14:18:22 -05001796 The DIU driver will look for the 'video-mode' environment
1797 variable, and if defined, enable the DIU as a console during
1798 boot. See the documentation file README.video for a
1799 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001800
wdenkc6097192002-11-03 00:24:07 +00001801- LCD Support: CONFIG_LCD
1802
1803 Define this to enable LCD support (for output to LCD
1804 display); also select one of the supported displays
1805 by defining one of these:
1806
Stelian Pop39cf4802008-05-09 21:57:18 +02001807 CONFIG_ATMEL_LCD:
1808
1809 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1810
wdenkfd3103b2003-11-25 16:55:19 +00001811 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001812
wdenkfd3103b2003-11-25 16:55:19 +00001813 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001814
wdenkfd3103b2003-11-25 16:55:19 +00001815 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001816
wdenkfd3103b2003-11-25 16:55:19 +00001817 NEC NL6448BC20-08. 6.5", 640x480.
1818 Active, color, single scan.
1819
1820 CONFIG_NEC_NL6448BC33_54
1821
1822 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001823 Active, color, single scan.
1824
1825 CONFIG_SHARP_16x9
1826
1827 Sharp 320x240. Active, color, single scan.
1828 It isn't 16x9, and I am not sure what it is.
1829
1830 CONFIG_SHARP_LQ64D341
1831
1832 Sharp LQ64D341 display, 640x480.
1833 Active, color, single scan.
1834
1835 CONFIG_HLD1045
1836
1837 HLD1045 display, 640x480.
1838 Active, color, single scan.
1839
1840 CONFIG_OPTREX_BW
1841
1842 Optrex CBL50840-2 NF-FW 99 22 M5
1843 or
1844 Hitachi LMG6912RPFC-00T
1845 or
1846 Hitachi SP14Q002
1847
1848 320x240. Black & white.
1849
1850 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001851 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001852
Simon Glass676d3192012-10-17 13:24:54 +00001853 CONFIG_LCD_ALIGNMENT
1854
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001855 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001856 defined then the LCD will be aligned to this value instead.
1857 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1858 here, since it is cheaper to change data cache settings on
1859 a per-section basis.
1860
Simon Glass0d89efe2012-10-17 13:24:59 +00001861 CONFIG_CONSOLE_SCROLL_LINES
1862
1863 When the console need to be scrolled, this is the number of
1864 lines to scroll by. It defaults to 1. Increasing this makes
1865 the console jump but can help speed up operation when scrolling
1866 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001867
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001868 CONFIG_LCD_ROTATION
1869
1870 Sometimes, for example if the display is mounted in portrait
1871 mode or even if it's mounted landscape but rotated by 180degree,
1872 we need to rotate our content of the display relative to the
1873 framebuffer, so that user can read the messages which are
1874 printed out.
1875 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1876 initialized with a given rotation from "vl_rot" out of
1877 "vidinfo_t" which is provided by the board specific code.
1878 The value for vl_rot is coded as following (matching to
1879 fbcon=rotate:<n> linux-kernel commandline):
1880 0 = no rotation respectively 0 degree
1881 1 = 90 degree rotation
1882 2 = 180 degree rotation
1883 3 = 270 degree rotation
1884
1885 If CONFIG_LCD_ROTATION is not defined, the console will be
1886 initialized with 0degree rotation.
1887
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001888 CONFIG_LCD_BMP_RLE8
1889
1890 Support drawing of RLE8-compressed bitmaps on the LCD.
1891
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001892 CONFIG_I2C_EDID
1893
1894 Enables an 'i2c edid' command which can read EDID
1895 information over I2C from an attached LCD display.
1896
wdenk7152b1d2003-09-05 23:19:14 +00001897- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001898
wdenk8bde7f72003-06-27 21:31:46 +00001899 If this option is set, the environment is checked for
1900 a variable "splashimage". If found, the usual display
1901 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001902 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001903 specified in "splashimage" is loaded instead. The
1904 console is redirected to the "nulldev", too. This
1905 allows for a "silent" boot where a splash screen is
1906 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001907
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001908 CONFIG_SPLASHIMAGE_GUARD
1909
1910 If this option is set, then U-Boot will prevent the environment
1911 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001912 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001913 This option is useful for targets where, due to alignment
1914 restrictions, an improperly aligned BMP image will cause a data
1915 abort. If you think you will not have problems with unaligned
1916 accesses (for example because your toolchain prevents them)
1917 there is no need to set this option.
1918
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001919 CONFIG_SPLASH_SCREEN_ALIGN
1920
1921 If this option is set the splash image can be freely positioned
1922 on the screen. Environment variable "splashpos" specifies the
1923 position as "x,y". If a positive number is given it is used as
1924 number of pixel from left/top. If a negative number is given it
1925 is used as number of pixel from right/bottom. You can also
1926 specify 'm' for centering the image.
1927
1928 Example:
1929 setenv splashpos m,m
1930 => image at center of screen
1931
1932 setenv splashpos 30,20
1933 => image at x = 30 and y = 20
1934
1935 setenv splashpos -10,m
1936 => vertically centered image
1937 at x = dspWidth - bmpWidth - 9
1938
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001939- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1940
1941 If this option is set, additionally to standard BMP
1942 images, gzipped BMP images can be displayed via the
1943 splashscreen support or the bmp command.
1944
Anatolij Gustschind5011762010-03-15 14:50:25 +01001945- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1946
1947 If this option is set, 8-bit RLE compressed BMP images
1948 can be displayed via the splashscreen support or the
1949 bmp command.
1950
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001951- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00001952 CONFIG_CMD_ZIP
1953
1954 If this option is set, it would use zlib deflate method
1955 to compress the specified memory at its best effort.
1956
wdenkc29fdfc2003-08-29 20:57:53 +00001957- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001958 CONFIG_GZIP
1959
1960 Enabled by default to support gzip compressed images.
1961
wdenkc29fdfc2003-08-29 20:57:53 +00001962 CONFIG_BZIP2
1963
1964 If this option is set, support for bzip2 compressed
1965 images is included. If not, only uncompressed and gzip
1966 compressed images are supported.
1967
wdenk42d1f032003-10-15 23:53:47 +00001968 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001969 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001970 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001971
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001972 CONFIG_LZMA
1973
1974 If this option is set, support for lzma compressed
1975 images is included.
1976
1977 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1978 requires an amount of dynamic memory that is given by the
1979 formula:
1980
1981 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1982
1983 Where lc and lp stand for, respectively, Literal context bits
1984 and Literal pos bits.
1985
1986 This value is upper-bounded by 14MB in the worst case. Anyway,
1987 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1988 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1989 a very small buffer.
1990
1991 Use the lzmainfo tool to determinate the lc and lp values and
1992 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001993 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001994
Kees Cook8ef70472013-08-16 07:59:12 -07001995 CONFIG_LZO
1996
1997 If this option is set, support for LZO compressed images
1998 is included.
1999
wdenk17ea1172004-06-06 21:51:03 +00002000- MII/PHY support:
2001 CONFIG_PHY_ADDR
2002
2003 The address of PHY on MII bus.
2004
2005 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2006
2007 The clock frequency of the MII bus
2008
2009 CONFIG_PHY_GIGE
2010
2011 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002012 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002013
2014 CONFIG_PHY_RESET_DELAY
2015
2016 Some PHY like Intel LXT971A need extra delay after
2017 reset before any MII register access is possible.
2018 For such PHY, set this option to the usec delay
2019 required. (minimum 300usec for LXT971A)
2020
2021 CONFIG_PHY_CMD_DELAY (ppc4xx)
2022
2023 Some PHY like Intel LXT971A need extra delay after
2024 command issued before MII status register can be read
2025
wdenkc6097192002-11-03 00:24:07 +00002026- IP address:
2027 CONFIG_IPADDR
2028
2029 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002030 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002031 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002032 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002033
2034- Server IP address:
2035 CONFIG_SERVERIP
2036
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002037 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002038 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002039 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002040
Robin Getz97cfe862009-07-21 12:15:28 -04002041 CONFIG_KEEP_SERVERADDR
2042
2043 Keeps the server's MAC address, in the env 'serveraddr'
2044 for passing to bootargs (like Linux's netconsole option)
2045
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002046- Gateway IP address:
2047 CONFIG_GATEWAYIP
2048
2049 Defines a default value for the IP address of the
2050 default router where packets to other networks are
2051 sent to.
2052 (Environment variable "gatewayip")
2053
2054- Subnet mask:
2055 CONFIG_NETMASK
2056
2057 Defines a default value for the subnet mask (or
2058 routing prefix) which is used to determine if an IP
2059 address belongs to the local subnet or needs to be
2060 forwarded through a router.
2061 (Environment variable "netmask")
2062
David Updegraff53a5c422007-06-11 10:41:07 -05002063- Multicast TFTP Mode:
2064 CONFIG_MCAST_TFTP
2065
2066 Defines whether you want to support multicast TFTP as per
2067 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002068 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002069 driver in use must provide a function: mcast() to join/leave a
2070 multicast group.
2071
wdenkc6097192002-11-03 00:24:07 +00002072- BOOTP Recovery Mode:
2073 CONFIG_BOOTP_RANDOM_DELAY
2074
2075 If you have many targets in a network that try to
2076 boot using BOOTP, you may want to avoid that all
2077 systems send out BOOTP requests at precisely the same
2078 moment (which would happen for instance at recovery
2079 from a power failure, when all systems will try to
2080 boot, thus flooding the BOOTP server. Defining
2081 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2082 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002083 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002084
2085 1st BOOTP request: delay 0 ... 1 sec
2086 2nd BOOTP request: delay 0 ... 2 sec
2087 3rd BOOTP request: delay 0 ... 4 sec
2088 4th and following
2089 BOOTP requests: delay 0 ... 8 sec
2090
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002091 CONFIG_BOOTP_ID_CACHE_SIZE
2092
2093 BOOTP packets are uniquely identified using a 32-bit ID. The
2094 server will copy the ID from client requests to responses and
2095 U-Boot will use this to determine if it is the destination of
2096 an incoming response. Some servers will check that addresses
2097 aren't in use before handing them out (usually using an ARP
2098 ping) and therefore take up to a few hundred milliseconds to
2099 respond. Network congestion may also influence the time it
2100 takes for a response to make it back to the client. If that
2101 time is too long, U-Boot will retransmit requests. In order
2102 to allow earlier responses to still be accepted after these
2103 retransmissions, U-Boot's BOOTP client keeps a small cache of
2104 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2105 cache. The default is to keep IDs for up to four outstanding
2106 requests. Increasing this will allow U-Boot to accept offers
2107 from a BOOTP client in networks with unusually high latency.
2108
stroesefe389a82003-08-28 14:17:32 +00002109- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002110 You can fine tune the DHCP functionality by defining
2111 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002112
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002113 CONFIG_BOOTP_SUBNETMASK
2114 CONFIG_BOOTP_GATEWAY
2115 CONFIG_BOOTP_HOSTNAME
2116 CONFIG_BOOTP_NISDOMAIN
2117 CONFIG_BOOTP_BOOTPATH
2118 CONFIG_BOOTP_BOOTFILESIZE
2119 CONFIG_BOOTP_DNS
2120 CONFIG_BOOTP_DNS2
2121 CONFIG_BOOTP_SEND_HOSTNAME
2122 CONFIG_BOOTP_NTPSERVER
2123 CONFIG_BOOTP_TIMEOFFSET
2124 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002125 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002126
Wilson Callan5d110f02007-07-28 10:56:13 -04002127 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2128 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002129
Joe Hershberger2c00e092012-05-23 07:59:19 +00002130 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2131 after the configured retry count, the call will fail
2132 instead of starting over. This can be used to fail over
2133 to Link-local IP address configuration if the DHCP server
2134 is not available.
2135
stroesefe389a82003-08-28 14:17:32 +00002136 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2137 serverip from a DHCP server, it is possible that more
2138 than one DNS serverip is offered to the client.
2139 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2140 serverip will be stored in the additional environment
2141 variable "dnsip2". The first DNS serverip is always
2142 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002143 is defined.
stroesefe389a82003-08-28 14:17:32 +00002144
2145 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2146 to do a dynamic update of a DNS server. To do this, they
2147 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002148 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002149 of the "hostname" environment variable is passed as
2150 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002151
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002152 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2153
2154 A 32bit value in microseconds for a delay between
2155 receiving a "DHCP Offer" and sending the "DHCP Request".
2156 This fixes a problem with certain DHCP servers that don't
2157 respond 100% of the time to a "DHCP request". E.g. On an
2158 AT91RM9200 processor running at 180MHz, this delay needed
2159 to be *at least* 15,000 usec before a Windows Server 2003
2160 DHCP server would reply 100% of the time. I recommend at
2161 least 50,000 usec to be safe. The alternative is to hope
2162 that one of the retries will be successful but note that
2163 the DHCP timeout and retry process takes a longer than
2164 this delay.
2165
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002166 - Link-local IP address negotiation:
2167 Negotiate with other link-local clients on the local network
2168 for an address that doesn't require explicit configuration.
2169 This is especially useful if a DHCP server cannot be guaranteed
2170 to exist in all environments that the device must operate.
2171
2172 See doc/README.link-local for more information.
2173
wdenka3d991b2004-04-15 21:48:45 +00002174 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002175 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002176
2177 The device id used in CDP trigger frames.
2178
2179 CONFIG_CDP_DEVICE_ID_PREFIX
2180
2181 A two character string which is prefixed to the MAC address
2182 of the device.
2183
2184 CONFIG_CDP_PORT_ID
2185
2186 A printf format string which contains the ascii name of
2187 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002188 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002189
2190 CONFIG_CDP_CAPABILITIES
2191
2192 A 32bit integer which indicates the device capabilities;
2193 0x00000010 for a normal host which does not forwards.
2194
2195 CONFIG_CDP_VERSION
2196
2197 An ascii string containing the version of the software.
2198
2199 CONFIG_CDP_PLATFORM
2200
2201 An ascii string containing the name of the platform.
2202
2203 CONFIG_CDP_TRIGGER
2204
2205 A 32bit integer sent on the trigger.
2206
2207 CONFIG_CDP_POWER_CONSUMPTION
2208
2209 A 16bit integer containing the power consumption of the
2210 device in .1 of milliwatts.
2211
2212 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2213
2214 A byte containing the id of the VLAN.
2215
wdenkc6097192002-11-03 00:24:07 +00002216- Status LED: CONFIG_STATUS_LED
2217
2218 Several configurations allow to display the current
2219 status using a LED. For instance, the LED will blink
2220 fast while running U-Boot code, stop blinking as
2221 soon as a reply to a BOOTP request was received, and
2222 start blinking slow once the Linux kernel is running
2223 (supported by a status LED driver in the Linux
2224 kernel). Defining CONFIG_STATUS_LED enables this
2225 feature in U-Boot.
2226
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002227 Additional options:
2228
2229 CONFIG_GPIO_LED
2230 The status LED can be connected to a GPIO pin.
2231 In such cases, the gpio_led driver can be used as a
2232 status LED backend implementation. Define CONFIG_GPIO_LED
2233 to include the gpio_led driver in the U-Boot binary.
2234
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002235 CONFIG_GPIO_LED_INVERTED_TABLE
2236 Some GPIO connected LEDs may have inverted polarity in which
2237 case the GPIO high value corresponds to LED off state and
2238 GPIO low value corresponds to LED on state.
2239 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2240 with a list of GPIO LEDs that have inverted polarity.
2241
wdenkc6097192002-11-03 00:24:07 +00002242- CAN Support: CONFIG_CAN_DRIVER
2243
2244 Defining CONFIG_CAN_DRIVER enables CAN driver support
2245 on those systems that support this (optional)
2246 feature, like the TQM8xxL modules.
2247
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002248- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002249
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002250 This enable the NEW i2c subsystem, and will allow you to use
2251 i2c commands at the u-boot command line (as long as you set
2252 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2253 based realtime clock chips or other i2c devices. See
2254 common/cmd_i2c.c for a description of the command line
2255 interface.
2256
2257 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002258 - drivers/i2c/soft_i2c.c:
2259 - activate first bus with CONFIG_SYS_I2C_SOFT define
2260 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2261 for defining speed and slave address
2262 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2263 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2264 for defining speed and slave address
2265 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2266 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2267 for defining speed and slave address
2268 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2269 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2270 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002271
Heiko Schocher00f792e2012-10-24 13:48:22 +02002272 - drivers/i2c/fsl_i2c.c:
2273 - activate i2c driver with CONFIG_SYS_I2C_FSL
2274 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2275 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2276 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2277 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002278 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002279 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2280 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2281 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2282 second bus.
2283
Simon Glass1f2ba722012-10-30 07:28:53 +00002284 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002285 - activate this driver with CONFIG_SYS_I2C_TEGRA
2286 - This driver adds 4 i2c buses with a fix speed from
2287 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002288
Dirk Eibach880540d2013-04-25 02:40:01 +00002289 - drivers/i2c/ppc4xx_i2c.c
2290 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2291 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2292 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2293
tremfac96402013-09-21 18:13:35 +02002294 - drivers/i2c/i2c_mxc.c
2295 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002296 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2297 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2298 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2299 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002300 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2301 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2302 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2303 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2304 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2305 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002306 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2307 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002308 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002309 for speed, and 0 for slave.
2310
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002311 - drivers/i2c/rcar_i2c.c:
2312 - activate this driver with CONFIG_SYS_I2C_RCAR
2313 - This driver adds 4 i2c buses
2314
2315 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2316 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2317 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2318 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2319 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2320 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2321 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2322 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2323 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2324
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002325 - drivers/i2c/sh_i2c.c:
2326 - activate this driver with CONFIG_SYS_I2C_SH
2327 - This driver adds from 2 to 5 i2c buses
2328
2329 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2330 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2331 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2332 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2333 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2334 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2335 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2336 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2337 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2338 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2339 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2340 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002341 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002342
Heiko Schocher6789e842013-10-22 11:03:18 +02002343 - drivers/i2c/omap24xx_i2c.c
2344 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2345 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2346 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2347 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2348 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2349 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2350 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2351 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2352 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2353 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2354 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2355
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002356 - drivers/i2c/zynq_i2c.c
2357 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2358 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2359 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2360
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302361 - drivers/i2c/s3c24x0_i2c.c:
2362 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2363 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2364 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2365 with a fix speed from 100000 and the slave addr 0!
2366
Dirk Eibachb46226b2014-07-03 09:28:18 +02002367 - drivers/i2c/ihs_i2c.c
2368 - activate this driver with CONFIG_SYS_I2C_IHS
2369 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2370 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2371 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2372 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2373 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2374 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2375 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2376 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2377 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2378 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2379 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2380 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002381 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2382 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2383 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2384 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2385 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2386 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2387 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2388 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2389 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002390
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002391 additional defines:
2392
2393 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002394 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002395 don't use/have i2c muxes on your i2c bus, this
2396 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2397 omit this define.
2398
2399 CONFIG_SYS_I2C_DIRECT_BUS
2400 define this, if you don't use i2c muxes on your hardware.
2401 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2402 omit this define.
2403
2404 CONFIG_SYS_I2C_MAX_HOPS
2405 define how many muxes are maximal consecutively connected
2406 on one i2c bus. If you not use i2c muxes, omit this
2407 define.
2408
2409 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002410 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002411 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2412 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2413 CONFIG_SYS_NUM_I2C_BUSES = 9:
2414
2415 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2416 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2417 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2418 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2419 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2420 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2421 {1, {I2C_NULL_HOP}}, \
2422 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2423 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2424 }
2425
2426 which defines
2427 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002428 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2429 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2430 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2431 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2432 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002433 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002434 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2435 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002436
2437 If you do not have i2c muxes on your board, omit this define.
2438
Heiko Schocherea818db2013-01-29 08:53:15 +01002439- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002440
2441 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2442 provides the following compelling advantages:
2443
2444 - more than one i2c adapter is usable
2445 - approved multibus support
2446 - better i2c mux support
2447
2448 ** Please consider updating your I2C driver now. **
2449
Heiko Schocherea818db2013-01-29 08:53:15 +01002450 These enable legacy I2C serial bus commands. Defining
2451 CONFIG_HARD_I2C will include the appropriate I2C driver
2452 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002453
wdenk945af8d2003-07-16 21:53:01 +00002454 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002455 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002456 CONFIG_COMMANDS) and communicate with i2c based realtime
2457 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002458 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002459
Ben Warrenbb99ad62006-09-07 16:50:54 -04002460 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002461
wdenk945af8d2003-07-16 21:53:01 +00002462 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002463 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002464
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002465 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002466 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002467 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002468 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002469
Peter Tyser8d321b82010-04-12 22:28:21 -05002470 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002471 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002472 and so its address should therefore be cleared to 0 (See,
2473 eg, MPC823e User's Manual p.16-473). So, set
2474 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002475
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002476 CONFIG_SYS_I2C_INIT_MPC5XXX
2477
2478 When a board is reset during an i2c bus transfer
2479 chips might think that the current transfer is still
2480 in progress. Reset the slave devices by sending start
2481 commands until the slave device responds.
2482
wdenk945af8d2003-07-16 21:53:01 +00002483 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002484
Heiko Schocherea818db2013-01-29 08:53:15 +01002485 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002486 then the following macros need to be defined (examples are
2487 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002488
2489 I2C_INIT
2490
wdenkb37c7e52003-06-30 16:24:52 +00002491 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002492 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002493
wdenkba56f622004-02-06 23:19:44 +00002494 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002495
wdenkc6097192002-11-03 00:24:07 +00002496 I2C_PORT
2497
wdenk43d96162003-03-06 00:02:04 +00002498 (Only for MPC8260 CPU). The I/O port to use (the code
2499 assumes both bits are on the same port). Valid values
2500 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002501
2502 I2C_ACTIVE
2503
2504 The code necessary to make the I2C data line active
2505 (driven). If the data line is open collector, this
2506 define can be null.
2507
wdenkb37c7e52003-06-30 16:24:52 +00002508 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2509
wdenkc6097192002-11-03 00:24:07 +00002510 I2C_TRISTATE
2511
2512 The code necessary to make the I2C data line tri-stated
2513 (inactive). If the data line is open collector, this
2514 define can be null.
2515
wdenkb37c7e52003-06-30 16:24:52 +00002516 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2517
wdenkc6097192002-11-03 00:24:07 +00002518 I2C_READ
2519
York Sun472d5462013-04-01 11:29:11 -07002520 Code that returns true if the I2C data line is high,
2521 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002522
wdenkb37c7e52003-06-30 16:24:52 +00002523 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2524
wdenkc6097192002-11-03 00:24:07 +00002525 I2C_SDA(bit)
2526
York Sun472d5462013-04-01 11:29:11 -07002527 If <bit> is true, sets the I2C data line high. If it
2528 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002529
wdenkb37c7e52003-06-30 16:24:52 +00002530 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002531 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002532 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002533
wdenkc6097192002-11-03 00:24:07 +00002534 I2C_SCL(bit)
2535
York Sun472d5462013-04-01 11:29:11 -07002536 If <bit> is true, sets the I2C clock line high. If it
2537 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002538
wdenkb37c7e52003-06-30 16:24:52 +00002539 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002540 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002541 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002542
wdenkc6097192002-11-03 00:24:07 +00002543 I2C_DELAY
2544
2545 This delay is invoked four times per clock cycle so this
2546 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002547 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002548 like:
2549
wdenkb37c7e52003-06-30 16:24:52 +00002550 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002551
Mike Frysinger793b5722010-07-21 13:38:02 -04002552 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2553
2554 If your arch supports the generic GPIO framework (asm/gpio.h),
2555 then you may alternatively define the two GPIOs that are to be
2556 used as SCL / SDA. Any of the previous I2C_xxx macros will
2557 have GPIO-based defaults assigned to them as appropriate.
2558
2559 You should define these to the GPIO value as given directly to
2560 the generic GPIO functions.
2561
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002562 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002563
wdenk8bde7f72003-06-27 21:31:46 +00002564 When a board is reset during an i2c bus transfer
2565 chips might think that the current transfer is still
2566 in progress. On some boards it is possible to access
2567 the i2c SCLK line directly, either by using the
2568 processor pin as a GPIO or by having a second pin
2569 connected to the bus. If this option is defined a
2570 custom i2c_init_board() routine in boards/xxx/board.c
2571 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002572
Richard Retanubun26a33502010-04-12 15:08:17 -04002573 CONFIG_SYS_I2C_BOARD_LATE_INIT
2574
2575 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2576 defined a custom i2c_board_late_init() routine in
2577 boards/xxx/board.c is run AFTER the operations in i2c_init()
2578 is completed. This callpoint can be used to unreset i2c bus
2579 using CPU i2c controller register accesses for CPUs whose i2c
2580 controller provide such a method. It is called at the end of
2581 i2c_init() to allow i2c_init operations to setup the i2c bus
2582 controller on the CPU (e.g. setting bus speed & slave address).
2583
wdenk17ea1172004-06-06 21:51:03 +00002584 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2585
2586 This option enables configuration of bi_iic_fast[] flags
2587 in u-boot bd_info structure based on u-boot environment
2588 variable "i2cfast". (see also i2cfast)
2589
Ben Warrenbb99ad62006-09-07 16:50:54 -04002590 CONFIG_I2C_MULTI_BUS
2591
2592 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002593 must have a controller. At any point in time, only one bus is
2594 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002595 Note that bus numbering is zero-based.
2596
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002597 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002598
2599 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002600 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002601 is set, specify a list of bus-device pairs. Otherwise, specify
2602 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002603
2604 e.g.
2605 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002606 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002607
2608 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2609
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002610 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002611 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002612
2613 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002615 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002616
2617 If defined, then this indicates the I2C bus number for DDR SPD.
2618 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2619
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002620 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002621
2622 If defined, then this indicates the I2C bus number for the RTC.
2623 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2624
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002625 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002626
2627 If defined, then this indicates the I2C bus number for the DTT.
2628 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2629
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002630 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002631
2632 If defined, specifies the I2C address of the DTT device.
2633 If not defined, then U-Boot uses predefined value for
2634 specified DTT device.
2635
Andrew Dyer2ac69852008-12-29 17:36:01 -06002636 CONFIG_SOFT_I2C_READ_REPEATED_START
2637
2638 defining this will force the i2c_read() function in
2639 the soft_i2c driver to perform an I2C repeated start
2640 between writing the address pointer and reading the
2641 data. If this define is omitted the default behaviour
2642 of doing a stop-start sequence will be used. Most I2C
2643 devices can use either method, but some require one or
2644 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002645
wdenkc6097192002-11-03 00:24:07 +00002646- SPI Support: CONFIG_SPI
2647
2648 Enables SPI driver (so far only tested with
2649 SPI EEPROM, also an instance works with Crystal A/D and
2650 D/As on the SACSng board)
2651
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002652 CONFIG_SH_SPI
2653
2654 Enables the driver for SPI controller on SuperH. Currently
2655 only SH7757 is supported.
2656
wdenkc6097192002-11-03 00:24:07 +00002657 CONFIG_SOFT_SPI
2658
wdenk43d96162003-03-06 00:02:04 +00002659 Enables a software (bit-bang) SPI driver rather than
2660 using hardware support. This is a general purpose
2661 driver that only requires three general I/O port pins
2662 (two outputs, one input) to function. If this is
2663 defined, the board configuration must define several
2664 SPI configuration items (port pins to use, etc). For
2665 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002666
Ben Warren04a9e112008-01-16 22:37:35 -05002667 CONFIG_HARD_SPI
2668
2669 Enables a hardware SPI driver for general-purpose reads
2670 and writes. As with CONFIG_SOFT_SPI, the board configuration
2671 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002672 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002673 example, see include/configs/mpc8349emds.h.
2674
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002675 CONFIG_MXC_SPI
2676
2677 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002678 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002679
Heiko Schocherf659b572014-07-14 10:22:11 +02002680 CONFIG_SYS_SPI_MXC_WAIT
2681 Timeout for waiting until spi transfer completed.
2682 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2683
Matthias Fuchs01335022007-12-27 17:12:34 +01002684- FPGA Support: CONFIG_FPGA
2685
2686 Enables FPGA subsystem.
2687
2688 CONFIG_FPGA_<vendor>
2689
2690 Enables support for specific chip vendors.
2691 (ALTERA, XILINX)
2692
2693 CONFIG_FPGA_<family>
2694
2695 Enables support for FPGA family.
2696 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2697
2698 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002699
wdenk43d96162003-03-06 00:02:04 +00002700 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002701
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302702 CONFIG_CMD_FPGA_LOADMK
2703
2704 Enable support for fpga loadmk command
2705
Michal Simek67193862014-05-02 13:43:39 +02002706 CONFIG_CMD_FPGA_LOADP
2707
2708 Enable support for fpga loadp command - load partial bitstream
2709
2710 CONFIG_CMD_FPGA_LOADBP
2711
2712 Enable support for fpga loadbp command - load partial bitstream
2713 (Xilinx only)
2714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002715 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002716
wdenk8bde7f72003-06-27 21:31:46 +00002717 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002719 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002720
wdenk43d96162003-03-06 00:02:04 +00002721 Enable checks on FPGA configuration interface busy
2722 status by the configuration function. This option
2723 will require a board or device specific function to
2724 be written.
wdenkc6097192002-11-03 00:24:07 +00002725
2726 CONFIG_FPGA_DELAY
2727
2728 If defined, a function that provides delays in the FPGA
2729 configuration driver.
2730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002731 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002732 Allow Control-C to interrupt FPGA configuration
2733
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002734 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002735
wdenk43d96162003-03-06 00:02:04 +00002736 Check for configuration errors during FPGA bitfile
2737 loading. For example, abort during Virtex II
2738 configuration if the INIT_B line goes low (which
2739 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002740
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002741 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002742
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002743 Maximum time to wait for the INIT_B line to de-assert
2744 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002745 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002746 ms.
wdenkc6097192002-11-03 00:24:07 +00002747
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002748 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002749
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002750 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002751 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002752
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002753 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002754
wdenk43d96162003-03-06 00:02:04 +00002755 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002756 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002757
2758- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002759 CONFIG_BUILD_TARGET
2760
2761 Some SoCs need special image types (e.g. U-Boot binary
2762 with a special header) as build targets. By defining
2763 CONFIG_BUILD_TARGET in the SoC / board header, this
2764 special image will be automatically built upon calling
2765 make / MAKEALL.
2766
wdenkc6097192002-11-03 00:24:07 +00002767 CONFIG_IDENT_STRING
2768
wdenk43d96162003-03-06 00:02:04 +00002769 If defined, this string will be added to the U-Boot
2770 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002771
2772- Vendor Parameter Protection:
2773
wdenk43d96162003-03-06 00:02:04 +00002774 U-Boot considers the values of the environment
2775 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002776 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002777 are set once by the board vendor / manufacturer, and
2778 protects these variables from casual modification by
2779 the user. Once set, these variables are read-only,
2780 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002781 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002782
2783 If CONFIG_ENV_OVERWRITE is #defined in your config
2784 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002785 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002786 these parameters.
2787
Joe Hershberger92ac5202015-05-04 14:55:14 -05002788 Alternatively, if you define _both_ an ethaddr in the
2789 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002790 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002791 which can be changed exactly ONCE by the user. [The
2792 serial# is unaffected by this, i. e. it remains
2793 read-only.]
2794
Joe Hershberger25980902012-12-11 22:16:31 -06002795 The same can be accomplished in a more flexible way
2796 for any variable by configuring the type of access
2797 to allow for those variables in the ".flags" variable
2798 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2799
wdenkc6097192002-11-03 00:24:07 +00002800- Protected RAM:
2801 CONFIG_PRAM
2802
2803 Define this variable to enable the reservation of
2804 "protected RAM", i. e. RAM which is not overwritten
2805 by U-Boot. Define CONFIG_PRAM to hold the number of
2806 kB you want to reserve for pRAM. You can overwrite
2807 this default value by defining an environment
2808 variable "pram" to the number of kB you want to
2809 reserve. Note that the board info structure will
2810 still show the full amount of RAM. If pRAM is
2811 reserved, a new environment variable "mem" will
2812 automatically be defined to hold the amount of
2813 remaining RAM in a form that can be passed as boot
2814 argument to Linux, for instance like that:
2815
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002816 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002817 saveenv
2818
2819 This way you can tell Linux not to use this memory,
2820 either, which results in a memory region that will
2821 not be affected by reboots.
2822
2823 *WARNING* If your board configuration uses automatic
2824 detection of the RAM size, you must make sure that
2825 this memory test is non-destructive. So far, the
2826 following board configurations are known to be
2827 "pRAM-clean":
2828
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002829 IVMS8, IVML24, SPD8xx, TQM8xxL,
2830 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002831 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002832
Gabe Black40fef042012-12-02 04:55:18 +00002833- Access to physical memory region (> 4GB)
2834 Some basic support is provided for operations on memory not
2835 normally accessible to U-Boot - e.g. some architectures
2836 support access to more than 4GB of memory on 32-bit
2837 machines using physical address extension or similar.
2838 Define CONFIG_PHYSMEM to access this basic support, which
2839 currently only supports clearing the memory.
2840
wdenkc6097192002-11-03 00:24:07 +00002841- Error Recovery:
2842 CONFIG_PANIC_HANG
2843
2844 Define this variable to stop the system in case of a
2845 fatal error, so that you have to reset it manually.
2846 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002847 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002848 automatically as fast as possible, but it may be
2849 useful during development since you can try to debug
2850 the conditions that lead to the situation.
2851
2852 CONFIG_NET_RETRY_COUNT
2853
wdenk43d96162003-03-06 00:02:04 +00002854 This variable defines the number of retries for
2855 network operations like ARP, RARP, TFTP, or BOOTP
2856 before giving up the operation. If not defined, a
2857 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002858
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002859 CONFIG_ARP_TIMEOUT
2860
2861 Timeout waiting for an ARP reply in milliseconds.
2862
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002863 CONFIG_NFS_TIMEOUT
2864
2865 Timeout in milliseconds used in NFS protocol.
2866 If you encounter "ERROR: Cannot umount" in nfs command,
2867 try longer timeout such as
2868 #define CONFIG_NFS_TIMEOUT 10000UL
2869
wdenkc6097192002-11-03 00:24:07 +00002870- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002871 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002872
2873 Enable auto completion of commands using TAB.
2874
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002875 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002876
2877 This defines the secondary prompt string, which is
2878 printed when the command interpreter needs more input
2879 to complete a command. Usually "> ".
2880
2881 Note:
2882
wdenk8bde7f72003-06-27 21:31:46 +00002883 In the current implementation, the local variables
2884 space and global environment variables space are
2885 separated. Local variables are those you define by
2886 simply typing `name=value'. To access a local
2887 variable later on, you have write `$name' or
2888 `${name}'; to execute the contents of a variable
2889 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002890
wdenk43d96162003-03-06 00:02:04 +00002891 Global environment variables are those you use
2892 setenv/printenv to work with. To run a command stored
2893 in such a variable, you need to use the run command,
2894 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002895
2896 To store commands and special characters in a
2897 variable, please use double quotation marks
2898 surrounding the whole text of the variable, instead
2899 of the backslashes before semicolons and special
2900 symbols.
2901
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002902- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002903 CONFIG_CMDLINE_EDITING
2904
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002905 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002906 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002907
wdenka8c7c702003-12-06 19:49:23 +00002908- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002909 CONFIG_EXTRA_ENV_SETTINGS
2910
wdenk43d96162003-03-06 00:02:04 +00002911 Define this to contain any number of null terminated
2912 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002913 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002914
wdenk43d96162003-03-06 00:02:04 +00002915 For example, place something like this in your
2916 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002917
2918 #define CONFIG_EXTRA_ENV_SETTINGS \
2919 "myvar1=value1\0" \
2920 "myvar2=value2\0"
2921
wdenk43d96162003-03-06 00:02:04 +00002922 Warning: This method is based on knowledge about the
2923 internal format how the environment is stored by the
2924 U-Boot code. This is NOT an official, exported
2925 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002926 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002927 You better know what you are doing here.
2928
wdenk43d96162003-03-06 00:02:04 +00002929 Note: overly (ab)use of the default environment is
2930 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002931 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002932 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002933
Stephen Warren5e724ca2012-05-22 09:21:54 +00002934 CONFIG_ENV_VARS_UBOOT_CONFIG
2935
2936 Define this in order to add variables describing the
2937 U-Boot build configuration to the default environment.
2938 These will be named arch, cpu, board, vendor, and soc.
2939
2940 Enabling this option will cause the following to be defined:
2941
2942 - CONFIG_SYS_ARCH
2943 - CONFIG_SYS_CPU
2944 - CONFIG_SYS_BOARD
2945 - CONFIG_SYS_VENDOR
2946 - CONFIG_SYS_SOC
2947
Tom Rini7e27f892012-10-24 07:28:16 +00002948 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2949
2950 Define this in order to add variables describing certain
2951 run-time determined information about the hardware to the
2952 environment. These will be named board_name, board_rev.
2953
Simon Glass06fd8532012-11-30 13:01:17 +00002954 CONFIG_DELAY_ENVIRONMENT
2955
2956 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002957 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002958 that so that the environment is not available until
2959 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2960 this is instead controlled by the value of
2961 /config/load-environment.
2962
Chris Packham3b10cf12015-06-19 20:25:59 +12002963- Parallel Flash support:
2964 CONFIG_SYS_NO_FLASH
2965
Bin Menga1875592016-02-05 19:30:11 -08002966 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham3b10cf12015-06-19 20:25:59 +12002967 flash. This option is used to disable support for parallel NOR
2968 flash. This option should be defined if the board does not have
2969 parallel flash.
2970
2971 If this option is not defined one of the generic flash drivers
2972 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2973 selected or the board must provide an implementation of the
2974 flash API (see include/flash.h).
2975
wdenka8c7c702003-12-06 19:49:23 +00002976- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002977 CONFIG_HAS_DATAFLASH
2978
wdenk8bde7f72003-06-27 21:31:46 +00002979 Defining this option enables DataFlash features and
2980 allows to read/write in Dataflash via the standard
2981 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002982
Eric Nelsonf61ec452012-01-31 10:52:08 -07002983- Serial Flash support
2984 CONFIG_CMD_SF
2985
2986 Defining this option enables SPI flash commands
2987 'sf probe/read/write/erase/update'.
2988
2989 Usage requires an initial 'probe' to define the serial
2990 flash parameters, followed by read/write/erase/update
2991 commands.
2992
2993 The following defaults may be provided by the platform
2994 to handle the common case when only a single serial
2995 flash is present on the system.
2996
2997 CONFIG_SF_DEFAULT_BUS Bus identifier
2998 CONFIG_SF_DEFAULT_CS Chip-select
2999 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3000 CONFIG_SF_DEFAULT_SPEED in Hz
3001
Simon Glass24007272012-10-08 13:16:02 +00003002 CONFIG_CMD_SF_TEST
3003
3004 Define this option to include a destructive SPI flash
3005 test ('sf test').
3006
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303007 CONFIG_SF_DUAL_FLASH Dual flash memories
3008
3009 Define this option to use dual flash support where two flash
3010 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003011 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303012
wdenk3f85ce22004-02-23 16:11:30 +00003013- SystemACE Support:
3014 CONFIG_SYSTEMACE
3015
3016 Adding this option adds support for Xilinx SystemACE
3017 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003018 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003019 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003020
3021 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003022 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003023
3024 When SystemACE support is added, the "ace" device type
3025 becomes available to the fat commands, i.e. fatls.
3026
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003027- TFTP Fixed UDP Port:
3028 CONFIG_TFTP_PORT
3029
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003030 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003031 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003032 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003033 number generator is used.
3034
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003035 Also, the environment variable tftpdstp is used to supply
3036 the TFTP UDP destination port value. If tftpdstp isn't
3037 defined, the normal port 69 is used.
3038
3039 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003040 blindly start the TFTP transfer using the pre-configured
3041 target IP address and UDP port. This has the effect of
3042 "punching through" the (Windows XP) firewall, allowing
3043 the remainder of the TFTP transfer to proceed normally.
3044 A better solution is to properly configure the firewall,
3045 but sometimes that is not allowed.
3046
Simon Glassbf36c5d2012-12-05 14:46:38 +00003047- Hashing support:
3048 CONFIG_CMD_HASH
3049
3050 This enables a generic 'hash' command which can produce
3051 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3052
3053 CONFIG_HASH_VERIFY
3054
3055 Enable the hash verify command (hash -v). This adds to code
3056 size a little.
3057
gaurav rana94e3c8c2015-02-20 12:51:46 +05303058 CONFIG_SHA1 - This option enables support of hashing using SHA1
3059 algorithm. The hash is calculated in software.
3060 CONFIG_SHA256 - This option enables support of hashing using
3061 SHA256 algorithm. The hash is calculated in software.
3062 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3063 for SHA1/SHA256 hashing.
3064 This affects the 'hash' command and also the
3065 hash_lookup_algo() function.
3066 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3067 hardware-acceleration for SHA1/SHA256 progressive hashing.
3068 Data can be streamed in a block at a time and the hashing
3069 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00003070
3071 Note: There is also a sha1sum command, which should perhaps
3072 be deprecated in favour of 'hash sha1'.
3073
Robert Winklera11f1872013-07-24 17:57:06 -07003074- Freescale i.MX specific commands:
3075 CONFIG_CMD_HDMIDETECT
3076 This enables 'hdmidet' command which returns true if an
3077 HDMI monitor is detected. This command is i.MX 6 specific.
3078
3079 CONFIG_CMD_BMODE
3080 This enables the 'bmode' (bootmode) command for forcing
3081 a boot from specific media.
3082
3083 This is useful for forcing the ROM's usb downloader to
3084 activate upon a watchdog reset which is nice when iterating
3085 on U-Boot. Using the reset button or running bmode normal
3086 will set it back to normal. This command currently
3087 supports i.MX53 and i.MX6.
3088
Simon Glass19c402a2013-06-13 15:10:02 -07003089- Signing support:
3090 CONFIG_RSA
3091
3092 This enables the RSA algorithm used for FIT image verification
Detlev Zundel8bf2aad2014-01-20 16:21:46 +01003093 in U-Boot. See doc/uImage.FIT/signature.txt for more information.
Simon Glass19c402a2013-06-13 15:10:02 -07003094
Ruchika Guptac937ff62015-01-23 16:01:54 +05303095 The Modular Exponentiation algorithm in RSA is implemented using
3096 driver model. So CONFIG_DM needs to be enabled by default for this
3097 library to function.
3098
Simon Glass19c402a2013-06-13 15:10:02 -07003099 The signing part is build into mkimage regardless of this
Ruchika Guptac937ff62015-01-23 16:01:54 +05303100 option. The software based modular exponentiation is built into
3101 mkimage irrespective of this option.
Simon Glass19c402a2013-06-13 15:10:02 -07003102
Heiko Schocher9e50c402014-01-25 07:27:13 +01003103- bootcount support:
3104 CONFIG_BOOTCOUNT_LIMIT
3105
3106 This enables the bootcounter support, see:
3107 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3108
3109 CONFIG_AT91SAM9XE
3110 enable special bootcounter support on at91sam9xe based boards.
3111 CONFIG_BLACKFIN
3112 enable special bootcounter support on blackfin based boards.
3113 CONFIG_SOC_DA8XX
3114 enable special bootcounter support on da850 based boards.
3115 CONFIG_BOOTCOUNT_RAM
3116 enable support for the bootcounter in RAM
3117 CONFIG_BOOTCOUNT_I2C
3118 enable support for the bootcounter on an i2c (like RTC) device.
3119 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3120 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3121 the bootcounter.
3122 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003123
wdenka8c7c702003-12-06 19:49:23 +00003124- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003125 CONFIG_SHOW_BOOT_PROGRESS
3126
wdenk43d96162003-03-06 00:02:04 +00003127 Defining this option allows to add some board-
3128 specific code (calling a user-provided function
3129 "show_boot_progress(int)") that enables you to show
3130 the system's boot progress on some display (for
3131 example, some LED's) on your board. At the moment,
3132 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003133
Simon Glass94fd1312012-09-28 08:56:37 +00003134
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003135Legacy uImage format:
3136
wdenkc6097192002-11-03 00:24:07 +00003137 Arg Where When
3138 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003139 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003140 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003141 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003142 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003143 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003144 4 common/cmd_bootm.c Image data has correct checksum
3145 -4 common/cmd_bootm.c Image is for unsupported architecture
3146 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003147 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003148 6 common/cmd_bootm.c Image Type check OK
3149 -6 common/cmd_bootm.c gunzip uncompression error
3150 -7 common/cmd_bootm.c Unimplemented compression type
3151 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003152 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003153 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003154
3155 9 common/image.c Start initial ramdisk verification
3156 -10 common/image.c Ramdisk header has bad magic number
3157 -11 common/image.c Ramdisk header has bad checksum
3158 10 common/image.c Ramdisk header is OK
3159 -12 common/image.c Ramdisk data has bad checksum
3160 11 common/image.c Ramdisk data has correct checksum
3161 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003162 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003163 13 common/image.c Start multifile image verification
3164 14 common/image.c No initial ramdisk, no multifile, continue.
3165
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003166 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003167
Stefan Roesea47a12b2010-04-15 16:07:28 +02003168 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003169 -31 post/post.c POST test failed, detected by post_output_backlog()
3170 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003171
Heiko Schocher566a4942007-06-22 19:11:54 +02003172 34 common/cmd_doc.c before loading a Image from a DOC device
3173 -35 common/cmd_doc.c Bad usage of "doc" command
3174 35 common/cmd_doc.c correct usage of "doc" command
3175 -36 common/cmd_doc.c No boot device
3176 36 common/cmd_doc.c correct boot device
3177 -37 common/cmd_doc.c Unknown Chip ID on boot device
3178 37 common/cmd_doc.c correct chip ID found, device available
3179 -38 common/cmd_doc.c Read Error on boot device
3180 38 common/cmd_doc.c reading Image header from DOC device OK
3181 -39 common/cmd_doc.c Image header has bad magic number
3182 39 common/cmd_doc.c Image header has correct magic number
3183 -40 common/cmd_doc.c Error reading Image from DOC device
3184 40 common/cmd_doc.c Image header has correct magic number
3185 41 common/cmd_ide.c before loading a Image from a IDE device
3186 -42 common/cmd_ide.c Bad usage of "ide" command
3187 42 common/cmd_ide.c correct usage of "ide" command
3188 -43 common/cmd_ide.c No boot device
3189 43 common/cmd_ide.c boot device found
3190 -44 common/cmd_ide.c Device not available
3191 44 common/cmd_ide.c Device available
3192 -45 common/cmd_ide.c wrong partition selected
3193 45 common/cmd_ide.c partition selected
3194 -46 common/cmd_ide.c Unknown partition table
3195 46 common/cmd_ide.c valid partition table found
3196 -47 common/cmd_ide.c Invalid partition type
3197 47 common/cmd_ide.c correct partition type
3198 -48 common/cmd_ide.c Error reading Image Header on boot device
3199 48 common/cmd_ide.c reading Image Header from IDE device OK
3200 -49 common/cmd_ide.c Image header has bad magic number
3201 49 common/cmd_ide.c Image header has correct magic number
3202 -50 common/cmd_ide.c Image header has bad checksum
3203 50 common/cmd_ide.c Image header has correct checksum
3204 -51 common/cmd_ide.c Error reading Image from IDE device
3205 51 common/cmd_ide.c reading Image from IDE device OK
3206 52 common/cmd_nand.c before loading a Image from a NAND device
3207 -53 common/cmd_nand.c Bad usage of "nand" command
3208 53 common/cmd_nand.c correct usage of "nand" command
3209 -54 common/cmd_nand.c No boot device
3210 54 common/cmd_nand.c boot device found
3211 -55 common/cmd_nand.c Unknown Chip ID on boot device
3212 55 common/cmd_nand.c correct chip ID found, device available
3213 -56 common/cmd_nand.c Error reading Image Header on boot device
3214 56 common/cmd_nand.c reading Image Header from NAND device OK
3215 -57 common/cmd_nand.c Image header has bad magic number
3216 57 common/cmd_nand.c Image header has correct magic number
3217 -58 common/cmd_nand.c Error reading Image from NAND device
3218 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003219
Heiko Schocher566a4942007-06-22 19:11:54 +02003220 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003221
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003222 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003223 -64 net/eth.c no Ethernet found.
3224 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003225
Heiko Schocher566a4942007-06-22 19:11:54 +02003226 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05003227 80 common/cmd_net.c before calling net_loop()
3228 -81 common/cmd_net.c some error in net_loop() occurred
3229 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02003230 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3231 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003232 83 common/cmd_net.c running "source" command
3233 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003234 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003235
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003236FIT uImage format:
3237
3238 Arg Where When
3239 100 common/cmd_bootm.c Kernel FIT Image has correct format
3240 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3241 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3242 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3243 102 common/cmd_bootm.c Kernel unit name specified
3244 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003245 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003246 104 common/cmd_bootm.c Got kernel subimage node offset
3247 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3248 105 common/cmd_bootm.c Kernel subimage hash verification OK
3249 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3250 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003251 -106 common/cmd_bootm.c Kernel subimage has wrong type
3252 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003253 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3254 108 common/cmd_bootm.c Got kernel subimage data/size
3255 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3256 -109 common/cmd_bootm.c Can't get kernel subimage type
3257 -110 common/cmd_bootm.c Can't get kernel subimage comp
3258 -111 common/cmd_bootm.c Can't get kernel subimage os
3259 -112 common/cmd_bootm.c Can't get kernel subimage load address
3260 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3261
3262 120 common/image.c Start initial ramdisk verification
3263 -120 common/image.c Ramdisk FIT image has incorrect format
3264 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003265 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003266 -122 common/image.c Can't get configuration for ramdisk subimage
3267 123 common/image.c Ramdisk unit name specified
3268 -124 common/image.c Can't get ramdisk subimage node offset
3269 125 common/image.c Got ramdisk subimage node offset
3270 -125 common/image.c Ramdisk subimage hash verification failed
3271 126 common/image.c Ramdisk subimage hash verification OK
3272 -126 common/image.c Ramdisk subimage for unsupported architecture
3273 127 common/image.c Architecture check OK
3274 -127 common/image.c Can't get ramdisk subimage data/size
3275 128 common/image.c Got ramdisk subimage data/size
3276 129 common/image.c Can't get ramdisk load address
3277 -129 common/image.c Got ramdisk load address
3278
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003279 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003280 131 common/cmd_doc.c FIT image format OK
3281
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003282 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003283 141 common/cmd_ide.c FIT image format OK
3284
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003285 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003286 151 common/cmd_nand.c FIT image format OK
3287
Heiko Schocher21d29f72014-05-28 11:33:33 +02003288- legacy image format:
3289 CONFIG_IMAGE_FORMAT_LEGACY
3290 enables the legacy image format support in U-Boot.
3291
3292 Default:
3293 enabled if CONFIG_FIT_SIGNATURE is not defined.
3294
3295 CONFIG_DISABLE_IMAGE_LEGACY
3296 disable the legacy image format
3297
3298 This define is introduced, as the legacy image format is
3299 enabled per default for backward compatibility.
3300
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003301- FIT image support:
3302 CONFIG_FIT
3303 Enable support for the FIT uImage format.
3304
3305 CONFIG_FIT_BEST_MATCH
3306 When no configuration is explicitly selected, default to the
3307 one whose fdt's compatibility field best matches that of
3308 U-Boot itself. A match is considered "best" if it matches the
3309 most specific compatibility entry of U-Boot's fdt's root node.
3310 The order of entries in the configuration's fdt is ignored.
3311
Simon Glass3e569a62013-06-13 15:10:00 -07003312 CONFIG_FIT_SIGNATURE
3313 This option enables signature verification of FIT uImages,
gaurav rana94e3c8c2015-02-20 12:51:46 +05303314 using a hash signed and verified using RSA. If
3315 CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive
3316 hashing is available using hardware, RSA library will use it.
3317 See doc/uImage.FIT/signature.txt for more details.
Simon Glass3e569a62013-06-13 15:10:00 -07003318
Heiko Schocher21d29f72014-05-28 11:33:33 +02003319 WARNING: When relying on signed FIT images with required
3320 signature check the legacy image format is default
3321 disabled. If a board need legacy image format support
3322 enable this through CONFIG_IMAGE_FORMAT_LEGACY
3323
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003324 CONFIG_FIT_DISABLE_SHA256
3325 Supporting SHA256 hashes has quite an impact on binary size.
3326 For constrained systems sha256 hash support can be disabled
3327 with this option.
3328
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003329- Standalone program support:
3330 CONFIG_STANDALONE_LOAD_ADDR
3331
Wolfgang Denk6feff892011-10-09 21:06:34 +02003332 This option defines a board specific value for the
3333 address where standalone program gets loaded, thus
3334 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003335 settings.
3336
3337- Frame Buffer Address:
3338 CONFIG_FB_ADDR
3339
3340 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003341 address for frame buffer. This is typically the case
3342 when using a graphics controller has separate video
3343 memory. U-Boot will then place the frame buffer at
3344 the given address instead of dynamically reserving it
3345 in system RAM by calling lcd_setmem(), which grabs
3346 the memory for the frame buffer depending on the
3347 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003348
3349 Please see board_init_f function.
3350
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003351- Automatic software updates via TFTP server
3352 CONFIG_UPDATE_TFTP
3353 CONFIG_UPDATE_TFTP_CNT_MAX
3354 CONFIG_UPDATE_TFTP_MSEC_MAX
3355
3356 These options enable and control the auto-update feature;
3357 for a more detailed description refer to doc/README.update.
3358
3359- MTD Support (mtdparts command, UBI support)
3360 CONFIG_MTD_DEVICE
3361
3362 Adds the MTD device infrastructure from the Linux kernel.
3363 Needed for mtdparts command support.
3364
3365 CONFIG_MTD_PARTITIONS
3366
3367 Adds the MTD partitioning infrastructure from the Linux
3368 kernel. Needed for UBI support.
3369
Joe Hershberger70c219c2013-04-08 10:32:48 +00003370- UBI support
3371 CONFIG_CMD_UBI
3372
3373 Adds commands for interacting with MTD partitions formatted
3374 with the UBI flash translation layer
3375
3376 Requires also defining CONFIG_RBTREE
3377
Joe Hershberger147162d2013-04-08 10:32:49 +00003378 CONFIG_UBI_SILENCE_MSG
3379
3380 Make the verbose messages from UBI stop printing. This leaves
3381 warnings and errors enabled.
3382
Heiko Schocherff94bc42014-06-24 10:10:04 +02003383
3384 CONFIG_MTD_UBI_WL_THRESHOLD
3385 This parameter defines the maximum difference between the highest
3386 erase counter value and the lowest erase counter value of eraseblocks
3387 of UBI devices. When this threshold is exceeded, UBI starts performing
3388 wear leveling by means of moving data from eraseblock with low erase
3389 counter to eraseblocks with high erase counter.
3390
3391 The default value should be OK for SLC NAND flashes, NOR flashes and
3392 other flashes which have eraseblock life-cycle 100000 or more.
3393 However, in case of MLC NAND flashes which typically have eraseblock
3394 life-cycle less than 10000, the threshold should be lessened (e.g.,
3395 to 128 or 256, although it does not have to be power of 2).
3396
3397 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003398
Heiko Schocherff94bc42014-06-24 10:10:04 +02003399 CONFIG_MTD_UBI_BEB_LIMIT
3400 This option specifies the maximum bad physical eraseblocks UBI
3401 expects on the MTD device (per 1024 eraseblocks). If the
3402 underlying flash does not admit of bad eraseblocks (e.g. NOR
3403 flash), this value is ignored.
3404
3405 NAND datasheets often specify the minimum and maximum NVM
3406 (Number of Valid Blocks) for the flashes' endurance lifetime.
3407 The maximum expected bad eraseblocks per 1024 eraseblocks
3408 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3409 which gives 20 for most NANDs (MaxNVB is basically the total
3410 count of eraseblocks on the chip).
3411
3412 To put it differently, if this value is 20, UBI will try to
3413 reserve about 1.9% of physical eraseblocks for bad blocks
3414 handling. And that will be 1.9% of eraseblocks on the entire
3415 NAND chip, not just the MTD partition UBI attaches. This means
3416 that if you have, say, a NAND flash chip admits maximum 40 bad
3417 eraseblocks, and it is split on two MTD partitions of the same
3418 size, UBI will reserve 40 eraseblocks when attaching a
3419 partition.
3420
3421 default: 20
3422
3423 CONFIG_MTD_UBI_FASTMAP
3424 Fastmap is a mechanism which allows attaching an UBI device
3425 in nearly constant time. Instead of scanning the whole MTD device it
3426 only has to locate a checkpoint (called fastmap) on the device.
3427 The on-flash fastmap contains all information needed to attach
3428 the device. Using fastmap makes only sense on large devices where
3429 attaching by scanning takes long. UBI will not automatically install
3430 a fastmap on old images, but you can set the UBI parameter
3431 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3432 that fastmap-enabled images are still usable with UBI implementations
3433 without fastmap support. On typical flash devices the whole fastmap
3434 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3435
3436 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3437 Set this parameter to enable fastmap automatically on images
3438 without a fastmap.
3439 default: 0
3440
Heiko Schocher0195a7b2015-10-22 06:19:21 +02003441 CONFIG_MTD_UBI_FM_DEBUG
3442 Enable UBI fastmap debug
3443 default: 0
3444
Joe Hershberger70c219c2013-04-08 10:32:48 +00003445- UBIFS support
3446 CONFIG_CMD_UBIFS
3447
3448 Adds commands for interacting with UBI volumes formatted as
3449 UBIFS. UBIFS is read-only in u-boot.
3450
3451 Requires UBI support as well as CONFIG_LZO
3452
Joe Hershberger147162d2013-04-08 10:32:49 +00003453 CONFIG_UBIFS_SILENCE_MSG
3454
3455 Make the verbose messages from UBIFS stop printing. This leaves
3456 warnings and errors enabled.
3457
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003458- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003459 CONFIG_SPL
3460 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003461
Tom Rini95579792012-02-14 07:29:40 +00003462 CONFIG_SPL_LDSCRIPT
3463 LDSCRIPT for linking the SPL binary.
3464
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003465 CONFIG_SPL_MAX_FOOTPRINT
3466 Maximum size in memory allocated to the SPL, BSS included.
3467 When defined, the linker checks that the actual memory
3468 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003469 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003470 must not be both defined at the same time.
3471
Tom Rini95579792012-02-14 07:29:40 +00003472 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003473 Maximum size of the SPL image (text, data, rodata, and
3474 linker lists sections), BSS excluded.
3475 When defined, the linker checks that the actual size does
3476 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003477
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003478 CONFIG_SPL_TEXT_BASE
3479 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003480
Scott Wood94a45bb2012-09-20 19:05:12 -05003481 CONFIG_SPL_RELOC_TEXT_BASE
3482 Address to relocate to. If unspecified, this is equal to
3483 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3484
Tom Rini95579792012-02-14 07:29:40 +00003485 CONFIG_SPL_BSS_START_ADDR
3486 Link address for the BSS within the SPL binary.
3487
3488 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003489 Maximum size in memory allocated to the SPL BSS.
3490 When defined, the linker checks that the actual memory used
3491 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003492 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003493 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003494
3495 CONFIG_SPL_STACK
3496 Adress of the start of the stack SPL will use
3497
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02003498 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3499 When defined, SPL will panic() if the image it has
3500 loaded does not have a signature.
3501 Defining this is useful when code which loads images
3502 in SPL cannot guarantee that absolutely all read errors
3503 will be caught.
3504 An example is the LPC32XX MLC NAND driver, which will
3505 consider that a completely unreadable NAND block is bad,
3506 and thus should be skipped silently.
3507
Scott Wood94a45bb2012-09-20 19:05:12 -05003508 CONFIG_SPL_RELOC_STACK
3509 Adress of the start of the stack SPL will use after
3510 relocation. If unspecified, this is equal to
3511 CONFIG_SPL_STACK.
3512
Tom Rini95579792012-02-14 07:29:40 +00003513 CONFIG_SYS_SPL_MALLOC_START
3514 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02003515 When this option is set the full malloc is used in SPL and
3516 it is set up by spl_init() and before that, the simple malloc()
3517 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00003518
3519 CONFIG_SYS_SPL_MALLOC_SIZE
3520 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003521
Tom Rini47f7bca2012-08-13 12:03:19 -07003522 CONFIG_SPL_FRAMEWORK
3523 Enable the SPL framework under common/. This framework
3524 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3525 NAND loading of the Linux Kernel.
3526
Tom Rini9607faf2014-03-28 12:03:39 -04003527 CONFIG_SPL_OS_BOOT
3528 Enable booting directly to an OS from SPL.
3529 See also: doc/README.falcon
3530
Tom Rini861a86f2012-08-13 11:37:56 -07003531 CONFIG_SPL_DISPLAY_PRINT
3532 For ARM, enable an optional function to print more information
3533 about the running system.
3534
Scott Wood4b919722012-09-20 16:35:21 -05003535 CONFIG_SPL_INIT_MINIMAL
3536 Arch init code should be built for a very small image
3537
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003538 CONFIG_SPL_LIBCOMMON_SUPPORT
3539 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003540
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003541 CONFIG_SPL_LIBDISK_SUPPORT
3542 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003543
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003544 CONFIG_SPL_I2C_SUPPORT
3545 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003546
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003547 CONFIG_SPL_GPIO_SUPPORT
3548 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003549
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003550 CONFIG_SPL_MMC_SUPPORT
3551 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003552
Tom Rini95579792012-02-14 07:29:40 +00003553 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3554 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003555 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003556 when the MMC is being used in raw mode.
3557
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003558 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3559 Partition on the MMC to load U-Boot from when the MMC is being
3560 used in raw mode
3561
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003562 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3563 Sector to load kernel uImage from when MMC is being
3564 used in raw mode (for Falcon mode)
3565
3566 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3567 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3568 Sector and number of sectors to load kernel argument
3569 parameters from when MMC is being used in raw mode
3570 (for falcon mode)
3571
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003572 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3573 Partition on the MMC to load U-Boot from when the MMC is being
3574 used in fs mode
3575
Tom Rini95579792012-02-14 07:29:40 +00003576 CONFIG_SPL_FAT_SUPPORT
3577 Support for fs/fat/libfat.o in SPL binary
3578
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003579 CONFIG_SPL_EXT_SUPPORT
3580 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003581
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003582 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3583 Filename to read to load U-Boot when reading from filesystem
3584
3585 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003586 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003587 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003588
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003589 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003590 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003591 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003592
Scott Wood06f60ae2012-12-06 13:33:17 +00003593 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3594 Set this for NAND SPL on PPC mpc83xx targets, so that
3595 start.S waits for the rest of the SPL to load before
3596 continuing (the hardware starts execution after just
3597 loading the first page rather than the full 4K).
3598
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303599 CONFIG_SPL_SKIP_RELOCATE
3600 Avoid SPL relocation
3601
Scott Wood6f2f01b2012-09-20 19:09:07 -05003602 CONFIG_SPL_NAND_BASE
3603 Include nand_base.c in the SPL. Requires
3604 CONFIG_SPL_NAND_DRIVERS.
3605
3606 CONFIG_SPL_NAND_DRIVERS
3607 SPL uses normal NAND drivers, not minimal drivers.
3608
3609 CONFIG_SPL_NAND_ECC
3610 Include standard software ECC in the SPL
3611
Tom Rini95579792012-02-14 07:29:40 +00003612 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003613 Support for NAND boot using simple NAND drivers that
3614 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003615
Tom Rini6dd3b562014-03-28 12:03:36 -04003616 CONFIG_SPL_MTD_SUPPORT
3617 Support for the MTD subsystem within SPL. Useful for
3618 environment on NAND support within SPL.
3619
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003620 CONFIG_SPL_NAND_RAW_ONLY
3621 Support to boot only raw u-boot.bin images. Use this only
3622 if you need to save space.
3623
Ying Zhangbb0dc102013-08-16 15:16:11 +08003624 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3625 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003626 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003627
Ying Zhang7c8eea52013-08-16 15:16:12 +08003628 CONFIG_SPL_COMMON_INIT_DDR
3629 Set for common ddr init with serial presence detect in
3630 SPL binary.
3631
Tom Rini95579792012-02-14 07:29:40 +00003632 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3633 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3634 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3635 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3636 CONFIG_SYS_NAND_ECCBYTES
3637 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003638 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003639
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303640 CONFIG_SPL_NAND_BOOT
3641 Add support NAND boot
3642
Tom Rini95579792012-02-14 07:29:40 +00003643 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003644 Location in NAND to read U-Boot from
3645
3646 CONFIG_SYS_NAND_U_BOOT_DST
3647 Location in memory to load U-Boot to
3648
3649 CONFIG_SYS_NAND_U_BOOT_SIZE
3650 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003651
3652 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003653 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003654
3655 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3656 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003657 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003658
3659 CONFIG_SPL_OMAP3_ID_NAND
3660 Support for an OMAP3-specific set of functions to return the
3661 ID and MFR of the first attached NAND chip, if present.
3662
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003663 CONFIG_SPL_SERIAL_SUPPORT
3664 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003665
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003666 CONFIG_SPL_SPI_FLASH_SUPPORT
3667 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003668
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003669 CONFIG_SPL_SPI_SUPPORT
3670 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003671
Pavel Machekc57b9532012-08-30 22:42:11 +02003672 CONFIG_SPL_RAM_DEVICE
3673 Support for running image already present in ram, in SPL binary
3674
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003675 CONFIG_SPL_LIBGENERIC_SUPPORT
3676 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003677
Ying Zhangba1bee42013-05-20 14:07:25 +08003678 CONFIG_SPL_ENV_SUPPORT
3679 Support for the environment operating in SPL binary
3680
3681 CONFIG_SPL_NET_SUPPORT
3682 Support for the net/libnet.o in SPL binary.
3683 It conflicts with SPL env from storage medium specified by
3684 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3685
Scott Wood74752ba2012-12-06 13:33:16 +00003686 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003687 Image offset to which the SPL should be padded before appending
3688 the SPL payload. By default, this is defined as
3689 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3690 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3691 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003692
Scott Woodca2fca22012-09-21 16:27:32 -05003693 CONFIG_SPL_TARGET
3694 Final target image containing SPL and payload. Some SPLs
3695 use an arch-specific makefile fragment instead, for
3696 example if more than one image needs to be produced.
3697
Simon Glass87ebee32013-05-08 08:05:59 +00003698 CONFIG_FIT_SPL_PRINT
3699 Printing information about a FIT image adds quite a bit of
3700 code to SPL. So this is normally disabled in SPL. Use this
3701 option to re-enable it. This will affect the output of the
3702 bootm command when booting a FIT image.
3703
Ying Zhang3aa29de2013-08-16 15:16:15 +08003704- TPL framework
3705 CONFIG_TPL
3706 Enable building of TPL globally.
3707
3708 CONFIG_TPL_PAD_TO
3709 Image offset to which the TPL should be padded before appending
3710 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003711 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3712 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3713 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003714
wdenkc6097192002-11-03 00:24:07 +00003715Modem Support:
3716--------------
3717
Wolfgang Denk566e5cf2011-05-01 20:44:23 +02003718[so far only for SMDK2400 boards]
wdenkc6097192002-11-03 00:24:07 +00003719
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003720- Modem support enable:
wdenkc6097192002-11-03 00:24:07 +00003721 CONFIG_MODEM_SUPPORT
3722
3723- RTS/CTS Flow control enable:
3724 CONFIG_HWFLOW
3725
wdenka8c7c702003-12-06 19:49:23 +00003726- Interrupt support (PPC):
3727
wdenkd4ca31c2004-01-02 14:00:00 +00003728 There are common interrupt_init() and timer_interrupt()
3729 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003730 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003731 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003732 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003733 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003734 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003735 specific handling. If board has watchdog / status_led
3736 / other_activity_monitor it works automatically from
3737 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003738
wdenkc6097192002-11-03 00:24:07 +00003739- General:
3740
wdenk43d96162003-03-06 00:02:04 +00003741 In the target system modem support is enabled when a
3742 specific key (key combination) is pressed during
3743 power-on. Otherwise U-Boot will boot normally
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003744 (autoboot). The key_pressed() function is called from
wdenk43d96162003-03-06 00:02:04 +00003745 board_init(). Currently key_pressed() is a dummy
3746 function, returning 1 and thus enabling modem
3747 initialization.
wdenkc6097192002-11-03 00:24:07 +00003748
wdenk43d96162003-03-06 00:02:04 +00003749 If there are no modem init strings in the
3750 environment, U-Boot proceed to autoboot; the
3751 previous output (banner, info printfs) will be
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003752 suppressed, though.
wdenkc6097192002-11-03 00:24:07 +00003753
3754 See also: doc/README.Modem
3755
Helmut Raiger9660e442011-10-20 04:19:47 +00003756Board initialization settings:
3757------------------------------
3758
3759During Initialization u-boot calls a number of board specific functions
3760to allow the preparation of board specific prerequisites, e.g. pin setup
3761before drivers are initialized. To enable these callbacks the
3762following configuration macros have to be defined. Currently this is
3763architecture specific, so please check arch/your_architecture/lib/board.c
3764typically in board_init_f() and board_init_r().
3765
3766- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3767- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3768- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3769- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003770
wdenkc6097192002-11-03 00:24:07 +00003771Configuration Settings:
3772-----------------------
3773
York Sun4d1fd7f2014-02-26 17:03:19 -08003774- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3775 Optionally it can be defined to support 64-bit memory commands.
3776
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003777- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003778 undefine this when you're short of memory.
3779
Peter Tyser2fb26042009-01-27 18:03:12 -06003780- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3781 width of the commands listed in the 'help' command output.
3782
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003783- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003784 prompt for user input.
3785
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003786- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003787
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003788- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003789
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003790- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003791
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003792- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003793 the application (usually a Linux kernel) when it is
3794 booted
3795
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003796- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003797 List of legal baudrate settings for this board.
3798
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003799- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003800 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003801
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003802- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003803 If the board specific function
3804 extern int overwrite_console (void);
3805 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003806 serial port, else the settings in the environment are used.
3807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003808- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003809 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003811- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003812 Enable overwrite of previous console environment settings.
3813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003814- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003815 Begin and End addresses of the area used by the
3816 simple memory test.
3817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003818- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003819 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003820
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003821- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003822 Scratch address used by the alternate memory test
3823 You only need to set this if address zero isn't writeable
3824
York Sune8149522015-12-04 11:57:07 -08003825- CONFIG_SYS_MEM_RESERVE_SECURE
3826 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3827 is substracted from total RAM and won't be reported to OS.
3828 This memory can be used as secure memory. A variable
3829 gd->secure_ram is used to track the location. In systems
3830 the RAM base is not zero, or RAM is divided into banks,
3831 this variable needs to be recalcuated to get the address.
3832
York Sunaabd7dd2015-12-07 11:05:29 -08003833- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003834 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003835 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003836 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003837 fixing up gd->ram_size the Linux kernel should gets passed
3838 the now "corrected" memory size and won't touch it either.
3839 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003840 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003841 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003842 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003843
3844 This option can be used as a workaround for the 440EPx/GRx
3845 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3846 be touched.
3847
3848 WARNING: Please make sure that this value is a multiple of
3849 the Linux page size (normally 4k). If this is not the case,
3850 then the end address of the Linux memory will be located at a
3851 non page size aligned address and this could cause major
3852 problems.
3853
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003854- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003855 Enable temporary baudrate change while serial download
3856
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003857- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003858 Physical start address of SDRAM. _Must_ be 0 here.
3859
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003860- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003861 Physical start address of Motherboard I/O (if using a
3862 Cogent motherboard)
3863
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003864- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003865 Physical start address of Flash memory.
3866
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003867- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003868 Physical start address of boot monitor code (set by
3869 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003870 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003871 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003872
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003873- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003874 Size of memory reserved for monitor code, used to
3875 determine _at_compile_time_ (!) if the environment is
3876 embedded within the U-Boot image, or in a separate
3877 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003878
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003879- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003880 Size of DRAM reserved for malloc() use.
3881
Simon Glassd59476b2014-07-10 22:23:28 -06003882- CONFIG_SYS_MALLOC_F_LEN
3883 Size of the malloc() pool for use before relocation. If
3884 this is defined, then a very simple malloc() implementation
3885 will become available before relocation. The address is just
3886 below the global data, and the stack is moved down to make
3887 space.
3888
3889 This feature allocates regions with increasing addresses
3890 within the region. calloc() is supported, but realloc()
3891 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003892 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003893 U-Boot relocates itself.
3894
Simon Glasse7b14e92014-09-15 06:33:18 -06003895 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06003896 at present but is fairly easy to enable for other archs.
3897
Simon Glass38687ae2014-11-10 17:16:54 -07003898- CONFIG_SYS_MALLOC_SIMPLE
3899 Provides a simple and small malloc() and calloc() for those
3900 boards which do not use the full malloc in SPL (which is
3901 enabled with CONFIG_SYS_SPL_MALLOC_START).
3902
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003903- CONFIG_SYS_NONCACHED_MEMORY:
3904 Size of non-cached memory area. This area of memory will be
3905 typically located right below the malloc() area and mapped
3906 uncached in the MMU. This is useful for drivers that would
3907 otherwise require a lot of explicit cache maintenance. For
3908 some drivers it's also impossible to properly maintain the
3909 cache. For example if the regions that need to be flushed
3910 are not a multiple of the cache-line size, *and* padding
3911 cannot be allocated between the regions to align them (i.e.
3912 if the HW requires a contiguous array of regions, and the
3913 size of each region is not cache-aligned), then a flush of
3914 one region may result in overwriting data that hardware has
3915 written to another region in the same cache-line. This can
3916 happen for example in network drivers where descriptors for
3917 buffers are typically smaller than the CPU cache-line (e.g.
3918 16 bytes vs. 32 or 64 bytes).
3919
3920 Non-cached memory is only supported on 32-bit ARM at present.
3921
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003922- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003923 Normally compressed uImages are limited to an
3924 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003925 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003926 to adjust this setting to your needs.
3927
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003928- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003929 Maximum size of memory mapped by the startup code of
3930 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003931 the Linux kernel (bd_info, boot arguments, FDT blob if
3932 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003933 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003934 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003935 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003936 variable "bootm_mapsize" will override the value of
3937 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3938 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003939
John Rigbyfca43cc2010-10-13 13:57:35 -06003940- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3941 Enable initrd_high functionality. If defined then the
3942 initrd_high feature is enabled and the bootm ramdisk subcommand
3943 is enabled.
3944
3945- CONFIG_SYS_BOOT_GET_CMDLINE:
3946 Enables allocating and saving kernel cmdline in space between
3947 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3948
3949- CONFIG_SYS_BOOT_GET_KBD:
3950 Enables allocating and saving a kernel copy of the bd_info in
3951 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3952
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003953- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003954 Max number of Flash memory banks
3955
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003956- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003957 Max number of sectors on a Flash chip
3958
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003959- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003960 Timeout for Flash erase operations (in ms)
3961
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003962- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003963 Timeout for Flash write operations (in ms)
3964
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003965- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003966 Timeout for Flash set sector lock bit operation (in ms)
3967
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003968- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003969 Timeout for Flash clear lock bits operation (in ms)
3970
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003971- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003972 If defined, hardware flash sectors protection is used
3973 instead of U-Boot software protection.
3974
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003975- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003976
3977 Enable TFTP transfers directly to flash memory;
3978 without this option such a download has to be
3979 performed in two steps: (1) download to RAM, and (2)
3980 copy from RAM to flash.
3981
3982 The two-step approach is usually more reliable, since
3983 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003984 the flash, but in some situations (when system RAM is
3985 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003986 downloaded image) this option may be very useful.
3987
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003988- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003989 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003990 common flash structure for storing flash geometry.
3991
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003992- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003993 This option also enables the building of the cfi_flash driver
3994 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003995
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003996- CONFIG_FLASH_CFI_MTD
3997 This option enables the building of the cfi_mtd driver
3998 in the drivers directory. The driver exports CFI flash
3999 to the MTD layer.
4000
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004001- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02004002 Use buffered writes to flash.
4003
4004- CONFIG_FLASH_SPANSION_S29WS_N
4005 s29ws-n MirrorBit flash has non-standard addresses for buffered
4006 write commands.
4007
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004008- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01004009 If this option is defined, the common CFI flash doesn't
4010 print it's warning upon not recognized FLASH banks. This
4011 is useful, if some of the configured banks are only
4012 optionally available.
4013
Jerry Van Baren9a042e92008-03-08 13:48:01 -05004014- CONFIG_FLASH_SHOW_PROGRESS
4015 If defined (must be an integer), print out countdown
4016 digits and dots. Recommended value: 45 (9..1) for 80
4017 column displays, 15 (3..1) for 40 column displays.
4018
Stefan Roese352ef3f2013-04-04 15:53:14 +02004019- CONFIG_FLASH_VERIFY
4020 If defined, the content of the flash (destination) is compared
4021 against the source after the write operation. An error message
4022 will be printed when the contents are not identical.
4023 Please note that this option is useless in nearly all cases,
4024 since such flash programming errors usually are detected earlier
4025 while unprotecting/erasing/programming. Please only enable
4026 this option if you really know what you are doing.
4027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004028- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004029 Defines the number of Ethernet receive buffers. On some
4030 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00004031 to 8 or even higher (EEPRO100 or 405 EMAC), since all
4032 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004033 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00004034 Defaults to 4 if not defined.
4035
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004036- CONFIG_ENV_MAX_ENTRIES
4037
Wolfgang Denk071bc922010-10-27 22:48:30 +02004038 Maximum number of entries in the hash table that is used
4039 internally to store the environment settings. The default
4040 setting is supposed to be generous and should work in most
4041 cases. This setting can be used to tune behaviour; see
4042 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02004043
Joe Hershberger25980902012-12-11 22:16:31 -06004044- CONFIG_ENV_FLAGS_LIST_DEFAULT
4045- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04004046 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06004047 calling env set. Variables can be restricted to only decimal,
4048 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
4049 the variables can also be restricted to IP address or MAC address.
4050
4051 The format of the list is:
4052 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004053 access_attribute = [a|r|o|c]
4054 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004055 entry = variable_name[:attributes]
4056 list = entry[,list]
4057
4058 The type attributes are:
4059 s - String (default)
4060 d - Decimal
4061 x - Hexadecimal
4062 b - Boolean ([1yYtT|0nNfF])
4063 i - IP address
4064 m - MAC address
4065
Joe Hershberger267541f2012-12-11 22:16:34 -06004066 The access attributes are:
4067 a - Any (default)
4068 r - Read-only
4069 o - Write-once
4070 c - Change-default
4071
Joe Hershberger25980902012-12-11 22:16:31 -06004072 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4073 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004074 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004075
4076 - CONFIG_ENV_FLAGS_LIST_STATIC
4077 Define this to a list (string) to define validation that
4078 should be done if an entry is not found in the ".flags"
4079 environment variable. To override a setting in the static
4080 list, simply add an entry for the same variable name to the
4081 ".flags" variable.
4082
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004083 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4084 regular expression. This allows multiple variables to define the same
4085 flags without explicitly listing them for each variable.
4086
Joe Hershberger267541f2012-12-11 22:16:34 -06004087- CONFIG_ENV_ACCESS_IGNORE_FORCE
4088 If defined, don't allow the -f switch to env set override variable
4089 access flags.
4090
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004091- CONFIG_SYS_GENERIC_BOARD
4092 This selects the architecture-generic board system instead of the
4093 architecture-specific board files. It is intended to move boards
4094 to this new framework over time. Defining this will disable the
4095 arch/foo/lib/board.c file and use common/board_f.c and
4096 common/board_r.c instead. To use this option your architecture
Masahiro Yamada0a12e682015-03-19 19:42:51 +09004097 must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
4098 If you find problems enabling this option on your board please report
4099 the problem and send patches!
Simon Glass5c1a7ea2013-03-08 13:45:27 +00004100
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004101- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4102 This is set by OMAP boards for the max time that reset should
4103 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004104 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004105
Gabe Black0d296cc2014-10-15 04:38:30 -06004106- CONFIG_USE_STDINT
4107 If stdint.h is available with your toolchain you can define this
4108 option to enable it. You can provide option 'USE_STDINT=1' when
4109 building U-Boot to enable this.
4110
wdenkc6097192002-11-03 00:24:07 +00004111The following definitions that deal with the placement and management
4112of environment data (variable area); in general, we support the
4113following configurations:
4114
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004115- CONFIG_BUILD_ENVCRC:
4116
4117 Builds up envcrc with the target environment so that external utils
4118 may easily extract it and embed it in final U-Boot images.
4119
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004120- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004121
4122 Define this if the environment is in flash memory.
4123
4124 a) The environment occupies one whole flash sector, which is
4125 "embedded" in the text segment with the U-Boot code. This
4126 happens usually with "bottom boot sector" or "top boot
4127 sector" type flash chips, which have several smaller
4128 sectors at the start or the end. For instance, such a
4129 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4130 such a case you would place the environment in one of the
4131 4 kB sectors - with U-Boot code before and after it. With
4132 "top boot sector" type flash chips, you would put the
4133 environment in one of the last sectors, leaving a gap
4134 between U-Boot and the environment.
4135
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004136 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004137
4138 Offset of environment data (variable area) to the
4139 beginning of flash memory; for instance, with bottom boot
4140 type flash chips the second sector can be used: the offset
4141 for this sector is given here.
4142
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004143 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004144
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004145 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004146
4147 This is just another way to specify the start address of
4148 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004149 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004150
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004151 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004152
4153 Size of the sector containing the environment.
4154
4155
4156 b) Sometimes flash chips have few, equal sized, BIG sectors.
4157 In such a case you don't want to spend a whole sector for
4158 the environment.
4159
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004160 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004161
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004162 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004163 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004164 of this flash sector for the environment. This saves
4165 memory for the RAM copy of the environment.
4166
4167 It may also save flash memory if you decide to use this
4168 when your environment is "embedded" within U-Boot code,
4169 since then the remainder of the flash sector could be used
4170 for U-Boot code. It should be pointed out that this is
4171 STRONGLY DISCOURAGED from a robustness point of view:
4172 updating the environment in flash makes it always
4173 necessary to erase the WHOLE sector. If something goes
4174 wrong before the contents has been restored from a copy in
4175 RAM, your target system will be dead.
4176
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004177 - CONFIG_ENV_ADDR_REDUND
4178 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004179
wdenk43d96162003-03-06 00:02:04 +00004180 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004181 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004182 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004183 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004184
4185BE CAREFUL! Any changes to the flash layout, and some changes to the
4186source code will make it necessary to adapt <board>/u-boot.lds*
4187accordingly!
4188
4189
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004190- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004191
4192 Define this if you have some non-volatile memory device
4193 (NVRAM, battery buffered SRAM) which you want to use for the
4194 environment.
4195
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004196 - CONFIG_ENV_ADDR:
4197 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004198
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004199 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004200 want to use for environment. It is assumed that this memory
4201 can just be read and written to, without any special
4202 provision.
4203
4204BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004205in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004206console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004207U-Boot will hang.
4208
4209Please note that even with NVRAM we still use a copy of the
4210environment in RAM: we could work on NVRAM directly, but we want to
4211keep settings there always unmodified except somebody uses "saveenv"
4212to save the current settings.
4213
4214
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004215- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004216
4217 Use this if you have an EEPROM or similar serial access
4218 device and a driver for it.
4219
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004220 - CONFIG_ENV_OFFSET:
4221 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004222
4223 These two #defines specify the offset and size of the
4224 environment area within the total memory of your EEPROM.
4225
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004226 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004227 If defined, specified the chip address of the EEPROM device.
4228 The default address is zero.
4229
Christian Gmeiner189d2572015-02-11 15:19:31 +01004230 - CONFIG_SYS_I2C_EEPROM_BUS:
4231 If defined, specified the i2c bus of the EEPROM device.
4232
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004233 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004234 If defined, the number of bits used to address bytes in a
4235 single page in the EEPROM device. A 64 byte page, for example
4236 would require six bits.
4237
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004238 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004239 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004240 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004241
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004242 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004243 The length in bytes of the EEPROM memory array address. Note
4244 that this is NOT the chip address length!
4245
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004246 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004247 EEPROM chips that implement "address overflow" are ones
4248 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4249 address and the extra bits end up in the "chip address" bit
4250 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4251 byte chips.
4252
4253 Note that we consider the length of the address field to
4254 still be one byte because the extra address bits are hidden
4255 in the chip address.
4256
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004257 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004258 The size in bytes of the EEPROM device.
4259
Heiko Schocher548738b2010-01-07 08:55:40 +01004260 - CONFIG_ENV_EEPROM_IS_ON_I2C
4261 define this, if you have I2C and SPI activated, and your
4262 EEPROM, which holds the environment, is on the I2C bus.
4263
4264 - CONFIG_I2C_ENV_EEPROM_BUS
4265 if you have an Environment on an EEPROM reached over
4266 I2C muxes, you can define here, how to reach this
4267 EEPROM. For example:
4268
Heiko Schocherea818db2013-01-29 08:53:15 +01004269 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004270
4271 EEPROM which holds the environment, is reached over
4272 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004273
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004274- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004275
wdenkd4ca31c2004-01-02 14:00:00 +00004276 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004277 want to use for the environment.
4278
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004279 - CONFIG_ENV_OFFSET:
4280 - CONFIG_ENV_ADDR:
4281 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004282
4283 These three #defines specify the offset and size of the
4284 environment area within the total memory of your DataFlash placed
4285 at the specified address.
4286
Wu, Joshbd83b592014-07-01 19:30:13 +08004287- CONFIG_ENV_IS_IN_SPI_FLASH:
4288
4289 Define this if you have a SPI Flash memory device which you
4290 want to use for the environment.
4291
4292 - CONFIG_ENV_OFFSET:
4293 - CONFIG_ENV_SIZE:
4294
4295 These two #defines specify the offset and size of the
4296 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4297 aligned to an erase sector boundary.
4298
4299 - CONFIG_ENV_SECT_SIZE:
4300
4301 Define the SPI flash's sector size.
4302
4303 - CONFIG_ENV_OFFSET_REDUND (optional):
4304
4305 This setting describes a second storage area of CONFIG_ENV_SIZE
4306 size used to hold a redundant copy of the environment data, so
4307 that there is a valid backup copy in case there is a power failure
4308 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4309 aligned to an erase sector boundary.
4310
4311 - CONFIG_ENV_SPI_BUS (optional):
4312 - CONFIG_ENV_SPI_CS (optional):
4313
4314 Define the SPI bus and chip select. If not defined they will be 0.
4315
4316 - CONFIG_ENV_SPI_MAX_HZ (optional):
4317
4318 Define the SPI max work clock. If not defined then use 1MHz.
4319
4320 - CONFIG_ENV_SPI_MODE (optional):
4321
4322 Define the SPI work mode. If not defined then use SPI_MODE_3.
4323
Liu Gang0a85a9e2012-03-08 00:33:20 +00004324- CONFIG_ENV_IS_IN_REMOTE:
4325
4326 Define this if you have a remote memory space which you
4327 want to use for the local device's environment.
4328
4329 - CONFIG_ENV_ADDR:
4330 - CONFIG_ENV_SIZE:
4331
4332 These two #defines specify the address and size of the
4333 environment area within the remote memory space. The
4334 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004335 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004336
4337BE CAREFUL! For some special cases, the local device can not use
4338"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004339environment stored in a remote NOR flash by SRIO or PCIE link,
4340but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004341
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004342- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004343
4344 Define this if you have a NAND device which you want to use
4345 for the environment.
4346
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004347 - CONFIG_ENV_OFFSET:
4348 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004349
4350 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004351 area within the first NAND device. CONFIG_ENV_OFFSET must be
4352 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004353
Scott Woodfdd813d2010-09-17 14:38:37 -05004354 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004355
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004356 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004357 size used to hold a redundant copy of the environment data, so
4358 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004359 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004360 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004361
Scott Woodfdd813d2010-09-17 14:38:37 -05004362 - CONFIG_ENV_RANGE (optional):
4363
4364 Specifies the length of the region in which the environment
4365 can be written. This should be a multiple of the NAND device's
4366 block size. Specifying a range with more erase blocks than
4367 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4368 the range to be avoided.
4369
4370 - CONFIG_ENV_OFFSET_OOB (optional):
4371
4372 Enables support for dynamically retrieving the offset of the
4373 environment from block zero's out-of-band data. The
4374 "nand env.oob" command can be used to record this offset.
4375 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4376 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004377
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004378- CONFIG_NAND_ENV_DST
4379
4380 Defines address in RAM to which the nand_spl code should copy the
4381 environment. If redundant environment is used, it will be copied to
4382 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4383
Joe Hershberger2b744332013-04-08 10:32:51 +00004384- CONFIG_ENV_IS_IN_UBI:
4385
4386 Define this if you have an UBI volume that you want to use for the
4387 environment. This has the benefit of wear-leveling the environment
4388 accesses, which is important on NAND.
4389
4390 - CONFIG_ENV_UBI_PART:
4391
4392 Define this to a string that is the mtd partition containing the UBI.
4393
4394 - CONFIG_ENV_UBI_VOLUME:
4395
4396 Define this to the name of the volume that you want to store the
4397 environment in.
4398
Joe Hershberger785881f2013-04-08 10:32:52 +00004399 - CONFIG_ENV_UBI_VOLUME_REDUND:
4400
4401 Define this to the name of another volume to store a second copy of
4402 the environment in. This will enable redundant environments in UBI.
4403 It is assumed that both volumes are in the same MTD partition.
4404
Joe Hershberger2b744332013-04-08 10:32:51 +00004405 - CONFIG_UBI_SILENCE_MSG
4406 - CONFIG_UBIFS_SILENCE_MSG
4407
4408 You will probably want to define these to avoid a really noisy system
4409 when storing the env in UBI.
4410
Wu, Joshd1db76f2014-06-24 17:31:03 +08004411- CONFIG_ENV_IS_IN_FAT:
4412 Define this if you want to use the FAT file system for the environment.
4413
4414 - FAT_ENV_INTERFACE:
4415
4416 Define this to a string that is the name of the block device.
4417
4418 - FAT_ENV_DEV_AND_PART:
4419
4420 Define this to a string to specify the partition of the device. It can
4421 be as following:
4422
4423 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4424 - "D:P": device D partition P. Error occurs if device D has no
4425 partition table.
4426 - "D:0": device D.
4427 - "D" or "D:": device D partition 1 if device D has partition
4428 table, or the whole device D if has no partition
4429 table.
4430 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004431 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004432 partition table then means device D.
4433
4434 - FAT_ENV_FILE:
4435
4436 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004437 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004438
4439 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004440 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004441
Stephen Warren06e4ae52013-06-11 15:14:00 -06004442- CONFIG_ENV_IS_IN_MMC:
4443
4444 Define this if you have an MMC device which you want to use for the
4445 environment.
4446
4447 - CONFIG_SYS_MMC_ENV_DEV:
4448
4449 Specifies which MMC device the environment is stored in.
4450
4451 - CONFIG_SYS_MMC_ENV_PART (optional):
4452
4453 Specifies which MMC partition the environment is stored in. If not
4454 set, defaults to partition 0, the user area. Common values might be
4455 1 (first MMC boot partition), 2 (second MMC boot partition).
4456
4457 - CONFIG_ENV_OFFSET:
4458 - CONFIG_ENV_SIZE:
4459
4460 These two #defines specify the offset and size of the environment
4461 area within the specified MMC device.
4462
Stephen Warren5c088ee2013-06-11 15:14:02 -06004463 If offset is positive (the usual case), it is treated as relative to
4464 the start of the MMC partition. If offset is negative, it is treated
4465 as relative to the end of the MMC partition. This can be useful if
4466 your board may be fitted with different MMC devices, which have
4467 different sizes for the MMC partitions, and you always want the
4468 environment placed at the very end of the partition, to leave the
4469 maximum possible space before it, to store other data.
4470
Stephen Warren06e4ae52013-06-11 15:14:00 -06004471 These two values are in units of bytes, but must be aligned to an
4472 MMC sector boundary.
4473
4474 - CONFIG_ENV_OFFSET_REDUND (optional):
4475
4476 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4477 hold a redundant copy of the environment data. This provides a
4478 valid backup copy in case the other copy is corrupted, e.g. due
4479 to a power failure during a "saveenv" operation.
4480
Stephen Warren5c088ee2013-06-11 15:14:02 -06004481 This value may also be positive or negative; this is handled in the
4482 same way as CONFIG_ENV_OFFSET.
4483
Stephen Warren06e4ae52013-06-11 15:14:00 -06004484 This value is also in units of bytes, but must also be aligned to
4485 an MMC sector boundary.
4486
4487 - CONFIG_ENV_SIZE_REDUND (optional):
4488
4489 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4490 set. If this value is set, it must be set to the same value as
4491 CONFIG_ENV_SIZE.
4492
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004493- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004494
4495 Defines offset to the initial SPI buffer area in DPRAM. The
4496 area is used at an early stage (ROM part) if the environment
4497 is configured to reside in the SPI EEPROM: We need a 520 byte
4498 scratch DPRAM area. It is used between the two initialization
4499 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4500 to be a good choice since it makes it far enough from the
4501 start of the data area as well as from the stack pointer.
4502
Bruce Adlere881cb52007-11-02 13:15:42 -07004503Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004504has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004505created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004506until then to read environment variables.
4507
wdenk85ec0bc2003-03-31 16:34:49 +00004508The environment is protected by a CRC32 checksum. Before the monitor
4509is relocated into RAM, as a result of a bad CRC you will be working
4510with the compiled-in default environment - *silently*!!! [This is
4511necessary, because the first environment variable we need is the
4512"baudrate" setting for the console - if we have a bad CRC, we don't
4513have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004514
4515Note: once the monitor has been relocated, then it will complain if
4516the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004517use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004518
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004519- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004520 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004521
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004522 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004523 also needs to be defined.
4524
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004525- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004526 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004527
Ron Madridf5675aa2009-02-18 14:30:44 -08004528- CONFIG_NS16550_MIN_FUNCTIONS:
4529 Define this if you desire to only have use of the NS16550_init
4530 and NS16550_putc functions for the serial driver located at
4531 drivers/serial/ns16550.c. This option is useful for saving
4532 space for already greatly restricted images, including but not
4533 limited to NAND_SPL configurations.
4534
Simon Glassb2b92f52012-11-30 13:01:18 +00004535- CONFIG_DISPLAY_BOARDINFO
4536 Display information about the board that U-Boot is running on
4537 when U-Boot starts up. The board function checkboard() is called
4538 to do this.
4539
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004540- CONFIG_DISPLAY_BOARDINFO_LATE
4541 Similar to the previous option, but display this information
4542 later, once stdio is running and output goes to the LCD, if
4543 present.
4544
Sascha Silbefeb85802013-08-11 16:40:43 +02004545- CONFIG_BOARD_SIZE_LIMIT:
4546 Maximum size of the U-Boot image. When defined, the
4547 build system checks that the actual size does not
4548 exceed it.
4549
wdenkc6097192002-11-03 00:24:07 +00004550Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004551---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004553- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004554 Cache Line Size of the CPU.
4555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004556- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004557 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004558
wdenk42d1f032003-10-15 23:53:47 +00004559 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4560 and RPXsuper) to be able to adjust the position of
4561 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004562
Timur Tabie46fedf2011-08-04 18:03:41 -05004563- CONFIG_SYS_CCSRBAR_DEFAULT:
4564 Default (power-on reset) physical address of CCSR on Freescale
4565 PowerPC SOCs.
4566
4567- CONFIG_SYS_CCSRBAR:
4568 Virtual address of CCSR. On a 32-bit build, this is typically
4569 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4570
4571 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4572 for cross-platform code that uses that macro instead.
4573
4574- CONFIG_SYS_CCSRBAR_PHYS:
4575 Physical address of CCSR. CCSR can be relocated to a new
4576 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004577 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004578 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4579 is typically relocated on 36-bit builds. It is recommended
4580 that this macro be defined via the _HIGH and _LOW macros:
4581
4582 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4583 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4584
4585- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004586 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4587 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004588 used in assembly code, so it must not contain typecasts or
4589 integer size suffixes (e.g. "ULL").
4590
4591- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4592 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4593 used in assembly code, so it must not contain typecasts or
4594 integer size suffixes (e.g. "ULL").
4595
4596- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4597 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4598 forced to a value that ensures that CCSR is not relocated.
4599
wdenk7f6c2cb2002-11-10 22:06:23 +00004600- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004601 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004602
4603 the default drive number (default value 0)
4604
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004605 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004606
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004607 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004608 (default value 1)
4609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004610 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004611
wdenk43d96162003-03-06 00:02:04 +00004612 defines the offset of register from address. It
4613 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004614 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004616 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4617 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004618 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004619
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004620 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004621 fdc_hw_init() is called at the beginning of the FDC
4622 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004623 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004624 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004625
Macpaul Lin0abddf82011-04-11 20:45:32 +00004626- CONFIG_IDE_AHB:
4627 Most IDE controllers were designed to be connected with PCI
4628 interface. Only few of them were designed for AHB interface.
4629 When software is doing ATA command and data transfer to
4630 IDE devices through IDE-AHB controller, some additional
4631 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004632 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004633
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004634- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004635 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004636 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004637
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004638- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004639
wdenk7152b1d2003-09-05 23:19:14 +00004640 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004641 initial data and stack; please note that this must be
4642 writable memory that is working WITHOUT special
4643 initialization, i. e. you CANNOT use normal RAM which
4644 will become available only after programming the
4645 memory controller and running certain initialization
4646 sequences.
4647
4648 U-Boot uses the following memory types:
4649 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4650 - MPC824X: data cache
4651 - PPC4xx: data cache
4652
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004653- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004654
4655 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004656 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4657 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004658 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004659 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004660 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4661 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4662 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004663
4664 Note:
4665 On the MPC824X (or other systems that use the data
4666 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004667 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004668 point to an otherwise UNUSED address space between
4669 the top of RAM and the start of the PCI space.
4670
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004671- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004672
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004673- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004674
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004675- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004676
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004677- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004678
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004679- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004680
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004681- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004682
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004683- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004684 SDRAM timing
4685
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004686- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004687 periodic timer for refresh
4688
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004689- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004690
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004691- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4692 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4693 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4694 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004695 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4696
4697- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004698 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4699 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004700 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4701
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004702- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4703 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004704 Machine Mode Register and Memory Periodic Timer
4705 Prescaler definitions (SDRAM timing)
4706
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004707- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004708 enable I2C microcode relocation patch (MPC8xx);
4709 define relocation offset in DPRAM [DSP2]
4710
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004711- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004712 enable SMC microcode relocation patch (MPC8xx);
4713 define relocation offset in DPRAM [SMC1]
4714
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004715- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004716 enable SPI microcode relocation patch (MPC8xx);
4717 define relocation offset in DPRAM [SCC4]
4718
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004719- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004720 Use OSCM clock mode on MBX8xx board. Be careful,
4721 wrong setting might damage your board. Read
4722 doc/README.MBX before setting this variable!
4723
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004724- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004725 Offset of the bootmode word in DPRAM used by post
4726 (Power On Self Tests). This definition overrides
4727 #define'd default value in commproc.h resp.
4728 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004729
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004730- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4731 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4732 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4733 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4734 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4735 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4736 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4737 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004738 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004739
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004740- CONFIG_PCI_DISABLE_PCIE:
4741 Disable PCI-Express on systems where it is supported but not
4742 required.
4743
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004744- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004745 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004746 Don't do any setup work, presumably because someone or
4747 something has already done it, and we don't need to do it
4748 a second time. Useful for platforms that are pre-booted
4749 by coreboot or similar.
4750
Gabor Juhos842033e2013-05-30 07:06:12 +00004751- CONFIG_PCI_INDIRECT_BRIDGE:
4752 Enable support for indirect PCI bridges.
4753
Kumar Galaa09b9b62010-12-30 12:09:53 -06004754- CONFIG_SYS_SRIO:
4755 Chip has SRIO or not
4756
4757- CONFIG_SRIO1:
4758 Board has SRIO 1 port available
4759
4760- CONFIG_SRIO2:
4761 Board has SRIO 2 port available
4762
Liu Gangc8b28152013-05-07 16:30:46 +08004763- CONFIG_SRIO_PCIE_BOOT_MASTER
4764 Board can support master function for Boot from SRIO and PCIE
4765
Kumar Galaa09b9b62010-12-30 12:09:53 -06004766- CONFIG_SYS_SRIOn_MEM_VIRT:
4767 Virtual Address of SRIO port 'n' memory region
4768
4769- CONFIG_SYS_SRIOn_MEM_PHYS:
4770 Physical Address of SRIO port 'n' memory region
4771
4772- CONFIG_SYS_SRIOn_MEM_SIZE:
4773 Size of SRIO port 'n' memory region
4774
Fabio Estevam66bd1842013-04-11 09:35:34 +00004775- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4776 Defined to tell the NAND controller that the NAND chip is using
4777 a 16 bit bus.
4778 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004779 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004780 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004781 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004782
4783- CONFIG_SYS_NDFC_EBC0_CFG
4784 Sets the EBC0_CFG register for the NDFC. If not defined
4785 a default value will be used.
4786
Ben Warrenbb99ad62006-09-07 16:50:54 -04004787- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004788 Get DDR timing information from an I2C EEPROM. Common
4789 with pluggable memory modules such as SODIMMs
4790
Ben Warrenbb99ad62006-09-07 16:50:54 -04004791 SPD_EEPROM_ADDRESS
4792 I2C address of the SPD EEPROM
4793
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004794- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004795 If SPD EEPROM is on an I2C bus other than the first
4796 one, specify here. Note that the value must resolve
4797 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004798
York Sun1b3e3c42011-06-07 09:42:16 +08004799- CONFIG_SYS_DDR_RAW_TIMING
4800 Get DDR timing information from other than SPD. Common with
4801 soldered DDR chips onboard without SPD. DDR raw timing
4802 parameters are extracted from datasheet and hard-coded into
4803 header files or board specific files.
4804
York Sun6f5e1dc2011-09-16 13:21:35 -07004805- CONFIG_FSL_DDR_INTERACTIVE
4806 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4807
York Sune32d59a2015-01-06 13:18:55 -08004808- CONFIG_FSL_DDR_SYNC_REFRESH
4809 Enable sync of refresh for multiple controllers.
4810
York Sun4516ff82015-03-19 09:30:28 -07004811- CONFIG_FSL_DDR_BIST
4812 Enable built-in memory test for Freescale DDR controllers.
4813
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004814- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004815 Only for 83xx systems. If specified, then DDR should
4816 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004817
wdenkc26e4542004-04-18 10:13:26 +00004818- CONFIG_ETHER_ON_FEC[12]
4819 Define to enable FEC[12] on a 8xx series processor.
4820
4821- CONFIG_FEC[12]_PHY
4822 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004823 to the given FEC; i. e.
4824 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004825 means that the PHY with address 4 is connected to FEC1
4826
4827 When set to -1, means to probe for first available.
4828
4829- CONFIG_FEC[12]_PHY_NORXERR
4830 The PHY does not have a RXERR line (RMII only).
4831 (so program the FEC to ignore it).
4832
4833- CONFIG_RMII
4834 Enable RMII mode for all FECs.
4835 Note that this is a global option, we can't
4836 have one FEC in standard MII mode and another in RMII mode.
4837
wdenk5cf91d62004-04-23 20:32:05 +00004838- CONFIG_CRC32_VERIFY
4839 Add a verify option to the crc32 command.
4840 The syntax is:
4841
4842 => crc32 -v <address> <count> <crc32>
4843
4844 Where address/count indicate a memory area
4845 and crc32 is the correct crc32 which the
4846 area should have.
4847
wdenk56523f12004-07-11 17:40:54 +00004848- CONFIG_LOOPW
4849 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004850 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004851
stroese7b466642004-12-16 18:46:55 +00004852- CONFIG_MX_CYCLIC
4853 Add the "mdc" and "mwc" memory commands. These are cyclic
4854 "md/mw" commands.
4855 Examples:
4856
wdenkefe2a4d2004-12-16 21:44:03 +00004857 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004858 This command will print 4 bytes (10,11,12,13) each 500 ms.
4859
wdenkefe2a4d2004-12-16 21:44:03 +00004860 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004861 This command will write 12345678 to address 100 all 10 ms.
4862
wdenkefe2a4d2004-12-16 21:44:03 +00004863 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004864 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004865
wdenk8aa1a2d2005-04-04 12:44:11 +00004866- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004867 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004868 low level initializations (like setting up the memory
4869 controller) are omitted and/or U-Boot does not
4870 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004871
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004872 Normally this variable MUST NOT be defined. The only
4873 exception is when U-Boot is loaded (to RAM) by some
4874 other boot loader or by a debugger which performs
4875 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004876
Aneesh V401bb302011-07-13 05:11:07 +00004877- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004878 Modifies the behaviour of start.S when compiling a loader
4879 that is executed before the actual U-Boot. E.g. when
4880 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004881
Ying Zhang3aa29de2013-08-16 15:16:15 +08004882- CONFIG_TPL_BUILD
4883 Modifies the behaviour of start.S when compiling a loader
4884 that is executed after the SPL and before the actual U-Boot.
4885 It is loaded by the SPL.
4886
Ying Zhang5df572f2013-05-20 14:07:23 +08004887- CONFIG_SYS_MPC85XX_NO_RESETVEC
4888 Only for 85xx systems. If this variable is specified, the section
4889 .resetvec is not kept and the section .bootpg is placed in the
4890 previous 4k of the .text section.
4891
Simon Glass4213fc22013-02-24 17:33:14 +00004892- CONFIG_ARCH_MAP_SYSMEM
4893 Generally U-Boot (and in particular the md command) uses
4894 effective address. It is therefore not necessary to regard
4895 U-Boot address as virtual addresses that need to be translated
4896 to physical addresses. However, sandbox requires this, since
4897 it maintains its own little RAM buffer which contains all
4898 addressable memory. This option causes some memory accesses
4899 to be mapped through map_sysmem() / unmap_sysmem().
4900
Matthias Weisserd8834a12011-03-10 21:36:32 +00004901- CONFIG_USE_ARCH_MEMCPY
4902 CONFIG_USE_ARCH_MEMSET
4903 If these options are used a optimized version of memcpy/memset will
4904 be used if available. These functions may be faster under some
4905 conditions but may increase the binary size.
4906
Simon Glass588a13f2013-02-14 04:18:54 +00004907- CONFIG_X86_RESET_VECTOR
4908 If defined, the x86 reset vector code is included. This is not
4909 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004910
Mark Jacksonfc337052013-03-04 01:27:20 +00004911- CONFIG_SYS_MPUCLK
4912 Defines the MPU clock speed (in MHz).
4913
4914 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004915
Heiko Schocher16678eb2013-11-04 14:05:00 +01004916- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4917 Enables the RTC32K OSC on AM33xx based plattforms
4918
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004919- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4920 Option to disable subpage write in NAND driver
4921 driver that uses this:
4922 drivers/mtd/nand/davinci_nand.c
4923
Timur Tabif2717b42011-11-22 09:21:25 -06004924Freescale QE/FMAN Firmware Support:
4925-----------------------------------
4926
4927The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4928loading of "firmware", which is encoded in the QE firmware binary format.
4929This firmware often needs to be loaded during U-Boot booting, so macros
4930are used to identify the storage device (NOR flash, SPI, etc) and the address
4931within that device.
4932
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004933- CONFIG_SYS_FMAN_FW_ADDR
4934 The address in the storage device where the FMAN microcode is located. The
4935 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4936 is also specified.
4937
4938- CONFIG_SYS_QE_FW_ADDR
4939 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004940 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4941 is also specified.
4942
4943- CONFIG_SYS_QE_FMAN_FW_LENGTH
4944 The maximum possible size of the firmware. The firmware binary format
4945 has a field that specifies the actual size of the firmware, but it
4946 might not be possible to read any part of the firmware unless some
4947 local storage is allocated to hold the entire firmware first.
4948
4949- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4950 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4951 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4952 virtual address in NOR flash.
4953
4954- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4955 Specifies that QE/FMAN firmware is located in NAND flash.
4956 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4957
4958- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4959 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4960 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4961
4962- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4963 Specifies that QE/FMAN firmware is located on the primary SPI
4964 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4965
Liu Gang292dc6c2012-03-08 00:33:18 +00004966- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4967 Specifies that QE/FMAN firmware is located in the remote (master)
4968 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004969 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4970 window->master inbound window->master LAW->the ucode address in
4971 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004972
J. German Riverab940ca62014-06-23 15:15:55 -07004973Freescale Layerscape Management Complex Firmware Support:
4974---------------------------------------------------------
4975The Freescale Layerscape Management Complex (MC) supports the loading of
4976"firmware".
4977This firmware often needs to be loaded during U-Boot booting, so macros
4978are used to identify the storage device (NOR flash, SPI, etc) and the address
4979within that device.
4980
4981- CONFIG_FSL_MC_ENET
4982 Enable the MC driver for Layerscape SoCs.
4983
4984- CONFIG_SYS_LS_MC_FW_ADDR
4985 The address in the storage device where the firmware is located. The
4986 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4987 is also specified.
4988
4989- CONFIG_SYS_LS_MC_FW_LENGTH
4990 The maximum possible size of the firmware. The firmware binary format
4991 has a field that specifies the actual size of the firmware, but it
4992 might not be possible to read any part of the firmware unless some
4993 local storage is allocated to hold the entire firmware first.
4994
4995- CONFIG_SYS_LS_MC_FW_IN_NOR
4996 Specifies that MC firmware is located in NOR flash, mapped as
4997 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4998 virtual address in NOR flash.
4999
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05305000Freescale Layerscape Debug Server Support:
5001-------------------------------------------
5002The Freescale Layerscape Debug Server Support supports the loading of
5003"Debug Server firmware" and triggering SP boot-rom.
5004This firmware often needs to be loaded during U-Boot booting.
5005
5006- CONFIG_FSL_DEBUG_SERVER
5007 Enable the Debug Server for Layerscape SoCs.
5008
5009- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
5010 Define minimum DDR size required for debug server image
5011
York Sunc0492142015-12-07 11:08:58 -08005012- CONFIG_SYS_MC_RSV_MEM_ALIGN
5013 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05305014
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02005015Reproducible builds
5016-------------------
5017
5018In order to achieve reproducible builds, timestamps used in the U-Boot build
5019process have to be set to a fixed value.
5020
5021This is done using the SOURCE_DATE_EPOCH environment variable.
5022SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
5023option for U-Boot or an environment variable in U-Boot.
5024
5025SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
5026
wdenkc6097192002-11-03 00:24:07 +00005027Building the Software:
5028======================
5029
Wolfgang Denk218ca722008-03-26 10:40:12 +01005030Building U-Boot has been tested in several native build environments
5031and in many different cross environments. Of course we cannot support
5032all possibly existing versions of cross development tools in all
5033(potentially obsolete) versions. In case of tool chain problems we
5034recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
5035which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005036
Wolfgang Denk218ca722008-03-26 10:40:12 +01005037If you are not using a native environment, it is assumed that you
5038have GNU cross compiling tools available in your path. In this case,
5039you must set the environment variable CROSS_COMPILE in your shell.
5040Note that no changes to the Makefile or any other source files are
5041necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00005042
Wolfgang Denk218ca722008-03-26 10:40:12 +01005043 $ CROSS_COMPILE=ppc_4xx-
5044 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00005045
Peter Tyser2f8d3962009-03-13 18:54:51 -05005046Note: If you wish to generate Windows versions of the utilities in
5047 the tools directory you can use the MinGW toolchain
5048 (http://www.mingw.org). Set your HOST tools to the MinGW
5049 toolchain and execute 'make tools'. For example:
5050
5051 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
5052
5053 Binaries such as tools/mkimage.exe will be created which can
5054 be executed on computers running Windows.
5055
Wolfgang Denk218ca722008-03-26 10:40:12 +01005056U-Boot is intended to be simple to build. After installing the
5057sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005058is done by typing:
5059
Holger Freytherab584d62014-08-04 09:26:05 +02005060 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005061
Holger Freytherab584d62014-08-04 09:26:05 +02005062where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005063rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005064
wdenk2729af92004-05-03 20:45:30 +00005065Note: for some board special configuration names may exist; check if
5066 additional information is available from the board vendor; for
5067 instance, the TQM823L systems are available without (standard)
5068 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005069 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005070
Holger Freytherab584d62014-08-04 09:26:05 +02005071 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005072 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005073
Holger Freytherab584d62014-08-04 09:26:05 +02005074 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005075 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005076
wdenk2729af92004-05-03 20:45:30 +00005077 etc.
wdenkc6097192002-11-03 00:24:07 +00005078
wdenkc6097192002-11-03 00:24:07 +00005079
wdenk2729af92004-05-03 20:45:30 +00005080Finally, type "make all", and you should get some working U-Boot
5081images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005082
wdenk2729af92004-05-03 20:45:30 +00005083- "u-boot.bin" is a raw binary image
5084- "u-boot" is an image in ELF binary format
5085- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005086
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005087By default the build is performed locally and the objects are saved
5088in the source directory. One of the two methods can be used to change
5089this behavior and build U-Boot to some external directory:
5090
50911. Add O= to the make command line invocations:
5092
5093 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005094 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005095 make O=/tmp/build all
5096
Timo Ketolaadbba992014-11-06 14:39:05 +020050972. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005098
Timo Ketolaadbba992014-11-06 14:39:05 +02005099 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005100 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005101 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005102 make all
5103
Timo Ketolaadbba992014-11-06 14:39:05 +02005104Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005105variable.
5106
wdenkc6097192002-11-03 00:24:07 +00005107
wdenk2729af92004-05-03 20:45:30 +00005108Please be aware that the Makefiles assume you are using GNU make, so
5109for instance on NetBSD you might need to use "gmake" instead of
5110native "make".
wdenkc6097192002-11-03 00:24:07 +00005111
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113If the system board that you have is not listed, then you will need
5114to port U-Boot to your hardware platform. To do this, follow these
5115steps:
wdenkc6097192002-11-03 00:24:07 +00005116
Phil Sutter3c1496c2015-12-25 14:41:18 +010051171. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00005118 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01005119 the "Makefile" and a "<board>.c".
51202. Create a new configuration file "include/configs/<board>.h" for
5121 your board.
wdenk2729af92004-05-03 20:45:30 +000051223. If you're porting U-Boot to a new CPU, then also create a new
5123 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020051244. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000051255. Type "make", and you should get a working "u-boot.srec" file
5126 to be installed on your target system.
51276. Debug and solve any problems that might arise.
5128 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005129
wdenkc6097192002-11-03 00:24:07 +00005130
wdenk2729af92004-05-03 20:45:30 +00005131Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5132==============================================================
wdenkc6097192002-11-03 00:24:07 +00005133
Wolfgang Denk218ca722008-03-26 10:40:12 +01005134If you have modified U-Boot sources (for instance added a new board
5135or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005136provide feedback to the other developers. The feedback normally takes
5137the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005138official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005139
Wolfgang Denk218ca722008-03-26 10:40:12 +01005140But before you submit such a patch, please verify that your modifi-
5141cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005142the supported boards compile WITHOUT ANY compiler warnings. To do so,
5143just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005144for ALL supported system. Be warned, this will take a while. You can
5145select which (cross) compiler to use by passing a `CROSS_COMPILE'
5146environment variable to the script, i. e. to use the ELDK cross tools
5147you can type
wdenkc6097192002-11-03 00:24:07 +00005148
wdenk2729af92004-05-03 20:45:30 +00005149 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005150
wdenk2729af92004-05-03 20:45:30 +00005151or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005152
wdenk2729af92004-05-03 20:45:30 +00005153 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005154
Wolfgang Denk218ca722008-03-26 10:40:12 +01005155When using the MAKEALL script, the default behaviour is to build
5156U-Boot in the source directory. This location can be changed by
5157setting the BUILD_DIR environment variable. Also, for each target
5158built, the MAKEALL script saves two log files (<target>.ERR and
5159<target>.MAKEALL) in the <source dir>/LOG directory. This default
5160location can be changed by setting the MAKEALL_LOGDIR environment
5161variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005162
5163 export BUILD_DIR=/tmp/build
5164 export MAKEALL_LOGDIR=/tmp/log
5165 CROSS_COMPILE=ppc_8xx- MAKEALL
5166
Wolfgang Denk218ca722008-03-26 10:40:12 +01005167With the above settings build objects are saved in the /tmp/build,
5168log files are saved in the /tmp/log and the source tree remains clean
5169during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005170
5171
wdenk2729af92004-05-03 20:45:30 +00005172See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005173
wdenkc6097192002-11-03 00:24:07 +00005174
wdenk2729af92004-05-03 20:45:30 +00005175Monitor Commands - Overview:
5176============================
wdenkc6097192002-11-03 00:24:07 +00005177
wdenk2729af92004-05-03 20:45:30 +00005178go - start application at address 'addr'
5179run - run commands in an environment variable
5180bootm - boot application image from memory
5181bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005182bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005183tftpboot- boot image via network using TFTP protocol
5184 and env variables "ipaddr" and "serverip"
5185 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005186tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005187rarpboot- boot image via network using RARP/TFTP protocol
5188diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5189loads - load S-Record file over serial line
5190loadb - load binary file over serial line (kermit mode)
5191md - memory display
5192mm - memory modify (auto-incrementing)
5193nm - memory modify (constant address)
5194mw - memory write (fill)
5195cp - memory copy
5196cmp - memory compare
5197crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005198i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005199sspi - SPI utility commands
5200base - print or set address offset
5201printenv- print environment variables
5202setenv - set environment variables
5203saveenv - save environment variables to persistent storage
5204protect - enable or disable FLASH write protection
5205erase - erase FLASH memory
5206flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005207nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005208bdinfo - print Board Info structure
5209iminfo - print header information for application image
5210coninfo - print console devices and informations
5211ide - IDE sub-system
5212loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005213loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005214mtest - simple RAM test
5215icache - enable or disable instruction cache
5216dcache - enable or disable data cache
5217reset - Perform RESET of the CPU
5218echo - echo args to console
5219version - print monitor version
5220help - print online help
5221? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005222
wdenkc6097192002-11-03 00:24:07 +00005223
wdenk2729af92004-05-03 20:45:30 +00005224Monitor Commands - Detailed Description:
5225========================================
wdenkc6097192002-11-03 00:24:07 +00005226
wdenk2729af92004-05-03 20:45:30 +00005227TODO.
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk2729af92004-05-03 20:45:30 +00005229For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005230
5231
wdenk2729af92004-05-03 20:45:30 +00005232Environment Variables:
5233======================
wdenkc6097192002-11-03 00:24:07 +00005234
wdenk2729af92004-05-03 20:45:30 +00005235U-Boot supports user configuration using Environment Variables which
5236can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005237
wdenk2729af92004-05-03 20:45:30 +00005238Environment Variables are set using "setenv", printed using
5239"printenv", and saved to Flash using "saveenv". Using "setenv"
5240without a value can be used to delete a variable from the
5241environment. As long as you don't save the environment you are
5242working with an in-memory copy. In case the Flash area containing the
5243environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005244
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005245Some configuration options can be set using Environment Variables.
5246
5247List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005248
wdenk2729af92004-05-03 20:45:30 +00005249 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005250
wdenk2729af92004-05-03 20:45:30 +00005251 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005252
wdenk2729af92004-05-03 20:45:30 +00005253 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005254
wdenk2729af92004-05-03 20:45:30 +00005255 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005256
wdenk2729af92004-05-03 20:45:30 +00005257 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005258
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005259 bootm_low - Memory range available for image processing in the bootm
5260 command can be restricted. This variable is given as
5261 a hexadecimal number and defines lowest address allowed
5262 for use by the bootm command. See also "bootm_size"
5263 environment variable. Address defined by "bootm_low" is
5264 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005265 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5266 bootm_mapsize.
5267
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005268 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005269 This variable is given as a hexadecimal number and it
5270 defines the size of the memory region starting at base
5271 address bootm_low that is accessible by the Linux kernel
5272 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5273 as the default value if it is defined, and bootm_size is
5274 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005275
5276 bootm_size - Memory range available for image processing in the bootm
5277 command can be restricted. This variable is given as
5278 a hexadecimal number and defines the size of the region
5279 allowed for use by the bootm command. See also "bootm_low"
5280 environment variable.
5281
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005282 updatefile - Location of the software update file on a TFTP server, used
5283 by the automatic software update feature. Please refer to
5284 documentation in doc/README.update for more details.
5285
wdenk2729af92004-05-03 20:45:30 +00005286 autoload - if set to "no" (any string beginning with 'n'),
5287 "bootp" will just load perform a lookup of the
5288 configuration from the BOOTP server, but not try to
5289 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005290
wdenk2729af92004-05-03 20:45:30 +00005291 autostart - if set to "yes", an image loaded using the "bootp",
5292 "rarpboot", "tftpboot" or "diskboot" commands will
5293 be automatically started (by internally calling
5294 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005295
wdenk2729af92004-05-03 20:45:30 +00005296 If set to "no", a standalone image passed to the
5297 "bootm" command will be copied to the load address
5298 (and eventually uncompressed), but NOT be started.
5299 This can be used to load and uncompress arbitrary
5300 data.
wdenkc6097192002-11-03 00:24:07 +00005301
David A. Longa28afca2011-07-09 16:40:19 -04005302 fdt_high - if set this restricts the maximum address that the
5303 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005304 For example, if you have a system with 1 GB memory
5305 at physical address 0x10000000, while Linux kernel
5306 only recognizes the first 704 MB as low memory, you
5307 may need to set fdt_high as 0x3C000000 to have the
5308 device tree blob be copied to the maximum address
5309 of the 704 MB low memory, so that Linux kernel can
5310 access it during the boot procedure.
5311
David A. Longa28afca2011-07-09 16:40:19 -04005312 If this is set to the special value 0xFFFFFFFF then
5313 the fdt will not be copied at all on boot. For this
5314 to work it must reside in writable memory, have
5315 sufficient padding on the end of it for u-boot to
5316 add the information it needs into it, and the memory
5317 must be accessible by the kernel.
5318
Simon Glasseea63e02011-10-24 19:15:34 +00005319 fdtcontroladdr- if set this is the address of the control flattened
5320 device tree used by U-Boot when CONFIG_OF_CONTROL is
5321 defined.
5322
wdenk17ea1172004-06-06 21:51:03 +00005323 i2cfast - (PPC405GP|PPC405EP only)
5324 if set to 'y' configures Linux I2C driver for fast
5325 mode (400kHZ). This environment variable is used in
5326 initialization code. So, for changes to be effective
5327 it must be saved and board must be reset.
5328
wdenk2729af92004-05-03 20:45:30 +00005329 initrd_high - restrict positioning of initrd images:
5330 If this variable is not set, initrd images will be
5331 copied to the highest possible address in RAM; this
5332 is usually what you want since it allows for
5333 maximum initrd size. If for some reason you want to
5334 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005335 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005336 variable to a value of "no" or "off" or "0".
5337 Alternatively, you can set it to a maximum upper
5338 address to use (U-Boot will still check that it
5339 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005340
wdenk2729af92004-05-03 20:45:30 +00005341 For instance, when you have a system with 16 MB
5342 RAM, and want to reserve 4 MB from use by Linux,
5343 you can do this by adding "mem=12M" to the value of
5344 the "bootargs" variable. However, now you must make
5345 sure that the initrd image is placed in the first
5346 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005347
wdenk2729af92004-05-03 20:45:30 +00005348 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005349
wdenk2729af92004-05-03 20:45:30 +00005350 If you set initrd_high to 0xFFFFFFFF, this is an
5351 indication to U-Boot that all addresses are legal
5352 for the Linux kernel, including addresses in flash
5353 memory. In this case U-Boot will NOT COPY the
5354 ramdisk at all. This may be useful to reduce the
5355 boot time on your system, but requires that this
5356 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005357
wdenk2729af92004-05-03 20:45:30 +00005358 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005359
wdenk2729af92004-05-03 20:45:30 +00005360 loadaddr - Default load address for commands like "bootp",
5361 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005362
wdenk2729af92004-05-03 20:45:30 +00005363 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005364
wdenk2729af92004-05-03 20:45:30 +00005365 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005366
wdenk2729af92004-05-03 20:45:30 +00005367 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005368
wdenk2729af92004-05-03 20:45:30 +00005369 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005370
wdenk2729af92004-05-03 20:45:30 +00005371 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005372
Mike Frysingere2a53452011-10-02 10:01:27 +00005373 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005374
Mike Frysingere2a53452011-10-02 10:01:27 +00005375 ethact - controls which interface is currently active.
5376 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005377
Heiko Schocher48690d82010-07-20 17:45:02 +02005378 => setenv ethact FEC
5379 => ping 192.168.0.1 # traffic sent on FEC
5380 => setenv ethact SCC
5381 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005382
Matthias Fuchse1692572008-01-17 07:45:05 +01005383 ethrotate - When set to "no" U-Boot does not go through all
5384 available network interfaces.
5385 It just stays at the currently selected interface.
5386
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005387 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005388 either succeed or fail without retrying.
5389 When set to "once" the network operation will
5390 fail when all the available network interfaces
5391 are tried once without success.
5392 Useful on scripts which control the retry operation
5393 themselves.
wdenkc6097192002-11-03 00:24:07 +00005394
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005395 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005396
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005397 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005398 changing the console to be empty. If "yes" it will be
5399 made silent. If "no" it will not be made silent. If
5400 unset, then it will be made silent if the U-Boot console
5401 is silent.
5402
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005403 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005404 UDP source port.
5405
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005406 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005407 destination port instead of the Well Know Port 69.
5408
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005409 tftpblocksize - Block size to use for TFTP transfers; if not set,
5410 we use the TFTP server's default block size
5411
5412 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5413 seconds, minimum value is 1000 = 1 second). Defines
5414 when a packet is considered to be lost so it has to
5415 be retransmitted. The default is 5000 = 5 seconds.
5416 Lowering this value may make downloads succeed
5417 faster in networks with high packet loss rates or
5418 with unreliable TFTP servers.
5419
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005420 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5421 unit, minimum value = 0). Defines how many timeouts
5422 can happen during a single file transfer before that
5423 transfer is aborted. The default is 10, and 0 means
5424 'no timeouts allowed'. Increasing this value may help
5425 downloads succeed with high packet loss rates, or with
5426 unreliable TFTP servers or client hardware.
5427
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005428 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005429 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005430 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005431
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005432The following image location variables contain the location of images
5433used in booting. The "Image" column gives the role of the image and is
5434not an environment variable name. The other columns are environment
5435variable names. "File Name" gives the name of the file on a TFTP
5436server, "RAM Address" gives the location in RAM the image will be
5437loaded to, and "Flash Location" gives the image's address in NOR
5438flash or offset in NAND flash.
5439
5440*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03005441boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005442boards use these variables for other purposes.
5443
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005444Image File Name RAM Address Flash Location
5445----- --------- ----------- --------------
5446u-boot u-boot u-boot_addr_r u-boot_addr
5447Linux kernel bootfile kernel_addr_r kernel_addr
5448device tree blob fdtfile fdt_addr_r fdt_addr
5449ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005450
wdenk2729af92004-05-03 20:45:30 +00005451The following environment variables may be used and automatically
5452updated by the network boot commands ("bootp" and "rarpboot"),
5453depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005454
wdenk2729af92004-05-03 20:45:30 +00005455 bootfile - see above
5456 dnsip - IP address of your Domain Name Server
5457 dnsip2 - IP address of your secondary Domain Name Server
5458 gatewayip - IP address of the Gateway (Router) to use
5459 hostname - Target hostname
5460 ipaddr - see above
5461 netmask - Subnet Mask
5462 rootpath - Pathname of the root filesystem on the NFS server
5463 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005464
wdenka3d991b2004-04-15 21:48:45 +00005465
wdenk2729af92004-05-03 20:45:30 +00005466There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005467
wdenk2729af92004-05-03 20:45:30 +00005468 serial# - contains hardware identification information such
5469 as type string and/or serial number
5470 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005471
wdenk2729af92004-05-03 20:45:30 +00005472These variables can be set only once (usually during manufacturing of
5473the board). U-Boot refuses to delete or overwrite these variables
5474once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005475
5476
wdenk2729af92004-05-03 20:45:30 +00005477Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005478
wdenk2729af92004-05-03 20:45:30 +00005479 ver - Contains the U-Boot version string as printed
5480 with the "version" command. This variable is
5481 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005482
wdenkc6097192002-11-03 00:24:07 +00005483
wdenk2729af92004-05-03 20:45:30 +00005484Please note that changes to some configuration parameters may take
5485only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005486
stroesec1551ea2003-04-04 15:53:41 +00005487
Joe Hershberger170ab112012-12-11 22:16:24 -06005488Callback functions for environment variables:
5489---------------------------------------------
5490
5491For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005492when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005493be associated with arbitrary variables. On creation, overwrite, or
5494deletion, the callback will provide the opportunity for some side
5495effect to happen or for the change to be rejected.
5496
5497The callbacks are named and associated with a function using the
5498U_BOOT_ENV_CALLBACK macro in your board or driver code.
5499
5500These callbacks are associated with variables in one of two ways. The
5501static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5502in the board configuration to a string that defines a list of
5503associations. The list must be in the following format:
5504
5505 entry = variable_name[:callback_name]
5506 list = entry[,list]
5507
5508If the callback name is not specified, then the callback is deleted.
5509Spaces are also allowed anywhere in the list.
5510
5511Callbacks can also be associated by defining the ".callbacks" variable
5512with the same list format above. Any association in ".callbacks" will
5513override any association in the static list. You can define
5514CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005515".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005516
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05005517If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5518regular expression. This allows multiple variables to be connected to
5519the same callback without explicitly listing them all out.
5520
Joe Hershberger170ab112012-12-11 22:16:24 -06005521
wdenk2729af92004-05-03 20:45:30 +00005522Command Line Parsing:
5523=====================
stroesec1551ea2003-04-04 15:53:41 +00005524
wdenk2729af92004-05-03 20:45:30 +00005525There are two different command line parsers available with U-Boot:
5526the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005527
wdenk2729af92004-05-03 20:45:30 +00005528Old, simple command line parser:
5529--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk2729af92004-05-03 20:45:30 +00005531- supports environment variables (through setenv / saveenv commands)
5532- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005533- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005534- special characters ('$', ';') can be escaped by prefixing with '\',
5535 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005536 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005537- You can also escape text by enclosing in single apostrophes, for example:
5538 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005539
wdenk2729af92004-05-03 20:45:30 +00005540Hush shell:
5541-----------
wdenkf07771c2003-05-28 08:06:31 +00005542
wdenk2729af92004-05-03 20:45:30 +00005543- similar to Bourne shell, with control structures like
5544 if...then...else...fi, for...do...done; while...do...done,
5545 until...do...done, ...
5546- supports environment ("global") variables (through setenv / saveenv
5547 commands) and local shell variables (through standard shell syntax
5548 "name=value"); only environment variables can be used with "run"
5549 command
wdenkf07771c2003-05-28 08:06:31 +00005550
wdenk2729af92004-05-03 20:45:30 +00005551General rules:
5552--------------
wdenkf07771c2003-05-28 08:06:31 +00005553
wdenk2729af92004-05-03 20:45:30 +00005554(1) If a command line (or an environment variable executed by a "run"
5555 command) contains several commands separated by semicolon, and
5556 one of these commands fails, then the remaining commands will be
5557 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005558
wdenk2729af92004-05-03 20:45:30 +00005559(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005560 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005561 command will cause "run" to terminate, i. e. the remaining
5562 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005563
wdenk2729af92004-05-03 20:45:30 +00005564Note for Redundant Ethernet Interfaces:
5565=======================================
wdenkf07771c2003-05-28 08:06:31 +00005566
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005567Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005568such configurations and is capable of automatic selection of a
5569"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005570
wdenk2729af92004-05-03 20:45:30 +00005571Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5572MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5573"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005574
wdenk2729af92004-05-03 20:45:30 +00005575If the network interface stores some valid MAC address (for instance
5576in SROM), this is used as default address if there is NO correspon-
5577ding setting in the environment; if the corresponding environment
5578variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005579
wdenk2729af92004-05-03 20:45:30 +00005580o If the SROM has a valid MAC address, and there is no address in the
5581 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005582
wdenk2729af92004-05-03 20:45:30 +00005583o If there is no valid address in the SROM, and a definition in the
5584 environment exists, then the value from the environment variable is
5585 used.
wdenkc6097192002-11-03 00:24:07 +00005586
wdenk2729af92004-05-03 20:45:30 +00005587o If both the SROM and the environment contain a MAC address, and
5588 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005589
wdenk2729af92004-05-03 20:45:30 +00005590o If both the SROM and the environment contain a MAC address, and the
5591 addresses differ, the value from the environment is used and a
5592 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05005595 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5596 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005597
Ben Warrenecee9322010-04-26 11:11:46 -07005598If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005599will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005600may be skipped by setting the appropriate 'ethmacskip' environment variable.
5601The naming convention is as follows:
5602"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005603
wdenk2729af92004-05-03 20:45:30 +00005604Image Formats:
5605==============
wdenkc6097192002-11-03 00:24:07 +00005606
Marian Balakowicz3310c542008-03-12 12:13:13 +01005607U-Boot is capable of booting (and performing other auxiliary operations on)
5608images in two formats:
5609
5610New uImage format (FIT)
5611-----------------------
5612
5613Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5614to Flattened Device Tree). It allows the use of images with multiple
5615components (several kernels, ramdisks, etc.), with contents protected by
5616SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5617
5618
5619Old uImage format
5620-----------------
5621
5622Old image format is based on binary files which can be basically anything,
5623preceded by a special header; see the definitions in include/image.h for
5624details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005625
wdenk2729af92004-05-03 20:45:30 +00005626* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5627 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005628 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5629 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5630 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005631* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005632 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5633 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005634* Compression Type (uncompressed, gzip, bzip2)
5635* Load Address
5636* Entry Point
5637* Image Name
5638* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005639
wdenk2729af92004-05-03 20:45:30 +00005640The header is marked by a special Magic Number, and both the header
5641and the data portions of the image are secured against corruption by
5642CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005643
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk2729af92004-05-03 20:45:30 +00005645Linux Support:
5646==============
wdenkc6097192002-11-03 00:24:07 +00005647
wdenk2729af92004-05-03 20:45:30 +00005648Although U-Boot should support any OS or standalone application
5649easily, the main focus has always been on Linux during the design of
5650U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652U-Boot includes many features that so far have been part of some
5653special "boot loader" code within the Linux kernel. Also, any
5654"initrd" images to be used are no longer part of one big Linux image;
5655instead, kernel and "initrd" are separate images. This implementation
5656serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005657
wdenk2729af92004-05-03 20:45:30 +00005658- the same features can be used for other OS or standalone
5659 applications (for instance: using compressed images to reduce the
5660 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005661
wdenk2729af92004-05-03 20:45:30 +00005662- it becomes much easier to port new Linux kernel versions because
5663 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005664
wdenk2729af92004-05-03 20:45:30 +00005665- the same Linux kernel image can now be used with different "initrd"
5666 images; of course this also means that different kernel images can
5667 be run with the same "initrd". This makes testing easier (you don't
5668 have to build a new "zImage.initrd" Linux image when you just
5669 change a file in your "initrd"). Also, a field-upgrade of the
5670 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005671
wdenkc6097192002-11-03 00:24:07 +00005672
wdenk2729af92004-05-03 20:45:30 +00005673Linux HOWTO:
5674============
wdenkc6097192002-11-03 00:24:07 +00005675
wdenk2729af92004-05-03 20:45:30 +00005676Porting Linux to U-Boot based systems:
5677---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005678
wdenk2729af92004-05-03 20:45:30 +00005679U-Boot cannot save you from doing all the necessary modifications to
5680configure the Linux device drivers for use with your target hardware
5681(no, we don't intend to provide a full virtual machine interface to
5682Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005683
Stefan Roesea47a12b2010-04-15 16:07:28 +02005684But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005685
wdenk2729af92004-05-03 20:45:30 +00005686Just make sure your machine specific header file (for instance
5687include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005688Information structure as we define in include/asm-<arch>/u-boot.h,
5689and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005690as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005691
Simon Glass2eb31b12014-06-11 23:29:46 -06005692Note that U-Boot now has a driver model, a unified model for drivers.
5693If you are adding a new driver, plumb it into driver model. If there
5694is no uclass available, you are encouraged to create one. See
5695doc/driver-model.
5696
wdenkc6097192002-11-03 00:24:07 +00005697
wdenk2729af92004-05-03 20:45:30 +00005698Configuring the Linux kernel:
5699-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005700
wdenk2729af92004-05-03 20:45:30 +00005701No specific requirements for U-Boot. Make sure you have some root
5702device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005703
wdenkc6097192002-11-03 00:24:07 +00005704
wdenk2729af92004-05-03 20:45:30 +00005705Building a Linux Image:
5706-----------------------
wdenkc6097192002-11-03 00:24:07 +00005707
wdenk2729af92004-05-03 20:45:30 +00005708With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5709not used. If you use recent kernel source, a new build target
5710"uImage" will exist which automatically builds an image usable by
5711U-Boot. Most older kernels also have support for a "pImage" target,
5712which was introduced for our predecessor project PPCBoot and uses a
5713100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005714
wdenk2729af92004-05-03 20:45:30 +00005715Example:
wdenkc6097192002-11-03 00:24:07 +00005716
Holger Freytherab584d62014-08-04 09:26:05 +02005717 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005718 make oldconfig
5719 make dep
5720 make uImage
wdenkc6097192002-11-03 00:24:07 +00005721
wdenk2729af92004-05-03 20:45:30 +00005722The "uImage" build target uses a special tool (in 'tools/mkimage') to
5723encapsulate a compressed Linux kernel image with header information,
5724CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005725
wdenk2729af92004-05-03 20:45:30 +00005726* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005727
wdenk2729af92004-05-03 20:45:30 +00005728* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005729
wdenk2729af92004-05-03 20:45:30 +00005730 ${CROSS_COMPILE}-objcopy -O binary \
5731 -R .note -R .comment \
5732 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005733
wdenk2729af92004-05-03 20:45:30 +00005734* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005735
wdenk2729af92004-05-03 20:45:30 +00005736 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005737
wdenk2729af92004-05-03 20:45:30 +00005738* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005739
wdenk2729af92004-05-03 20:45:30 +00005740 mkimage -A ppc -O linux -T kernel -C gzip \
5741 -a 0 -e 0 -n "Linux Kernel Image" \
5742 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005743
wdenk24ee89b2002-11-03 17:56:27 +00005744
wdenk2729af92004-05-03 20:45:30 +00005745The "mkimage" tool can also be used to create ramdisk images for use
5746with U-Boot, either separated from the Linux kernel image, or
5747combined into one file. "mkimage" encapsulates the images with a 64
5748byte header containing information about target architecture,
5749operating system, image type, compression method, entry points, time
5750stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005751
wdenk2729af92004-05-03 20:45:30 +00005752"mkimage" can be called in two ways: to verify existing images and
5753print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005754
wdenk2729af92004-05-03 20:45:30 +00005755In the first form (with "-l" option) mkimage lists the information
5756contained in the header of an existing U-Boot image; this includes
5757checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005758
wdenk2729af92004-05-03 20:45:30 +00005759 tools/mkimage -l image
5760 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005761
wdenk2729af92004-05-03 20:45:30 +00005762The second form (with "-d" option) is used to build a U-Boot image
5763from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005764
wdenk2729af92004-05-03 20:45:30 +00005765 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5766 -n name -d data_file image
5767 -A ==> set architecture to 'arch'
5768 -O ==> set operating system to 'os'
5769 -T ==> set image type to 'type'
5770 -C ==> set compression type 'comp'
5771 -a ==> set load address to 'addr' (hex)
5772 -e ==> set entry point to 'ep' (hex)
5773 -n ==> set image name to 'name'
5774 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005775
wdenk69459792004-05-29 16:53:29 +00005776Right now, all Linux kernels for PowerPC systems use the same load
5777address (0x00000000), but the entry point address depends on the
5778kernel version:
wdenkc6097192002-11-03 00:24:07 +00005779
wdenk2729af92004-05-03 20:45:30 +00005780- 2.2.x kernels have the entry point at 0x0000000C,
5781- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005782
wdenk2729af92004-05-03 20:45:30 +00005783So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005784
wdenk2729af92004-05-03 20:45:30 +00005785 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5786 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005787 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005788 > examples/uImage.TQM850L
5789 Image Name: 2.4.4 kernel for TQM850L
5790 Created: Wed Jul 19 02:34:59 2000
5791 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5792 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5793 Load Address: 0x00000000
5794 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005795
wdenk2729af92004-05-03 20:45:30 +00005796To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005797
wdenk2729af92004-05-03 20:45:30 +00005798 -> tools/mkimage -l examples/uImage.TQM850L
5799 Image Name: 2.4.4 kernel for TQM850L
5800 Created: Wed Jul 19 02:34:59 2000
5801 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5802 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5803 Load Address: 0x00000000
5804 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk2729af92004-05-03 20:45:30 +00005806NOTE: for embedded systems where boot time is critical you can trade
5807speed for memory and install an UNCOMPRESSED image instead: this
5808needs more space in Flash, but boots much faster since it does not
5809need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005810
Stefan Roesea47a12b2010-04-15 16:07:28 +02005811 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005812 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5813 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005814 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005815 > examples/uImage.TQM850L-uncompressed
5816 Image Name: 2.4.4 kernel for TQM850L
5817 Created: Wed Jul 19 02:34:59 2000
5818 Image Type: PowerPC Linux Kernel Image (uncompressed)
5819 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5820 Load Address: 0x00000000
5821 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005822
wdenkc6097192002-11-03 00:24:07 +00005823
wdenk2729af92004-05-03 20:45:30 +00005824Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5825when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005826
wdenk2729af92004-05-03 20:45:30 +00005827 -> tools/mkimage -n 'Simple Ramdisk Image' \
5828 > -A ppc -O linux -T ramdisk -C gzip \
5829 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5830 Image Name: Simple Ramdisk Image
5831 Created: Wed Jan 12 14:01:50 2000
5832 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5833 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5834 Load Address: 0x00000000
5835 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005836
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005837The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5838option performs the converse operation of the mkimage's second form (the "-d"
5839option). Given an image built by mkimage, the dumpimage extracts a "data file"
5840from the image:
5841
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005842 tools/dumpimage -i image -T type -p position data_file
5843 -i ==> extract from the 'image' a specific 'data_file'
5844 -T ==> set image type to 'type'
5845 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005846
wdenkdb01a2e2004-04-15 23:14:49 +00005847
wdenk2729af92004-05-03 20:45:30 +00005848Installing a Linux Image:
5849-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005850
wdenk2729af92004-05-03 20:45:30 +00005851To downloading a U-Boot image over the serial (console) interface,
5852you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005853
wdenk2729af92004-05-03 20:45:30 +00005854 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005855
wdenk2729af92004-05-03 20:45:30 +00005856The 'objcopy' does not understand the information in the U-Boot
5857image header, so the resulting S-Record file will be relative to
5858address 0x00000000. To load it to a given address, you need to
5859specify the target address as 'offset' parameter with the 'loads'
5860command.
wdenkc6097192002-11-03 00:24:07 +00005861
wdenk2729af92004-05-03 20:45:30 +00005862Example: install the image to address 0x40100000 (which on the
5863TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005864
wdenk2729af92004-05-03 20:45:30 +00005865 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005866
wdenk2729af92004-05-03 20:45:30 +00005867 .......... done
5868 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005869
wdenk2729af92004-05-03 20:45:30 +00005870 => loads 40100000
5871 ## Ready for S-Record download ...
5872 ~>examples/image.srec
5873 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5874 ...
5875 15989 15990 15991 15992
5876 [file transfer complete]
5877 [connected]
5878 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005879
5880
wdenk2729af92004-05-03 20:45:30 +00005881You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005882this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005883corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005884
wdenk2729af92004-05-03 20:45:30 +00005885 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005886
wdenk2729af92004-05-03 20:45:30 +00005887 ## Checking Image at 40100000 ...
5888 Image Name: 2.2.13 for initrd on TQM850L
5889 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5890 Data Size: 335725 Bytes = 327 kB = 0 MB
5891 Load Address: 00000000
5892 Entry Point: 0000000c
5893 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005894
5895
wdenk2729af92004-05-03 20:45:30 +00005896Boot Linux:
5897-----------
wdenkc6097192002-11-03 00:24:07 +00005898
wdenk2729af92004-05-03 20:45:30 +00005899The "bootm" command is used to boot an application that is stored in
5900memory (RAM or Flash). In case of a Linux kernel image, the contents
5901of the "bootargs" environment variable is passed to the kernel as
5902parameters. You can check and modify this variable using the
5903"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005904
5905
wdenk2729af92004-05-03 20:45:30 +00005906 => printenv bootargs
5907 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005908
wdenk2729af92004-05-03 20:45:30 +00005909 => 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 +00005910
wdenk2729af92004-05-03 20:45:30 +00005911 => printenv bootargs
5912 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 +00005913
wdenk2729af92004-05-03 20:45:30 +00005914 => bootm 40020000
5915 ## Booting Linux kernel at 40020000 ...
5916 Image Name: 2.2.13 for NFS on TQM850L
5917 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5918 Data Size: 381681 Bytes = 372 kB = 0 MB
5919 Load Address: 00000000
5920 Entry Point: 0000000c
5921 Verifying Checksum ... OK
5922 Uncompressing Kernel Image ... OK
5923 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
5924 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5925 time_init: decrementer frequency = 187500000/60
5926 Calibrating delay loop... 49.77 BogoMIPS
5927 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5928 ...
wdenkc6097192002-11-03 00:24:07 +00005929
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005930If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005931the memory addresses of both the kernel and the initrd image (PPBCOOT
5932format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005933
wdenk2729af92004-05-03 20:45:30 +00005934 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005935
wdenk2729af92004-05-03 20:45:30 +00005936 ## Checking Image at 40100000 ...
5937 Image Name: 2.2.13 for initrd on TQM850L
5938 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5939 Data Size: 335725 Bytes = 327 kB = 0 MB
5940 Load Address: 00000000
5941 Entry Point: 0000000c
5942 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005943
wdenk2729af92004-05-03 20:45:30 +00005944 ## Checking Image at 40200000 ...
5945 Image Name: Simple Ramdisk Image
5946 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5947 Data Size: 566530 Bytes = 553 kB = 0 MB
5948 Load Address: 00000000
5949 Entry Point: 00000000
5950 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005951
wdenk2729af92004-05-03 20:45:30 +00005952 => bootm 40100000 40200000
5953 ## Booting Linux kernel at 40100000 ...
5954 Image Name: 2.2.13 for initrd on TQM850L
5955 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5956 Data Size: 335725 Bytes = 327 kB = 0 MB
5957 Load Address: 00000000
5958 Entry Point: 0000000c
5959 Verifying Checksum ... OK
5960 Uncompressing Kernel Image ... OK
5961 ## Loading RAMDisk Image at 40200000 ...
5962 Image Name: Simple Ramdisk Image
5963 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5964 Data Size: 566530 Bytes = 553 kB = 0 MB
5965 Load Address: 00000000
5966 Entry Point: 00000000
5967 Verifying Checksum ... OK
5968 Loading Ramdisk ... OK
5969 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
5970 Boot arguments: root=/dev/ram
5971 time_init: decrementer frequency = 187500000/60
5972 Calibrating delay loop... 49.77 BogoMIPS
5973 ...
5974 RAMDISK: Compressed image found at block 0
5975 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005976
wdenk2729af92004-05-03 20:45:30 +00005977 bash#
wdenkc6097192002-11-03 00:24:07 +00005978
Matthew McClintock02677682006-06-28 10:41:37 -05005979Boot Linux and pass a flat device tree:
5980-----------
5981
5982First, U-Boot must be compiled with the appropriate defines. See the section
5983titled "Linux Kernel Interface" above for a more in depth explanation. The
5984following is an example of how to start a kernel and pass an updated
5985flat device tree:
5986
5987=> print oftaddr
5988oftaddr=0x300000
5989=> print oft
5990oft=oftrees/mpc8540ads.dtb
5991=> tftp $oftaddr $oft
5992Speed: 1000, full duplex
5993Using TSEC0 device
5994TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5995Filename 'oftrees/mpc8540ads.dtb'.
5996Load address: 0x300000
5997Loading: #
5998done
5999Bytes transferred = 4106 (100a hex)
6000=> tftp $loadaddr $bootfile
6001Speed: 1000, full duplex
6002Using TSEC0 device
6003TFTP from server 192.168.1.1; our IP address is 192.168.1.2
6004Filename 'uImage'.
6005Load address: 0x200000
6006Loading:############
6007done
6008Bytes transferred = 1029407 (fb51f hex)
6009=> print loadaddr
6010loadaddr=200000
6011=> print oftaddr
6012oftaddr=0x300000
6013=> bootm $loadaddr - $oftaddr
6014## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01006015 Image Name: Linux-2.6.17-dirty
6016 Image Type: PowerPC Linux Kernel Image (gzip compressed)
6017 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05006018 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01006019 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05006020 Verifying Checksum ... OK
6021 Uncompressing Kernel Image ... OK
6022Booting using flat device tree at 0x300000
6023Using MPC85xx ADS machine description
6024Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
6025[snip]
6026
6027
wdenk2729af92004-05-03 20:45:30 +00006028More About U-Boot Image Types:
6029------------------------------
wdenk6069ff22003-02-28 00:49:47 +00006030
wdenk2729af92004-05-03 20:45:30 +00006031U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00006032
wdenk2729af92004-05-03 20:45:30 +00006033 "Standalone Programs" are directly runnable in the environment
6034 provided by U-Boot; it is expected that (if they behave
6035 well) you can continue to work in U-Boot after return from
6036 the Standalone Program.
6037 "OS Kernel Images" are usually images of some Embedded OS which
6038 will take over control completely. Usually these programs
6039 will install their own set of exception handlers, device
6040 drivers, set up the MMU, etc. - this means, that you cannot
6041 expect to re-enter U-Boot except by resetting the CPU.
6042 "RAMDisk Images" are more or less just data blocks, and their
6043 parameters (address, size) are passed to an OS kernel that is
6044 being started.
6045 "Multi-File Images" contain several images, typically an OS
6046 (Linux) kernel image and one or more data images like
6047 RAMDisks. This construct is useful for instance when you want
6048 to boot over the network using BOOTP etc., where the boot
6049 server provides just a single image file, but you want to get
6050 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006051
wdenk2729af92004-05-03 20:45:30 +00006052 "Multi-File Images" start with a list of image sizes, each
6053 image size (in bytes) specified by an "uint32_t" in network
6054 byte order. This list is terminated by an "(uint32_t)0".
6055 Immediately after the terminating 0 follow the images, one by
6056 one, all aligned on "uint32_t" boundaries (size rounded up to
6057 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006058
wdenk2729af92004-05-03 20:45:30 +00006059 "Firmware Images" are binary images containing firmware (like
6060 U-Boot or FPGA images) which usually will be programmed to
6061 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006062
wdenk2729af92004-05-03 20:45:30 +00006063 "Script files" are command sequences that will be executed by
6064 U-Boot's command interpreter; this feature is especially
6065 useful when you configure U-Boot to use a real shell (hush)
6066 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006067
Marek Vasut44f074c2012-03-14 21:52:45 +00006068Booting the Linux zImage:
6069-------------------------
6070
6071On some platforms, it's possible to boot Linux zImage. This is done
6072using the "bootz" command. The syntax of "bootz" command is the same
6073as the syntax of "bootm" command.
6074
Tom Rini8ac28562013-05-16 11:40:11 -04006075Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006076kernel with raw initrd images. The syntax is slightly different, the
6077address of the initrd must be augmented by it's size, in the following
6078format: "<initrd addres>:<initrd size>".
6079
wdenkc6097192002-11-03 00:24:07 +00006080
wdenk2729af92004-05-03 20:45:30 +00006081Standalone HOWTO:
6082=================
wdenkc6097192002-11-03 00:24:07 +00006083
wdenk2729af92004-05-03 20:45:30 +00006084One of the features of U-Boot is that you can dynamically load and
6085run "standalone" applications, which can use some resources of
6086U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006087
wdenk2729af92004-05-03 20:45:30 +00006088Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006089
wdenk2729af92004-05-03 20:45:30 +00006090"Hello World" Demo:
6091-------------------
wdenkc6097192002-11-03 00:24:07 +00006092
wdenk2729af92004-05-03 20:45:30 +00006093'examples/hello_world.c' contains a small "Hello World" Demo
6094application; it is automatically compiled when you build U-Boot.
6095It's configured to run at address 0x00040004, so you can play with it
6096like that:
wdenkc6097192002-11-03 00:24:07 +00006097
wdenk2729af92004-05-03 20:45:30 +00006098 => loads
6099 ## Ready for S-Record download ...
6100 ~>examples/hello_world.srec
6101 1 2 3 4 5 6 7 8 9 10 11 ...
6102 [file transfer complete]
6103 [connected]
6104 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006105
wdenk2729af92004-05-03 20:45:30 +00006106 => go 40004 Hello World! This is a test.
6107 ## Starting application at 0x00040004 ...
6108 Hello World
6109 argc = 7
6110 argv[0] = "40004"
6111 argv[1] = "Hello"
6112 argv[2] = "World!"
6113 argv[3] = "This"
6114 argv[4] = "is"
6115 argv[5] = "a"
6116 argv[6] = "test."
6117 argv[7] = "<NULL>"
6118 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006119
wdenk2729af92004-05-03 20:45:30 +00006120 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006121
wdenk2729af92004-05-03 20:45:30 +00006122Another example, which demonstrates how to register a CPM interrupt
6123handler with the U-Boot code, can be found in 'examples/timer.c'.
6124Here, a CPM timer is set up to generate an interrupt every second.
6125The interrupt service routine is trivial, just printing a '.'
6126character, but this is just a demo program. The application can be
6127controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006128
wdenk2729af92004-05-03 20:45:30 +00006129 ? - print current values og the CPM Timer registers
6130 b - enable interrupts and start timer
6131 e - stop timer and disable interrupts
6132 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006133
wdenk2729af92004-05-03 20:45:30 +00006134 => loads
6135 ## Ready for S-Record download ...
6136 ~>examples/timer.srec
6137 1 2 3 4 5 6 7 8 9 10 11 ...
6138 [file transfer complete]
6139 [connected]
6140 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006141
wdenk2729af92004-05-03 20:45:30 +00006142 => go 40004
6143 ## Starting application at 0x00040004 ...
6144 TIMERS=0xfff00980
6145 Using timer 1
6146 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006147
wdenk2729af92004-05-03 20:45:30 +00006148Hit 'b':
6149 [q, b, e, ?] Set interval 1000000 us
6150 Enabling timer
6151Hit '?':
6152 [q, b, e, ?] ........
6153 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6154Hit '?':
6155 [q, b, e, ?] .
6156 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6157Hit '?':
6158 [q, b, e, ?] .
6159 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6160Hit '?':
6161 [q, b, e, ?] .
6162 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6163Hit 'e':
6164 [q, b, e, ?] ...Stopping timer
6165Hit 'q':
6166 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006167
6168
wdenk2729af92004-05-03 20:45:30 +00006169Minicom warning:
6170================
wdenk85ec0bc2003-03-31 16:34:49 +00006171
wdenk2729af92004-05-03 20:45:30 +00006172Over time, many people have reported problems when trying to use the
6173"minicom" terminal emulation program for serial download. I (wd)
6174consider minicom to be broken, and recommend not to use it. Under
6175Unix, I recommend to use C-Kermit for general purpose use (and
6176especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006177use "cu" for S-Record download ("loads" command). See
6178http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6179for help with kermit.
6180
wdenk85ec0bc2003-03-31 16:34:49 +00006181
wdenk2729af92004-05-03 20:45:30 +00006182Nevertheless, if you absolutely want to use it try adding this
6183configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006184
wdenk2729af92004-05-03 20:45:30 +00006185 Name Program Name U/D FullScr IO-Red. Multi
6186 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6187 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006188
6189
wdenk2729af92004-05-03 20:45:30 +00006190NetBSD Notes:
6191=============
wdenkc6097192002-11-03 00:24:07 +00006192
wdenk2729af92004-05-03 20:45:30 +00006193Starting at version 0.9.2, U-Boot supports NetBSD both as host
6194(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006195
wdenk2729af92004-05-03 20:45:30 +00006196Building requires a cross environment; it is known to work on
6197NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6198need gmake since the Makefiles are not compatible with BSD make).
6199Note that the cross-powerpc package does not install include files;
6200attempting to build U-Boot will fail because <machine/ansi.h> is
6201missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006202
wdenk2729af92004-05-03 20:45:30 +00006203 # cd /usr/pkg/cross/powerpc-netbsd/include
6204 # mkdir powerpc
6205 # ln -s powerpc machine
6206 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6207 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006208
wdenk2729af92004-05-03 20:45:30 +00006209Native builds *don't* work due to incompatibilities between native
6210and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006211
wdenk2729af92004-05-03 20:45:30 +00006212Booting assumes that (the first part of) the image booted is a
6213stage-2 loader which in turn loads and then invokes the kernel
6214proper. Loader sources will eventually appear in the NetBSD source
6215tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006216meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006217
6218
wdenk2729af92004-05-03 20:45:30 +00006219Implementation Internals:
6220=========================
wdenkc6097192002-11-03 00:24:07 +00006221
wdenk2729af92004-05-03 20:45:30 +00006222The following is not intended to be a complete description of every
6223implementation detail. However, it should help to understand the
6224inner workings of U-Boot and make it easier to port it to custom
6225hardware.
wdenkc6097192002-11-03 00:24:07 +00006226
6227
wdenk2729af92004-05-03 20:45:30 +00006228Initial Stack, Global Data:
6229---------------------------
wdenkc6097192002-11-03 00:24:07 +00006230
wdenk2729af92004-05-03 20:45:30 +00006231The implementation of U-Boot is complicated by the fact that U-Boot
6232starts running out of ROM (flash memory), usually without access to
6233system RAM (because the memory controller is not initialized yet).
6234This means that we don't have writable Data or BSS segments, and BSS
6235is not initialized as zero. To be able to get a C environment working
6236at all, we have to allocate at least a minimal stack. Implementation
6237options for this are defined and restricted by the CPU used: Some CPU
6238models provide on-chip memory (like the IMMR area on MPC8xx and
6239MPC826x processors), on others (parts of) the data cache can be
6240locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006241
Wolfgang Denk218ca722008-03-26 10:40:12 +01006242 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006243 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006244
wdenk2729af92004-05-03 20:45:30 +00006245 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6246 From: "Chris Hallinan" <clh@net1plus.com>
6247 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6248 ...
wdenk43d96162003-03-06 00:02:04 +00006249
wdenk2729af92004-05-03 20:45:30 +00006250 Correct me if I'm wrong, folks, but the way I understand it
6251 is this: Using DCACHE as initial RAM for Stack, etc, does not
6252 require any physical RAM backing up the cache. The cleverness
6253 is that the cache is being used as a temporary supply of
6254 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006255 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006256 can see how this works by studying the cache architecture and
6257 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006258
wdenk2729af92004-05-03 20:45:30 +00006259 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6260 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006261 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006262 option should work for you. Using CS 4 should be fine if your
6263 board designers haven't used it for something that would
6264 cause you grief during the initial boot! It is frequently not
6265 used.
wdenk43d96162003-03-06 00:02:04 +00006266
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006267 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006268 with your processor/board/system design. The default value
6269 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006270 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006271 than your SDRAM module. If you have a 64MB SDRAM module, set
6272 it above 400_0000. Just make sure your board has no resources
6273 that are supposed to respond to that address! That code in
6274 start.S has been around a while and should work as is when
6275 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006276
wdenk2729af92004-05-03 20:45:30 +00006277 -Chris Hallinan
6278 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006279
wdenk2729af92004-05-03 20:45:30 +00006280It is essential to remember this, since it has some impact on the C
6281code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006282
wdenk2729af92004-05-03 20:45:30 +00006283* Initialized global data (data segment) is read-only. Do not attempt
6284 to write it.
wdenkc6097192002-11-03 00:24:07 +00006285
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006286* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006287 as zero data - BSS segment) at all - this is undefined, initiali-
6288 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006289
wdenk2729af92004-05-03 20:45:30 +00006290* Stack space is very limited. Avoid big data buffers or things like
6291 that.
wdenkc6097192002-11-03 00:24:07 +00006292
wdenk2729af92004-05-03 20:45:30 +00006293Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006294normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006295turned out that the implementation of U-Boot can be greatly
6296simplified by making a global data structure (gd_t) available to all
6297functions. We could pass a pointer to this data as argument to _all_
6298functions, but this would bloat the code. Instead we use a feature of
6299the GCC compiler (Global Register Variables) to share the data: we
6300place a pointer (gd) to the global data into a register which we
6301reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006302
wdenk2729af92004-05-03 20:45:30 +00006303When choosing a register for such a purpose we are restricted by the
6304relevant (E)ABI specifications for the current architecture, and by
6305GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006306
wdenk2729af92004-05-03 20:45:30 +00006307For PowerPC, the following registers have specific use:
6308 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006309 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006310 R3-R4: parameter passing and return values
6311 R5-R10: parameter passing
6312 R13: small data area pointer
6313 R30: GOT pointer
6314 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006315
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006316 (U-Boot also uses R12 as internal GOT pointer. r12
6317 is a volatile register so r12 needs to be reset when
6318 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006319
Wolfgang Denke7670f62008-02-14 22:43:22 +01006320 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006321
wdenk2729af92004-05-03 20:45:30 +00006322 Note: on PPC, we could use a static initializer (since the
6323 address of the global data structure is known at compile time),
6324 but it turned out that reserving a register results in somewhat
6325 smaller code - although the code savings are not that big (on
6326 average for all boards 752 bytes for the whole U-Boot image,
6327 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006328
Robin Getzc4db3352009-08-17 15:23:02 +00006329On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006330 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6331
Robin Getzc4db3352009-08-17 15:23:02 +00006332 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006333
wdenk2729af92004-05-03 20:45:30 +00006334On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006335
wdenk2729af92004-05-03 20:45:30 +00006336 R0: function argument word/integer result
6337 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006338 R9: platform specific
6339 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006340 R11: argument (frame) pointer
6341 R12: temporary workspace
6342 R13: stack pointer
6343 R14: link register
6344 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006345
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006346 ==> U-Boot will use R9 to hold a pointer to the global data
6347
6348 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006349
Thomas Chou0df01fd2010-05-21 11:08:03 +08006350On Nios II, the ABI is documented here:
6351 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6352
6353 ==> U-Boot will use gp to hold a pointer to the global data
6354
6355 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6356 to access small data sections, so gp is free.
6357
Macpaul Linafc1ce82011-10-19 20:41:11 +00006358On NDS32, the following registers are used:
6359
6360 R0-R1: argument/return
6361 R2-R5: argument
6362 R15: temporary register for assembler
6363 R16: trampoline register
6364 R28: frame pointer (FP)
6365 R29: global pointer (GP)
6366 R30: link register (LP)
6367 R31: stack pointer (SP)
6368 PC: program counter (PC)
6369
6370 ==> U-Boot will use R10 to hold a pointer to the global data
6371
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006372NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6373or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006374
wdenk2729af92004-05-03 20:45:30 +00006375Memory Management:
6376------------------
wdenkc6097192002-11-03 00:24:07 +00006377
wdenk2729af92004-05-03 20:45:30 +00006378U-Boot runs in system state and uses physical addresses, i.e. the
6379MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006380
wdenk2729af92004-05-03 20:45:30 +00006381The available memory is mapped to fixed addresses using the memory
6382controller. In this process, a contiguous block is formed for each
6383memory type (Flash, SDRAM, SRAM), even when it consists of several
6384physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006385
wdenk2729af92004-05-03 20:45:30 +00006386U-Boot is installed in the first 128 kB of the first Flash bank (on
6387TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6388booting and sizing and initializing DRAM, the code relocates itself
6389to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006390memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006391configuration setting]. Below that, a structure with global Board
6392Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006393
wdenk2729af92004-05-03 20:45:30 +00006394Additionally, some exception handler code is copied to the low 8 kB
6395of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006396
wdenk2729af92004-05-03 20:45:30 +00006397So a typical memory configuration with 16 MB of DRAM could look like
6398this:
wdenkc6097192002-11-03 00:24:07 +00006399
wdenk2729af92004-05-03 20:45:30 +00006400 0x0000 0000 Exception Vector code
6401 :
6402 0x0000 1FFF
6403 0x0000 2000 Free for Application Use
6404 :
6405 :
wdenkc6097192002-11-03 00:24:07 +00006406
wdenk2729af92004-05-03 20:45:30 +00006407 :
6408 :
6409 0x00FB FF20 Monitor Stack (Growing downward)
6410 0x00FB FFAC Board Info Data and permanent copy of global data
6411 0x00FC 0000 Malloc Arena
6412 :
6413 0x00FD FFFF
6414 0x00FE 0000 RAM Copy of Monitor Code
6415 ... eventually: LCD or video framebuffer
6416 ... eventually: pRAM (Protected RAM - unchanged by reset)
6417 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006418
6419
wdenk2729af92004-05-03 20:45:30 +00006420System Initialization:
6421----------------------
wdenkc6097192002-11-03 00:24:07 +00006422
wdenk2729af92004-05-03 20:45:30 +00006423In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006424(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006425configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006426To be able to re-map memory U-Boot then jumps to its link address.
6427To be able to implement the initialization code in C, a (small!)
6428initial stack is set up in the internal Dual Ported RAM (in case CPUs
6429which provide such a feature like MPC8xx or MPC8260), or in a locked
6430part of the data cache. After that, U-Boot initializes the CPU core,
6431the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006432
wdenk2729af92004-05-03 20:45:30 +00006433Next, all (potentially) available memory banks are mapped using a
6434preliminary mapping. For example, we put them on 512 MB boundaries
6435(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6436on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6437programmed for SDRAM access. Using the temporary configuration, a
6438simple memory test is run that determines the size of the SDRAM
6439banks.
wdenkc6097192002-11-03 00:24:07 +00006440
wdenk2729af92004-05-03 20:45:30 +00006441When there is more than one SDRAM bank, and the banks are of
6442different size, the largest is mapped first. For equal size, the first
6443bank (CS2#) is mapped first. The first mapping is always for address
64440x00000000, with any additional banks following immediately to create
6445contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006446
wdenk2729af92004-05-03 20:45:30 +00006447Then, the monitor installs itself at the upper end of the SDRAM area
6448and allocates memory for use by malloc() and for the global Board
6449Info data; also, the exception vector code is copied to the low RAM
6450pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006451
wdenk2729af92004-05-03 20:45:30 +00006452Only after this relocation will you have a "normal" C environment;
6453until that you are restricted in several ways, mostly because you are
6454running from ROM, and because the code will have to be relocated to a
6455new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006456
6457
wdenk2729af92004-05-03 20:45:30 +00006458U-Boot Porting Guide:
6459----------------------
wdenkc6097192002-11-03 00:24:07 +00006460
wdenk2729af92004-05-03 20:45:30 +00006461[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6462list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006463
6464
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006465int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006466{
6467 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006468
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006469 signal(SIGALRM, no_more_time);
6470 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006471
wdenk2729af92004-05-03 20:45:30 +00006472 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006473 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006474 return 0;
6475 }
6476
wdenk2729af92004-05-03 20:45:30 +00006477 Download latest U-Boot source;
6478
Wolfgang Denk06682362008-12-30 22:56:11 +01006479 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006480
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006481 if (clueless)
6482 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006483
wdenk2729af92004-05-03 20:45:30 +00006484 while (learning) {
6485 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006486 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6487 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006488 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006489 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006490 }
wdenkc6097192002-11-03 00:24:07 +00006491
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006492 if (available_money > toLocalCurrency ($2500))
6493 Buy a BDI3000;
6494 else
wdenk2729af92004-05-03 20:45:30 +00006495 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006496
6497 if (a similar board exists) { /* hopefully... */
6498 cp -a board/<similar> board/<myboard>
6499 cp include/configs/<similar>.h include/configs/<myboard>.h
6500 } else {
6501 Create your own board support subdirectory;
6502 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006503 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006504 Edit new board/<myboard> files
6505 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006506
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006507 while (!accepted) {
6508 while (!running) {
6509 do {
6510 Add / modify source code;
6511 } until (compiles);
6512 Debug;
6513 if (clueless)
6514 email("Hi, I am having problems...");
6515 }
6516 Send patch file to the U-Boot email list;
6517 if (reasonable critiques)
6518 Incorporate improvements from email list code review;
6519 else
6520 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006521 }
wdenkc6097192002-11-03 00:24:07 +00006522
wdenk2729af92004-05-03 20:45:30 +00006523 return 0;
6524}
6525
6526void no_more_time (int sig)
6527{
6528 hire_a_guru();
6529}
wdenkc6097192002-11-03 00:24:07 +00006530
6531
wdenk2729af92004-05-03 20:45:30 +00006532Coding Standards:
6533-----------------
wdenkc6097192002-11-03 00:24:07 +00006534
wdenk2729af92004-05-03 20:45:30 +00006535All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006536coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006537"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006538
Detlev Zundel2c051652006-09-01 15:39:02 +02006539Source files originating from a different project (for example the
6540MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006541reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006542sources.
6543
6544Please note that U-Boot is implemented in C (and to some small parts in
6545Assembler); no C++ is used, so please do not use C++ style comments (//)
6546in your code.
wdenk2729af92004-05-03 20:45:30 +00006547
6548Please also stick to the following formatting rules:
6549- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006550- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006551- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006552- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006553- do not add trailing empty lines to source files
6554
6555Submissions which do not conform to the standards may be returned
6556with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006557
6558
wdenk2729af92004-05-03 20:45:30 +00006559Submitting Patches:
6560-------------------
wdenkc6097192002-11-03 00:24:07 +00006561
wdenk2729af92004-05-03 20:45:30 +00006562Since the number of patches for U-Boot is growing, we need to
6563establish some rules. Submissions which do not conform to these rules
6564may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006565
Magnus Lilja0d28f342008-08-06 19:32:33 +02006566Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006567
Wolfgang Denk06682362008-12-30 22:56:11 +01006568Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6569see http://lists.denx.de/mailman/listinfo/u-boot
6570
wdenk2729af92004-05-03 20:45:30 +00006571When you send a patch, please include the following information with
6572it:
wdenkc6097192002-11-03 00:24:07 +00006573
wdenk2729af92004-05-03 20:45:30 +00006574* For bug fixes: a description of the bug and how your patch fixes
6575 this bug. Please try to include a way of demonstrating that the
6576 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006577
wdenk2729af92004-05-03 20:45:30 +00006578* For new features: a description of the feature and your
6579 implementation.
wdenkc6097192002-11-03 00:24:07 +00006580
wdenk2729af92004-05-03 20:45:30 +00006581* A CHANGELOG entry as plaintext (separate from the patch)
6582
Robert P. J. Day7207b362015-12-19 07:16:10 -05006583* For major contributions, add a MAINTAINERS file with your
6584 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00006585
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006586* When you add support for a new board, don't forget to add a
6587 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006588
6589* If your patch adds new configuration options, don't forget to
6590 document these in the README file.
6591
Wolfgang Denk218ca722008-03-26 10:40:12 +01006592* The patch itself. If you are using git (which is *strongly*
6593 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006594 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006595 the U-Boot mailing list, you will avoid most of the common problems
6596 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006597
Wolfgang Denk218ca722008-03-26 10:40:12 +01006598 If you cannot use git, use "diff -purN OLD NEW". If your version of
6599 diff does not support these options, then get the latest version of
6600 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006601
Wolfgang Denk218ca722008-03-26 10:40:12 +01006602 The current directory when running this command shall be the parent
6603 directory of the U-Boot source tree (i. e. please make sure that
6604 your patch includes sufficient directory information for the
6605 affected files).
6606
6607 We prefer patches as plain text. MIME attachments are discouraged,
6608 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006609
6610* If one logical set of modifications affects or creates several
6611 files, all these changes shall be submitted in a SINGLE patch file.
6612
6613* Changesets that contain different, unrelated modifications shall be
6614 submitted as SEPARATE patches, one patch per changeset.
6615
6616
6617Notes:
6618
6619* Before sending the patch, run the MAKEALL script on your patched
6620 source tree and make sure that no errors or warnings are reported
6621 for any of the boards.
6622
6623* Keep your modifications to the necessary minimum: A patch
6624 containing several unrelated changes or arbitrary reformats will be
6625 returned with a request to re-formatting / split it.
6626
6627* If you modify existing code, make sure that your new code does not
6628 add to the memory footprint of the code ;-) Small is beautiful!
6629 When adding new features, these should compile conditionally only
6630 (using #ifdef), and the resulting code with the new feature
6631 disabled must not need more memory than the old code without your
6632 modification.
wdenk90dc6702005-05-03 14:12:25 +00006633
Wolfgang Denk06682362008-12-30 22:56:11 +01006634* Remember that there is a size limit of 100 kB per message on the
6635 u-boot mailing list. Bigger patches will be moderated. If they are
6636 reasonable and not too big, they will be acknowledged. But patches
6637 bigger than the size limit should be avoided.