blob: cadb571166bf4117730f81fd044d0beb21b8f1b3 [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
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400514 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700515 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
Tim Harveyadde4352016-05-24 14:59:59 -0700843 CONFIG_HIDE_LOGO_VERSION
844 do not display bootloader
845 version string
wdenkc6097192002-11-03 00:24:07 +0000846
Pali Rohár33a35bb2012-10-19 13:30:09 +0000847 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
848 a limited number of ANSI escape sequences (cursor control,
849 erase functions and limited graphics rendition control).
850
wdenk43d96162003-03-06 00:02:04 +0000851 When CONFIG_CFB_CONSOLE is defined, video console is
852 default i/o. Serial console can be forced with
853 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000854
wdenkd4ca31c2004-01-02 14:00:00 +0000855 When CONFIG_SILENT_CONSOLE is defined, all console
856 messages (by U-Boot and Linux!) can be silenced with
857 the "silent" environment variable. See
858 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000859
Heiko Schocher45ae2542013-10-22 11:06:06 +0200860 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
861 is 0x00.
862 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
863 is 0xa0.
864
wdenkc6097192002-11-03 00:24:07 +0000865- Console Baudrate:
866 CONFIG_BAUDRATE - in bps
867 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200868 CONFIG_SYS_BAUDRATE_TABLE, see below.
869 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000870
Heiko Schocherc92fac92009-01-30 12:55:38 +0100871- Console Rx buffer length
872 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
873 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100874 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100875 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
876 must be defined, to setup the maximum idle timeout for
877 the SMC.
878
Graeme Russ9558b482011-09-01 00:48:27 +0000879- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200880 Prior to the console being initialised (i.e. serial UART
881 initialised etc) all console output is silently discarded.
882 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
883 buffer any console messages prior to the console being
884 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
885 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
886 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200887 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200888 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000889
Hans de Goedea8552c72015-05-05 13:13:36 +0200890 Note that when printing the buffer a copy is made on the
891 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
892
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200893 'Sane' compilers will generate smaller code if
894 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000895
wdenkc6097192002-11-03 00:24:07 +0000896- Autoboot Command:
897 CONFIG_BOOTCOMMAND
898 Only needed when CONFIG_BOOTDELAY is enabled;
899 define a command string that is automatically executed
900 when no character is read on the console interface
901 within "Boot Delay" after reset.
902
903 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000904 This can be used to pass arguments to the bootm
905 command. The value of CONFIG_BOOTARGS goes into the
906 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000907
908 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000909 The value of these goes into the environment as
910 "ramboot" and "nfsboot" respectively, and can be used
911 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200912 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000913
Heiko Schochereda0ba32013-11-04 14:04:59 +0100914- Bootcount:
915 CONFIG_BOOTCOUNT_LIMIT
916 Implements a mechanism for detecting a repeating reboot
917 cycle, see:
918 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
919
920 CONFIG_BOOTCOUNT_ENV
921 If no softreset save registers are found on the hardware
922 "bootcount" is stored in the environment. To prevent a
923 saveenv on all reboots, the environment variable
924 "upgrade_available" is used. If "upgrade_available" is
925 0, "bootcount" is always 0, if "upgrade_available" is
926 1 "bootcount" is incremented in the environment.
927 So the Userspace Applikation must set the "upgrade_available"
928 and "bootcount" variable to 0, if a boot was successfully.
929
wdenkc6097192002-11-03 00:24:07 +0000930- Pre-Boot Commands:
931 CONFIG_PREBOOT
932
933 When this option is #defined, the existence of the
934 environment variable "preboot" will be checked
935 immediately before starting the CONFIG_BOOTDELAY
936 countdown and/or running the auto-boot command resp.
937 entering interactive mode.
938
939 This feature is especially useful when "preboot" is
940 automatically generated or modified. For an example
941 see the LWMON board specific code: here "preboot" is
942 modified when the user holds down a certain
943 combination of keys on the (special) keyboard when
944 booting the systems
945
946- Serial Download Echo Mode:
947 CONFIG_LOADS_ECHO
948 If defined to 1, all characters received during a
949 serial download (using the "loads" command) are
950 echoed back. This might be needed by some terminal
951 emulations (like "cu"), but may as well just take
952 time on others. This setting #define's the initial
953 value of the "loads_echo" environment variable.
954
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500955- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000956 CONFIG_KGDB_BAUDRATE
957 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200958 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000959
960- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500961 Monitor commands can be included or excluded
962 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000963 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500964 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000965
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500966 The default command configuration includes all commands
967 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000968
Marek Vasutb401b732014-03-05 19:58:39 +0100969 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500970 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500971 CONFIG_CMD_BDI bdinfo
972 CONFIG_CMD_BEDBUG * Include BedBug Debugger
973 CONFIG_CMD_BMP * BMP support
974 CONFIG_CMD_BSP * Board specific commands
975 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400976 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500977 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800978 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500979 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500980 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500981 CONFIG_CMD_DATE * support for RTC, date/time...
982 CONFIG_CMD_DHCP * DHCP support
983 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600984 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
985 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
986 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
987 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500988 CONFIG_CMD_DTT * Digital Therm and Thermostat
989 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500990 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500991 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanovaa9e6042016-04-16 17:55:03 +0300992 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500993 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600994 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600995 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500996 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500997 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000998 CONFIG_CMD_EXT2 * ext2 command support
999 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001000 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1001 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001002 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001003 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001004 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001005 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001006 CONFIG_CMD_FLASH flinfo, erase, protect
1007 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001008 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001009 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001010 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001011 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001012 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001013 CONFIG_CMD_I2C * I2C serial bus support
1014 CONFIG_CMD_IDE * IDE harddisk support
1015 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001016 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001017 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001018 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001019 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001020 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001021 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001022 CONFIG_CMD_IRQ * irqinfo
1023 CONFIG_CMD_ITEST Integer/string test of 2 values
1024 CONFIG_CMD_JFFS2 * JFFS2 Support
1025 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001026 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001027 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1028 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001029 CONFIG_CMD_LOADB loadb
1030 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001031 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001032 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001033 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001034 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001035 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001036 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001037 CONFIG_CMD_MISC Misc functions like sleep etc
1038 CONFIG_CMD_MMC * MMC memory mapped support
1039 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001040 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001041 CONFIG_CMD_NAND * NAND support
1042 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001043 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001044 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001045 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001046 CONFIG_CMD_PCI * pciinfo
1047 CONFIG_CMD_PCMCIA * PCMCIA support
1048 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1049 host
1050 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001051 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001052 CONFIG_CMD_REGINFO * Register dump
1053 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001054 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001055 CONFIG_CMD_SAVES * save S record dump
Simon Glassc649e3c2016-05-01 11:36:02 -06001056 CONFIG_SCSI * SCSI Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001057 CONFIG_CMD_SDRAM * print SDRAM configuration information
1058 (requires CONFIG_CMD_I2C)
1059 CONFIG_CMD_SETGETDCR Support for DCR Register access
1060 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001061 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001062 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001063 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001064 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001065 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001066 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001067 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001068 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001069 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1070 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001071 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001072 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001073 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001074 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001075 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001076
1077 EXAMPLE: If you want all functions except of network
1078 support you can write:
1079
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001080 #include "config_cmd_all.h"
1081 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001082
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001083 Other Commands:
1084 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001085
1086 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001087 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001088 what you (and your U-Boot users) are doing. Data
1089 cache cannot be enabled on systems like the 8xx or
1090 8260 (where accesses to the IMMR region must be
1091 uncached), and it cannot be disabled on all other
1092 systems where we (mis-) use the data cache to hold an
1093 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001094
1095
1096 XXX - this list needs to get updated!
1097
Simon Glass302a6482016-03-13 19:07:28 -06001098- Removal of commands
1099 If no commands are needed to boot, you can disable
1100 CONFIG_CMDLINE to remove them. In this case, the command line
1101 will not be available, and when U-Boot wants to execute the
1102 boot command (on start-up) it will call board_run_command()
1103 instead. This can reduce image size significantly for very
1104 simple boot procedures.
1105
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001106- Regular expression support:
1107 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001108 If this variable is defined, U-Boot is linked against
1109 the SLRE (Super Light Regular Expression) library,
1110 which adds regex support to some commands, as for
1111 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001112
Simon Glass45ba8072011-10-15 05:48:20 +00001113- Device tree:
1114 CONFIG_OF_CONTROL
1115 If this variable is defined, U-Boot will use a device tree
1116 to configure its devices, instead of relying on statically
1117 compiled #defines in the board file. This option is
1118 experimental and only available on a few boards. The device
1119 tree is available in the global data as gd->fdt_blob.
1120
Simon Glass2c0f79e2011-10-24 19:15:31 +00001121 U-Boot needs to get its device tree from somewhere. This can
1122 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001123
1124 CONFIG_OF_EMBED
1125 If this variable is defined, U-Boot will embed a device tree
1126 binary in its image. This device tree file should be in the
1127 board directory and called <soc>-<board>.dts. The binary file
1128 is then picked up in board_init_f() and made available through
1129 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001130
Simon Glass2c0f79e2011-10-24 19:15:31 +00001131 CONFIG_OF_SEPARATE
1132 If this variable is defined, U-Boot will build a device tree
1133 binary. It will be called u-boot.dtb. Architecture-specific
1134 code will locate it at run-time. Generally this works by:
1135
1136 cat u-boot.bin u-boot.dtb >image.bin
1137
1138 and in fact, U-Boot does this for you, creating a file called
1139 u-boot-dtb.bin which is useful in the common case. You can
1140 still use the individual files if you need something more
1141 exotic.
1142
wdenkc6097192002-11-03 00:24:07 +00001143- Watchdog:
1144 CONFIG_WATCHDOG
1145 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001146 support for the SoC. There must be support in the SoC
1147 specific code for a watchdog. For the 8xx and 8260
1148 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1149 register. When supported for a specific SoC is
1150 available, then no further board specific code should
1151 be needed to use it.
1152
1153 CONFIG_HW_WATCHDOG
1154 When using a watchdog circuitry external to the used
1155 SoC, then define this variable and provide board
1156 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001157
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001158 CONFIG_AT91_HW_WDT_TIMEOUT
1159 specify the timeout in seconds. default 2 seconds.
1160
stroesec1551ea2003-04-04 15:53:41 +00001161- U-Boot Version:
1162 CONFIG_VERSION_VARIABLE
1163 If this variable is defined, an environment variable
1164 named "ver" is created by U-Boot showing the U-Boot
1165 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e512012-08-13 15:01:14 +02001166 Any change to this variable will be reverted at the
1167 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001168
wdenkc6097192002-11-03 00:24:07 +00001169- Real-Time Clock:
1170
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001171 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001172 has to be selected, too. Define exactly one of the
1173 following options:
1174
1175 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1176 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001177 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001178 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001179 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001180 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001181 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001182 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001183 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001184 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001185 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001186 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001187 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1188 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001189
wdenkb37c7e52003-06-30 16:24:52 +00001190 Note that if the RTC uses I2C, then the I2C interface
1191 must also be configured. See I2C Support, below.
1192
Peter Tysere92739d2008-12-17 16:36:21 -06001193- GPIO Support:
1194 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001195
Chris Packham5dec49c2010-12-19 10:12:13 +00001196 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1197 chip-ngpio pairs that tell the PCA953X driver the number of
1198 pins supported by a particular chip.
1199
Peter Tysere92739d2008-12-17 16:36:21 -06001200 Note that if the GPIO device uses I2C, then the I2C interface
1201 must also be configured. See I2C Support, below.
1202
Simon Glassaa532332014-06-11 23:29:41 -06001203- I/O tracing:
1204 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1205 accesses and can checksum them or write a list of them out
1206 to memory. See the 'iotrace' command for details. This is
1207 useful for testing device drivers since it can confirm that
1208 the driver behaves the same way before and after a code
1209 change. Currently this is supported on sandbox and arm. To
1210 add support for your architecture, add '#include <iotrace.h>'
1211 to the bottom of arch/<arch>/include/asm/io.h and test.
1212
1213 Example output from the 'iotrace stats' command is below.
1214 Note that if the trace buffer is exhausted, the checksum will
1215 still continue to operate.
1216
1217 iotrace is enabled
1218 Start: 10000000 (buffer start address)
1219 Size: 00010000 (buffer size)
1220 Offset: 00000120 (current buffer offset)
1221 Output: 10000120 (start + offset)
1222 Count: 00000018 (number of trace records)
1223 CRC32: 9526fb66 (CRC32 of all trace records)
1224
wdenkc6097192002-11-03 00:24:07 +00001225- Timestamp Support:
1226
wdenk43d96162003-03-06 00:02:04 +00001227 When CONFIG_TIMESTAMP is selected, the timestamp
1228 (date and time) of an image is printed by image
1229 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001230 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001231
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001232- Partition Labels (disklabels) Supported:
1233 Zero or more of the following:
1234 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1235 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1236 Intel architecture, USB sticks, etc.
1237 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1238 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1239 bootloader. Note 2TB partition limit; see
1240 disk/part_efi.c
1241 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001242
Wolfgang Denk218ca722008-03-26 10:40:12 +01001243 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -06001244 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001245 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001246
1247- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001248 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1249 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001250
wdenk4d13cba2004-03-14 14:09:05 +00001251 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1252 be performed by calling the function
1253 ide_set_reset(int reset)
1254 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001255
1256- ATAPI Support:
1257 CONFIG_ATAPI
1258
1259 Set this to enable ATAPI support.
1260
wdenkc40b2952004-03-13 23:29:43 +00001261- LBA48 Support
1262 CONFIG_LBA48
1263
1264 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001265 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001266 Whithout these , LBA48 support uses 32bit variables and will 'only'
1267 support disks up to 2.1TB.
1268
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001269 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001270 When enabled, makes the IDE subsystem use 64bit sector addresses.
1271 Default is 32bit.
1272
wdenkc6097192002-11-03 00:24:07 +00001273- SCSI Support:
1274 At the moment only there is only support for the
1275 SYM53C8XX SCSI controller; define
1276 CONFIG_SCSI_SYM53C8XX to enable it.
1277
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001278 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1279 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1280 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001281 maximum numbers of LUNs, SCSI ID's and target
1282 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001283 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001284
Wolfgang Denk93e14592013-10-04 17:43:24 +02001285 The environment variable 'scsidevs' is set to the number of
1286 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001287
wdenkc6097192002-11-03 00:24:07 +00001288- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001289 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001290 Support for Intel 8254x/8257x gigabit chips.
1291
1292 CONFIG_E1000_SPI
1293 Utility code for direct access to the SPI bus on Intel 8257x.
1294 This does not do anything useful unless you set at least one
1295 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1296
1297 CONFIG_E1000_SPI_GENERIC
1298 Allow generic access to the SPI bus on the Intel 8257x, for
1299 example with the "sspi" command.
1300
1301 CONFIG_CMD_E1000
1302 Management command for E1000 devices. When used on devices
1303 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001304
wdenkc6097192002-11-03 00:24:07 +00001305 CONFIG_EEPRO100
1306 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001307 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001308 write routine for first time initialisation.
1309
1310 CONFIG_TULIP
1311 Support for Digital 2114x chips.
1312 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1313 modem chip initialisation (KS8761/QS6611).
1314
1315 CONFIG_NATSEMI
1316 Support for National dp83815 chips.
1317
1318 CONFIG_NS8382X
1319 Support for National dp8382[01] gigabit chips.
1320
wdenk45219c42003-05-12 21:50:16 +00001321- NETWORK Support (other):
1322
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001323 CONFIG_DRIVER_AT91EMAC
1324 Support for AT91RM9200 EMAC.
1325
1326 CONFIG_RMII
1327 Define this to use reduced MII inteface
1328
1329 CONFIG_DRIVER_AT91EMAC_QUIET
1330 If this defined, the driver is quiet.
1331 The driver doen't show link status messages.
1332
Rob Herringefdd7312011-12-15 11:15:49 +00001333 CONFIG_CALXEDA_XGMAC
1334 Support for the Calxeda XGMAC device
1335
Ashok3bb46d22012-10-15 06:20:47 +00001336 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001337 Support for SMSC's LAN91C96 chips.
1338
1339 CONFIG_LAN91C96_BASE
1340 Define this to hold the physical address
1341 of the LAN91C96's I/O space
1342
1343 CONFIG_LAN91C96_USE_32_BIT
1344 Define this to enable 32 bit addressing
1345
Ashok3bb46d22012-10-15 06:20:47 +00001346 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001347 Support for SMSC's LAN91C111 chip
1348
1349 CONFIG_SMC91111_BASE
1350 Define this to hold the physical address
1351 of the device (I/O space)
1352
1353 CONFIG_SMC_USE_32_BIT
1354 Define this if data bus is 32 bits
1355
1356 CONFIG_SMC_USE_IOFUNCS
1357 Define this to use i/o functions instead of macros
1358 (some hardware wont work with macros)
1359
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001360 CONFIG_DRIVER_TI_EMAC
1361 Support for davinci emac
1362
1363 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1364 Define this if you have more then 3 PHYs.
1365
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001366 CONFIG_FTGMAC100
1367 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1368
1369 CONFIG_FTGMAC100_EGIGA
1370 Define this to use GE link update with gigabit PHY.
1371 Define this if FTGMAC100 is connected to gigabit PHY.
1372 If your system has 10/100 PHY only, it might not occur
1373 wrong behavior. Because PHY usually return timeout or
1374 useless data when polling gigabit status and gigabit
1375 control registers. This behavior won't affect the
1376 correctnessof 10/100 link speed update.
1377
Mike Rapoportc2fff332009-11-11 10:03:03 +02001378 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001379 Support for SMSC's LAN911x and LAN921x chips
1380
Mike Rapoportc2fff332009-11-11 10:03:03 +02001381 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001382 Define this to hold the physical address
1383 of the device (I/O space)
1384
Mike Rapoportc2fff332009-11-11 10:03:03 +02001385 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001386 Define this if data bus is 32 bits
1387
Mike Rapoportc2fff332009-11-11 10:03:03 +02001388 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001389 Define this if data bus is 16 bits. If your processor
1390 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001391 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001392
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001393 CONFIG_SH_ETHER
1394 Support for Renesas on-chip Ethernet controller
1395
1396 CONFIG_SH_ETHER_USE_PORT
1397 Define the number of ports to be used
1398
1399 CONFIG_SH_ETHER_PHY_ADDR
1400 Define the ETH PHY's address
1401
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001402 CONFIG_SH_ETHER_CACHE_WRITEBACK
1403 If this option is set, the driver enables cache flush.
1404
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001405- PWM Support:
1406 CONFIG_PWM_IMX
1407 Support for PWM modul on the imx6.
1408
Vadim Bendebury5e124722011-10-17 08:36:14 +00001409- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001410 CONFIG_TPM
1411 Support TPM devices.
1412
Christophe Ricard0766ad22015-10-06 22:54:41 +02001413 CONFIG_TPM_TIS_INFINEON
1414 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001415 per system is supported at this time.
1416
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001417 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1418 Define the burst count bytes upper limit
1419
Christophe Ricard3aa74082016-01-21 23:27:13 +01001420 CONFIG_TPM_ST33ZP24
1421 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1422
1423 CONFIG_TPM_ST33ZP24_I2C
1424 Support for STMicroelectronics ST33ZP24 I2C devices.
1425 Requires TPM_ST33ZP24 and I2C.
1426
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001427 CONFIG_TPM_ST33ZP24_SPI
1428 Support for STMicroelectronics ST33ZP24 SPI devices.
1429 Requires TPM_ST33ZP24 and SPI.
1430
Dirk Eibachc01939c2013-06-26 15:55:15 +02001431 CONFIG_TPM_ATMEL_TWI
1432 Support for Atmel TWI TPM device. Requires I2C support.
1433
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001434 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001435 Support for generic parallel port TPM devices. Only one device
1436 per system is supported at this time.
1437
1438 CONFIG_TPM_TIS_BASE_ADDRESS
1439 Base address where the generic TPM device is mapped
1440 to. Contemporary x86 systems usually map it at
1441 0xfed40000.
1442
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001443 CONFIG_CMD_TPM
1444 Add tpm monitor functions.
1445 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1446 provides monitor access to authorized functions.
1447
1448 CONFIG_TPM
1449 Define this to enable the TPM support library which provides
1450 functional interfaces to some TPM commands.
1451 Requires support for a TPM device.
1452
1453 CONFIG_TPM_AUTH_SESSIONS
1454 Define this to enable authorized functions in the TPM library.
1455 Requires CONFIG_TPM and CONFIG_SHA1.
1456
wdenkc6097192002-11-03 00:24:07 +00001457- USB Support:
1458 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001459 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001460 CONFIG_USB_UHCI to enable it.
1461 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001462 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001463 storage devices.
1464 Note:
1465 Supported are USB Keyboards and USB Floppy drives
1466 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001467 MPC5200 USB requires additional defines:
1468 CONFIG_USB_CLOCK
1469 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001470 CONFIG_PSC3_USB
1471 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001472 CONFIG_USB_CONFIG
1473 for differential drivers: 0x00001000
1474 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001475 for differential drivers on PSC3: 0x00000100
1476 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001477 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001478 May be defined to allow interrupt polling
1479 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001480
Simon Glass9ab4ce22012-02-27 10:52:47 +00001481 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1482 txfilltuning field in the EHCI controller on reset.
1483
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001484 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1485 HW module registers.
1486
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001487- USB Device:
1488 Define the below if you wish to use the USB console.
1489 Once firmware is rebuilt from a serial console issue the
1490 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001491 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001492 it has found a new device. The environment variable usbtty
1493 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001494 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001495 Common Device Class Abstract Control Model serial device.
1496 If you select usbtty = gserial you should be able to enumerate
1497 a Linux host by
1498 # modprobe usbserial vendor=0xVendorID product=0xProductID
1499 else if using cdc_acm, simply setting the environment
1500 variable usbtty to be cdc_acm should suffice. The following
1501 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001502
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001503 CONFIG_USB_DEVICE
1504 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001505
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001506 CONFIG_USB_TTY
1507 Define this to have a tty type of device available to
1508 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001509
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301510 CONFIG_USBD_HS
1511 Define this to enable the high speed support for usb
1512 device and usbtty. If this feature is enabled, a routine
1513 int is_usbd_high_speed(void)
1514 also needs to be defined by the driver to dynamically poll
1515 whether the enumeration has succeded at high speed or full
1516 speed.
1517
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001518 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001519 Define this if you want stdin, stdout &/or stderr to
1520 be set to usbtty.
1521
1522 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001523 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001524 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001525 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001526
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001527 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001528 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001529 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001530
Wolfgang Denk386eda02006-06-14 18:14:56 +02001531 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001532 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001533 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001534 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1535 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1536 should pretend to be a Linux device to it's target host.
1537
1538 CONFIG_USBD_MANUFACTURER
1539 Define this string as the name of your company for
1540 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001541
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001542 CONFIG_USBD_PRODUCT_NAME
1543 Define this string as the name of your product
1544 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1545
1546 CONFIG_USBD_VENDORID
1547 Define this as your assigned Vendor ID from the USB
1548 Implementors Forum. This *must* be a genuine Vendor ID
1549 to avoid polluting the USB namespace.
1550 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001551
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001552 CONFIG_USBD_PRODUCTID
1553 Define this as the unique Product ID
1554 for your device
1555 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001556
Igor Grinbergd70a5602011-12-12 12:08:35 +02001557- ULPI Layer Support:
1558 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1559 the generic ULPI layer. The generic layer accesses the ULPI PHY
1560 via the platform viewport, so you need both the genric layer and
1561 the viewport enabled. Currently only Chipidea/ARC based
1562 viewport is supported.
1563 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1564 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001565 If your ULPI phy needs a different reference clock than the
1566 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1567 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001568
1569- MMC Support:
1570 The MMC controller on the Intel PXA is supported. To
1571 enable this define CONFIG_MMC. The MMC can be
1572 accessed from the boot prompt by mapping the device
1573 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001574 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1575 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001576
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001577 CONFIG_SH_MMCIF
1578 Support for Renesas on-chip MMCIF controller
1579
1580 CONFIG_SH_MMCIF_ADDR
1581 Define the base address of MMCIF registers
1582
1583 CONFIG_SH_MMCIF_CLK
1584 Define the clock frequency for MMCIF
1585
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001586 CONFIG_GENERIC_MMC
1587 Enable the generic MMC driver
1588
1589 CONFIG_SUPPORT_EMMC_BOOT
1590 Enable some additional features of the eMMC boot partitions.
1591
1592 CONFIG_SUPPORT_EMMC_RPMB
1593 Enable the commands for reading, writing and programming the
1594 key for the Replay Protection Memory Block partition in eMMC.
1595
Tom Rinib3ba6e92013-03-14 05:32:47 +00001596- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001597 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001598 This enables the USB portion of the DFU USB class
1599
1600 CONFIG_CMD_DFU
1601 This enables the command "dfu" which is used to have
1602 U-Boot create a DFU class device via USB. This command
1603 requires that the "dfu_alt_info" environment variable be
1604 set and define the alt settings to expose to the host.
1605
1606 CONFIG_DFU_MMC
1607 This enables support for exposing (e)MMC devices via DFU.
1608
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001609 CONFIG_DFU_NAND
1610 This enables support for exposing NAND devices via DFU.
1611
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301612 CONFIG_DFU_RAM
1613 This enables support for exposing RAM via DFU.
1614 Note: DFU spec refer to non-volatile memory usage, but
1615 allow usages beyond the scope of spec - here RAM usage,
1616 one that would help mostly the developer.
1617
Heiko Schochere7e75c72013-06-12 06:05:51 +02001618 CONFIG_SYS_DFU_DATA_BUF_SIZE
1619 Dfu transfer uses a buffer before writing data to the
1620 raw storage device. Make the size (in bytes) of this buffer
1621 configurable. The size of this buffer is also configurable
1622 through the "dfu_bufsiz" environment variable.
1623
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001624 CONFIG_SYS_DFU_MAX_FILE_SIZE
1625 When updating files rather than the raw storage device,
1626 we use a static buffer to copy the file into and then write
1627 the buffer once we've been given the whole file. Define
1628 this to the maximum filesize (in bytes) for the buffer.
1629 Default is 4 MiB if undefined.
1630
Heiko Schocher001a8312014-03-18 08:09:56 +01001631 DFU_DEFAULT_POLL_TIMEOUT
1632 Poll timeout [ms], is the timeout a device can send to the
1633 host. The host must wait for this timeout before sending
1634 a subsequent DFU_GET_STATUS request to the device.
1635
1636 DFU_MANIFEST_POLL_TIMEOUT
1637 Poll timeout [ms], which the device sends to the host when
1638 entering dfuMANIFEST state. Host waits this timeout, before
1639 sending again an USB request to the device.
1640
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001641- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001642 CONFIG_USB_FUNCTION_FASTBOOT
1643 This enables the USB part of the fastboot gadget
1644
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001645 CONFIG_CMD_FASTBOOT
1646 This enables the command "fastboot" which enables the Android
1647 fastboot mode for the platform's USB device. Fastboot is a USB
1648 protocol for downloading images, flashing and device control
1649 used on Android devices.
1650 See doc/README.android-fastboot for more information.
1651
1652 CONFIG_ANDROID_BOOT_IMAGE
1653 This enables support for booting images which use the Android
1654 image format header.
1655
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001656 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001657 The fastboot protocol requires a large memory buffer for
1658 downloads. Define this to the starting RAM address to use for
1659 downloaded images.
1660
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001661 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001662 The fastboot protocol requires a large memory buffer for
1663 downloads. This buffer should be as large as possible for a
1664 platform. Define this to the size available RAM for fastboot.
1665
Steve Raed1b5ed02014-08-26 11:47:28 -07001666 CONFIG_FASTBOOT_FLASH
1667 The fastboot protocol includes a "flash" command for writing
1668 the downloaded image to a non-volatile storage device. Define
1669 this to enable the "fastboot flash" command.
1670
1671 CONFIG_FASTBOOT_FLASH_MMC_DEV
1672 The fastboot "flash" command requires additional information
1673 regarding the non-volatile storage device. Define this to
1674 the eMMC device that fastboot should use to store the image.
1675
Steve Rae0ff7e582014-12-12 15:51:54 -08001676 CONFIG_FASTBOOT_GPT_NAME
1677 The fastboot "flash" command supports writing the downloaded
1678 image to the Protective MBR and the Primary GUID Partition
1679 Table. (Additionally, this downloaded image is post-processed
1680 to generate and write the Backup GUID Partition Table.)
1681 This occurs when the specified "partition name" on the
1682 "fastboot flash" command line matches this value.
1683 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1684
wdenk6705d812004-08-02 23:22:59 +00001685- Journaling Flash filesystem support:
1686 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1687 CONFIG_JFFS2_NAND_DEV
1688 Define these for a default partition on a NAND device
1689
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001690 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1691 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001692 Define these for a default partition on a NOR device
1693
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001694 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001695 Define this to create an own partition. You have to provide a
1696 function struct part_info* jffs2_part_info(int part_num)
1697
1698 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001699 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001700 to disable the command chpart. This is the default when you
1701 have not defined a custom partition
1702
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001703- FAT(File Allocation Table) filesystem write function support:
1704 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001705
1706 Define this to enable support for saving memory data as a
1707 file in FAT formatted partition.
1708
1709 This will also enable the command "fatwrite" enabling the
1710 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001711
Gabe Black84cd9322012-10-12 14:26:11 +00001712CBFS (Coreboot Filesystem) support
1713 CONFIG_CMD_CBFS
1714
1715 Define this to enable support for reading from a Coreboot
1716 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1717 and cbfsload.
1718
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301719- FAT(File Allocation Table) filesystem cluster size:
1720 CONFIG_FS_FAT_MAX_CLUSTSIZE
1721
1722 Define the max cluster size for fat operations else
1723 a default value of 65536 will be defined.
1724
wdenkc6097192002-11-03 00:24:07 +00001725- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001726 See Kconfig help for available keyboard drivers.
1727
1728 CONFIG_KEYBOARD
1729
1730 Define this to enable a custom keyboard support.
1731 This simply calls drv_keyboard_init() which must be
1732 defined in your board-specific files. This option is deprecated
1733 and is only used by novena. For new boards, use driver model
1734 instead.
wdenkc6097192002-11-03 00:24:07 +00001735
1736- Video support:
1737 CONFIG_VIDEO
1738
1739 Define this to enable video support (for output to
1740 video).
1741
1742 CONFIG_VIDEO_CT69000
1743
1744 Enable Chips & Technologies 69000 Video chip
1745
1746 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001747 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001748 video output is selected via environment 'videoout'
1749 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1750 assumed.
wdenkc6097192002-11-03 00:24:07 +00001751
wdenkb79a11c2004-03-25 15:14:43 +00001752 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001753 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001754 are possible:
1755 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001756 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001757
1758 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1759 -------------+---------------------------------------------
1760 8 bits | 0x301* 0x303 0x305 0x161 0x307
1761 15 bits | 0x310 0x313 0x316 0x162 0x319
1762 16 bits | 0x311 0x314 0x317 0x163 0x31A
1763 24 bits | 0x312 0x315 0x318 ? 0x31B
1764 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001765 (i.e. setenv videomode 317; saveenv; reset;)
1766
wdenkb79a11c2004-03-25 15:14:43 +00001767 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001768 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001769
1770
stroesec1551ea2003-04-04 15:53:41 +00001771 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001772 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001773 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1774 or CONFIG_VIDEO_SED13806_16BPP
1775
Timur Tabi7d3053f2011-02-15 17:09:19 -06001776 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001777 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001778 SOCs that have a DIU should define this macro to enable DIU
1779 support, and should also define these other macros:
1780
1781 CONFIG_SYS_DIU_ADDR
1782 CONFIG_VIDEO
1783 CONFIG_CMD_BMP
1784 CONFIG_CFB_CONSOLE
1785 CONFIG_VIDEO_SW_CURSOR
1786 CONFIG_VGA_AS_SINGLE_DEVICE
1787 CONFIG_VIDEO_LOGO
1788 CONFIG_VIDEO_BMP_LOGO
1789
Timur Tabiba8e76b2011-04-11 14:18:22 -05001790 The DIU driver will look for the 'video-mode' environment
1791 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001792 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001793 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001794
wdenkc6097192002-11-03 00:24:07 +00001795- LCD Support: CONFIG_LCD
1796
1797 Define this to enable LCD support (for output to LCD
1798 display); also select one of the supported displays
1799 by defining one of these:
1800
Stelian Pop39cf4802008-05-09 21:57:18 +02001801 CONFIG_ATMEL_LCD:
1802
1803 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1804
wdenkfd3103b2003-11-25 16:55:19 +00001805 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001806
wdenkfd3103b2003-11-25 16:55:19 +00001807 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001808
wdenkfd3103b2003-11-25 16:55:19 +00001809 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001810
wdenkfd3103b2003-11-25 16:55:19 +00001811 NEC NL6448BC20-08. 6.5", 640x480.
1812 Active, color, single scan.
1813
1814 CONFIG_NEC_NL6448BC33_54
1815
1816 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001817 Active, color, single scan.
1818
1819 CONFIG_SHARP_16x9
1820
1821 Sharp 320x240. Active, color, single scan.
1822 It isn't 16x9, and I am not sure what it is.
1823
1824 CONFIG_SHARP_LQ64D341
1825
1826 Sharp LQ64D341 display, 640x480.
1827 Active, color, single scan.
1828
1829 CONFIG_HLD1045
1830
1831 HLD1045 display, 640x480.
1832 Active, color, single scan.
1833
1834 CONFIG_OPTREX_BW
1835
1836 Optrex CBL50840-2 NF-FW 99 22 M5
1837 or
1838 Hitachi LMG6912RPFC-00T
1839 or
1840 Hitachi SP14Q002
1841
1842 320x240. Black & white.
1843
1844 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001845 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001846
Simon Glass676d3192012-10-17 13:24:54 +00001847 CONFIG_LCD_ALIGNMENT
1848
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001849 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001850 defined then the LCD will be aligned to this value instead.
1851 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1852 here, since it is cheaper to change data cache settings on
1853 a per-section basis.
1854
Simon Glass0d89efe2012-10-17 13:24:59 +00001855 CONFIG_CONSOLE_SCROLL_LINES
1856
1857 When the console need to be scrolled, this is the number of
1858 lines to scroll by. It defaults to 1. Increasing this makes
1859 the console jump but can help speed up operation when scrolling
1860 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001861
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001862 CONFIG_LCD_ROTATION
1863
1864 Sometimes, for example if the display is mounted in portrait
1865 mode or even if it's mounted landscape but rotated by 180degree,
1866 we need to rotate our content of the display relative to the
1867 framebuffer, so that user can read the messages which are
1868 printed out.
1869 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1870 initialized with a given rotation from "vl_rot" out of
1871 "vidinfo_t" which is provided by the board specific code.
1872 The value for vl_rot is coded as following (matching to
1873 fbcon=rotate:<n> linux-kernel commandline):
1874 0 = no rotation respectively 0 degree
1875 1 = 90 degree rotation
1876 2 = 180 degree rotation
1877 3 = 270 degree rotation
1878
1879 If CONFIG_LCD_ROTATION is not defined, the console will be
1880 initialized with 0degree rotation.
1881
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001882 CONFIG_LCD_BMP_RLE8
1883
1884 Support drawing of RLE8-compressed bitmaps on the LCD.
1885
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001886 CONFIG_I2C_EDID
1887
1888 Enables an 'i2c edid' command which can read EDID
1889 information over I2C from an attached LCD display.
1890
wdenk7152b1d2003-09-05 23:19:14 +00001891- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001892
wdenk8bde7f72003-06-27 21:31:46 +00001893 If this option is set, the environment is checked for
1894 a variable "splashimage". If found, the usual display
1895 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001896 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001897 specified in "splashimage" is loaded instead. The
1898 console is redirected to the "nulldev", too. This
1899 allows for a "silent" boot where a splash screen is
1900 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001901
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001902 CONFIG_SPLASHIMAGE_GUARD
1903
1904 If this option is set, then U-Boot will prevent the environment
1905 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001906 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001907 This option is useful for targets where, due to alignment
1908 restrictions, an improperly aligned BMP image will cause a data
1909 abort. If you think you will not have problems with unaligned
1910 accesses (for example because your toolchain prevents them)
1911 there is no need to set this option.
1912
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001913 CONFIG_SPLASH_SCREEN_ALIGN
1914
1915 If this option is set the splash image can be freely positioned
1916 on the screen. Environment variable "splashpos" specifies the
1917 position as "x,y". If a positive number is given it is used as
1918 number of pixel from left/top. If a negative number is given it
1919 is used as number of pixel from right/bottom. You can also
1920 specify 'm' for centering the image.
1921
1922 Example:
1923 setenv splashpos m,m
1924 => image at center of screen
1925
1926 setenv splashpos 30,20
1927 => image at x = 30 and y = 20
1928
1929 setenv splashpos -10,m
1930 => vertically centered image
1931 at x = dspWidth - bmpWidth - 9
1932
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001933- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1934
1935 If this option is set, additionally to standard BMP
1936 images, gzipped BMP images can be displayed via the
1937 splashscreen support or the bmp command.
1938
Anatolij Gustschind5011762010-03-15 14:50:25 +01001939- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1940
1941 If this option is set, 8-bit RLE compressed BMP images
1942 can be displayed via the splashscreen support or the
1943 bmp command.
1944
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001945- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00001946 CONFIG_CMD_ZIP
1947
1948 If this option is set, it would use zlib deflate method
1949 to compress the specified memory at its best effort.
1950
wdenkc29fdfc2003-08-29 20:57:53 +00001951- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001952 CONFIG_GZIP
1953
1954 Enabled by default to support gzip compressed images.
1955
wdenkc29fdfc2003-08-29 20:57:53 +00001956 CONFIG_BZIP2
1957
1958 If this option is set, support for bzip2 compressed
1959 images is included. If not, only uncompressed and gzip
1960 compressed images are supported.
1961
wdenk42d1f032003-10-15 23:53:47 +00001962 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001963 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001964 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001965
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001966 CONFIG_LZMA
1967
1968 If this option is set, support for lzma compressed
1969 images is included.
1970
1971 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1972 requires an amount of dynamic memory that is given by the
1973 formula:
1974
1975 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1976
1977 Where lc and lp stand for, respectively, Literal context bits
1978 and Literal pos bits.
1979
1980 This value is upper-bounded by 14MB in the worst case. Anyway,
1981 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1982 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1983 a very small buffer.
1984
1985 Use the lzmainfo tool to determinate the lc and lp values and
1986 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001987 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001988
Kees Cook8ef70472013-08-16 07:59:12 -07001989 CONFIG_LZO
1990
1991 If this option is set, support for LZO compressed images
1992 is included.
1993
wdenk17ea1172004-06-06 21:51:03 +00001994- MII/PHY support:
1995 CONFIG_PHY_ADDR
1996
1997 The address of PHY on MII bus.
1998
1999 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2000
2001 The clock frequency of the MII bus
2002
2003 CONFIG_PHY_GIGE
2004
2005 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002006 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002007
2008 CONFIG_PHY_RESET_DELAY
2009
2010 Some PHY like Intel LXT971A need extra delay after
2011 reset before any MII register access is possible.
2012 For such PHY, set this option to the usec delay
2013 required. (minimum 300usec for LXT971A)
2014
2015 CONFIG_PHY_CMD_DELAY (ppc4xx)
2016
2017 Some PHY like Intel LXT971A need extra delay after
2018 command issued before MII status register can be read
2019
wdenkc6097192002-11-03 00:24:07 +00002020- IP address:
2021 CONFIG_IPADDR
2022
2023 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002024 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002025 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002026 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002027
2028- Server IP address:
2029 CONFIG_SERVERIP
2030
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002031 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002032 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002033 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002034
Robin Getz97cfe862009-07-21 12:15:28 -04002035 CONFIG_KEEP_SERVERADDR
2036
2037 Keeps the server's MAC address, in the env 'serveraddr'
2038 for passing to bootargs (like Linux's netconsole option)
2039
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002040- Gateway IP address:
2041 CONFIG_GATEWAYIP
2042
2043 Defines a default value for the IP address of the
2044 default router where packets to other networks are
2045 sent to.
2046 (Environment variable "gatewayip")
2047
2048- Subnet mask:
2049 CONFIG_NETMASK
2050
2051 Defines a default value for the subnet mask (or
2052 routing prefix) which is used to determine if an IP
2053 address belongs to the local subnet or needs to be
2054 forwarded through a router.
2055 (Environment variable "netmask")
2056
David Updegraff53a5c422007-06-11 10:41:07 -05002057- Multicast TFTP Mode:
2058 CONFIG_MCAST_TFTP
2059
2060 Defines whether you want to support multicast TFTP as per
2061 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002062 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002063 driver in use must provide a function: mcast() to join/leave a
2064 multicast group.
2065
wdenkc6097192002-11-03 00:24:07 +00002066- BOOTP Recovery Mode:
2067 CONFIG_BOOTP_RANDOM_DELAY
2068
2069 If you have many targets in a network that try to
2070 boot using BOOTP, you may want to avoid that all
2071 systems send out BOOTP requests at precisely the same
2072 moment (which would happen for instance at recovery
2073 from a power failure, when all systems will try to
2074 boot, thus flooding the BOOTP server. Defining
2075 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2076 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002077 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002078
2079 1st BOOTP request: delay 0 ... 1 sec
2080 2nd BOOTP request: delay 0 ... 2 sec
2081 3rd BOOTP request: delay 0 ... 4 sec
2082 4th and following
2083 BOOTP requests: delay 0 ... 8 sec
2084
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002085 CONFIG_BOOTP_ID_CACHE_SIZE
2086
2087 BOOTP packets are uniquely identified using a 32-bit ID. The
2088 server will copy the ID from client requests to responses and
2089 U-Boot will use this to determine if it is the destination of
2090 an incoming response. Some servers will check that addresses
2091 aren't in use before handing them out (usually using an ARP
2092 ping) and therefore take up to a few hundred milliseconds to
2093 respond. Network congestion may also influence the time it
2094 takes for a response to make it back to the client. If that
2095 time is too long, U-Boot will retransmit requests. In order
2096 to allow earlier responses to still be accepted after these
2097 retransmissions, U-Boot's BOOTP client keeps a small cache of
2098 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2099 cache. The default is to keep IDs for up to four outstanding
2100 requests. Increasing this will allow U-Boot to accept offers
2101 from a BOOTP client in networks with unusually high latency.
2102
stroesefe389a82003-08-28 14:17:32 +00002103- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002104 You can fine tune the DHCP functionality by defining
2105 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002106
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002107 CONFIG_BOOTP_SUBNETMASK
2108 CONFIG_BOOTP_GATEWAY
2109 CONFIG_BOOTP_HOSTNAME
2110 CONFIG_BOOTP_NISDOMAIN
2111 CONFIG_BOOTP_BOOTPATH
2112 CONFIG_BOOTP_BOOTFILESIZE
2113 CONFIG_BOOTP_DNS
2114 CONFIG_BOOTP_DNS2
2115 CONFIG_BOOTP_SEND_HOSTNAME
2116 CONFIG_BOOTP_NTPSERVER
2117 CONFIG_BOOTP_TIMEOFFSET
2118 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002119 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002120
Wilson Callan5d110f02007-07-28 10:56:13 -04002121 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2122 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002123
Joe Hershberger2c00e092012-05-23 07:59:19 +00002124 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2125 after the configured retry count, the call will fail
2126 instead of starting over. This can be used to fail over
2127 to Link-local IP address configuration if the DHCP server
2128 is not available.
2129
stroesefe389a82003-08-28 14:17:32 +00002130 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2131 serverip from a DHCP server, it is possible that more
2132 than one DNS serverip is offered to the client.
2133 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2134 serverip will be stored in the additional environment
2135 variable "dnsip2". The first DNS serverip is always
2136 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002137 is defined.
stroesefe389a82003-08-28 14:17:32 +00002138
2139 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2140 to do a dynamic update of a DNS server. To do this, they
2141 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002142 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002143 of the "hostname" environment variable is passed as
2144 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002145
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002146 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2147
2148 A 32bit value in microseconds for a delay between
2149 receiving a "DHCP Offer" and sending the "DHCP Request".
2150 This fixes a problem with certain DHCP servers that don't
2151 respond 100% of the time to a "DHCP request". E.g. On an
2152 AT91RM9200 processor running at 180MHz, this delay needed
2153 to be *at least* 15,000 usec before a Windows Server 2003
2154 DHCP server would reply 100% of the time. I recommend at
2155 least 50,000 usec to be safe. The alternative is to hope
2156 that one of the retries will be successful but note that
2157 the DHCP timeout and retry process takes a longer than
2158 this delay.
2159
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002160 - Link-local IP address negotiation:
2161 Negotiate with other link-local clients on the local network
2162 for an address that doesn't require explicit configuration.
2163 This is especially useful if a DHCP server cannot be guaranteed
2164 to exist in all environments that the device must operate.
2165
2166 See doc/README.link-local for more information.
2167
wdenka3d991b2004-04-15 21:48:45 +00002168 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002169 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002170
2171 The device id used in CDP trigger frames.
2172
2173 CONFIG_CDP_DEVICE_ID_PREFIX
2174
2175 A two character string which is prefixed to the MAC address
2176 of the device.
2177
2178 CONFIG_CDP_PORT_ID
2179
2180 A printf format string which contains the ascii name of
2181 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002182 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002183
2184 CONFIG_CDP_CAPABILITIES
2185
2186 A 32bit integer which indicates the device capabilities;
2187 0x00000010 for a normal host which does not forwards.
2188
2189 CONFIG_CDP_VERSION
2190
2191 An ascii string containing the version of the software.
2192
2193 CONFIG_CDP_PLATFORM
2194
2195 An ascii string containing the name of the platform.
2196
2197 CONFIG_CDP_TRIGGER
2198
2199 A 32bit integer sent on the trigger.
2200
2201 CONFIG_CDP_POWER_CONSUMPTION
2202
2203 A 16bit integer containing the power consumption of the
2204 device in .1 of milliwatts.
2205
2206 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2207
2208 A byte containing the id of the VLAN.
2209
wdenkc6097192002-11-03 00:24:07 +00002210- Status LED: CONFIG_STATUS_LED
2211
2212 Several configurations allow to display the current
2213 status using a LED. For instance, the LED will blink
2214 fast while running U-Boot code, stop blinking as
2215 soon as a reply to a BOOTP request was received, and
2216 start blinking slow once the Linux kernel is running
2217 (supported by a status LED driver in the Linux
2218 kernel). Defining CONFIG_STATUS_LED enables this
2219 feature in U-Boot.
2220
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002221 Additional options:
2222
2223 CONFIG_GPIO_LED
2224 The status LED can be connected to a GPIO pin.
2225 In such cases, the gpio_led driver can be used as a
2226 status LED backend implementation. Define CONFIG_GPIO_LED
2227 to include the gpio_led driver in the U-Boot binary.
2228
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002229 CONFIG_GPIO_LED_INVERTED_TABLE
2230 Some GPIO connected LEDs may have inverted polarity in which
2231 case the GPIO high value corresponds to LED off state and
2232 GPIO low value corresponds to LED on state.
2233 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2234 with a list of GPIO LEDs that have inverted polarity.
2235
wdenkc6097192002-11-03 00:24:07 +00002236- CAN Support: CONFIG_CAN_DRIVER
2237
2238 Defining CONFIG_CAN_DRIVER enables CAN driver support
2239 on those systems that support this (optional)
2240 feature, like the TQM8xxL modules.
2241
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002242- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002243
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002244 This enable the NEW i2c subsystem, and will allow you to use
2245 i2c commands at the u-boot command line (as long as you set
2246 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2247 based realtime clock chips or other i2c devices. See
2248 common/cmd_i2c.c for a description of the command line
2249 interface.
2250
2251 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002252 - drivers/i2c/soft_i2c.c:
2253 - activate first bus with CONFIG_SYS_I2C_SOFT define
2254 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2255 for defining speed and slave address
2256 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2257 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2258 for defining speed and slave address
2259 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2260 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2261 for defining speed and slave address
2262 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2263 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2264 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002265
Heiko Schocher00f792e2012-10-24 13:48:22 +02002266 - drivers/i2c/fsl_i2c.c:
2267 - activate i2c driver with CONFIG_SYS_I2C_FSL
2268 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2269 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2270 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2271 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002272 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002273 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2274 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2275 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2276 second bus.
2277
Simon Glass1f2ba722012-10-30 07:28:53 +00002278 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002279 - activate this driver with CONFIG_SYS_I2C_TEGRA
2280 - This driver adds 4 i2c buses with a fix speed from
2281 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002282
Dirk Eibach880540d2013-04-25 02:40:01 +00002283 - drivers/i2c/ppc4xx_i2c.c
2284 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2285 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2286 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2287
tremfac96402013-09-21 18:13:35 +02002288 - drivers/i2c/i2c_mxc.c
2289 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002290 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2291 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2292 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2293 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002294 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2295 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2296 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2297 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2298 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2299 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002300 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2301 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002302 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002303 for speed, and 0 for slave.
2304
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002305 - drivers/i2c/rcar_i2c.c:
2306 - activate this driver with CONFIG_SYS_I2C_RCAR
2307 - This driver adds 4 i2c buses
2308
2309 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2310 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2311 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2312 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2313 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2314 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2315 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2316 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2317 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2318
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002319 - drivers/i2c/sh_i2c.c:
2320 - activate this driver with CONFIG_SYS_I2C_SH
2321 - This driver adds from 2 to 5 i2c buses
2322
2323 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2324 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2325 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2326 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2327 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2328 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2329 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2330 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2331 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2332 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2333 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2334 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002335 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002336
Heiko Schocher6789e842013-10-22 11:03:18 +02002337 - drivers/i2c/omap24xx_i2c.c
2338 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2339 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2340 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2341 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2342 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2343 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2344 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2345 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2346 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2347 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2348 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2349
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002350 - drivers/i2c/zynq_i2c.c
2351 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2352 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2353 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2354
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302355 - drivers/i2c/s3c24x0_i2c.c:
2356 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2357 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2358 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2359 with a fix speed from 100000 and the slave addr 0!
2360
Dirk Eibachb46226b2014-07-03 09:28:18 +02002361 - drivers/i2c/ihs_i2c.c
2362 - activate this driver with CONFIG_SYS_I2C_IHS
2363 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2364 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2365 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2366 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2367 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2368 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2369 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2370 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2371 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2372 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2373 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2374 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002375 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2376 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2377 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2378 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2379 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2380 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2381 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2382 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2383 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002384
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002385 additional defines:
2386
2387 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002388 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002389 don't use/have i2c muxes on your i2c bus, this
2390 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2391 omit this define.
2392
2393 CONFIG_SYS_I2C_DIRECT_BUS
2394 define this, if you don't use i2c muxes on your hardware.
2395 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2396 omit this define.
2397
2398 CONFIG_SYS_I2C_MAX_HOPS
2399 define how many muxes are maximal consecutively connected
2400 on one i2c bus. If you not use i2c muxes, omit this
2401 define.
2402
2403 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002404 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002405 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2406 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2407 CONFIG_SYS_NUM_I2C_BUSES = 9:
2408
2409 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2410 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2411 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2412 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2413 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2414 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2415 {1, {I2C_NULL_HOP}}, \
2416 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2417 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2418 }
2419
2420 which defines
2421 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002422 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2423 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2424 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2425 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2426 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002427 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002428 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2429 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002430
2431 If you do not have i2c muxes on your board, omit this define.
2432
Heiko Schocherea818db2013-01-29 08:53:15 +01002433- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002434
2435 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2436 provides the following compelling advantages:
2437
2438 - more than one i2c adapter is usable
2439 - approved multibus support
2440 - better i2c mux support
2441
2442 ** Please consider updating your I2C driver now. **
2443
Heiko Schocherea818db2013-01-29 08:53:15 +01002444 These enable legacy I2C serial bus commands. Defining
2445 CONFIG_HARD_I2C will include the appropriate I2C driver
2446 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002447
wdenk945af8d2003-07-16 21:53:01 +00002448 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002449 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002450 CONFIG_COMMANDS) and communicate with i2c based realtime
2451 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002452 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002453
Ben Warrenbb99ad62006-09-07 16:50:54 -04002454 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002455
wdenk945af8d2003-07-16 21:53:01 +00002456 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002457 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002458
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002459 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002460 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002461 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002462 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002463
Peter Tyser8d321b82010-04-12 22:28:21 -05002464 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002465 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002466 and so its address should therefore be cleared to 0 (See,
2467 eg, MPC823e User's Manual p.16-473). So, set
2468 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002469
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002470 CONFIG_SYS_I2C_INIT_MPC5XXX
2471
2472 When a board is reset during an i2c bus transfer
2473 chips might think that the current transfer is still
2474 in progress. Reset the slave devices by sending start
2475 commands until the slave device responds.
2476
wdenk945af8d2003-07-16 21:53:01 +00002477 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002478
Heiko Schocherea818db2013-01-29 08:53:15 +01002479 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002480 then the following macros need to be defined (examples are
2481 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002482
2483 I2C_INIT
2484
wdenkb37c7e52003-06-30 16:24:52 +00002485 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002486 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002487
wdenkba56f622004-02-06 23:19:44 +00002488 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002489
wdenkc6097192002-11-03 00:24:07 +00002490 I2C_PORT
2491
wdenk43d96162003-03-06 00:02:04 +00002492 (Only for MPC8260 CPU). The I/O port to use (the code
2493 assumes both bits are on the same port). Valid values
2494 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002495
2496 I2C_ACTIVE
2497
2498 The code necessary to make the I2C data line active
2499 (driven). If the data line is open collector, this
2500 define can be null.
2501
wdenkb37c7e52003-06-30 16:24:52 +00002502 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2503
wdenkc6097192002-11-03 00:24:07 +00002504 I2C_TRISTATE
2505
2506 The code necessary to make the I2C data line tri-stated
2507 (inactive). If the data line is open collector, this
2508 define can be null.
2509
wdenkb37c7e52003-06-30 16:24:52 +00002510 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2511
wdenkc6097192002-11-03 00:24:07 +00002512 I2C_READ
2513
York Sun472d5462013-04-01 11:29:11 -07002514 Code that returns true if the I2C data line is high,
2515 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002516
wdenkb37c7e52003-06-30 16:24:52 +00002517 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2518
wdenkc6097192002-11-03 00:24:07 +00002519 I2C_SDA(bit)
2520
York Sun472d5462013-04-01 11:29:11 -07002521 If <bit> is true, sets the I2C data line high. If it
2522 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002523
wdenkb37c7e52003-06-30 16:24:52 +00002524 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002525 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002526 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002527
wdenkc6097192002-11-03 00:24:07 +00002528 I2C_SCL(bit)
2529
York Sun472d5462013-04-01 11:29:11 -07002530 If <bit> is true, sets the I2C clock line high. If it
2531 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002532
wdenkb37c7e52003-06-30 16:24:52 +00002533 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002534 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002535 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002536
wdenkc6097192002-11-03 00:24:07 +00002537 I2C_DELAY
2538
2539 This delay is invoked four times per clock cycle so this
2540 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002541 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002542 like:
2543
wdenkb37c7e52003-06-30 16:24:52 +00002544 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002545
Mike Frysinger793b5722010-07-21 13:38:02 -04002546 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2547
2548 If your arch supports the generic GPIO framework (asm/gpio.h),
2549 then you may alternatively define the two GPIOs that are to be
2550 used as SCL / SDA. Any of the previous I2C_xxx macros will
2551 have GPIO-based defaults assigned to them as appropriate.
2552
2553 You should define these to the GPIO value as given directly to
2554 the generic GPIO functions.
2555
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002556 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002557
wdenk8bde7f72003-06-27 21:31:46 +00002558 When a board is reset during an i2c bus transfer
2559 chips might think that the current transfer is still
2560 in progress. On some boards it is possible to access
2561 the i2c SCLK line directly, either by using the
2562 processor pin as a GPIO or by having a second pin
2563 connected to the bus. If this option is defined a
2564 custom i2c_init_board() routine in boards/xxx/board.c
2565 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002566
Richard Retanubun26a33502010-04-12 15:08:17 -04002567 CONFIG_SYS_I2C_BOARD_LATE_INIT
2568
2569 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2570 defined a custom i2c_board_late_init() routine in
2571 boards/xxx/board.c is run AFTER the operations in i2c_init()
2572 is completed. This callpoint can be used to unreset i2c bus
2573 using CPU i2c controller register accesses for CPUs whose i2c
2574 controller provide such a method. It is called at the end of
2575 i2c_init() to allow i2c_init operations to setup the i2c bus
2576 controller on the CPU (e.g. setting bus speed & slave address).
2577
wdenk17ea1172004-06-06 21:51:03 +00002578 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2579
2580 This option enables configuration of bi_iic_fast[] flags
2581 in u-boot bd_info structure based on u-boot environment
2582 variable "i2cfast". (see also i2cfast)
2583
Ben Warrenbb99ad62006-09-07 16:50:54 -04002584 CONFIG_I2C_MULTI_BUS
2585
2586 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002587 must have a controller. At any point in time, only one bus is
2588 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002589 Note that bus numbering is zero-based.
2590
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002591 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002592
2593 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002594 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002595 is set, specify a list of bus-device pairs. Otherwise, specify
2596 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002597
2598 e.g.
2599 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002600 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002601
2602 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2603
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002604 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002605 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002606
2607 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2608
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002609 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002610
2611 If defined, then this indicates the I2C bus number for DDR SPD.
2612 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002614 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002615
2616 If defined, then this indicates the I2C bus number for the RTC.
2617 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002619 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002620
2621 If defined, then this indicates the I2C bus number for the DTT.
2622 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002624 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002625
2626 If defined, specifies the I2C address of the DTT device.
2627 If not defined, then U-Boot uses predefined value for
2628 specified DTT device.
2629
Andrew Dyer2ac69852008-12-29 17:36:01 -06002630 CONFIG_SOFT_I2C_READ_REPEATED_START
2631
2632 defining this will force the i2c_read() function in
2633 the soft_i2c driver to perform an I2C repeated start
2634 between writing the address pointer and reading the
2635 data. If this define is omitted the default behaviour
2636 of doing a stop-start sequence will be used. Most I2C
2637 devices can use either method, but some require one or
2638 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002639
wdenkc6097192002-11-03 00:24:07 +00002640- SPI Support: CONFIG_SPI
2641
2642 Enables SPI driver (so far only tested with
2643 SPI EEPROM, also an instance works with Crystal A/D and
2644 D/As on the SACSng board)
2645
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002646 CONFIG_SH_SPI
2647
2648 Enables the driver for SPI controller on SuperH. Currently
2649 only SH7757 is supported.
2650
wdenkc6097192002-11-03 00:24:07 +00002651 CONFIG_SOFT_SPI
2652
wdenk43d96162003-03-06 00:02:04 +00002653 Enables a software (bit-bang) SPI driver rather than
2654 using hardware support. This is a general purpose
2655 driver that only requires three general I/O port pins
2656 (two outputs, one input) to function. If this is
2657 defined, the board configuration must define several
2658 SPI configuration items (port pins to use, etc). For
2659 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002660
Ben Warren04a9e112008-01-16 22:37:35 -05002661 CONFIG_HARD_SPI
2662
2663 Enables a hardware SPI driver for general-purpose reads
2664 and writes. As with CONFIG_SOFT_SPI, the board configuration
2665 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002666 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002667 example, see include/configs/mpc8349emds.h.
2668
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002669 CONFIG_MXC_SPI
2670
2671 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002672 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002673
Heiko Schocherf659b572014-07-14 10:22:11 +02002674 CONFIG_SYS_SPI_MXC_WAIT
2675 Timeout for waiting until spi transfer completed.
2676 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2677
Matthias Fuchs01335022007-12-27 17:12:34 +01002678- FPGA Support: CONFIG_FPGA
2679
2680 Enables FPGA subsystem.
2681
2682 CONFIG_FPGA_<vendor>
2683
2684 Enables support for specific chip vendors.
2685 (ALTERA, XILINX)
2686
2687 CONFIG_FPGA_<family>
2688
2689 Enables support for FPGA family.
2690 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2691
2692 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002693
wdenk43d96162003-03-06 00:02:04 +00002694 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002695
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302696 CONFIG_CMD_FPGA_LOADMK
2697
2698 Enable support for fpga loadmk command
2699
Michal Simek67193862014-05-02 13:43:39 +02002700 CONFIG_CMD_FPGA_LOADP
2701
2702 Enable support for fpga loadp command - load partial bitstream
2703
2704 CONFIG_CMD_FPGA_LOADBP
2705
2706 Enable support for fpga loadbp command - load partial bitstream
2707 (Xilinx only)
2708
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002709 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002710
wdenk8bde7f72003-06-27 21:31:46 +00002711 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002712
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002713 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002714
wdenk43d96162003-03-06 00:02:04 +00002715 Enable checks on FPGA configuration interface busy
2716 status by the configuration function. This option
2717 will require a board or device specific function to
2718 be written.
wdenkc6097192002-11-03 00:24:07 +00002719
2720 CONFIG_FPGA_DELAY
2721
2722 If defined, a function that provides delays in the FPGA
2723 configuration driver.
2724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002726 Allow Control-C to interrupt FPGA configuration
2727
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002728 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002729
wdenk43d96162003-03-06 00:02:04 +00002730 Check for configuration errors during FPGA bitfile
2731 loading. For example, abort during Virtex II
2732 configuration if the INIT_B line goes low (which
2733 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002735 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002736
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002737 Maximum time to wait for the INIT_B line to de-assert
2738 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002739 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002740 ms.
wdenkc6097192002-11-03 00:24:07 +00002741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002742 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002743
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002744 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002745 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002746
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002747 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002748
wdenk43d96162003-03-06 00:02:04 +00002749 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002750 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002751
2752- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002753 CONFIG_BUILD_TARGET
2754
2755 Some SoCs need special image types (e.g. U-Boot binary
2756 with a special header) as build targets. By defining
2757 CONFIG_BUILD_TARGET in the SoC / board header, this
2758 special image will be automatically built upon calling
2759 make / MAKEALL.
2760
wdenkc6097192002-11-03 00:24:07 +00002761 CONFIG_IDENT_STRING
2762
wdenk43d96162003-03-06 00:02:04 +00002763 If defined, this string will be added to the U-Boot
2764 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002765
2766- Vendor Parameter Protection:
2767
wdenk43d96162003-03-06 00:02:04 +00002768 U-Boot considers the values of the environment
2769 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002770 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002771 are set once by the board vendor / manufacturer, and
2772 protects these variables from casual modification by
2773 the user. Once set, these variables are read-only,
2774 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002775 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002776
2777 If CONFIG_ENV_OVERWRITE is #defined in your config
2778 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002779 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002780 these parameters.
2781
Joe Hershberger92ac5202015-05-04 14:55:14 -05002782 Alternatively, if you define _both_ an ethaddr in the
2783 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002784 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002785 which can be changed exactly ONCE by the user. [The
2786 serial# is unaffected by this, i. e. it remains
2787 read-only.]
2788
Joe Hershberger25980902012-12-11 22:16:31 -06002789 The same can be accomplished in a more flexible way
2790 for any variable by configuring the type of access
2791 to allow for those variables in the ".flags" variable
2792 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2793
wdenkc6097192002-11-03 00:24:07 +00002794- Protected RAM:
2795 CONFIG_PRAM
2796
2797 Define this variable to enable the reservation of
2798 "protected RAM", i. e. RAM which is not overwritten
2799 by U-Boot. Define CONFIG_PRAM to hold the number of
2800 kB you want to reserve for pRAM. You can overwrite
2801 this default value by defining an environment
2802 variable "pram" to the number of kB you want to
2803 reserve. Note that the board info structure will
2804 still show the full amount of RAM. If pRAM is
2805 reserved, a new environment variable "mem" will
2806 automatically be defined to hold the amount of
2807 remaining RAM in a form that can be passed as boot
2808 argument to Linux, for instance like that:
2809
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002810 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002811 saveenv
2812
2813 This way you can tell Linux not to use this memory,
2814 either, which results in a memory region that will
2815 not be affected by reboots.
2816
2817 *WARNING* If your board configuration uses automatic
2818 detection of the RAM size, you must make sure that
2819 this memory test is non-destructive. So far, the
2820 following board configurations are known to be
2821 "pRAM-clean":
2822
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002823 IVMS8, IVML24, SPD8xx, TQM8xxL,
2824 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002825 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002826
Gabe Black40fef042012-12-02 04:55:18 +00002827- Access to physical memory region (> 4GB)
2828 Some basic support is provided for operations on memory not
2829 normally accessible to U-Boot - e.g. some architectures
2830 support access to more than 4GB of memory on 32-bit
2831 machines using physical address extension or similar.
2832 Define CONFIG_PHYSMEM to access this basic support, which
2833 currently only supports clearing the memory.
2834
wdenkc6097192002-11-03 00:24:07 +00002835- Error Recovery:
2836 CONFIG_PANIC_HANG
2837
2838 Define this variable to stop the system in case of a
2839 fatal error, so that you have to reset it manually.
2840 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002841 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002842 automatically as fast as possible, but it may be
2843 useful during development since you can try to debug
2844 the conditions that lead to the situation.
2845
2846 CONFIG_NET_RETRY_COUNT
2847
wdenk43d96162003-03-06 00:02:04 +00002848 This variable defines the number of retries for
2849 network operations like ARP, RARP, TFTP, or BOOTP
2850 before giving up the operation. If not defined, a
2851 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002852
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002853 CONFIG_ARP_TIMEOUT
2854
2855 Timeout waiting for an ARP reply in milliseconds.
2856
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002857 CONFIG_NFS_TIMEOUT
2858
2859 Timeout in milliseconds used in NFS protocol.
2860 If you encounter "ERROR: Cannot umount" in nfs command,
2861 try longer timeout such as
2862 #define CONFIG_NFS_TIMEOUT 10000UL
2863
wdenkc6097192002-11-03 00:24:07 +00002864- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002865 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002866
2867 Enable auto completion of commands using TAB.
2868
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002869 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002870
2871 This defines the secondary prompt string, which is
2872 printed when the command interpreter needs more input
2873 to complete a command. Usually "> ".
2874
2875 Note:
2876
wdenk8bde7f72003-06-27 21:31:46 +00002877 In the current implementation, the local variables
2878 space and global environment variables space are
2879 separated. Local variables are those you define by
2880 simply typing `name=value'. To access a local
2881 variable later on, you have write `$name' or
2882 `${name}'; to execute the contents of a variable
2883 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002884
wdenk43d96162003-03-06 00:02:04 +00002885 Global environment variables are those you use
2886 setenv/printenv to work with. To run a command stored
2887 in such a variable, you need to use the run command,
2888 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002889
2890 To store commands and special characters in a
2891 variable, please use double quotation marks
2892 surrounding the whole text of the variable, instead
2893 of the backslashes before semicolons and special
2894 symbols.
2895
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002896- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002897 CONFIG_CMDLINE_EDITING
2898
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002899 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002900 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002901
Marek Vasutf3b267b2016-01-27 04:47:55 +01002902- Command Line PS1/PS2 support:
2903 CONFIG_CMDLINE_PS_SUPPORT
2904
2905 Enable support for changing the command prompt string
2906 at run-time. Only static string is supported so far.
2907 The string is obtained from environment variables PS1
2908 and PS2.
2909
wdenka8c7c702003-12-06 19:49:23 +00002910- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002911 CONFIG_EXTRA_ENV_SETTINGS
2912
wdenk43d96162003-03-06 00:02:04 +00002913 Define this to contain any number of null terminated
2914 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002915 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002916
wdenk43d96162003-03-06 00:02:04 +00002917 For example, place something like this in your
2918 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002919
2920 #define CONFIG_EXTRA_ENV_SETTINGS \
2921 "myvar1=value1\0" \
2922 "myvar2=value2\0"
2923
wdenk43d96162003-03-06 00:02:04 +00002924 Warning: This method is based on knowledge about the
2925 internal format how the environment is stored by the
2926 U-Boot code. This is NOT an official, exported
2927 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002928 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002929 You better know what you are doing here.
2930
wdenk43d96162003-03-06 00:02:04 +00002931 Note: overly (ab)use of the default environment is
2932 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002933 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002934 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002935
Stephen Warren5e724ca2012-05-22 09:21:54 +00002936 CONFIG_ENV_VARS_UBOOT_CONFIG
2937
2938 Define this in order to add variables describing the
2939 U-Boot build configuration to the default environment.
2940 These will be named arch, cpu, board, vendor, and soc.
2941
2942 Enabling this option will cause the following to be defined:
2943
2944 - CONFIG_SYS_ARCH
2945 - CONFIG_SYS_CPU
2946 - CONFIG_SYS_BOARD
2947 - CONFIG_SYS_VENDOR
2948 - CONFIG_SYS_SOC
2949
Tom Rini7e27f892012-10-24 07:28:16 +00002950 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2951
2952 Define this in order to add variables describing certain
2953 run-time determined information about the hardware to the
2954 environment. These will be named board_name, board_rev.
2955
Simon Glass06fd8532012-11-30 13:01:17 +00002956 CONFIG_DELAY_ENVIRONMENT
2957
2958 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002959 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002960 that so that the environment is not available until
2961 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2962 this is instead controlled by the value of
2963 /config/load-environment.
2964
Chris Packham3b10cf12015-06-19 20:25:59 +12002965- Parallel Flash support:
2966 CONFIG_SYS_NO_FLASH
2967
Bin Menga1875592016-02-05 19:30:11 -08002968 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham3b10cf12015-06-19 20:25:59 +12002969 flash. This option is used to disable support for parallel NOR
2970 flash. This option should be defined if the board does not have
2971 parallel flash.
2972
2973 If this option is not defined one of the generic flash drivers
2974 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2975 selected or the board must provide an implementation of the
2976 flash API (see include/flash.h).
2977
wdenka8c7c702003-12-06 19:49:23 +00002978- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002979 CONFIG_HAS_DATAFLASH
2980
wdenk8bde7f72003-06-27 21:31:46 +00002981 Defining this option enables DataFlash features and
2982 allows to read/write in Dataflash via the standard
2983 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002984
Eric Nelsonf61ec452012-01-31 10:52:08 -07002985- Serial Flash support
2986 CONFIG_CMD_SF
2987
2988 Defining this option enables SPI flash commands
2989 'sf probe/read/write/erase/update'.
2990
2991 Usage requires an initial 'probe' to define the serial
2992 flash parameters, followed by read/write/erase/update
2993 commands.
2994
2995 The following defaults may be provided by the platform
2996 to handle the common case when only a single serial
2997 flash is present on the system.
2998
2999 CONFIG_SF_DEFAULT_BUS Bus identifier
3000 CONFIG_SF_DEFAULT_CS Chip-select
3001 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
3002 CONFIG_SF_DEFAULT_SPEED in Hz
3003
Simon Glass24007272012-10-08 13:16:02 +00003004 CONFIG_CMD_SF_TEST
3005
3006 Define this option to include a destructive SPI flash
3007 test ('sf test').
3008
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303009 CONFIG_SF_DUAL_FLASH Dual flash memories
3010
3011 Define this option to use dual flash support where two flash
3012 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003013 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303014
wdenk3f85ce22004-02-23 16:11:30 +00003015- SystemACE Support:
3016 CONFIG_SYSTEMACE
3017
3018 Adding this option adds support for Xilinx SystemACE
3019 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003020 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003021 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003022
3023 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003024 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003025
3026 When SystemACE support is added, the "ace" device type
3027 becomes available to the fat commands, i.e. fatls.
3028
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003029- TFTP Fixed UDP Port:
3030 CONFIG_TFTP_PORT
3031
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003032 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003033 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003034 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003035 number generator is used.
3036
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003037 Also, the environment variable tftpdstp is used to supply
3038 the TFTP UDP destination port value. If tftpdstp isn't
3039 defined, the normal port 69 is used.
3040
3041 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003042 blindly start the TFTP transfer using the pre-configured
3043 target IP address and UDP port. This has the effect of
3044 "punching through" the (Windows XP) firewall, allowing
3045 the remainder of the TFTP transfer to proceed normally.
3046 A better solution is to properly configure the firewall,
3047 but sometimes that is not allowed.
3048
Simon Glassbf36c5d2012-12-05 14:46:38 +00003049- Hashing support:
3050 CONFIG_CMD_HASH
3051
3052 This enables a generic 'hash' command which can produce
3053 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3054
3055 CONFIG_HASH_VERIFY
3056
3057 Enable the hash verify command (hash -v). This adds to code
3058 size a little.
3059
gaurav rana94e3c8c2015-02-20 12:51:46 +05303060 CONFIG_SHA1 - This option enables support of hashing using SHA1
3061 algorithm. The hash is calculated in software.
3062 CONFIG_SHA256 - This option enables support of hashing using
3063 SHA256 algorithm. The hash is calculated in software.
3064 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3065 for SHA1/SHA256 hashing.
3066 This affects the 'hash' command and also the
3067 hash_lookup_algo() function.
3068 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3069 hardware-acceleration for SHA1/SHA256 progressive hashing.
3070 Data can be streamed in a block at a time and the hashing
3071 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00003072
3073 Note: There is also a sha1sum command, which should perhaps
3074 be deprecated in favour of 'hash sha1'.
3075
Robert Winklera11f1872013-07-24 17:57:06 -07003076- Freescale i.MX specific commands:
3077 CONFIG_CMD_HDMIDETECT
3078 This enables 'hdmidet' command which returns true if an
3079 HDMI monitor is detected. This command is i.MX 6 specific.
3080
3081 CONFIG_CMD_BMODE
3082 This enables the 'bmode' (bootmode) command for forcing
3083 a boot from specific media.
3084
3085 This is useful for forcing the ROM's usb downloader to
3086 activate upon a watchdog reset which is nice when iterating
3087 on U-Boot. Using the reset button or running bmode normal
3088 will set it back to normal. This command currently
3089 supports i.MX53 and i.MX6.
3090
Heiko Schocher9e50c402014-01-25 07:27:13 +01003091- bootcount support:
3092 CONFIG_BOOTCOUNT_LIMIT
3093
3094 This enables the bootcounter support, see:
3095 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3096
3097 CONFIG_AT91SAM9XE
3098 enable special bootcounter support on at91sam9xe based boards.
3099 CONFIG_BLACKFIN
3100 enable special bootcounter support on blackfin based boards.
3101 CONFIG_SOC_DA8XX
3102 enable special bootcounter support on da850 based boards.
3103 CONFIG_BOOTCOUNT_RAM
3104 enable support for the bootcounter in RAM
3105 CONFIG_BOOTCOUNT_I2C
3106 enable support for the bootcounter on an i2c (like RTC) device.
3107 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3108 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3109 the bootcounter.
3110 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003111
wdenka8c7c702003-12-06 19:49:23 +00003112- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003113 CONFIG_SHOW_BOOT_PROGRESS
3114
wdenk43d96162003-03-06 00:02:04 +00003115 Defining this option allows to add some board-
3116 specific code (calling a user-provided function
3117 "show_boot_progress(int)") that enables you to show
3118 the system's boot progress on some display (for
3119 example, some LED's) on your board. At the moment,
3120 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003121
Simon Glass94fd1312012-09-28 08:56:37 +00003122
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003123Legacy uImage format:
3124
wdenkc6097192002-11-03 00:24:07 +00003125 Arg Where When
3126 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003127 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003128 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003129 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003130 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003131 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003132 4 common/cmd_bootm.c Image data has correct checksum
3133 -4 common/cmd_bootm.c Image is for unsupported architecture
3134 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003135 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003136 6 common/cmd_bootm.c Image Type check OK
3137 -6 common/cmd_bootm.c gunzip uncompression error
3138 -7 common/cmd_bootm.c Unimplemented compression type
3139 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003140 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003141 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003142
3143 9 common/image.c Start initial ramdisk verification
3144 -10 common/image.c Ramdisk header has bad magic number
3145 -11 common/image.c Ramdisk header has bad checksum
3146 10 common/image.c Ramdisk header is OK
3147 -12 common/image.c Ramdisk data has bad checksum
3148 11 common/image.c Ramdisk data has correct checksum
3149 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003150 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003151 13 common/image.c Start multifile image verification
3152 14 common/image.c No initial ramdisk, no multifile, continue.
3153
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003154 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003155
Stefan Roesea47a12b2010-04-15 16:07:28 +02003156 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd542004-02-27 00:07:27 +00003157 -31 post/post.c POST test failed, detected by post_output_backlog()
3158 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003159
Heiko Schocher566a4942007-06-22 19:11:54 +02003160 34 common/cmd_doc.c before loading a Image from a DOC device
3161 -35 common/cmd_doc.c Bad usage of "doc" command
3162 35 common/cmd_doc.c correct usage of "doc" command
3163 -36 common/cmd_doc.c No boot device
3164 36 common/cmd_doc.c correct boot device
3165 -37 common/cmd_doc.c Unknown Chip ID on boot device
3166 37 common/cmd_doc.c correct chip ID found, device available
3167 -38 common/cmd_doc.c Read Error on boot device
3168 38 common/cmd_doc.c reading Image header from DOC device OK
3169 -39 common/cmd_doc.c Image header has bad magic number
3170 39 common/cmd_doc.c Image header has correct magic number
3171 -40 common/cmd_doc.c Error reading Image from DOC device
3172 40 common/cmd_doc.c Image header has correct magic number
3173 41 common/cmd_ide.c before loading a Image from a IDE device
3174 -42 common/cmd_ide.c Bad usage of "ide" command
3175 42 common/cmd_ide.c correct usage of "ide" command
3176 -43 common/cmd_ide.c No boot device
3177 43 common/cmd_ide.c boot device found
3178 -44 common/cmd_ide.c Device not available
3179 44 common/cmd_ide.c Device available
3180 -45 common/cmd_ide.c wrong partition selected
3181 45 common/cmd_ide.c partition selected
3182 -46 common/cmd_ide.c Unknown partition table
3183 46 common/cmd_ide.c valid partition table found
3184 -47 common/cmd_ide.c Invalid partition type
3185 47 common/cmd_ide.c correct partition type
3186 -48 common/cmd_ide.c Error reading Image Header on boot device
3187 48 common/cmd_ide.c reading Image Header from IDE device OK
3188 -49 common/cmd_ide.c Image header has bad magic number
3189 49 common/cmd_ide.c Image header has correct magic number
3190 -50 common/cmd_ide.c Image header has bad checksum
3191 50 common/cmd_ide.c Image header has correct checksum
3192 -51 common/cmd_ide.c Error reading Image from IDE device
3193 51 common/cmd_ide.c reading Image from IDE device OK
3194 52 common/cmd_nand.c before loading a Image from a NAND device
3195 -53 common/cmd_nand.c Bad usage of "nand" command
3196 53 common/cmd_nand.c correct usage of "nand" command
3197 -54 common/cmd_nand.c No boot device
3198 54 common/cmd_nand.c boot device found
3199 -55 common/cmd_nand.c Unknown Chip ID on boot device
3200 55 common/cmd_nand.c correct chip ID found, device available
3201 -56 common/cmd_nand.c Error reading Image Header on boot device
3202 56 common/cmd_nand.c reading Image Header from NAND device OK
3203 -57 common/cmd_nand.c Image header has bad magic number
3204 57 common/cmd_nand.c Image header has correct magic number
3205 -58 common/cmd_nand.c Error reading Image from NAND device
3206 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003207
Heiko Schocher566a4942007-06-22 19:11:54 +02003208 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003209
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003210 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003211 -64 net/eth.c no Ethernet found.
3212 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003213
Heiko Schocher566a4942007-06-22 19:11:54 +02003214 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05003215 80 common/cmd_net.c before calling net_loop()
3216 -81 common/cmd_net.c some error in net_loop() occurred
3217 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02003218 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3219 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003220 83 common/cmd_net.c running "source" command
3221 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003222 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003223
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003224FIT uImage format:
3225
3226 Arg Where When
3227 100 common/cmd_bootm.c Kernel FIT Image has correct format
3228 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3229 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3230 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3231 102 common/cmd_bootm.c Kernel unit name specified
3232 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003233 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003234 104 common/cmd_bootm.c Got kernel subimage node offset
3235 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3236 105 common/cmd_bootm.c Kernel subimage hash verification OK
3237 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3238 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003239 -106 common/cmd_bootm.c Kernel subimage has wrong type
3240 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003241 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3242 108 common/cmd_bootm.c Got kernel subimage data/size
3243 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3244 -109 common/cmd_bootm.c Can't get kernel subimage type
3245 -110 common/cmd_bootm.c Can't get kernel subimage comp
3246 -111 common/cmd_bootm.c Can't get kernel subimage os
3247 -112 common/cmd_bootm.c Can't get kernel subimage load address
3248 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3249
3250 120 common/image.c Start initial ramdisk verification
3251 -120 common/image.c Ramdisk FIT image has incorrect format
3252 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003253 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003254 -122 common/image.c Can't get configuration for ramdisk subimage
3255 123 common/image.c Ramdisk unit name specified
3256 -124 common/image.c Can't get ramdisk subimage node offset
3257 125 common/image.c Got ramdisk subimage node offset
3258 -125 common/image.c Ramdisk subimage hash verification failed
3259 126 common/image.c Ramdisk subimage hash verification OK
3260 -126 common/image.c Ramdisk subimage for unsupported architecture
3261 127 common/image.c Architecture check OK
3262 -127 common/image.c Can't get ramdisk subimage data/size
3263 128 common/image.c Got ramdisk subimage data/size
3264 129 common/image.c Can't get ramdisk load address
3265 -129 common/image.c Got ramdisk load address
3266
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003267 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003268 131 common/cmd_doc.c FIT image format OK
3269
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003270 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003271 141 common/cmd_ide.c FIT image format OK
3272
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003273 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003274 151 common/cmd_nand.c FIT image format OK
3275
Heiko Schocher21d29f72014-05-28 11:33:33 +02003276- legacy image format:
3277 CONFIG_IMAGE_FORMAT_LEGACY
3278 enables the legacy image format support in U-Boot.
3279
3280 Default:
3281 enabled if CONFIG_FIT_SIGNATURE is not defined.
3282
3283 CONFIG_DISABLE_IMAGE_LEGACY
3284 disable the legacy image format
3285
3286 This define is introduced, as the legacy image format is
3287 enabled per default for backward compatibility.
3288
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003289- FIT image support:
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003290 CONFIG_FIT_DISABLE_SHA256
3291 Supporting SHA256 hashes has quite an impact on binary size.
3292 For constrained systems sha256 hash support can be disabled
3293 with this option.
3294
Simon Glass73223f02016-02-22 22:55:43 -07003295 TODO(sjg@chromium.org): Adjust this option to be positive,
3296 and move it to Kconfig
3297
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003298- Standalone program support:
3299 CONFIG_STANDALONE_LOAD_ADDR
3300
Wolfgang Denk6feff892011-10-09 21:06:34 +02003301 This option defines a board specific value for the
3302 address where standalone program gets loaded, thus
3303 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003304 settings.
3305
3306- Frame Buffer Address:
3307 CONFIG_FB_ADDR
3308
3309 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003310 address for frame buffer. This is typically the case
3311 when using a graphics controller has separate video
3312 memory. U-Boot will then place the frame buffer at
3313 the given address instead of dynamically reserving it
3314 in system RAM by calling lcd_setmem(), which grabs
3315 the memory for the frame buffer depending on the
3316 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003317
3318 Please see board_init_f function.
3319
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003320- Automatic software updates via TFTP server
3321 CONFIG_UPDATE_TFTP
3322 CONFIG_UPDATE_TFTP_CNT_MAX
3323 CONFIG_UPDATE_TFTP_MSEC_MAX
3324
3325 These options enable and control the auto-update feature;
3326 for a more detailed description refer to doc/README.update.
3327
3328- MTD Support (mtdparts command, UBI support)
3329 CONFIG_MTD_DEVICE
3330
3331 Adds the MTD device infrastructure from the Linux kernel.
3332 Needed for mtdparts command support.
3333
3334 CONFIG_MTD_PARTITIONS
3335
3336 Adds the MTD partitioning infrastructure from the Linux
3337 kernel. Needed for UBI support.
3338
Joe Hershberger70c219c2013-04-08 10:32:48 +00003339- UBI support
3340 CONFIG_CMD_UBI
3341
3342 Adds commands for interacting with MTD partitions formatted
3343 with the UBI flash translation layer
3344
3345 Requires also defining CONFIG_RBTREE
3346
Joe Hershberger147162d2013-04-08 10:32:49 +00003347 CONFIG_UBI_SILENCE_MSG
3348
3349 Make the verbose messages from UBI stop printing. This leaves
3350 warnings and errors enabled.
3351
Heiko Schocherff94bc42014-06-24 10:10:04 +02003352
3353 CONFIG_MTD_UBI_WL_THRESHOLD
3354 This parameter defines the maximum difference between the highest
3355 erase counter value and the lowest erase counter value of eraseblocks
3356 of UBI devices. When this threshold is exceeded, UBI starts performing
3357 wear leveling by means of moving data from eraseblock with low erase
3358 counter to eraseblocks with high erase counter.
3359
3360 The default value should be OK for SLC NAND flashes, NOR flashes and
3361 other flashes which have eraseblock life-cycle 100000 or more.
3362 However, in case of MLC NAND flashes which typically have eraseblock
3363 life-cycle less than 10000, the threshold should be lessened (e.g.,
3364 to 128 or 256, although it does not have to be power of 2).
3365
3366 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003367
Heiko Schocherff94bc42014-06-24 10:10:04 +02003368 CONFIG_MTD_UBI_BEB_LIMIT
3369 This option specifies the maximum bad physical eraseblocks UBI
3370 expects on the MTD device (per 1024 eraseblocks). If the
3371 underlying flash does not admit of bad eraseblocks (e.g. NOR
3372 flash), this value is ignored.
3373
3374 NAND datasheets often specify the minimum and maximum NVM
3375 (Number of Valid Blocks) for the flashes' endurance lifetime.
3376 The maximum expected bad eraseblocks per 1024 eraseblocks
3377 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3378 which gives 20 for most NANDs (MaxNVB is basically the total
3379 count of eraseblocks on the chip).
3380
3381 To put it differently, if this value is 20, UBI will try to
3382 reserve about 1.9% of physical eraseblocks for bad blocks
3383 handling. And that will be 1.9% of eraseblocks on the entire
3384 NAND chip, not just the MTD partition UBI attaches. This means
3385 that if you have, say, a NAND flash chip admits maximum 40 bad
3386 eraseblocks, and it is split on two MTD partitions of the same
3387 size, UBI will reserve 40 eraseblocks when attaching a
3388 partition.
3389
3390 default: 20
3391
3392 CONFIG_MTD_UBI_FASTMAP
3393 Fastmap is a mechanism which allows attaching an UBI device
3394 in nearly constant time. Instead of scanning the whole MTD device it
3395 only has to locate a checkpoint (called fastmap) on the device.
3396 The on-flash fastmap contains all information needed to attach
3397 the device. Using fastmap makes only sense on large devices where
3398 attaching by scanning takes long. UBI will not automatically install
3399 a fastmap on old images, but you can set the UBI parameter
3400 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3401 that fastmap-enabled images are still usable with UBI implementations
3402 without fastmap support. On typical flash devices the whole fastmap
3403 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3404
3405 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3406 Set this parameter to enable fastmap automatically on images
3407 without a fastmap.
3408 default: 0
3409
Heiko Schocher0195a7b2015-10-22 06:19:21 +02003410 CONFIG_MTD_UBI_FM_DEBUG
3411 Enable UBI fastmap debug
3412 default: 0
3413
Joe Hershberger70c219c2013-04-08 10:32:48 +00003414- UBIFS support
3415 CONFIG_CMD_UBIFS
3416
3417 Adds commands for interacting with UBI volumes formatted as
3418 UBIFS. UBIFS is read-only in u-boot.
3419
3420 Requires UBI support as well as CONFIG_LZO
3421
Joe Hershberger147162d2013-04-08 10:32:49 +00003422 CONFIG_UBIFS_SILENCE_MSG
3423
3424 Make the verbose messages from UBIFS stop printing. This leaves
3425 warnings and errors enabled.
3426
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003427- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003428 CONFIG_SPL
3429 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003430
Tom Rini95579792012-02-14 07:29:40 +00003431 CONFIG_SPL_LDSCRIPT
3432 LDSCRIPT for linking the SPL binary.
3433
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003434 CONFIG_SPL_MAX_FOOTPRINT
3435 Maximum size in memory allocated to the SPL, BSS included.
3436 When defined, the linker checks that the actual memory
3437 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003438 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003439 must not be both defined at the same time.
3440
Tom Rini95579792012-02-14 07:29:40 +00003441 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003442 Maximum size of the SPL image (text, data, rodata, and
3443 linker lists sections), BSS excluded.
3444 When defined, the linker checks that the actual size does
3445 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003446
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003447 CONFIG_SPL_TEXT_BASE
3448 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003449
Scott Wood94a45bb2012-09-20 19:05:12 -05003450 CONFIG_SPL_RELOC_TEXT_BASE
3451 Address to relocate to. If unspecified, this is equal to
3452 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3453
Tom Rini95579792012-02-14 07:29:40 +00003454 CONFIG_SPL_BSS_START_ADDR
3455 Link address for the BSS within the SPL binary.
3456
3457 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003458 Maximum size in memory allocated to the SPL BSS.
3459 When defined, the linker checks that the actual memory used
3460 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003461 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003462 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003463
3464 CONFIG_SPL_STACK
3465 Adress of the start of the stack SPL will use
3466
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02003467 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3468 When defined, SPL will panic() if the image it has
3469 loaded does not have a signature.
3470 Defining this is useful when code which loads images
3471 in SPL cannot guarantee that absolutely all read errors
3472 will be caught.
3473 An example is the LPC32XX MLC NAND driver, which will
3474 consider that a completely unreadable NAND block is bad,
3475 and thus should be skipped silently.
3476
Marek Vasute0727512016-04-29 00:44:55 +02003477 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3478 When defined, SPL will proceed to another boot method
3479 if the image it has loaded does not have a signature.
3480
Scott Wood94a45bb2012-09-20 19:05:12 -05003481 CONFIG_SPL_RELOC_STACK
3482 Adress of the start of the stack SPL will use after
3483 relocation. If unspecified, this is equal to
3484 CONFIG_SPL_STACK.
3485
Tom Rini95579792012-02-14 07:29:40 +00003486 CONFIG_SYS_SPL_MALLOC_START
3487 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02003488 When this option is set the full malloc is used in SPL and
3489 it is set up by spl_init() and before that, the simple malloc()
3490 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00003491
3492 CONFIG_SYS_SPL_MALLOC_SIZE
3493 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003494
Tom Rini47f7bca2012-08-13 12:03:19 -07003495 CONFIG_SPL_FRAMEWORK
3496 Enable the SPL framework under common/. This framework
3497 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3498 NAND loading of the Linux Kernel.
3499
Tom Rini9607faf2014-03-28 12:03:39 -04003500 CONFIG_SPL_OS_BOOT
3501 Enable booting directly to an OS from SPL.
3502 See also: doc/README.falcon
3503
Tom Rini861a86f2012-08-13 11:37:56 -07003504 CONFIG_SPL_DISPLAY_PRINT
3505 For ARM, enable an optional function to print more information
3506 about the running system.
3507
Scott Wood4b919722012-09-20 16:35:21 -05003508 CONFIG_SPL_INIT_MINIMAL
3509 Arch init code should be built for a very small image
3510
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003511 CONFIG_SPL_LIBCOMMON_SUPPORT
3512 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003513
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003514 CONFIG_SPL_LIBDISK_SUPPORT
3515 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003516
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003517 CONFIG_SPL_I2C_SUPPORT
3518 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003519
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003520 CONFIG_SPL_GPIO_SUPPORT
3521 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003522
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003523 CONFIG_SPL_MMC_SUPPORT
3524 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003525
Tom Rini95579792012-02-14 07:29:40 +00003526 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3527 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003528 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003529 when the MMC is being used in raw mode.
3530
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003531 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3532 Partition on the MMC to load U-Boot from when the MMC is being
3533 used in raw mode
3534
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003535 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3536 Sector to load kernel uImage from when MMC is being
3537 used in raw mode (for Falcon mode)
3538
3539 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3540 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3541 Sector and number of sectors to load kernel argument
3542 parameters from when MMC is being used in raw mode
3543 (for falcon mode)
3544
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003545 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3546 Partition on the MMC to load U-Boot from when the MMC is being
3547 used in fs mode
3548
Tom Rini95579792012-02-14 07:29:40 +00003549 CONFIG_SPL_FAT_SUPPORT
3550 Support for fs/fat/libfat.o in SPL binary
3551
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003552 CONFIG_SPL_EXT_SUPPORT
3553 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003554
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003555 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3556 Filename to read to load U-Boot when reading from filesystem
3557
3558 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003559 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003560 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003561
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003562 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003563 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003564 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003565
Scott Wood06f60ae2012-12-06 13:33:17 +00003566 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3567 Set this for NAND SPL on PPC mpc83xx targets, so that
3568 start.S waits for the rest of the SPL to load before
3569 continuing (the hardware starts execution after just
3570 loading the first page rather than the full 4K).
3571
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303572 CONFIG_SPL_SKIP_RELOCATE
3573 Avoid SPL relocation
3574
Scott Wood6f2f01b2012-09-20 19:09:07 -05003575 CONFIG_SPL_NAND_BASE
3576 Include nand_base.c in the SPL. Requires
3577 CONFIG_SPL_NAND_DRIVERS.
3578
3579 CONFIG_SPL_NAND_DRIVERS
3580 SPL uses normal NAND drivers, not minimal drivers.
3581
3582 CONFIG_SPL_NAND_ECC
3583 Include standard software ECC in the SPL
3584
Tom Rini95579792012-02-14 07:29:40 +00003585 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003586 Support for NAND boot using simple NAND drivers that
3587 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003588
Thomas Gleixner6f4e7d32016-07-12 20:28:12 +02003589 CONFIG_SPL_UBI
3590 Support for a lightweight UBI (fastmap) scanner and
3591 loader
3592
Tom Rini6dd3b562014-03-28 12:03:36 -04003593 CONFIG_SPL_MTD_SUPPORT
3594 Support for the MTD subsystem within SPL. Useful for
3595 environment on NAND support within SPL.
3596
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003597 CONFIG_SPL_NAND_RAW_ONLY
3598 Support to boot only raw u-boot.bin images. Use this only
3599 if you need to save space.
3600
Ying Zhangbb0dc102013-08-16 15:16:11 +08003601 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3602 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003603 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003604
Ying Zhang7c8eea52013-08-16 15:16:12 +08003605 CONFIG_SPL_COMMON_INIT_DDR
3606 Set for common ddr init with serial presence detect in
3607 SPL binary.
3608
Tom Rini95579792012-02-14 07:29:40 +00003609 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3610 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3611 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3612 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3613 CONFIG_SYS_NAND_ECCBYTES
3614 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003615 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003616
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303617 CONFIG_SPL_NAND_BOOT
3618 Add support NAND boot
3619
Tom Rini95579792012-02-14 07:29:40 +00003620 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003621 Location in NAND to read U-Boot from
3622
3623 CONFIG_SYS_NAND_U_BOOT_DST
3624 Location in memory to load U-Boot to
3625
3626 CONFIG_SYS_NAND_U_BOOT_SIZE
3627 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003628
3629 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003630 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003631
3632 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3633 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003634 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003635
3636 CONFIG_SPL_OMAP3_ID_NAND
3637 Support for an OMAP3-specific set of functions to return the
3638 ID and MFR of the first attached NAND chip, if present.
3639
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003640 CONFIG_SPL_SERIAL_SUPPORT
3641 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003642
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003643 CONFIG_SPL_SPI_FLASH_SUPPORT
3644 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003645
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003646 CONFIG_SPL_SPI_SUPPORT
3647 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003648
Pavel Machekc57b9532012-08-30 22:42:11 +02003649 CONFIG_SPL_RAM_DEVICE
3650 Support for running image already present in ram, in SPL binary
3651
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003652 CONFIG_SPL_LIBGENERIC_SUPPORT
3653 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003654
Ying Zhangba1bee42013-05-20 14:07:25 +08003655 CONFIG_SPL_ENV_SUPPORT
3656 Support for the environment operating in SPL binary
3657
3658 CONFIG_SPL_NET_SUPPORT
3659 Support for the net/libnet.o in SPL binary.
3660 It conflicts with SPL env from storage medium specified by
3661 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3662
Scott Wood74752ba2012-12-06 13:33:16 +00003663 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003664 Image offset to which the SPL should be padded before appending
3665 the SPL payload. By default, this is defined as
3666 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3667 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3668 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003669
Scott Woodca2fca22012-09-21 16:27:32 -05003670 CONFIG_SPL_TARGET
3671 Final target image containing SPL and payload. Some SPLs
3672 use an arch-specific makefile fragment instead, for
3673 example if more than one image needs to be produced.
3674
Simon Glass87ebee32013-05-08 08:05:59 +00003675 CONFIG_FIT_SPL_PRINT
3676 Printing information about a FIT image adds quite a bit of
3677 code to SPL. So this is normally disabled in SPL. Use this
3678 option to re-enable it. This will affect the output of the
3679 bootm command when booting a FIT image.
3680
Ying Zhang3aa29de2013-08-16 15:16:15 +08003681- TPL framework
3682 CONFIG_TPL
3683 Enable building of TPL globally.
3684
3685 CONFIG_TPL_PAD_TO
3686 Image offset to which the TPL should be padded before appending
3687 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003688 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3689 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3690 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003691
wdenka8c7c702003-12-06 19:49:23 +00003692- Interrupt support (PPC):
3693
wdenkd4ca31c2004-01-02 14:00:00 +00003694 There are common interrupt_init() and timer_interrupt()
3695 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003696 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003697 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003698 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003699 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003700 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003701 specific handling. If board has watchdog / status_led
3702 / other_activity_monitor it works automatically from
3703 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003704
wdenkc6097192002-11-03 00:24:07 +00003705
Helmut Raiger9660e442011-10-20 04:19:47 +00003706Board initialization settings:
3707------------------------------
3708
3709During Initialization u-boot calls a number of board specific functions
3710to allow the preparation of board specific prerequisites, e.g. pin setup
3711before drivers are initialized. To enable these callbacks the
3712following configuration macros have to be defined. Currently this is
3713architecture specific, so please check arch/your_architecture/lib/board.c
3714typically in board_init_f() and board_init_r().
3715
3716- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3717- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3718- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3719- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003720
wdenkc6097192002-11-03 00:24:07 +00003721Configuration Settings:
3722-----------------------
3723
York Sun4d1fd7f2014-02-26 17:03:19 -08003724- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3725 Optionally it can be defined to support 64-bit memory commands.
3726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003727- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003728 undefine this when you're short of memory.
3729
Peter Tyser2fb26042009-01-27 18:03:12 -06003730- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3731 width of the commands listed in the 'help' command output.
3732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003733- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003734 prompt for user input.
3735
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003736- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003737
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003738- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003739
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003740- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003742- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003743 the application (usually a Linux kernel) when it is
3744 booted
3745
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003746- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003747 List of legal baudrate settings for this board.
3748
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003749- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003750 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003752- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003753 If the board specific function
3754 extern int overwrite_console (void);
3755 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003756 serial port, else the settings in the environment are used.
3757
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003758- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003759 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003760
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003761- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003762 Enable overwrite of previous console environment settings.
3763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003764- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003765 Begin and End addresses of the area used by the
3766 simple memory test.
3767
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003768- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003769 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003770
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003771- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003772 Scratch address used by the alternate memory test
3773 You only need to set this if address zero isn't writeable
3774
York Sune8149522015-12-04 11:57:07 -08003775- CONFIG_SYS_MEM_RESERVE_SECURE
York Sune61a7532016-06-24 16:46:18 -07003776 Only implemented for ARMv8 for now.
York Sune8149522015-12-04 11:57:07 -08003777 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3778 is substracted from total RAM and won't be reported to OS.
3779 This memory can be used as secure memory. A variable
York Sune61a7532016-06-24 16:46:18 -07003780 gd->arch.secure_ram is used to track the location. In systems
York Sune8149522015-12-04 11:57:07 -08003781 the RAM base is not zero, or RAM is divided into banks,
3782 this variable needs to be recalcuated to get the address.
3783
York Sunaabd7dd2015-12-07 11:05:29 -08003784- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003785 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003786 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003787 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003788 fixing up gd->ram_size the Linux kernel should gets passed
3789 the now "corrected" memory size and won't touch it either.
3790 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003791 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003792 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003793 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003794
3795 This option can be used as a workaround for the 440EPx/GRx
3796 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3797 be touched.
3798
3799 WARNING: Please make sure that this value is a multiple of
3800 the Linux page size (normally 4k). If this is not the case,
3801 then the end address of the Linux memory will be located at a
3802 non page size aligned address and this could cause major
3803 problems.
3804
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003805- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003806 Enable temporary baudrate change while serial download
3807
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003808- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003809 Physical start address of SDRAM. _Must_ be 0 here.
3810
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003811- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003812 Physical start address of Motherboard I/O (if using a
3813 Cogent motherboard)
3814
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003815- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003816 Physical start address of Flash memory.
3817
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003818- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003819 Physical start address of boot monitor code (set by
3820 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003821 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003822 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003823
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003824- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003825 Size of memory reserved for monitor code, used to
3826 determine _at_compile_time_ (!) if the environment is
3827 embedded within the U-Boot image, or in a separate
3828 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003829
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003830- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003831 Size of DRAM reserved for malloc() use.
3832
Simon Glassd59476b2014-07-10 22:23:28 -06003833- CONFIG_SYS_MALLOC_F_LEN
3834 Size of the malloc() pool for use before relocation. If
3835 this is defined, then a very simple malloc() implementation
3836 will become available before relocation. The address is just
3837 below the global data, and the stack is moved down to make
3838 space.
3839
3840 This feature allocates regions with increasing addresses
3841 within the region. calloc() is supported, but realloc()
3842 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003843 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003844 U-Boot relocates itself.
3845
Simon Glass38687ae2014-11-10 17:16:54 -07003846- CONFIG_SYS_MALLOC_SIMPLE
3847 Provides a simple and small malloc() and calloc() for those
3848 boards which do not use the full malloc in SPL (which is
3849 enabled with CONFIG_SYS_SPL_MALLOC_START).
3850
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003851- CONFIG_SYS_NONCACHED_MEMORY:
3852 Size of non-cached memory area. This area of memory will be
3853 typically located right below the malloc() area and mapped
3854 uncached in the MMU. This is useful for drivers that would
3855 otherwise require a lot of explicit cache maintenance. For
3856 some drivers it's also impossible to properly maintain the
3857 cache. For example if the regions that need to be flushed
3858 are not a multiple of the cache-line size, *and* padding
3859 cannot be allocated between the regions to align them (i.e.
3860 if the HW requires a contiguous array of regions, and the
3861 size of each region is not cache-aligned), then a flush of
3862 one region may result in overwriting data that hardware has
3863 written to another region in the same cache-line. This can
3864 happen for example in network drivers where descriptors for
3865 buffers are typically smaller than the CPU cache-line (e.g.
3866 16 bytes vs. 32 or 64 bytes).
3867
3868 Non-cached memory is only supported on 32-bit ARM at present.
3869
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003870- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003871 Normally compressed uImages are limited to an
3872 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003873 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003874 to adjust this setting to your needs.
3875
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003876- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003877 Maximum size of memory mapped by the startup code of
3878 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003879 the Linux kernel (bd_info, boot arguments, FDT blob if
3880 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003881 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003882 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003883 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003884 variable "bootm_mapsize" will override the value of
3885 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3886 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003887
John Rigbyfca43cc2010-10-13 13:57:35 -06003888- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3889 Enable initrd_high functionality. If defined then the
3890 initrd_high feature is enabled and the bootm ramdisk subcommand
3891 is enabled.
3892
3893- CONFIG_SYS_BOOT_GET_CMDLINE:
3894 Enables allocating and saving kernel cmdline in space between
3895 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3896
3897- CONFIG_SYS_BOOT_GET_KBD:
3898 Enables allocating and saving a kernel copy of the bd_info in
3899 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3900
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003901- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003902 Max number of Flash memory banks
3903
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003904- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003905 Max number of sectors on a Flash chip
3906
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003907- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003908 Timeout for Flash erase operations (in ms)
3909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003910- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003911 Timeout for Flash write operations (in ms)
3912
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003913- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003914 Timeout for Flash set sector lock bit operation (in ms)
3915
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003916- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003917 Timeout for Flash clear lock bits operation (in ms)
3918
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003919- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003920 If defined, hardware flash sectors protection is used
3921 instead of U-Boot software protection.
3922
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003923- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003924
3925 Enable TFTP transfers directly to flash memory;
3926 without this option such a download has to be
3927 performed in two steps: (1) download to RAM, and (2)
3928 copy from RAM to flash.
3929
3930 The two-step approach is usually more reliable, since
3931 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003932 the flash, but in some situations (when system RAM is
3933 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003934 downloaded image) this option may be very useful.
3935
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003936- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003937 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003938 common flash structure for storing flash geometry.
3939
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003940- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003941 This option also enables the building of the cfi_flash driver
3942 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003943
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003944- CONFIG_FLASH_CFI_MTD
3945 This option enables the building of the cfi_mtd driver
3946 in the drivers directory. The driver exports CFI flash
3947 to the MTD layer.
3948
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003949- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003950 Use buffered writes to flash.
3951
3952- CONFIG_FLASH_SPANSION_S29WS_N
3953 s29ws-n MirrorBit flash has non-standard addresses for buffered
3954 write commands.
3955
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003956- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003957 If this option is defined, the common CFI flash doesn't
3958 print it's warning upon not recognized FLASH banks. This
3959 is useful, if some of the configured banks are only
3960 optionally available.
3961
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003962- CONFIG_FLASH_SHOW_PROGRESS
3963 If defined (must be an integer), print out countdown
3964 digits and dots. Recommended value: 45 (9..1) for 80
3965 column displays, 15 (3..1) for 40 column displays.
3966
Stefan Roese352ef3f2013-04-04 15:53:14 +02003967- CONFIG_FLASH_VERIFY
3968 If defined, the content of the flash (destination) is compared
3969 against the source after the write operation. An error message
3970 will be printed when the contents are not identical.
3971 Please note that this option is useless in nearly all cases,
3972 since such flash programming errors usually are detected earlier
3973 while unprotecting/erasing/programming. Please only enable
3974 this option if you really know what you are doing.
3975
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003976- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003977 Defines the number of Ethernet receive buffers. On some
3978 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003979 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3980 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003981 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003982 Defaults to 4 if not defined.
3983
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003984- CONFIG_ENV_MAX_ENTRIES
3985
Wolfgang Denk071bc922010-10-27 22:48:30 +02003986 Maximum number of entries in the hash table that is used
3987 internally to store the environment settings. The default
3988 setting is supposed to be generous and should work in most
3989 cases. This setting can be used to tune behaviour; see
3990 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003991
Joe Hershberger25980902012-12-11 22:16:31 -06003992- CONFIG_ENV_FLAGS_LIST_DEFAULT
3993- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003994 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003995 calling env set. Variables can be restricted to only decimal,
3996 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3997 the variables can also be restricted to IP address or MAC address.
3998
3999 The format of the list is:
4000 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004001 access_attribute = [a|r|o|c]
4002 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06004003 entry = variable_name[:attributes]
4004 list = entry[,list]
4005
4006 The type attributes are:
4007 s - String (default)
4008 d - Decimal
4009 x - Hexadecimal
4010 b - Boolean ([1yYtT|0nNfF])
4011 i - IP address
4012 m - MAC address
4013
Joe Hershberger267541f2012-12-11 22:16:34 -06004014 The access attributes are:
4015 a - Any (default)
4016 r - Read-only
4017 o - Write-once
4018 c - Change-default
4019
Joe Hershberger25980902012-12-11 22:16:31 -06004020 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4021 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004022 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004023
4024 - CONFIG_ENV_FLAGS_LIST_STATIC
4025 Define this to a list (string) to define validation that
4026 should be done if an entry is not found in the ".flags"
4027 environment variable. To override a setting in the static
4028 list, simply add an entry for the same variable name to the
4029 ".flags" variable.
4030
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004031 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4032 regular expression. This allows multiple variables to define the same
4033 flags without explicitly listing them for each variable.
4034
Joe Hershberger267541f2012-12-11 22:16:34 -06004035- CONFIG_ENV_ACCESS_IGNORE_FORCE
4036 If defined, don't allow the -f switch to env set override variable
4037 access flags.
4038
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004039- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4040 This is set by OMAP boards for the max time that reset should
4041 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004042 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004043
Gabe Black0d296cc2014-10-15 04:38:30 -06004044- CONFIG_USE_STDINT
4045 If stdint.h is available with your toolchain you can define this
4046 option to enable it. You can provide option 'USE_STDINT=1' when
4047 building U-Boot to enable this.
4048
wdenkc6097192002-11-03 00:24:07 +00004049The following definitions that deal with the placement and management
4050of environment data (variable area); in general, we support the
4051following configurations:
4052
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004053- CONFIG_BUILD_ENVCRC:
4054
4055 Builds up envcrc with the target environment so that external utils
4056 may easily extract it and embed it in final U-Boot images.
4057
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004058- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004059
4060 Define this if the environment is in flash memory.
4061
4062 a) The environment occupies one whole flash sector, which is
4063 "embedded" in the text segment with the U-Boot code. This
4064 happens usually with "bottom boot sector" or "top boot
4065 sector" type flash chips, which have several smaller
4066 sectors at the start or the end. For instance, such a
4067 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4068 such a case you would place the environment in one of the
4069 4 kB sectors - with U-Boot code before and after it. With
4070 "top boot sector" type flash chips, you would put the
4071 environment in one of the last sectors, leaving a gap
4072 between U-Boot and the environment.
4073
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004074 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004075
4076 Offset of environment data (variable area) to the
4077 beginning of flash memory; for instance, with bottom boot
4078 type flash chips the second sector can be used: the offset
4079 for this sector is given here.
4080
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004081 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004082
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004083 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004084
4085 This is just another way to specify the start address of
4086 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004087 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004088
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004089 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004090
4091 Size of the sector containing the environment.
4092
4093
4094 b) Sometimes flash chips have few, equal sized, BIG sectors.
4095 In such a case you don't want to spend a whole sector for
4096 the environment.
4097
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004098 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004099
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004100 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004101 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004102 of this flash sector for the environment. This saves
4103 memory for the RAM copy of the environment.
4104
4105 It may also save flash memory if you decide to use this
4106 when your environment is "embedded" within U-Boot code,
4107 since then the remainder of the flash sector could be used
4108 for U-Boot code. It should be pointed out that this is
4109 STRONGLY DISCOURAGED from a robustness point of view:
4110 updating the environment in flash makes it always
4111 necessary to erase the WHOLE sector. If something goes
4112 wrong before the contents has been restored from a copy in
4113 RAM, your target system will be dead.
4114
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004115 - CONFIG_ENV_ADDR_REDUND
4116 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004117
wdenk43d96162003-03-06 00:02:04 +00004118 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004119 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004120 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004121 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004122
4123BE CAREFUL! Any changes to the flash layout, and some changes to the
4124source code will make it necessary to adapt <board>/u-boot.lds*
4125accordingly!
4126
4127
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004128- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004129
4130 Define this if you have some non-volatile memory device
4131 (NVRAM, battery buffered SRAM) which you want to use for the
4132 environment.
4133
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004134 - CONFIG_ENV_ADDR:
4135 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004136
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004137 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004138 want to use for environment. It is assumed that this memory
4139 can just be read and written to, without any special
4140 provision.
4141
4142BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004143in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004144console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004145U-Boot will hang.
4146
4147Please note that even with NVRAM we still use a copy of the
4148environment in RAM: we could work on NVRAM directly, but we want to
4149keep settings there always unmodified except somebody uses "saveenv"
4150to save the current settings.
4151
4152
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004153- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004154
4155 Use this if you have an EEPROM or similar serial access
4156 device and a driver for it.
4157
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004158 - CONFIG_ENV_OFFSET:
4159 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004160
4161 These two #defines specify the offset and size of the
4162 environment area within the total memory of your EEPROM.
4163
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004164 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004165 If defined, specified the chip address of the EEPROM device.
4166 The default address is zero.
4167
Christian Gmeiner189d2572015-02-11 15:19:31 +01004168 - CONFIG_SYS_I2C_EEPROM_BUS:
4169 If defined, specified the i2c bus of the EEPROM device.
4170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004171 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004172 If defined, the number of bits used to address bytes in a
4173 single page in the EEPROM device. A 64 byte page, for example
4174 would require six bits.
4175
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004176 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004177 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004178 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004179
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004180 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004181 The length in bytes of the EEPROM memory array address. Note
4182 that this is NOT the chip address length!
4183
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004184 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004185 EEPROM chips that implement "address overflow" are ones
4186 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4187 address and the extra bits end up in the "chip address" bit
4188 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4189 byte chips.
4190
4191 Note that we consider the length of the address field to
4192 still be one byte because the extra address bits are hidden
4193 in the chip address.
4194
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004195 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004196 The size in bytes of the EEPROM device.
4197
Heiko Schocher548738b2010-01-07 08:55:40 +01004198 - CONFIG_ENV_EEPROM_IS_ON_I2C
4199 define this, if you have I2C and SPI activated, and your
4200 EEPROM, which holds the environment, is on the I2C bus.
4201
4202 - CONFIG_I2C_ENV_EEPROM_BUS
4203 if you have an Environment on an EEPROM reached over
4204 I2C muxes, you can define here, how to reach this
4205 EEPROM. For example:
4206
Heiko Schocherea818db2013-01-29 08:53:15 +01004207 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004208
4209 EEPROM which holds the environment, is reached over
4210 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004211
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004212- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004213
wdenkd4ca31c2004-01-02 14:00:00 +00004214 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004215 want to use for the environment.
4216
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004217 - CONFIG_ENV_OFFSET:
4218 - CONFIG_ENV_ADDR:
4219 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004220
4221 These three #defines specify the offset and size of the
4222 environment area within the total memory of your DataFlash placed
4223 at the specified address.
4224
Wu, Joshbd83b592014-07-01 19:30:13 +08004225- CONFIG_ENV_IS_IN_SPI_FLASH:
4226
4227 Define this if you have a SPI Flash memory device which you
4228 want to use for the environment.
4229
4230 - CONFIG_ENV_OFFSET:
4231 - CONFIG_ENV_SIZE:
4232
4233 These two #defines specify the offset and size of the
4234 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4235 aligned to an erase sector boundary.
4236
4237 - CONFIG_ENV_SECT_SIZE:
4238
4239 Define the SPI flash's sector size.
4240
4241 - CONFIG_ENV_OFFSET_REDUND (optional):
4242
4243 This setting describes a second storage area of CONFIG_ENV_SIZE
4244 size used to hold a redundant copy of the environment data, so
4245 that there is a valid backup copy in case there is a power failure
4246 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4247 aligned to an erase sector boundary.
4248
4249 - CONFIG_ENV_SPI_BUS (optional):
4250 - CONFIG_ENV_SPI_CS (optional):
4251
4252 Define the SPI bus and chip select. If not defined they will be 0.
4253
4254 - CONFIG_ENV_SPI_MAX_HZ (optional):
4255
4256 Define the SPI max work clock. If not defined then use 1MHz.
4257
4258 - CONFIG_ENV_SPI_MODE (optional):
4259
4260 Define the SPI work mode. If not defined then use SPI_MODE_3.
4261
Liu Gang0a85a9e2012-03-08 00:33:20 +00004262- CONFIG_ENV_IS_IN_REMOTE:
4263
4264 Define this if you have a remote memory space which you
4265 want to use for the local device's environment.
4266
4267 - CONFIG_ENV_ADDR:
4268 - CONFIG_ENV_SIZE:
4269
4270 These two #defines specify the address and size of the
4271 environment area within the remote memory space. The
4272 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004273 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004274
4275BE CAREFUL! For some special cases, the local device can not use
4276"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004277environment stored in a remote NOR flash by SRIO or PCIE link,
4278but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004279
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004280- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004281
4282 Define this if you have a NAND device which you want to use
4283 for the environment.
4284
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004285 - CONFIG_ENV_OFFSET:
4286 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004287
4288 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004289 area within the first NAND device. CONFIG_ENV_OFFSET must be
4290 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004291
Scott Woodfdd813d2010-09-17 14:38:37 -05004292 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004293
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004294 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004295 size used to hold a redundant copy of the environment data, so
4296 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004297 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004298 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004299
Scott Woodfdd813d2010-09-17 14:38:37 -05004300 - CONFIG_ENV_RANGE (optional):
4301
4302 Specifies the length of the region in which the environment
4303 can be written. This should be a multiple of the NAND device's
4304 block size. Specifying a range with more erase blocks than
4305 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4306 the range to be avoided.
4307
4308 - CONFIG_ENV_OFFSET_OOB (optional):
4309
4310 Enables support for dynamically retrieving the offset of the
4311 environment from block zero's out-of-band data. The
4312 "nand env.oob" command can be used to record this offset.
4313 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4314 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004315
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004316- CONFIG_NAND_ENV_DST
4317
4318 Defines address in RAM to which the nand_spl code should copy the
4319 environment. If redundant environment is used, it will be copied to
4320 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4321
Joe Hershberger2b744332013-04-08 10:32:51 +00004322- CONFIG_ENV_IS_IN_UBI:
4323
4324 Define this if you have an UBI volume that you want to use for the
4325 environment. This has the benefit of wear-leveling the environment
4326 accesses, which is important on NAND.
4327
4328 - CONFIG_ENV_UBI_PART:
4329
4330 Define this to a string that is the mtd partition containing the UBI.
4331
4332 - CONFIG_ENV_UBI_VOLUME:
4333
4334 Define this to the name of the volume that you want to store the
4335 environment in.
4336
Joe Hershberger785881f2013-04-08 10:32:52 +00004337 - CONFIG_ENV_UBI_VOLUME_REDUND:
4338
4339 Define this to the name of another volume to store a second copy of
4340 the environment in. This will enable redundant environments in UBI.
4341 It is assumed that both volumes are in the same MTD partition.
4342
Joe Hershberger2b744332013-04-08 10:32:51 +00004343 - CONFIG_UBI_SILENCE_MSG
4344 - CONFIG_UBIFS_SILENCE_MSG
4345
4346 You will probably want to define these to avoid a really noisy system
4347 when storing the env in UBI.
4348
Wu, Joshd1db76f2014-06-24 17:31:03 +08004349- CONFIG_ENV_IS_IN_FAT:
4350 Define this if you want to use the FAT file system for the environment.
4351
4352 - FAT_ENV_INTERFACE:
4353
4354 Define this to a string that is the name of the block device.
4355
4356 - FAT_ENV_DEV_AND_PART:
4357
4358 Define this to a string to specify the partition of the device. It can
4359 be as following:
4360
4361 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4362 - "D:P": device D partition P. Error occurs if device D has no
4363 partition table.
4364 - "D:0": device D.
4365 - "D" or "D:": device D partition 1 if device D has partition
4366 table, or the whole device D if has no partition
4367 table.
4368 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004369 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004370 partition table then means device D.
4371
4372 - FAT_ENV_FILE:
4373
4374 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004375 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004376
4377 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004378 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004379
Stephen Warren06e4ae52013-06-11 15:14:00 -06004380- CONFIG_ENV_IS_IN_MMC:
4381
4382 Define this if you have an MMC device which you want to use for the
4383 environment.
4384
4385 - CONFIG_SYS_MMC_ENV_DEV:
4386
4387 Specifies which MMC device the environment is stored in.
4388
4389 - CONFIG_SYS_MMC_ENV_PART (optional):
4390
4391 Specifies which MMC partition the environment is stored in. If not
4392 set, defaults to partition 0, the user area. Common values might be
4393 1 (first MMC boot partition), 2 (second MMC boot partition).
4394
4395 - CONFIG_ENV_OFFSET:
4396 - CONFIG_ENV_SIZE:
4397
4398 These two #defines specify the offset and size of the environment
4399 area within the specified MMC device.
4400
Stephen Warren5c088ee2013-06-11 15:14:02 -06004401 If offset is positive (the usual case), it is treated as relative to
4402 the start of the MMC partition. If offset is negative, it is treated
4403 as relative to the end of the MMC partition. This can be useful if
4404 your board may be fitted with different MMC devices, which have
4405 different sizes for the MMC partitions, and you always want the
4406 environment placed at the very end of the partition, to leave the
4407 maximum possible space before it, to store other data.
4408
Stephen Warren06e4ae52013-06-11 15:14:00 -06004409 These two values are in units of bytes, but must be aligned to an
4410 MMC sector boundary.
4411
4412 - CONFIG_ENV_OFFSET_REDUND (optional):
4413
4414 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4415 hold a redundant copy of the environment data. This provides a
4416 valid backup copy in case the other copy is corrupted, e.g. due
4417 to a power failure during a "saveenv" operation.
4418
Stephen Warren5c088ee2013-06-11 15:14:02 -06004419 This value may also be positive or negative; this is handled in the
4420 same way as CONFIG_ENV_OFFSET.
4421
Stephen Warren06e4ae52013-06-11 15:14:00 -06004422 This value is also in units of bytes, but must also be aligned to
4423 an MMC sector boundary.
4424
4425 - CONFIG_ENV_SIZE_REDUND (optional):
4426
4427 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4428 set. If this value is set, it must be set to the same value as
4429 CONFIG_ENV_SIZE.
4430
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004431- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004432
4433 Defines offset to the initial SPI buffer area in DPRAM. The
4434 area is used at an early stage (ROM part) if the environment
4435 is configured to reside in the SPI EEPROM: We need a 520 byte
4436 scratch DPRAM area. It is used between the two initialization
4437 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4438 to be a good choice since it makes it far enough from the
4439 start of the data area as well as from the stack pointer.
4440
Bruce Adlere881cb52007-11-02 13:15:42 -07004441Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004442has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004443created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004444until then to read environment variables.
4445
wdenk85ec0bc2003-03-31 16:34:49 +00004446The environment is protected by a CRC32 checksum. Before the monitor
4447is relocated into RAM, as a result of a bad CRC you will be working
4448with the compiled-in default environment - *silently*!!! [This is
4449necessary, because the first environment variable we need is the
4450"baudrate" setting for the console - if we have a bad CRC, we don't
4451have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004452
4453Note: once the monitor has been relocated, then it will complain if
4454the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004455use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004456
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004457- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004458 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004459
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004460 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004461 also needs to be defined.
4462
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004463- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004464 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004465
Ron Madridf5675aa2009-02-18 14:30:44 -08004466- CONFIG_NS16550_MIN_FUNCTIONS:
4467 Define this if you desire to only have use of the NS16550_init
4468 and NS16550_putc functions for the serial driver located at
4469 drivers/serial/ns16550.c. This option is useful for saving
4470 space for already greatly restricted images, including but not
4471 limited to NAND_SPL configurations.
4472
Simon Glassb2b92f52012-11-30 13:01:18 +00004473- CONFIG_DISPLAY_BOARDINFO
4474 Display information about the board that U-Boot is running on
4475 when U-Boot starts up. The board function checkboard() is called
4476 to do this.
4477
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004478- CONFIG_DISPLAY_BOARDINFO_LATE
4479 Similar to the previous option, but display this information
4480 later, once stdio is running and output goes to the LCD, if
4481 present.
4482
Sascha Silbefeb85802013-08-11 16:40:43 +02004483- CONFIG_BOARD_SIZE_LIMIT:
4484 Maximum size of the U-Boot image. When defined, the
4485 build system checks that the actual size does not
4486 exceed it.
4487
wdenkc6097192002-11-03 00:24:07 +00004488Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004489---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004490
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004491- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004492 Cache Line Size of the CPU.
4493
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004494- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004495 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004496
wdenk42d1f032003-10-15 23:53:47 +00004497 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4498 and RPXsuper) to be able to adjust the position of
4499 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004500
Timur Tabie46fedf2011-08-04 18:03:41 -05004501- CONFIG_SYS_CCSRBAR_DEFAULT:
4502 Default (power-on reset) physical address of CCSR on Freescale
4503 PowerPC SOCs.
4504
4505- CONFIG_SYS_CCSRBAR:
4506 Virtual address of CCSR. On a 32-bit build, this is typically
4507 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4508
4509 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4510 for cross-platform code that uses that macro instead.
4511
4512- CONFIG_SYS_CCSRBAR_PHYS:
4513 Physical address of CCSR. CCSR can be relocated to a new
4514 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004515 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004516 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4517 is typically relocated on 36-bit builds. It is recommended
4518 that this macro be defined via the _HIGH and _LOW macros:
4519
4520 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4521 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4522
4523- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004524 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4525 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004526 used in assembly code, so it must not contain typecasts or
4527 integer size suffixes (e.g. "ULL").
4528
4529- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4530 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4531 used in assembly code, so it must not contain typecasts or
4532 integer size suffixes (e.g. "ULL").
4533
4534- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4535 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4536 forced to a value that ensures that CCSR is not relocated.
4537
wdenk7f6c2cb2002-11-10 22:06:23 +00004538- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004539 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004540
4541 the default drive number (default value 0)
4542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004543 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004544
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004545 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004546 (default value 1)
4547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004548 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004549
wdenk43d96162003-03-06 00:02:04 +00004550 defines the offset of register from address. It
4551 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004552 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004553
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004554 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4555 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004556 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004557
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004558 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004559 fdc_hw_init() is called at the beginning of the FDC
4560 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004561 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004562 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004563
Macpaul Lin0abddf82011-04-11 20:45:32 +00004564- CONFIG_IDE_AHB:
4565 Most IDE controllers were designed to be connected with PCI
4566 interface. Only few of them were designed for AHB interface.
4567 When software is doing ATA command and data transfer to
4568 IDE devices through IDE-AHB controller, some additional
4569 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004570 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004571
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004572- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004573 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004574 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004575
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004576- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004577
wdenk7152b1d2003-09-05 23:19:14 +00004578 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004579 initial data and stack; please note that this must be
4580 writable memory that is working WITHOUT special
4581 initialization, i. e. you CANNOT use normal RAM which
4582 will become available only after programming the
4583 memory controller and running certain initialization
4584 sequences.
4585
4586 U-Boot uses the following memory types:
4587 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4588 - MPC824X: data cache
4589 - PPC4xx: data cache
4590
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004591- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004592
4593 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004594 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4595 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004596 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004597 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004598 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4599 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4600 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004601
4602 Note:
4603 On the MPC824X (or other systems that use the data
4604 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004605 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004606 point to an otherwise UNUSED address space between
4607 the top of RAM and the start of the PCI space.
4608
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004609- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004611- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004612
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004613- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004614
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004615- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004616
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004617- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004619- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004621- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004622 SDRAM timing
4623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004624- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004625 periodic timer for refresh
4626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004627- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004628
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004629- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4630 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4631 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4632 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004633 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4634
4635- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004636 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4637 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004638 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4639
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004640- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4641 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004642 Machine Mode Register and Memory Periodic Timer
4643 Prescaler definitions (SDRAM timing)
4644
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004645- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004646 enable I2C microcode relocation patch (MPC8xx);
4647 define relocation offset in DPRAM [DSP2]
4648
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004649- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004650 enable SMC microcode relocation patch (MPC8xx);
4651 define relocation offset in DPRAM [SMC1]
4652
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004653- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004654 enable SPI microcode relocation patch (MPC8xx);
4655 define relocation offset in DPRAM [SCC4]
4656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004657- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004658 Use OSCM clock mode on MBX8xx board. Be careful,
4659 wrong setting might damage your board. Read
4660 doc/README.MBX before setting this variable!
4661
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004662- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004663 Offset of the bootmode word in DPRAM used by post
4664 (Power On Self Tests). This definition overrides
4665 #define'd default value in commproc.h resp.
4666 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004667
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004668- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4669 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4670 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4671 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4672 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4673 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4674 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4675 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004676 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004677
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004678- CONFIG_PCI_DISABLE_PCIE:
4679 Disable PCI-Express on systems where it is supported but not
4680 required.
4681
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004682- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004683 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004684 Don't do any setup work, presumably because someone or
4685 something has already done it, and we don't need to do it
4686 a second time. Useful for platforms that are pre-booted
4687 by coreboot or similar.
4688
Gabor Juhos842033e2013-05-30 07:06:12 +00004689- CONFIG_PCI_INDIRECT_BRIDGE:
4690 Enable support for indirect PCI bridges.
4691
Kumar Galaa09b9b62010-12-30 12:09:53 -06004692- CONFIG_SYS_SRIO:
4693 Chip has SRIO or not
4694
4695- CONFIG_SRIO1:
4696 Board has SRIO 1 port available
4697
4698- CONFIG_SRIO2:
4699 Board has SRIO 2 port available
4700
Liu Gangc8b28152013-05-07 16:30:46 +08004701- CONFIG_SRIO_PCIE_BOOT_MASTER
4702 Board can support master function for Boot from SRIO and PCIE
4703
Kumar Galaa09b9b62010-12-30 12:09:53 -06004704- CONFIG_SYS_SRIOn_MEM_VIRT:
4705 Virtual Address of SRIO port 'n' memory region
4706
4707- CONFIG_SYS_SRIOn_MEM_PHYS:
4708 Physical Address of SRIO port 'n' memory region
4709
4710- CONFIG_SYS_SRIOn_MEM_SIZE:
4711 Size of SRIO port 'n' memory region
4712
Fabio Estevam66bd1842013-04-11 09:35:34 +00004713- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4714 Defined to tell the NAND controller that the NAND chip is using
4715 a 16 bit bus.
4716 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004717 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004718 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004719 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004720
4721- CONFIG_SYS_NDFC_EBC0_CFG
4722 Sets the EBC0_CFG register for the NDFC. If not defined
4723 a default value will be used.
4724
Ben Warrenbb99ad62006-09-07 16:50:54 -04004725- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004726 Get DDR timing information from an I2C EEPROM. Common
4727 with pluggable memory modules such as SODIMMs
4728
Ben Warrenbb99ad62006-09-07 16:50:54 -04004729 SPD_EEPROM_ADDRESS
4730 I2C address of the SPD EEPROM
4731
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004732- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004733 If SPD EEPROM is on an I2C bus other than the first
4734 one, specify here. Note that the value must resolve
4735 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004736
York Sun1b3e3c42011-06-07 09:42:16 +08004737- CONFIG_SYS_DDR_RAW_TIMING
4738 Get DDR timing information from other than SPD. Common with
4739 soldered DDR chips onboard without SPD. DDR raw timing
4740 parameters are extracted from datasheet and hard-coded into
4741 header files or board specific files.
4742
York Sun6f5e1dc2011-09-16 13:21:35 -07004743- CONFIG_FSL_DDR_INTERACTIVE
4744 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4745
York Sune32d59a2015-01-06 13:18:55 -08004746- CONFIG_FSL_DDR_SYNC_REFRESH
4747 Enable sync of refresh for multiple controllers.
4748
York Sun4516ff82015-03-19 09:30:28 -07004749- CONFIG_FSL_DDR_BIST
4750 Enable built-in memory test for Freescale DDR controllers.
4751
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004752- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004753 Only for 83xx systems. If specified, then DDR should
4754 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004755
wdenkc26e4542004-04-18 10:13:26 +00004756- CONFIG_ETHER_ON_FEC[12]
4757 Define to enable FEC[12] on a 8xx series processor.
4758
4759- CONFIG_FEC[12]_PHY
4760 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004761 to the given FEC; i. e.
4762 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004763 means that the PHY with address 4 is connected to FEC1
4764
4765 When set to -1, means to probe for first available.
4766
4767- CONFIG_FEC[12]_PHY_NORXERR
4768 The PHY does not have a RXERR line (RMII only).
4769 (so program the FEC to ignore it).
4770
4771- CONFIG_RMII
4772 Enable RMII mode for all FECs.
4773 Note that this is a global option, we can't
4774 have one FEC in standard MII mode and another in RMII mode.
4775
wdenk5cf91d62004-04-23 20:32:05 +00004776- CONFIG_CRC32_VERIFY
4777 Add a verify option to the crc32 command.
4778 The syntax is:
4779
4780 => crc32 -v <address> <count> <crc32>
4781
4782 Where address/count indicate a memory area
4783 and crc32 is the correct crc32 which the
4784 area should have.
4785
wdenk56523f12004-07-11 17:40:54 +00004786- CONFIG_LOOPW
4787 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004788 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004789
stroese7b466642004-12-16 18:46:55 +00004790- CONFIG_MX_CYCLIC
4791 Add the "mdc" and "mwc" memory commands. These are cyclic
4792 "md/mw" commands.
4793 Examples:
4794
wdenkefe2a4d2004-12-16 21:44:03 +00004795 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004796 This command will print 4 bytes (10,11,12,13) each 500 ms.
4797
wdenkefe2a4d2004-12-16 21:44:03 +00004798 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004799 This command will write 12345678 to address 100 all 10 ms.
4800
wdenkefe2a4d2004-12-16 21:44:03 +00004801 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004802 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004803
wdenk8aa1a2d2005-04-04 12:44:11 +00004804- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004805 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004806 low level initializations (like setting up the memory
4807 controller) are omitted and/or U-Boot does not
4808 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004809
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004810 Normally this variable MUST NOT be defined. The only
4811 exception is when U-Boot is loaded (to RAM) by some
4812 other boot loader or by a debugger which performs
4813 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004814
Simon Glassb5bd0982016-05-05 07:28:06 -06004815- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4816 [ARM926EJ-S only] This allows just the call to lowlevel_init()
yeongjun Kim90211f72016-07-20 22:56:12 +09004817 to be skipped. The normal CP15 init (such as enabling the
Simon Glassb5bd0982016-05-05 07:28:06 -06004818 instruction cache) is still performed.
4819
Aneesh V401bb302011-07-13 05:11:07 +00004820- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004821 Modifies the behaviour of start.S when compiling a loader
4822 that is executed before the actual U-Boot. E.g. when
4823 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004824
Ying Zhang3aa29de2013-08-16 15:16:15 +08004825- CONFIG_TPL_BUILD
4826 Modifies the behaviour of start.S when compiling a loader
4827 that is executed after the SPL and before the actual U-Boot.
4828 It is loaded by the SPL.
4829
Ying Zhang5df572f2013-05-20 14:07:23 +08004830- CONFIG_SYS_MPC85XX_NO_RESETVEC
4831 Only for 85xx systems. If this variable is specified, the section
4832 .resetvec is not kept and the section .bootpg is placed in the
4833 previous 4k of the .text section.
4834
Simon Glass4213fc22013-02-24 17:33:14 +00004835- CONFIG_ARCH_MAP_SYSMEM
4836 Generally U-Boot (and in particular the md command) uses
4837 effective address. It is therefore not necessary to regard
4838 U-Boot address as virtual addresses that need to be translated
4839 to physical addresses. However, sandbox requires this, since
4840 it maintains its own little RAM buffer which contains all
4841 addressable memory. This option causes some memory accesses
4842 to be mapped through map_sysmem() / unmap_sysmem().
4843
Matthias Weisserd8834a12011-03-10 21:36:32 +00004844- CONFIG_USE_ARCH_MEMCPY
4845 CONFIG_USE_ARCH_MEMSET
4846 If these options are used a optimized version of memcpy/memset will
4847 be used if available. These functions may be faster under some
4848 conditions but may increase the binary size.
4849
Simon Glass588a13f2013-02-14 04:18:54 +00004850- CONFIG_X86_RESET_VECTOR
4851 If defined, the x86 reset vector code is included. This is not
4852 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004853
Mark Jacksonfc337052013-03-04 01:27:20 +00004854- CONFIG_SYS_MPUCLK
4855 Defines the MPU clock speed (in MHz).
4856
4857 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004858
Heiko Schocher16678eb2013-11-04 14:05:00 +01004859- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4860 Enables the RTC32K OSC on AM33xx based plattforms
4861
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004862- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4863 Option to disable subpage write in NAND driver
4864 driver that uses this:
4865 drivers/mtd/nand/davinci_nand.c
4866
Timur Tabif2717b42011-11-22 09:21:25 -06004867Freescale QE/FMAN Firmware Support:
4868-----------------------------------
4869
4870The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4871loading of "firmware", which is encoded in the QE firmware binary format.
4872This firmware often needs to be loaded during U-Boot booting, so macros
4873are used to identify the storage device (NOR flash, SPI, etc) and the address
4874within that device.
4875
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004876- CONFIG_SYS_FMAN_FW_ADDR
4877 The address in the storage device where the FMAN microcode is located. The
4878 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4879 is also specified.
4880
4881- CONFIG_SYS_QE_FW_ADDR
4882 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004883 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4884 is also specified.
4885
4886- CONFIG_SYS_QE_FMAN_FW_LENGTH
4887 The maximum possible size of the firmware. The firmware binary format
4888 has a field that specifies the actual size of the firmware, but it
4889 might not be possible to read any part of the firmware unless some
4890 local storage is allocated to hold the entire firmware first.
4891
4892- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4893 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4894 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4895 virtual address in NOR flash.
4896
4897- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4898 Specifies that QE/FMAN firmware is located in NAND flash.
4899 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4900
4901- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4902 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4903 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4904
4905- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4906 Specifies that QE/FMAN firmware is located on the primary SPI
4907 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4908
Liu Gang292dc6c2012-03-08 00:33:18 +00004909- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4910 Specifies that QE/FMAN firmware is located in the remote (master)
4911 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004912 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4913 window->master inbound window->master LAW->the ucode address in
4914 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004915
J. German Riverab940ca62014-06-23 15:15:55 -07004916Freescale Layerscape Management Complex Firmware Support:
4917---------------------------------------------------------
4918The Freescale Layerscape Management Complex (MC) supports the loading of
4919"firmware".
4920This firmware often needs to be loaded during U-Boot booting, so macros
4921are used to identify the storage device (NOR flash, SPI, etc) and the address
4922within that device.
4923
4924- CONFIG_FSL_MC_ENET
4925 Enable the MC driver for Layerscape SoCs.
4926
4927- CONFIG_SYS_LS_MC_FW_ADDR
4928 The address in the storage device where the firmware is located. The
4929 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4930 is also specified.
4931
4932- CONFIG_SYS_LS_MC_FW_LENGTH
4933 The maximum possible size of the firmware. The firmware binary format
4934 has a field that specifies the actual size of the firmware, but it
4935 might not be possible to read any part of the firmware unless some
4936 local storage is allocated to hold the entire firmware first.
4937
4938- CONFIG_SYS_LS_MC_FW_IN_NOR
4939 Specifies that MC firmware is located in NOR flash, mapped as
4940 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4941 virtual address in NOR flash.
4942
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304943Freescale Layerscape Debug Server Support:
4944-------------------------------------------
4945The Freescale Layerscape Debug Server Support supports the loading of
4946"Debug Server firmware" and triggering SP boot-rom.
4947This firmware often needs to be loaded during U-Boot booting.
4948
4949- CONFIG_FSL_DEBUG_SERVER
4950 Enable the Debug Server for Layerscape SoCs.
4951
4952- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
4953 Define minimum DDR size required for debug server image
4954
York Sunc0492142015-12-07 11:08:58 -08004955- CONFIG_SYS_MC_RSV_MEM_ALIGN
4956 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304957
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02004958Reproducible builds
4959-------------------
4960
4961In order to achieve reproducible builds, timestamps used in the U-Boot build
4962process have to be set to a fixed value.
4963
4964This is done using the SOURCE_DATE_EPOCH environment variable.
4965SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4966option for U-Boot or an environment variable in U-Boot.
4967
4968SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4969
wdenkc6097192002-11-03 00:24:07 +00004970Building the Software:
4971======================
4972
Wolfgang Denk218ca722008-03-26 10:40:12 +01004973Building U-Boot has been tested in several native build environments
4974and in many different cross environments. Of course we cannot support
4975all possibly existing versions of cross development tools in all
4976(potentially obsolete) versions. In case of tool chain problems we
4977recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4978which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004979
Wolfgang Denk218ca722008-03-26 10:40:12 +01004980If you are not using a native environment, it is assumed that you
4981have GNU cross compiling tools available in your path. In this case,
4982you must set the environment variable CROSS_COMPILE in your shell.
4983Note that no changes to the Makefile or any other source files are
4984necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004985
Wolfgang Denk218ca722008-03-26 10:40:12 +01004986 $ CROSS_COMPILE=ppc_4xx-
4987 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004988
Peter Tyser2f8d3962009-03-13 18:54:51 -05004989Note: If you wish to generate Windows versions of the utilities in
4990 the tools directory you can use the MinGW toolchain
4991 (http://www.mingw.org). Set your HOST tools to the MinGW
4992 toolchain and execute 'make tools'. For example:
4993
4994 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4995
4996 Binaries such as tools/mkimage.exe will be created which can
4997 be executed on computers running Windows.
4998
Wolfgang Denk218ca722008-03-26 10:40:12 +01004999U-Boot is intended to be simple to build. After installing the
5000sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00005001is done by typing:
5002
Holger Freytherab584d62014-08-04 09:26:05 +02005003 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00005004
Holger Freytherab584d62014-08-04 09:26:05 +02005005where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005006rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005007
wdenk2729af92004-05-03 20:45:30 +00005008Note: for some board special configuration names may exist; check if
5009 additional information is available from the board vendor; for
5010 instance, the TQM823L systems are available without (standard)
5011 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005012 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005013
Holger Freytherab584d62014-08-04 09:26:05 +02005014 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005015 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005016
Holger Freytherab584d62014-08-04 09:26:05 +02005017 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005018 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005019
wdenk2729af92004-05-03 20:45:30 +00005020 etc.
wdenkc6097192002-11-03 00:24:07 +00005021
wdenkc6097192002-11-03 00:24:07 +00005022
wdenk2729af92004-05-03 20:45:30 +00005023Finally, type "make all", and you should get some working U-Boot
5024images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005025
wdenk2729af92004-05-03 20:45:30 +00005026- "u-boot.bin" is a raw binary image
5027- "u-boot" is an image in ELF binary format
5028- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005029
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005030By default the build is performed locally and the objects are saved
5031in the source directory. One of the two methods can be used to change
5032this behavior and build U-Boot to some external directory:
5033
50341. Add O= to the make command line invocations:
5035
5036 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005037 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005038 make O=/tmp/build all
5039
Timo Ketolaadbba992014-11-06 14:39:05 +020050402. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005041
Timo Ketolaadbba992014-11-06 14:39:05 +02005042 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005043 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005044 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005045 make all
5046
Timo Ketolaadbba992014-11-06 14:39:05 +02005047Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005048variable.
5049
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk2729af92004-05-03 20:45:30 +00005051Please be aware that the Makefiles assume you are using GNU make, so
5052for instance on NetBSD you might need to use "gmake" instead of
5053native "make".
wdenkc6097192002-11-03 00:24:07 +00005054
wdenkc6097192002-11-03 00:24:07 +00005055
wdenk2729af92004-05-03 20:45:30 +00005056If the system board that you have is not listed, then you will need
5057to port U-Boot to your hardware platform. To do this, follow these
5058steps:
wdenkc6097192002-11-03 00:24:07 +00005059
Phil Sutter3c1496c2015-12-25 14:41:18 +010050601. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00005061 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01005062 the "Makefile" and a "<board>.c".
50632. Create a new configuration file "include/configs/<board>.h" for
5064 your board.
wdenk2729af92004-05-03 20:45:30 +000050653. If you're porting U-Boot to a new CPU, then also create a new
5066 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020050674. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000050685. Type "make", and you should get a working "u-boot.srec" file
5069 to be installed on your target system.
50706. Debug and solve any problems that might arise.
5071 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005072
wdenkc6097192002-11-03 00:24:07 +00005073
wdenk2729af92004-05-03 20:45:30 +00005074Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5075==============================================================
wdenkc6097192002-11-03 00:24:07 +00005076
Wolfgang Denk218ca722008-03-26 10:40:12 +01005077If you have modified U-Boot sources (for instance added a new board
5078or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005079provide feedback to the other developers. The feedback normally takes
5080the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005081official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005082
Wolfgang Denk218ca722008-03-26 10:40:12 +01005083But before you submit such a patch, please verify that your modifi-
5084cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005085the supported boards compile WITHOUT ANY compiler warnings. To do so,
5086just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005087for ALL supported system. Be warned, this will take a while. You can
5088select which (cross) compiler to use by passing a `CROSS_COMPILE'
5089environment variable to the script, i. e. to use the ELDK cross tools
5090you can type
wdenkc6097192002-11-03 00:24:07 +00005091
wdenk2729af92004-05-03 20:45:30 +00005092 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005093
wdenk2729af92004-05-03 20:45:30 +00005094or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005095
wdenk2729af92004-05-03 20:45:30 +00005096 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005097
Wolfgang Denk218ca722008-03-26 10:40:12 +01005098When using the MAKEALL script, the default behaviour is to build
5099U-Boot in the source directory. This location can be changed by
5100setting the BUILD_DIR environment variable. Also, for each target
5101built, the MAKEALL script saves two log files (<target>.ERR and
5102<target>.MAKEALL) in the <source dir>/LOG directory. This default
5103location can be changed by setting the MAKEALL_LOGDIR environment
5104variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005105
5106 export BUILD_DIR=/tmp/build
5107 export MAKEALL_LOGDIR=/tmp/log
5108 CROSS_COMPILE=ppc_8xx- MAKEALL
5109
Wolfgang Denk218ca722008-03-26 10:40:12 +01005110With the above settings build objects are saved in the /tmp/build,
5111log files are saved in the /tmp/log and the source tree remains clean
5112during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005113
5114
wdenk2729af92004-05-03 20:45:30 +00005115See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005116
wdenkc6097192002-11-03 00:24:07 +00005117
wdenk2729af92004-05-03 20:45:30 +00005118Monitor Commands - Overview:
5119============================
wdenkc6097192002-11-03 00:24:07 +00005120
wdenk2729af92004-05-03 20:45:30 +00005121go - start application at address 'addr'
5122run - run commands in an environment variable
5123bootm - boot application image from memory
5124bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005125bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005126tftpboot- boot image via network using TFTP protocol
5127 and env variables "ipaddr" and "serverip"
5128 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005129tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005130rarpboot- boot image via network using RARP/TFTP protocol
5131diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5132loads - load S-Record file over serial line
5133loadb - load binary file over serial line (kermit mode)
5134md - memory display
5135mm - memory modify (auto-incrementing)
5136nm - memory modify (constant address)
5137mw - memory write (fill)
5138cp - memory copy
5139cmp - memory compare
5140crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005141i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005142sspi - SPI utility commands
5143base - print or set address offset
5144printenv- print environment variables
5145setenv - set environment variables
5146saveenv - save environment variables to persistent storage
5147protect - enable or disable FLASH write protection
5148erase - erase FLASH memory
5149flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005150nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005151bdinfo - print Board Info structure
5152iminfo - print header information for application image
5153coninfo - print console devices and informations
5154ide - IDE sub-system
5155loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005156loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005157mtest - simple RAM test
5158icache - enable or disable instruction cache
5159dcache - enable or disable data cache
5160reset - Perform RESET of the CPU
5161echo - echo args to console
5162version - print monitor version
5163help - print online help
5164? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005165
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk2729af92004-05-03 20:45:30 +00005167Monitor Commands - Detailed Description:
5168========================================
wdenkc6097192002-11-03 00:24:07 +00005169
wdenk2729af92004-05-03 20:45:30 +00005170TODO.
wdenkc6097192002-11-03 00:24:07 +00005171
wdenk2729af92004-05-03 20:45:30 +00005172For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005173
5174
wdenk2729af92004-05-03 20:45:30 +00005175Environment Variables:
5176======================
wdenkc6097192002-11-03 00:24:07 +00005177
wdenk2729af92004-05-03 20:45:30 +00005178U-Boot supports user configuration using Environment Variables which
5179can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005180
wdenk2729af92004-05-03 20:45:30 +00005181Environment Variables are set using "setenv", printed using
5182"printenv", and saved to Flash using "saveenv". Using "setenv"
5183without a value can be used to delete a variable from the
5184environment. As long as you don't save the environment you are
5185working with an in-memory copy. In case the Flash area containing the
5186environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005187
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005188Some configuration options can be set using Environment Variables.
5189
5190List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005191
wdenk2729af92004-05-03 20:45:30 +00005192 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005193
wdenk2729af92004-05-03 20:45:30 +00005194 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005195
wdenk2729af92004-05-03 20:45:30 +00005196 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005197
wdenk2729af92004-05-03 20:45:30 +00005198 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005199
wdenk2729af92004-05-03 20:45:30 +00005200 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005201
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005202 bootm_low - Memory range available for image processing in the bootm
5203 command can be restricted. This variable is given as
5204 a hexadecimal number and defines lowest address allowed
5205 for use by the bootm command. See also "bootm_size"
5206 environment variable. Address defined by "bootm_low" is
5207 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005208 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5209 bootm_mapsize.
5210
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005211 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005212 This variable is given as a hexadecimal number and it
5213 defines the size of the memory region starting at base
5214 address bootm_low that is accessible by the Linux kernel
5215 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5216 as the default value if it is defined, and bootm_size is
5217 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005218
5219 bootm_size - Memory range available for image processing in the bootm
5220 command can be restricted. This variable is given as
5221 a hexadecimal number and defines the size of the region
5222 allowed for use by the bootm command. See also "bootm_low"
5223 environment variable.
5224
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005225 updatefile - Location of the software update file on a TFTP server, used
5226 by the automatic software update feature. Please refer to
5227 documentation in doc/README.update for more details.
5228
wdenk2729af92004-05-03 20:45:30 +00005229 autoload - if set to "no" (any string beginning with 'n'),
5230 "bootp" will just load perform a lookup of the
5231 configuration from the BOOTP server, but not try to
5232 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005233
wdenk2729af92004-05-03 20:45:30 +00005234 autostart - if set to "yes", an image loaded using the "bootp",
5235 "rarpboot", "tftpboot" or "diskboot" commands will
5236 be automatically started (by internally calling
5237 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005238
wdenk2729af92004-05-03 20:45:30 +00005239 If set to "no", a standalone image passed to the
5240 "bootm" command will be copied to the load address
5241 (and eventually uncompressed), but NOT be started.
5242 This can be used to load and uncompress arbitrary
5243 data.
wdenkc6097192002-11-03 00:24:07 +00005244
David A. Longa28afca2011-07-09 16:40:19 -04005245 fdt_high - if set this restricts the maximum address that the
5246 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005247 For example, if you have a system with 1 GB memory
5248 at physical address 0x10000000, while Linux kernel
5249 only recognizes the first 704 MB as low memory, you
5250 may need to set fdt_high as 0x3C000000 to have the
5251 device tree blob be copied to the maximum address
5252 of the 704 MB low memory, so that Linux kernel can
5253 access it during the boot procedure.
5254
David A. Longa28afca2011-07-09 16:40:19 -04005255 If this is set to the special value 0xFFFFFFFF then
5256 the fdt will not be copied at all on boot. For this
5257 to work it must reside in writable memory, have
5258 sufficient padding on the end of it for u-boot to
5259 add the information it needs into it, and the memory
5260 must be accessible by the kernel.
5261
Simon Glasseea63e02011-10-24 19:15:34 +00005262 fdtcontroladdr- if set this is the address of the control flattened
5263 device tree used by U-Boot when CONFIG_OF_CONTROL is
5264 defined.
5265
wdenk17ea1172004-06-06 21:51:03 +00005266 i2cfast - (PPC405GP|PPC405EP only)
5267 if set to 'y' configures Linux I2C driver for fast
5268 mode (400kHZ). This environment variable is used in
5269 initialization code. So, for changes to be effective
5270 it must be saved and board must be reset.
5271
wdenk2729af92004-05-03 20:45:30 +00005272 initrd_high - restrict positioning of initrd images:
5273 If this variable is not set, initrd images will be
5274 copied to the highest possible address in RAM; this
5275 is usually what you want since it allows for
5276 maximum initrd size. If for some reason you want to
5277 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005278 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005279 variable to a value of "no" or "off" or "0".
5280 Alternatively, you can set it to a maximum upper
5281 address to use (U-Boot will still check that it
5282 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005283
wdenk2729af92004-05-03 20:45:30 +00005284 For instance, when you have a system with 16 MB
5285 RAM, and want to reserve 4 MB from use by Linux,
5286 you can do this by adding "mem=12M" to the value of
5287 the "bootargs" variable. However, now you must make
5288 sure that the initrd image is placed in the first
5289 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005290
wdenk2729af92004-05-03 20:45:30 +00005291 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005292
wdenk2729af92004-05-03 20:45:30 +00005293 If you set initrd_high to 0xFFFFFFFF, this is an
5294 indication to U-Boot that all addresses are legal
5295 for the Linux kernel, including addresses in flash
5296 memory. In this case U-Boot will NOT COPY the
5297 ramdisk at all. This may be useful to reduce the
5298 boot time on your system, but requires that this
5299 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005300
wdenk2729af92004-05-03 20:45:30 +00005301 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk2729af92004-05-03 20:45:30 +00005303 loadaddr - Default load address for commands like "bootp",
5304 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005305
wdenk2729af92004-05-03 20:45:30 +00005306 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005307
wdenk2729af92004-05-03 20:45:30 +00005308 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005309
wdenk2729af92004-05-03 20:45:30 +00005310 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005311
wdenk2729af92004-05-03 20:45:30 +00005312 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005313
wdenk2729af92004-05-03 20:45:30 +00005314 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005315
Mike Frysingere2a53452011-10-02 10:01:27 +00005316 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005317
Mike Frysingere2a53452011-10-02 10:01:27 +00005318 ethact - controls which interface is currently active.
5319 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005320
Heiko Schocher48690d82010-07-20 17:45:02 +02005321 => setenv ethact FEC
5322 => ping 192.168.0.1 # traffic sent on FEC
5323 => setenv ethact SCC
5324 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005325
Matthias Fuchse1692572008-01-17 07:45:05 +01005326 ethrotate - When set to "no" U-Boot does not go through all
5327 available network interfaces.
5328 It just stays at the currently selected interface.
5329
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005330 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005331 either succeed or fail without retrying.
5332 When set to "once" the network operation will
5333 fail when all the available network interfaces
5334 are tried once without success.
5335 Useful on scripts which control the retry operation
5336 themselves.
wdenkc6097192002-11-03 00:24:07 +00005337
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005338 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005339
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005340 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005341 changing the console to be empty. If "yes" it will be
5342 made silent. If "no" it will not be made silent. If
5343 unset, then it will be made silent if the U-Boot console
5344 is silent.
5345
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005346 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005347 UDP source port.
5348
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005349 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005350 destination port instead of the Well Know Port 69.
5351
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005352 tftpblocksize - Block size to use for TFTP transfers; if not set,
5353 we use the TFTP server's default block size
5354
5355 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5356 seconds, minimum value is 1000 = 1 second). Defines
5357 when a packet is considered to be lost so it has to
5358 be retransmitted. The default is 5000 = 5 seconds.
5359 Lowering this value may make downloads succeed
5360 faster in networks with high packet loss rates or
5361 with unreliable TFTP servers.
5362
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005363 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5364 unit, minimum value = 0). Defines how many timeouts
5365 can happen during a single file transfer before that
5366 transfer is aborted. The default is 10, and 0 means
5367 'no timeouts allowed'. Increasing this value may help
5368 downloads succeed with high packet loss rates, or with
5369 unreliable TFTP servers or client hardware.
5370
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005371 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005372 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005373 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005374
Alexandre Messier50768f52016-02-01 17:08:57 -05005375 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5376 Unsigned value, in milliseconds. If not set, the period will
5377 be either the default (28000), or a value based on
5378 CONFIG_NET_RETRY_COUNT, if defined. This value has
5379 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5380
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005381The following image location variables contain the location of images
5382used in booting. The "Image" column gives the role of the image and is
5383not an environment variable name. The other columns are environment
5384variable names. "File Name" gives the name of the file on a TFTP
5385server, "RAM Address" gives the location in RAM the image will be
5386loaded to, and "Flash Location" gives the image's address in NOR
5387flash or offset in NAND flash.
5388
5389*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03005390boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005391boards use these variables for other purposes.
5392
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005393Image File Name RAM Address Flash Location
5394----- --------- ----------- --------------
5395u-boot u-boot u-boot_addr_r u-boot_addr
5396Linux kernel bootfile kernel_addr_r kernel_addr
5397device tree blob fdtfile fdt_addr_r fdt_addr
5398ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005399
wdenk2729af92004-05-03 20:45:30 +00005400The following environment variables may be used and automatically
5401updated by the network boot commands ("bootp" and "rarpboot"),
5402depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005403
wdenk2729af92004-05-03 20:45:30 +00005404 bootfile - see above
5405 dnsip - IP address of your Domain Name Server
5406 dnsip2 - IP address of your secondary Domain Name Server
5407 gatewayip - IP address of the Gateway (Router) to use
5408 hostname - Target hostname
5409 ipaddr - see above
5410 netmask - Subnet Mask
5411 rootpath - Pathname of the root filesystem on the NFS server
5412 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005413
wdenka3d991b2004-04-15 21:48:45 +00005414
wdenk2729af92004-05-03 20:45:30 +00005415There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005416
wdenk2729af92004-05-03 20:45:30 +00005417 serial# - contains hardware identification information such
5418 as type string and/or serial number
5419 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005420
wdenk2729af92004-05-03 20:45:30 +00005421These variables can be set only once (usually during manufacturing of
5422the board). U-Boot refuses to delete or overwrite these variables
5423once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005424
5425
wdenk2729af92004-05-03 20:45:30 +00005426Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005427
wdenk2729af92004-05-03 20:45:30 +00005428 ver - Contains the U-Boot version string as printed
5429 with the "version" command. This variable is
5430 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005431
wdenkc6097192002-11-03 00:24:07 +00005432
wdenk2729af92004-05-03 20:45:30 +00005433Please note that changes to some configuration parameters may take
5434only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005435
stroesec1551ea2003-04-04 15:53:41 +00005436
Joe Hershberger170ab112012-12-11 22:16:24 -06005437Callback functions for environment variables:
5438---------------------------------------------
5439
5440For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005441when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005442be associated with arbitrary variables. On creation, overwrite, or
5443deletion, the callback will provide the opportunity for some side
5444effect to happen or for the change to be rejected.
5445
5446The callbacks are named and associated with a function using the
5447U_BOOT_ENV_CALLBACK macro in your board or driver code.
5448
5449These callbacks are associated with variables in one of two ways. The
5450static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5451in the board configuration to a string that defines a list of
5452associations. The list must be in the following format:
5453
5454 entry = variable_name[:callback_name]
5455 list = entry[,list]
5456
5457If the callback name is not specified, then the callback is deleted.
5458Spaces are also allowed anywhere in the list.
5459
5460Callbacks can also be associated by defining the ".callbacks" variable
5461with the same list format above. Any association in ".callbacks" will
5462override any association in the static list. You can define
5463CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005464".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005465
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05005466If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5467regular expression. This allows multiple variables to be connected to
5468the same callback without explicitly listing them all out.
5469
Joe Hershberger170ab112012-12-11 22:16:24 -06005470
wdenk2729af92004-05-03 20:45:30 +00005471Command Line Parsing:
5472=====================
stroesec1551ea2003-04-04 15:53:41 +00005473
wdenk2729af92004-05-03 20:45:30 +00005474There are two different command line parsers available with U-Boot:
5475the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005476
wdenk2729af92004-05-03 20:45:30 +00005477Old, simple command line parser:
5478--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005479
wdenk2729af92004-05-03 20:45:30 +00005480- supports environment variables (through setenv / saveenv commands)
5481- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005482- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005483- special characters ('$', ';') can be escaped by prefixing with '\',
5484 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005485 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005486- You can also escape text by enclosing in single apostrophes, for example:
5487 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005488
wdenk2729af92004-05-03 20:45:30 +00005489Hush shell:
5490-----------
wdenkf07771c2003-05-28 08:06:31 +00005491
wdenk2729af92004-05-03 20:45:30 +00005492- similar to Bourne shell, with control structures like
5493 if...then...else...fi, for...do...done; while...do...done,
5494 until...do...done, ...
5495- supports environment ("global") variables (through setenv / saveenv
5496 commands) and local shell variables (through standard shell syntax
5497 "name=value"); only environment variables can be used with "run"
5498 command
wdenkf07771c2003-05-28 08:06:31 +00005499
wdenk2729af92004-05-03 20:45:30 +00005500General rules:
5501--------------
wdenkf07771c2003-05-28 08:06:31 +00005502
wdenk2729af92004-05-03 20:45:30 +00005503(1) If a command line (or an environment variable executed by a "run"
5504 command) contains several commands separated by semicolon, and
5505 one of these commands fails, then the remaining commands will be
5506 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005507
wdenk2729af92004-05-03 20:45:30 +00005508(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005509 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005510 command will cause "run" to terminate, i. e. the remaining
5511 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005512
wdenk2729af92004-05-03 20:45:30 +00005513Note for Redundant Ethernet Interfaces:
5514=======================================
wdenkf07771c2003-05-28 08:06:31 +00005515
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005516Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005517such configurations and is capable of automatic selection of a
5518"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005519
wdenk2729af92004-05-03 20:45:30 +00005520Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5521MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5522"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005523
wdenk2729af92004-05-03 20:45:30 +00005524If the network interface stores some valid MAC address (for instance
5525in SROM), this is used as default address if there is NO correspon-
5526ding setting in the environment; if the corresponding environment
5527variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005528
wdenk2729af92004-05-03 20:45:30 +00005529o If the SROM has a valid MAC address, and there is no address in the
5530 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005531
wdenk2729af92004-05-03 20:45:30 +00005532o If there is no valid address in the SROM, and a definition in the
5533 environment exists, then the value from the environment variable is
5534 used.
wdenkc6097192002-11-03 00:24:07 +00005535
wdenk2729af92004-05-03 20:45:30 +00005536o If both the SROM and the environment contain a MAC address, and
5537 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005538
wdenk2729af92004-05-03 20:45:30 +00005539o If both the SROM and the environment contain a MAC address, and the
5540 addresses differ, the value from the environment is used and a
5541 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005542
wdenk2729af92004-05-03 20:45:30 +00005543o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05005544 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5545 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005546
Ben Warrenecee9322010-04-26 11:11:46 -07005547If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005548will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005549may be skipped by setting the appropriate 'ethmacskip' environment variable.
5550The naming convention is as follows:
5551"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005552
wdenk2729af92004-05-03 20:45:30 +00005553Image Formats:
5554==============
wdenkc6097192002-11-03 00:24:07 +00005555
Marian Balakowicz3310c542008-03-12 12:13:13 +01005556U-Boot is capable of booting (and performing other auxiliary operations on)
5557images in two formats:
5558
5559New uImage format (FIT)
5560-----------------------
5561
5562Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5563to Flattened Device Tree). It allows the use of images with multiple
5564components (several kernels, ramdisks, etc.), with contents protected by
5565SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5566
5567
5568Old uImage format
5569-----------------
5570
5571Old image format is based on binary files which can be basically anything,
5572preceded by a special header; see the definitions in include/image.h for
5573details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005574
wdenk2729af92004-05-03 20:45:30 +00005575* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5576 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005577 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5578 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5579 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005580* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005581 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5582 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005583* Compression Type (uncompressed, gzip, bzip2)
5584* Load Address
5585* Entry Point
5586* Image Name
5587* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk2729af92004-05-03 20:45:30 +00005589The header is marked by a special Magic Number, and both the header
5590and the data portions of the image are secured against corruption by
5591CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005592
wdenkc6097192002-11-03 00:24:07 +00005593
wdenk2729af92004-05-03 20:45:30 +00005594Linux Support:
5595==============
wdenkc6097192002-11-03 00:24:07 +00005596
wdenk2729af92004-05-03 20:45:30 +00005597Although U-Boot should support any OS or standalone application
5598easily, the main focus has always been on Linux during the design of
5599U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005600
wdenk2729af92004-05-03 20:45:30 +00005601U-Boot includes many features that so far have been part of some
5602special "boot loader" code within the Linux kernel. Also, any
5603"initrd" images to be used are no longer part of one big Linux image;
5604instead, kernel and "initrd" are separate images. This implementation
5605serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005606
wdenk2729af92004-05-03 20:45:30 +00005607- the same features can be used for other OS or standalone
5608 applications (for instance: using compressed images to reduce the
5609 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005610
wdenk2729af92004-05-03 20:45:30 +00005611- it becomes much easier to port new Linux kernel versions because
5612 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005613
wdenk2729af92004-05-03 20:45:30 +00005614- the same Linux kernel image can now be used with different "initrd"
5615 images; of course this also means that different kernel images can
5616 be run with the same "initrd". This makes testing easier (you don't
5617 have to build a new "zImage.initrd" Linux image when you just
5618 change a file in your "initrd"). Also, a field-upgrade of the
5619 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005620
wdenkc6097192002-11-03 00:24:07 +00005621
wdenk2729af92004-05-03 20:45:30 +00005622Linux HOWTO:
5623============
wdenkc6097192002-11-03 00:24:07 +00005624
wdenk2729af92004-05-03 20:45:30 +00005625Porting Linux to U-Boot based systems:
5626---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005627
wdenk2729af92004-05-03 20:45:30 +00005628U-Boot cannot save you from doing all the necessary modifications to
5629configure the Linux device drivers for use with your target hardware
5630(no, we don't intend to provide a full virtual machine interface to
5631Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005632
Stefan Roesea47a12b2010-04-15 16:07:28 +02005633But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005634
wdenk2729af92004-05-03 20:45:30 +00005635Just make sure your machine specific header file (for instance
5636include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005637Information structure as we define in include/asm-<arch>/u-boot.h,
5638and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005639as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005640
Simon Glass2eb31b12014-06-11 23:29:46 -06005641Note that U-Boot now has a driver model, a unified model for drivers.
5642If you are adding a new driver, plumb it into driver model. If there
5643is no uclass available, you are encouraged to create one. See
5644doc/driver-model.
5645
wdenkc6097192002-11-03 00:24:07 +00005646
wdenk2729af92004-05-03 20:45:30 +00005647Configuring the Linux kernel:
5648-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005649
wdenk2729af92004-05-03 20:45:30 +00005650No specific requirements for U-Boot. Make sure you have some root
5651device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005652
wdenkc6097192002-11-03 00:24:07 +00005653
wdenk2729af92004-05-03 20:45:30 +00005654Building a Linux Image:
5655-----------------------
wdenkc6097192002-11-03 00:24:07 +00005656
wdenk2729af92004-05-03 20:45:30 +00005657With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5658not used. If you use recent kernel source, a new build target
5659"uImage" will exist which automatically builds an image usable by
5660U-Boot. Most older kernels also have support for a "pImage" target,
5661which was introduced for our predecessor project PPCBoot and uses a
5662100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005663
wdenk2729af92004-05-03 20:45:30 +00005664Example:
wdenkc6097192002-11-03 00:24:07 +00005665
Holger Freytherab584d62014-08-04 09:26:05 +02005666 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005667 make oldconfig
5668 make dep
5669 make uImage
wdenkc6097192002-11-03 00:24:07 +00005670
wdenk2729af92004-05-03 20:45:30 +00005671The "uImage" build target uses a special tool (in 'tools/mkimage') to
5672encapsulate a compressed Linux kernel image with header information,
5673CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005674
wdenk2729af92004-05-03 20:45:30 +00005675* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005676
wdenk2729af92004-05-03 20:45:30 +00005677* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005678
wdenk2729af92004-05-03 20:45:30 +00005679 ${CROSS_COMPILE}-objcopy -O binary \
5680 -R .note -R .comment \
5681 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005682
wdenk2729af92004-05-03 20:45:30 +00005683* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005684
wdenk2729af92004-05-03 20:45:30 +00005685 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005686
wdenk2729af92004-05-03 20:45:30 +00005687* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005688
wdenk2729af92004-05-03 20:45:30 +00005689 mkimage -A ppc -O linux -T kernel -C gzip \
5690 -a 0 -e 0 -n "Linux Kernel Image" \
5691 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005692
wdenk24ee89b2002-11-03 17:56:27 +00005693
wdenk2729af92004-05-03 20:45:30 +00005694The "mkimage" tool can also be used to create ramdisk images for use
5695with U-Boot, either separated from the Linux kernel image, or
5696combined into one file. "mkimage" encapsulates the images with a 64
5697byte header containing information about target architecture,
5698operating system, image type, compression method, entry points, time
5699stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005700
wdenk2729af92004-05-03 20:45:30 +00005701"mkimage" can be called in two ways: to verify existing images and
5702print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005703
wdenk2729af92004-05-03 20:45:30 +00005704In the first form (with "-l" option) mkimage lists the information
5705contained in the header of an existing U-Boot image; this includes
5706checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005707
wdenk2729af92004-05-03 20:45:30 +00005708 tools/mkimage -l image
5709 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005710
wdenk2729af92004-05-03 20:45:30 +00005711The second form (with "-d" option) is used to build a U-Boot image
5712from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005713
wdenk2729af92004-05-03 20:45:30 +00005714 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5715 -n name -d data_file image
5716 -A ==> set architecture to 'arch'
5717 -O ==> set operating system to 'os'
5718 -T ==> set image type to 'type'
5719 -C ==> set compression type 'comp'
5720 -a ==> set load address to 'addr' (hex)
5721 -e ==> set entry point to 'ep' (hex)
5722 -n ==> set image name to 'name'
5723 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005724
wdenk69459792004-05-29 16:53:29 +00005725Right now, all Linux kernels for PowerPC systems use the same load
5726address (0x00000000), but the entry point address depends on the
5727kernel version:
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk2729af92004-05-03 20:45:30 +00005729- 2.2.x kernels have the entry point at 0x0000000C,
5730- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005731
wdenk2729af92004-05-03 20:45:30 +00005732So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005733
wdenk2729af92004-05-03 20:45:30 +00005734 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5735 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005736 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005737 > examples/uImage.TQM850L
5738 Image Name: 2.4.4 kernel for TQM850L
5739 Created: Wed Jul 19 02:34:59 2000
5740 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5741 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5742 Load Address: 0x00000000
5743 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005744
wdenk2729af92004-05-03 20:45:30 +00005745To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005746
wdenk2729af92004-05-03 20:45:30 +00005747 -> tools/mkimage -l examples/uImage.TQM850L
5748 Image Name: 2.4.4 kernel for TQM850L
5749 Created: Wed Jul 19 02:34:59 2000
5750 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5751 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5752 Load Address: 0x00000000
5753 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005754
wdenk2729af92004-05-03 20:45:30 +00005755NOTE: for embedded systems where boot time is critical you can trade
5756speed for memory and install an UNCOMPRESSED image instead: this
5757needs more space in Flash, but boots much faster since it does not
5758need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005759
Stefan Roesea47a12b2010-04-15 16:07:28 +02005760 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005761 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5762 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005763 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005764 > examples/uImage.TQM850L-uncompressed
5765 Image Name: 2.4.4 kernel for TQM850L
5766 Created: Wed Jul 19 02:34:59 2000
5767 Image Type: PowerPC Linux Kernel Image (uncompressed)
5768 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5769 Load Address: 0x00000000
5770 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005771
wdenkc6097192002-11-03 00:24:07 +00005772
wdenk2729af92004-05-03 20:45:30 +00005773Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5774when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005775
wdenk2729af92004-05-03 20:45:30 +00005776 -> tools/mkimage -n 'Simple Ramdisk Image' \
5777 > -A ppc -O linux -T ramdisk -C gzip \
5778 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5779 Image Name: Simple Ramdisk Image
5780 Created: Wed Jan 12 14:01:50 2000
5781 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5782 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5783 Load Address: 0x00000000
5784 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005785
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005786The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5787option performs the converse operation of the mkimage's second form (the "-d"
5788option). Given an image built by mkimage, the dumpimage extracts a "data file"
5789from the image:
5790
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005791 tools/dumpimage -i image -T type -p position data_file
5792 -i ==> extract from the 'image' a specific 'data_file'
5793 -T ==> set image type to 'type'
5794 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005795
wdenkdb01a2e2004-04-15 23:14:49 +00005796
wdenk2729af92004-05-03 20:45:30 +00005797Installing a Linux Image:
5798-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005799
wdenk2729af92004-05-03 20:45:30 +00005800To downloading a U-Boot image over the serial (console) interface,
5801you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005802
wdenk2729af92004-05-03 20:45:30 +00005803 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005804
wdenk2729af92004-05-03 20:45:30 +00005805The 'objcopy' does not understand the information in the U-Boot
5806image header, so the resulting S-Record file will be relative to
5807address 0x00000000. To load it to a given address, you need to
5808specify the target address as 'offset' parameter with the 'loads'
5809command.
wdenkc6097192002-11-03 00:24:07 +00005810
wdenk2729af92004-05-03 20:45:30 +00005811Example: install the image to address 0x40100000 (which on the
5812TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk2729af92004-05-03 20:45:30 +00005814 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005815
wdenk2729af92004-05-03 20:45:30 +00005816 .......... done
5817 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005818
wdenk2729af92004-05-03 20:45:30 +00005819 => loads 40100000
5820 ## Ready for S-Record download ...
5821 ~>examples/image.srec
5822 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5823 ...
5824 15989 15990 15991 15992
5825 [file transfer complete]
5826 [connected]
5827 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005828
5829
wdenk2729af92004-05-03 20:45:30 +00005830You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005831this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005832corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005833
wdenk2729af92004-05-03 20:45:30 +00005834 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005835
wdenk2729af92004-05-03 20:45:30 +00005836 ## Checking Image at 40100000 ...
5837 Image Name: 2.2.13 for initrd on TQM850L
5838 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5839 Data Size: 335725 Bytes = 327 kB = 0 MB
5840 Load Address: 00000000
5841 Entry Point: 0000000c
5842 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005843
5844
wdenk2729af92004-05-03 20:45:30 +00005845Boot Linux:
5846-----------
wdenkc6097192002-11-03 00:24:07 +00005847
wdenk2729af92004-05-03 20:45:30 +00005848The "bootm" command is used to boot an application that is stored in
5849memory (RAM or Flash). In case of a Linux kernel image, the contents
5850of the "bootargs" environment variable is passed to the kernel as
5851parameters. You can check and modify this variable using the
5852"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005853
5854
wdenk2729af92004-05-03 20:45:30 +00005855 => printenv bootargs
5856 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005857
wdenk2729af92004-05-03 20:45:30 +00005858 => 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 +00005859
wdenk2729af92004-05-03 20:45:30 +00005860 => printenv bootargs
5861 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 +00005862
wdenk2729af92004-05-03 20:45:30 +00005863 => bootm 40020000
5864 ## Booting Linux kernel at 40020000 ...
5865 Image Name: 2.2.13 for NFS on TQM850L
5866 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5867 Data Size: 381681 Bytes = 372 kB = 0 MB
5868 Load Address: 00000000
5869 Entry Point: 0000000c
5870 Verifying Checksum ... OK
5871 Uncompressing Kernel Image ... OK
5872 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
5873 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5874 time_init: decrementer frequency = 187500000/60
5875 Calibrating delay loop... 49.77 BogoMIPS
5876 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5877 ...
wdenkc6097192002-11-03 00:24:07 +00005878
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005879If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005880the memory addresses of both the kernel and the initrd image (PPBCOOT
5881format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005882
wdenk2729af92004-05-03 20:45:30 +00005883 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005884
wdenk2729af92004-05-03 20:45:30 +00005885 ## Checking Image at 40100000 ...
5886 Image Name: 2.2.13 for initrd on TQM850L
5887 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5888 Data Size: 335725 Bytes = 327 kB = 0 MB
5889 Load Address: 00000000
5890 Entry Point: 0000000c
5891 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005892
wdenk2729af92004-05-03 20:45:30 +00005893 ## Checking Image at 40200000 ...
5894 Image Name: Simple Ramdisk Image
5895 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5896 Data Size: 566530 Bytes = 553 kB = 0 MB
5897 Load Address: 00000000
5898 Entry Point: 00000000
5899 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005900
wdenk2729af92004-05-03 20:45:30 +00005901 => bootm 40100000 40200000
5902 ## Booting Linux kernel at 40100000 ...
5903 Image Name: 2.2.13 for initrd on TQM850L
5904 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5905 Data Size: 335725 Bytes = 327 kB = 0 MB
5906 Load Address: 00000000
5907 Entry Point: 0000000c
5908 Verifying Checksum ... OK
5909 Uncompressing Kernel Image ... OK
5910 ## Loading RAMDisk Image at 40200000 ...
5911 Image Name: Simple Ramdisk Image
5912 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5913 Data Size: 566530 Bytes = 553 kB = 0 MB
5914 Load Address: 00000000
5915 Entry Point: 00000000
5916 Verifying Checksum ... OK
5917 Loading Ramdisk ... OK
5918 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
5919 Boot arguments: root=/dev/ram
5920 time_init: decrementer frequency = 187500000/60
5921 Calibrating delay loop... 49.77 BogoMIPS
5922 ...
5923 RAMDISK: Compressed image found at block 0
5924 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005925
wdenk2729af92004-05-03 20:45:30 +00005926 bash#
wdenkc6097192002-11-03 00:24:07 +00005927
Matthew McClintock02677682006-06-28 10:41:37 -05005928Boot Linux and pass a flat device tree:
5929-----------
5930
5931First, U-Boot must be compiled with the appropriate defines. See the section
5932titled "Linux Kernel Interface" above for a more in depth explanation. The
5933following is an example of how to start a kernel and pass an updated
5934flat device tree:
5935
5936=> print oftaddr
5937oftaddr=0x300000
5938=> print oft
5939oft=oftrees/mpc8540ads.dtb
5940=> tftp $oftaddr $oft
5941Speed: 1000, full duplex
5942Using TSEC0 device
5943TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5944Filename 'oftrees/mpc8540ads.dtb'.
5945Load address: 0x300000
5946Loading: #
5947done
5948Bytes transferred = 4106 (100a hex)
5949=> tftp $loadaddr $bootfile
5950Speed: 1000, full duplex
5951Using TSEC0 device
5952TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5953Filename 'uImage'.
5954Load address: 0x200000
5955Loading:############
5956done
5957Bytes transferred = 1029407 (fb51f hex)
5958=> print loadaddr
5959loadaddr=200000
5960=> print oftaddr
5961oftaddr=0x300000
5962=> bootm $loadaddr - $oftaddr
5963## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005964 Image Name: Linux-2.6.17-dirty
5965 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5966 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005967 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005968 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005969 Verifying Checksum ... OK
5970 Uncompressing Kernel Image ... OK
5971Booting using flat device tree at 0x300000
5972Using MPC85xx ADS machine description
5973Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5974[snip]
5975
5976
wdenk2729af92004-05-03 20:45:30 +00005977More About U-Boot Image Types:
5978------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005979
wdenk2729af92004-05-03 20:45:30 +00005980U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005981
wdenk2729af92004-05-03 20:45:30 +00005982 "Standalone Programs" are directly runnable in the environment
5983 provided by U-Boot; it is expected that (if they behave
5984 well) you can continue to work in U-Boot after return from
5985 the Standalone Program.
5986 "OS Kernel Images" are usually images of some Embedded OS which
5987 will take over control completely. Usually these programs
5988 will install their own set of exception handlers, device
5989 drivers, set up the MMU, etc. - this means, that you cannot
5990 expect to re-enter U-Boot except by resetting the CPU.
5991 "RAMDisk Images" are more or less just data blocks, and their
5992 parameters (address, size) are passed to an OS kernel that is
5993 being started.
5994 "Multi-File Images" contain several images, typically an OS
5995 (Linux) kernel image and one or more data images like
5996 RAMDisks. This construct is useful for instance when you want
5997 to boot over the network using BOOTP etc., where the boot
5998 server provides just a single image file, but you want to get
5999 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00006000
wdenk2729af92004-05-03 20:45:30 +00006001 "Multi-File Images" start with a list of image sizes, each
6002 image size (in bytes) specified by an "uint32_t" in network
6003 byte order. This list is terminated by an "(uint32_t)0".
6004 Immediately after the terminating 0 follow the images, one by
6005 one, all aligned on "uint32_t" boundaries (size rounded up to
6006 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006007
wdenk2729af92004-05-03 20:45:30 +00006008 "Firmware Images" are binary images containing firmware (like
6009 U-Boot or FPGA images) which usually will be programmed to
6010 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006011
wdenk2729af92004-05-03 20:45:30 +00006012 "Script files" are command sequences that will be executed by
6013 U-Boot's command interpreter; this feature is especially
6014 useful when you configure U-Boot to use a real shell (hush)
6015 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006016
Marek Vasut44f074c2012-03-14 21:52:45 +00006017Booting the Linux zImage:
6018-------------------------
6019
6020On some platforms, it's possible to boot Linux zImage. This is done
6021using the "bootz" command. The syntax of "bootz" command is the same
6022as the syntax of "bootm" command.
6023
Tom Rini8ac28562013-05-16 11:40:11 -04006024Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006025kernel with raw initrd images. The syntax is slightly different, the
6026address of the initrd must be augmented by it's size, in the following
6027format: "<initrd addres>:<initrd size>".
6028
wdenkc6097192002-11-03 00:24:07 +00006029
wdenk2729af92004-05-03 20:45:30 +00006030Standalone HOWTO:
6031=================
wdenkc6097192002-11-03 00:24:07 +00006032
wdenk2729af92004-05-03 20:45:30 +00006033One of the features of U-Boot is that you can dynamically load and
6034run "standalone" applications, which can use some resources of
6035U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006036
wdenk2729af92004-05-03 20:45:30 +00006037Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006038
wdenk2729af92004-05-03 20:45:30 +00006039"Hello World" Demo:
6040-------------------
wdenkc6097192002-11-03 00:24:07 +00006041
wdenk2729af92004-05-03 20:45:30 +00006042'examples/hello_world.c' contains a small "Hello World" Demo
6043application; it is automatically compiled when you build U-Boot.
6044It's configured to run at address 0x00040004, so you can play with it
6045like that:
wdenkc6097192002-11-03 00:24:07 +00006046
wdenk2729af92004-05-03 20:45:30 +00006047 => loads
6048 ## Ready for S-Record download ...
6049 ~>examples/hello_world.srec
6050 1 2 3 4 5 6 7 8 9 10 11 ...
6051 [file transfer complete]
6052 [connected]
6053 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006054
wdenk2729af92004-05-03 20:45:30 +00006055 => go 40004 Hello World! This is a test.
6056 ## Starting application at 0x00040004 ...
6057 Hello World
6058 argc = 7
6059 argv[0] = "40004"
6060 argv[1] = "Hello"
6061 argv[2] = "World!"
6062 argv[3] = "This"
6063 argv[4] = "is"
6064 argv[5] = "a"
6065 argv[6] = "test."
6066 argv[7] = "<NULL>"
6067 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006068
wdenk2729af92004-05-03 20:45:30 +00006069 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006070
wdenk2729af92004-05-03 20:45:30 +00006071Another example, which demonstrates how to register a CPM interrupt
6072handler with the U-Boot code, can be found in 'examples/timer.c'.
6073Here, a CPM timer is set up to generate an interrupt every second.
6074The interrupt service routine is trivial, just printing a '.'
6075character, but this is just a demo program. The application can be
6076controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006077
wdenk2729af92004-05-03 20:45:30 +00006078 ? - print current values og the CPM Timer registers
6079 b - enable interrupts and start timer
6080 e - stop timer and disable interrupts
6081 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006082
wdenk2729af92004-05-03 20:45:30 +00006083 => loads
6084 ## Ready for S-Record download ...
6085 ~>examples/timer.srec
6086 1 2 3 4 5 6 7 8 9 10 11 ...
6087 [file transfer complete]
6088 [connected]
6089 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006090
wdenk2729af92004-05-03 20:45:30 +00006091 => go 40004
6092 ## Starting application at 0x00040004 ...
6093 TIMERS=0xfff00980
6094 Using timer 1
6095 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006096
wdenk2729af92004-05-03 20:45:30 +00006097Hit 'b':
6098 [q, b, e, ?] Set interval 1000000 us
6099 Enabling timer
6100Hit '?':
6101 [q, b, e, ?] ........
6102 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6103Hit '?':
6104 [q, b, e, ?] .
6105 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6106Hit '?':
6107 [q, b, e, ?] .
6108 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6109Hit '?':
6110 [q, b, e, ?] .
6111 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6112Hit 'e':
6113 [q, b, e, ?] ...Stopping timer
6114Hit 'q':
6115 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006116
6117
wdenk2729af92004-05-03 20:45:30 +00006118Minicom warning:
6119================
wdenk85ec0bc2003-03-31 16:34:49 +00006120
wdenk2729af92004-05-03 20:45:30 +00006121Over time, many people have reported problems when trying to use the
6122"minicom" terminal emulation program for serial download. I (wd)
6123consider minicom to be broken, and recommend not to use it. Under
6124Unix, I recommend to use C-Kermit for general purpose use (and
6125especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006126use "cu" for S-Record download ("loads" command). See
6127http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6128for help with kermit.
6129
wdenk85ec0bc2003-03-31 16:34:49 +00006130
wdenk2729af92004-05-03 20:45:30 +00006131Nevertheless, if you absolutely want to use it try adding this
6132configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006133
wdenk2729af92004-05-03 20:45:30 +00006134 Name Program Name U/D FullScr IO-Red. Multi
6135 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6136 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006137
6138
wdenk2729af92004-05-03 20:45:30 +00006139NetBSD Notes:
6140=============
wdenkc6097192002-11-03 00:24:07 +00006141
wdenk2729af92004-05-03 20:45:30 +00006142Starting at version 0.9.2, U-Boot supports NetBSD both as host
6143(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006144
wdenk2729af92004-05-03 20:45:30 +00006145Building requires a cross environment; it is known to work on
6146NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6147need gmake since the Makefiles are not compatible with BSD make).
6148Note that the cross-powerpc package does not install include files;
6149attempting to build U-Boot will fail because <machine/ansi.h> is
6150missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006151
wdenk2729af92004-05-03 20:45:30 +00006152 # cd /usr/pkg/cross/powerpc-netbsd/include
6153 # mkdir powerpc
6154 # ln -s powerpc machine
6155 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6156 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006157
wdenk2729af92004-05-03 20:45:30 +00006158Native builds *don't* work due to incompatibilities between native
6159and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006160
wdenk2729af92004-05-03 20:45:30 +00006161Booting assumes that (the first part of) the image booted is a
6162stage-2 loader which in turn loads and then invokes the kernel
6163proper. Loader sources will eventually appear in the NetBSD source
6164tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006165meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006166
6167
wdenk2729af92004-05-03 20:45:30 +00006168Implementation Internals:
6169=========================
wdenkc6097192002-11-03 00:24:07 +00006170
wdenk2729af92004-05-03 20:45:30 +00006171The following is not intended to be a complete description of every
6172implementation detail. However, it should help to understand the
6173inner workings of U-Boot and make it easier to port it to custom
6174hardware.
wdenkc6097192002-11-03 00:24:07 +00006175
6176
wdenk2729af92004-05-03 20:45:30 +00006177Initial Stack, Global Data:
6178---------------------------
wdenkc6097192002-11-03 00:24:07 +00006179
wdenk2729af92004-05-03 20:45:30 +00006180The implementation of U-Boot is complicated by the fact that U-Boot
6181starts running out of ROM (flash memory), usually without access to
6182system RAM (because the memory controller is not initialized yet).
6183This means that we don't have writable Data or BSS segments, and BSS
6184is not initialized as zero. To be able to get a C environment working
6185at all, we have to allocate at least a minimal stack. Implementation
6186options for this are defined and restricted by the CPU used: Some CPU
6187models provide on-chip memory (like the IMMR area on MPC8xx and
6188MPC826x processors), on others (parts of) the data cache can be
6189locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006190
Wolfgang Denk218ca722008-03-26 10:40:12 +01006191 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006192 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006193
wdenk2729af92004-05-03 20:45:30 +00006194 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6195 From: "Chris Hallinan" <clh@net1plus.com>
6196 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6197 ...
wdenk43d96162003-03-06 00:02:04 +00006198
wdenk2729af92004-05-03 20:45:30 +00006199 Correct me if I'm wrong, folks, but the way I understand it
6200 is this: Using DCACHE as initial RAM for Stack, etc, does not
6201 require any physical RAM backing up the cache. The cleverness
6202 is that the cache is being used as a temporary supply of
6203 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006204 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006205 can see how this works by studying the cache architecture and
6206 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006207
wdenk2729af92004-05-03 20:45:30 +00006208 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6209 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006210 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006211 option should work for you. Using CS 4 should be fine if your
6212 board designers haven't used it for something that would
6213 cause you grief during the initial boot! It is frequently not
6214 used.
wdenk43d96162003-03-06 00:02:04 +00006215
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006216 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006217 with your processor/board/system design. The default value
6218 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006219 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006220 than your SDRAM module. If you have a 64MB SDRAM module, set
6221 it above 400_0000. Just make sure your board has no resources
6222 that are supposed to respond to that address! That code in
6223 start.S has been around a while and should work as is when
6224 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006225
wdenk2729af92004-05-03 20:45:30 +00006226 -Chris Hallinan
6227 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006228
wdenk2729af92004-05-03 20:45:30 +00006229It is essential to remember this, since it has some impact on the C
6230code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006231
wdenk2729af92004-05-03 20:45:30 +00006232* Initialized global data (data segment) is read-only. Do not attempt
6233 to write it.
wdenkc6097192002-11-03 00:24:07 +00006234
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006235* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006236 as zero data - BSS segment) at all - this is undefined, initiali-
6237 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006238
wdenk2729af92004-05-03 20:45:30 +00006239* Stack space is very limited. Avoid big data buffers or things like
6240 that.
wdenkc6097192002-11-03 00:24:07 +00006241
wdenk2729af92004-05-03 20:45:30 +00006242Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006243normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006244turned out that the implementation of U-Boot can be greatly
6245simplified by making a global data structure (gd_t) available to all
6246functions. We could pass a pointer to this data as argument to _all_
6247functions, but this would bloat the code. Instead we use a feature of
6248the GCC compiler (Global Register Variables) to share the data: we
6249place a pointer (gd) to the global data into a register which we
6250reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006251
wdenk2729af92004-05-03 20:45:30 +00006252When choosing a register for such a purpose we are restricted by the
6253relevant (E)ABI specifications for the current architecture, and by
6254GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006255
wdenk2729af92004-05-03 20:45:30 +00006256For PowerPC, the following registers have specific use:
6257 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006258 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006259 R3-R4: parameter passing and return values
6260 R5-R10: parameter passing
6261 R13: small data area pointer
6262 R30: GOT pointer
6263 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006264
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006265 (U-Boot also uses R12 as internal GOT pointer. r12
6266 is a volatile register so r12 needs to be reset when
6267 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006268
Wolfgang Denke7670f62008-02-14 22:43:22 +01006269 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006270
wdenk2729af92004-05-03 20:45:30 +00006271 Note: on PPC, we could use a static initializer (since the
6272 address of the global data structure is known at compile time),
6273 but it turned out that reserving a register results in somewhat
6274 smaller code - although the code savings are not that big (on
6275 average for all boards 752 bytes for the whole U-Boot image,
6276 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006277
Robin Getzc4db3352009-08-17 15:23:02 +00006278On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006279 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6280
Robin Getzc4db3352009-08-17 15:23:02 +00006281 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006282
wdenk2729af92004-05-03 20:45:30 +00006283On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006284
wdenk2729af92004-05-03 20:45:30 +00006285 R0: function argument word/integer result
6286 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006287 R9: platform specific
6288 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006289 R11: argument (frame) pointer
6290 R12: temporary workspace
6291 R13: stack pointer
6292 R14: link register
6293 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006294
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006295 ==> U-Boot will use R9 to hold a pointer to the global data
6296
6297 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006298
Thomas Chou0df01fd32010-05-21 11:08:03 +08006299On Nios II, the ABI is documented here:
6300 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6301
6302 ==> U-Boot will use gp to hold a pointer to the global data
6303
6304 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6305 to access small data sections, so gp is free.
6306
Macpaul Linafc1ce82011-10-19 20:41:11 +00006307On NDS32, the following registers are used:
6308
6309 R0-R1: argument/return
6310 R2-R5: argument
6311 R15: temporary register for assembler
6312 R16: trampoline register
6313 R28: frame pointer (FP)
6314 R29: global pointer (GP)
6315 R30: link register (LP)
6316 R31: stack pointer (SP)
6317 PC: program counter (PC)
6318
6319 ==> U-Boot will use R10 to hold a pointer to the global data
6320
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006321NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6322or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006323
wdenk2729af92004-05-03 20:45:30 +00006324Memory Management:
6325------------------
wdenkc6097192002-11-03 00:24:07 +00006326
wdenk2729af92004-05-03 20:45:30 +00006327U-Boot runs in system state and uses physical addresses, i.e. the
6328MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006329
wdenk2729af92004-05-03 20:45:30 +00006330The available memory is mapped to fixed addresses using the memory
6331controller. In this process, a contiguous block is formed for each
6332memory type (Flash, SDRAM, SRAM), even when it consists of several
6333physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006334
wdenk2729af92004-05-03 20:45:30 +00006335U-Boot is installed in the first 128 kB of the first Flash bank (on
6336TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6337booting and sizing and initializing DRAM, the code relocates itself
6338to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006339memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006340configuration setting]. Below that, a structure with global Board
6341Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006342
wdenk2729af92004-05-03 20:45:30 +00006343Additionally, some exception handler code is copied to the low 8 kB
6344of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006345
wdenk2729af92004-05-03 20:45:30 +00006346So a typical memory configuration with 16 MB of DRAM could look like
6347this:
wdenkc6097192002-11-03 00:24:07 +00006348
wdenk2729af92004-05-03 20:45:30 +00006349 0x0000 0000 Exception Vector code
6350 :
6351 0x0000 1FFF
6352 0x0000 2000 Free for Application Use
6353 :
6354 :
wdenkc6097192002-11-03 00:24:07 +00006355
wdenk2729af92004-05-03 20:45:30 +00006356 :
6357 :
6358 0x00FB FF20 Monitor Stack (Growing downward)
6359 0x00FB FFAC Board Info Data and permanent copy of global data
6360 0x00FC 0000 Malloc Arena
6361 :
6362 0x00FD FFFF
6363 0x00FE 0000 RAM Copy of Monitor Code
6364 ... eventually: LCD or video framebuffer
6365 ... eventually: pRAM (Protected RAM - unchanged by reset)
6366 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006367
6368
wdenk2729af92004-05-03 20:45:30 +00006369System Initialization:
6370----------------------
wdenkc6097192002-11-03 00:24:07 +00006371
wdenk2729af92004-05-03 20:45:30 +00006372In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006373(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006374configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006375To be able to re-map memory U-Boot then jumps to its link address.
6376To be able to implement the initialization code in C, a (small!)
6377initial stack is set up in the internal Dual Ported RAM (in case CPUs
6378which provide such a feature like MPC8xx or MPC8260), or in a locked
6379part of the data cache. After that, U-Boot initializes the CPU core,
6380the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006381
wdenk2729af92004-05-03 20:45:30 +00006382Next, all (potentially) available memory banks are mapped using a
6383preliminary mapping. For example, we put them on 512 MB boundaries
6384(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6385on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6386programmed for SDRAM access. Using the temporary configuration, a
6387simple memory test is run that determines the size of the SDRAM
6388banks.
wdenkc6097192002-11-03 00:24:07 +00006389
wdenk2729af92004-05-03 20:45:30 +00006390When there is more than one SDRAM bank, and the banks are of
6391different size, the largest is mapped first. For equal size, the first
6392bank (CS2#) is mapped first. The first mapping is always for address
63930x00000000, with any additional banks following immediately to create
6394contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006395
wdenk2729af92004-05-03 20:45:30 +00006396Then, the monitor installs itself at the upper end of the SDRAM area
6397and allocates memory for use by malloc() and for the global Board
6398Info data; also, the exception vector code is copied to the low RAM
6399pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006400
wdenk2729af92004-05-03 20:45:30 +00006401Only after this relocation will you have a "normal" C environment;
6402until that you are restricted in several ways, mostly because you are
6403running from ROM, and because the code will have to be relocated to a
6404new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006405
6406
wdenk2729af92004-05-03 20:45:30 +00006407U-Boot Porting Guide:
6408----------------------
wdenkc6097192002-11-03 00:24:07 +00006409
wdenk2729af92004-05-03 20:45:30 +00006410[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6411list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006412
6413
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006414int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006415{
6416 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006417
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006418 signal(SIGALRM, no_more_time);
6419 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006420
wdenk2729af92004-05-03 20:45:30 +00006421 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006422 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006423 return 0;
6424 }
6425
wdenk2729af92004-05-03 20:45:30 +00006426 Download latest U-Boot source;
6427
Wolfgang Denk06682362008-12-30 22:56:11 +01006428 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006429
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006430 if (clueless)
6431 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006432
wdenk2729af92004-05-03 20:45:30 +00006433 while (learning) {
6434 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006435 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6436 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006437 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006438 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006439 }
wdenkc6097192002-11-03 00:24:07 +00006440
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006441 if (available_money > toLocalCurrency ($2500))
6442 Buy a BDI3000;
6443 else
wdenk2729af92004-05-03 20:45:30 +00006444 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006445
6446 if (a similar board exists) { /* hopefully... */
6447 cp -a board/<similar> board/<myboard>
6448 cp include/configs/<similar>.h include/configs/<myboard>.h
6449 } else {
6450 Create your own board support subdirectory;
6451 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006452 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006453 Edit new board/<myboard> files
6454 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006455
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006456 while (!accepted) {
6457 while (!running) {
6458 do {
6459 Add / modify source code;
6460 } until (compiles);
6461 Debug;
6462 if (clueless)
6463 email("Hi, I am having problems...");
6464 }
6465 Send patch file to the U-Boot email list;
6466 if (reasonable critiques)
6467 Incorporate improvements from email list code review;
6468 else
6469 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006470 }
wdenkc6097192002-11-03 00:24:07 +00006471
wdenk2729af92004-05-03 20:45:30 +00006472 return 0;
6473}
6474
6475void no_more_time (int sig)
6476{
6477 hire_a_guru();
6478}
wdenkc6097192002-11-03 00:24:07 +00006479
6480
wdenk2729af92004-05-03 20:45:30 +00006481Coding Standards:
6482-----------------
wdenkc6097192002-11-03 00:24:07 +00006483
wdenk2729af92004-05-03 20:45:30 +00006484All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006485coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006486"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006487
Detlev Zundel2c051652006-09-01 15:39:02 +02006488Source files originating from a different project (for example the
6489MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006490reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006491sources.
6492
6493Please note that U-Boot is implemented in C (and to some small parts in
6494Assembler); no C++ is used, so please do not use C++ style comments (//)
6495in your code.
wdenk2729af92004-05-03 20:45:30 +00006496
6497Please also stick to the following formatting rules:
6498- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006499- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006500- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006501- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006502- do not add trailing empty lines to source files
6503
6504Submissions which do not conform to the standards may be returned
6505with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006506
6507
wdenk2729af92004-05-03 20:45:30 +00006508Submitting Patches:
6509-------------------
wdenkc6097192002-11-03 00:24:07 +00006510
wdenk2729af92004-05-03 20:45:30 +00006511Since the number of patches for U-Boot is growing, we need to
6512establish some rules. Submissions which do not conform to these rules
6513may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006514
Magnus Lilja0d28f342008-08-06 19:32:33 +02006515Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006516
Wolfgang Denk06682362008-12-30 22:56:11 +01006517Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6518see http://lists.denx.de/mailman/listinfo/u-boot
6519
wdenk2729af92004-05-03 20:45:30 +00006520When you send a patch, please include the following information with
6521it:
wdenkc6097192002-11-03 00:24:07 +00006522
wdenk2729af92004-05-03 20:45:30 +00006523* For bug fixes: a description of the bug and how your patch fixes
6524 this bug. Please try to include a way of demonstrating that the
6525 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006526
wdenk2729af92004-05-03 20:45:30 +00006527* For new features: a description of the feature and your
6528 implementation.
wdenkc6097192002-11-03 00:24:07 +00006529
wdenk2729af92004-05-03 20:45:30 +00006530* A CHANGELOG entry as plaintext (separate from the patch)
6531
Robert P. J. Day7207b362015-12-19 07:16:10 -05006532* For major contributions, add a MAINTAINERS file with your
6533 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00006534
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006535* When you add support for a new board, don't forget to add a
6536 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006537
6538* If your patch adds new configuration options, don't forget to
6539 document these in the README file.
6540
Wolfgang Denk218ca722008-03-26 10:40:12 +01006541* The patch itself. If you are using git (which is *strongly*
6542 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006543 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006544 the U-Boot mailing list, you will avoid most of the common problems
6545 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006546
Wolfgang Denk218ca722008-03-26 10:40:12 +01006547 If you cannot use git, use "diff -purN OLD NEW". If your version of
6548 diff does not support these options, then get the latest version of
6549 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006550
Wolfgang Denk218ca722008-03-26 10:40:12 +01006551 The current directory when running this command shall be the parent
6552 directory of the U-Boot source tree (i. e. please make sure that
6553 your patch includes sufficient directory information for the
6554 affected files).
6555
6556 We prefer patches as plain text. MIME attachments are discouraged,
6557 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006558
6559* If one logical set of modifications affects or creates several
6560 files, all these changes shall be submitted in a SINGLE patch file.
6561
6562* Changesets that contain different, unrelated modifications shall be
6563 submitted as SEPARATE patches, one patch per changeset.
6564
6565
6566Notes:
6567
6568* Before sending the patch, run the MAKEALL script on your patched
6569 source tree and make sure that no errors or warnings are reported
6570 for any of the boards.
6571
6572* Keep your modifications to the necessary minimum: A patch
6573 containing several unrelated changes or arbitrary reformats will be
6574 returned with a request to re-formatting / split it.
6575
6576* If you modify existing code, make sure that your new code does not
6577 add to the memory footprint of the code ;-) Small is beautiful!
6578 When adding new features, these should compile conditionally only
6579 (using #ifdef), and the resulting code with the new feature
6580 disabled must not need more memory than the old code without your
6581 modification.
wdenk90dc6702005-05-03 14:12:25 +00006582
Wolfgang Denk06682362008-12-30 22:56:11 +01006583* Remember that there is a size limit of 100 kB per message on the
6584 u-boot mailing list. Bigger patches will be moderated. If they are
6585 reasonable and not too big, they will be acknowledged. But patches
6586 bigger than the size limit should be avoided.