blob: 26d5ad273ef2d1524bad067b820611a0804df07f [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day7207b362015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day7207b362015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day7207b362015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denk218ca722008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day7207b362015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000115
116
wdenk93f19cc2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Weber360d8832010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000126
Thomas Weber360d8832010-09-28 08:06:25 +0200127Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
130 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tyser8d321b82010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /blackfin Files generic to Analog Devices Blackfin architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500143 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000144 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500145 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400146 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200147 /powerpc Files generic to PowerPC architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500148 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sh Files generic to SH architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500150 /sparc Files generic to SPARC architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400151 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500152/api Machine/arch independent API for external apps
153/board Board dependent files
154/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500155/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500156/disk Code for disk drive partition handling
157/doc Documentation (don't expect too much)
158/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400159/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500160/examples Example code for standalone applications, etc.
161/fs Filesystem code (cramfs, ext2, jffs2, etc.)
162/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500163/lib Library routines generic to all architectures
164/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500165/net Networking code
166/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500167/scripts Various build scripts and Makefiles
168/test Various unit test files
Peter Tyser8d321b82010-04-12 22:28:21 -0500169/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000170
wdenkc6097192002-11-03 00:24:07 +0000171Software Configuration:
172=======================
173
174Configuration is usually done using C preprocessor defines; the
175rationale behind that is to avoid dead code whenever possible.
176
177There are two classes of configuration variables:
178
179* Configuration _OPTIONS_:
180 These are selectable by the user and have names beginning with
181 "CONFIG_".
182
183* Configuration _SETTINGS_:
184 These depend on the hardware etc. and should not be meddled with if
185 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200186 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000187
Robert P. J. Day7207b362015-12-19 07:16:10 -0500188Previously, all configuration was done by hand, which involved creating
189symbolic links and editing configuration files manually. More recently,
190U-Boot has added the Kbuild infrastructure used by the Linux kernel,
191allowing you to use the "make menuconfig" command to configure your
192build.
wdenkc6097192002-11-03 00:24:07 +0000193
194
195Selection of Processor Architecture and Board Type:
196---------------------------------------------------
197
198For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200199configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000200
201Example: For a TQM823L module type:
202
203 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200204 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000205
Robert P. J. Day7207b362015-12-19 07:16:10 -0500206Note: If you're looking for the default configuration file for a board
207you're sure used to be there but is now missing, check the file
208doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000209
Simon Glass75b3c3a2014-03-22 17:12:59 -0600210Sandbox Environment:
211--------------------
212
213U-Boot can be built natively to run on a Linux host using the 'sandbox'
214board. This allows feature development which is not board- or architecture-
215specific to be undertaken on a native platform. The sandbox is also used to
216run some of U-Boot's tests.
217
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530218See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600219
220
Simon Glassdb910352015-03-03 08:03:00 -0700221Board Initialisation Flow:
222--------------------------
223
224This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500225SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700226
Robert P. J. Day7207b362015-12-19 07:16:10 -0500227Note: "SPL" stands for "Secondary Program Loader," which is explained in
228more detail later in this file.
229
230At present, SPL mostly uses a separate code path, but the function names
231and roles of each function are the same. Some boards or architectures
232may not conform to this. At least most ARM boards which use
233CONFIG_SPL_FRAMEWORK conform to this.
234
235Execution typically starts with an architecture-specific (and possibly
236CPU-specific) start.S file, such as:
237
238 - arch/arm/cpu/armv7/start.S
239 - arch/powerpc/cpu/mpc83xx/start.S
240 - arch/mips/cpu/start.S
241
242and so on. From there, three functions are called; the purpose and
243limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700244
245lowlevel_init():
246 - purpose: essential init to permit execution to reach board_init_f()
247 - no global_data or BSS
248 - there is no stack (ARMv7 may have one but it will soon be removed)
249 - must not set up SDRAM or use console
250 - must only do the bare minimum to allow execution to continue to
251 board_init_f()
252 - this is almost never needed
253 - return normally from this function
254
255board_init_f():
256 - purpose: set up the machine ready for running board_init_r():
257 i.e. SDRAM and serial UART
258 - global_data is available
259 - stack is in SRAM
260 - BSS is not available, so you cannot use global/static variables,
261 only stack variables and global_data
262
263 Non-SPL-specific notes:
264 - dram_init() is called to set up DRAM. If already done in SPL this
265 can do nothing
266
267 SPL-specific notes:
268 - you can override the entire board_init_f() function with your own
269 version as needed.
270 - preloader_console_init() can be called here in extremis
271 - should set up SDRAM, and anything needed to make the UART work
272 - these is no need to clear BSS, it will be done by crt0.S
273 - must return normally from this function (don't call board_init_r()
274 directly)
275
276Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
277this point the stack and global_data are relocated to below
278CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
279memory.
280
281board_init_r():
282 - purpose: main execution, common code
283 - global_data is available
284 - SDRAM is available
285 - BSS is available, all static/global variables can be used
286 - execution eventually continues to main_loop()
287
288 Non-SPL-specific notes:
289 - U-Boot is relocated to the top of memory and is now running from
290 there.
291
292 SPL-specific notes:
293 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
294 CONFIG_SPL_STACK_R_ADDR points into SDRAM
295 - preloader_console_init() can be called here - typically this is
296 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
297 spl_board_init() function containing this call
298 - loads U-Boot or (in falcon mode) Linux
299
300
301
wdenkc6097192002-11-03 00:24:07 +0000302Configuration Options:
303----------------------
304
305Configuration depends on the combination of board and CPU type; all
306such information is kept in a configuration file
307"include/configs/<board_name>.h".
308
309Example: For a TQM823L module, all configuration settings are in
310"include/configs/TQM823L.h".
311
312
wdenk7f6c2cb2002-11-10 22:06:23 +0000313Many of the options are named exactly as the corresponding Linux
314kernel configuration options. The intention is to make it easier to
315build a config tool - later.
316
317
wdenkc6097192002-11-03 00:24:07 +0000318The following options need to be configured:
319
Kim Phillips26281142007-08-10 13:28:25 -0500320- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000321
Kim Phillips26281142007-08-10 13:28:25 -0500322- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200323
324- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100325 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000326
327- CPU Module Type: (if CONFIG_COGENT is defined)
328 Define exactly one of
329 CONFIG_CMA286_60_OLD
330--- FIXME --- not tested yet:
331 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
332 CONFIG_CMA287_23, CONFIG_CMA287_50
333
334- Motherboard Type: (if CONFIG_COGENT is defined)
335 Define exactly one of
336 CONFIG_CMA101, CONFIG_CMA102
337
338- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
339 Define one or more of
340 CONFIG_CMA302
341
342- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
343 Define one or more of
344 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200345 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000346 a "rotator" |\-/|\-/
347
Lei Wencf946c62011-02-09 18:06:58 +0530348- Marvell Family Member
349 CONFIG_SYS_MVFS - define it if you want to enable
350 multiple fs option at one time
351 for marvell soc family
352
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200353- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000354 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
355 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000356 e.g. if there is no 32KHz
357 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000358 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
359 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000360
wdenk66ca92a2004-09-28 17:59:53 +0000361- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200362 CONFIG_SYS_8xx_CPUCLK_MIN
363 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000364 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000365 See doc/README.MPC866
366
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200367 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000368
wdenkba56f622004-02-06 23:19:44 +0000369 Define this to measure the actual CPU clock instead
370 of relying on the correctness of the configured
371 values. Mostly useful for board bringup to make sure
372 the PLL is locked at the intended frequency. Note
373 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200374 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000375
Heiko Schocher506f3912009-03-12 07:37:15 +0100376 CONFIG_SYS_DELAYED_ICACHE
377
378 Define this option if you want to enable the
379 ICache only when Code runs from RAM.
380
Kumar Gala66412c62011-02-18 05:40:54 -0600381- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000382 CONFIG_SYS_PPC64
383
384 Specifies that the core is a 64-bit PowerPC implementation (implements
385 the "64" category of the Power ISA). This is necessary for ePAPR
386 compliance, among other possible reasons.
387
Kumar Gala66412c62011-02-18 05:40:54 -0600388 CONFIG_SYS_FSL_TBCLK_DIV
389
390 Defines the core time base clock divider ratio compared to the
391 system clock. On most PQ3 devices this is 8, on newer QorIQ
392 devices it can be 16 or 32. The ratio varies from SoC to Soc.
393
Kumar Gala8f290842011-05-20 00:39:21 -0500394 CONFIG_SYS_FSL_PCIE_COMPAT
395
396 Defines the string to utilize when trying to match PCIe device
397 tree nodes for the given platform.
398
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000399 CONFIG_SYS_PPC_E500_DEBUG_TLB
400
401 Enables a temporary TLB entry to be used during boot to work
402 around limitations in e500v1 and e500v2 external debugger
403 support. This reduces the portions of the boot code where
404 breakpoints and single stepping do not work. The value of this
405 symbol should be set to the TLB1 entry to be used for this
406 purpose.
407
Scott Wood33eee332012-08-14 10:14:53 +0000408 CONFIG_SYS_FSL_ERRATUM_A004510
409
410 Enables a workaround for erratum A004510. If set,
411 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
413
414 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
415 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
416
417 Defines one or two SoC revisions (low 8 bits of SVR)
418 for which the A004510 workaround should be applied.
419
420 The rest of SVR is either not relevant to the decision
421 of whether the erratum is present (e.g. p2040 versus
422 p2041) or is implied by the build target, which controls
423 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
424
425 See Freescale App Note 4493 for more information about
426 this erratum.
427
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530428 CONFIG_A003399_NOR_WORKAROUND
429 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800430 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530431
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530432 CONFIG_A008044_WORKAROUND
433 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800434 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530435
Scott Wood33eee332012-08-14 10:14:53 +0000436 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
437
438 This is the value to write into CCSR offset 0x18600
439 according to the A004510 workaround.
440
Priyanka Jain64501c62013-07-02 09:21:04 +0530441 CONFIG_SYS_FSL_DSP_DDR_ADDR
442 This value denotes start offset of DDR memory which is
443 connected exclusively to the DSP cores.
444
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530445 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
446 This value denotes start offset of M2 memory
447 which is directly connected to the DSP core.
448
Priyanka Jain64501c62013-07-02 09:21:04 +0530449 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
450 This value denotes start offset of M3 memory which is directly
451 connected to the DSP core.
452
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530453 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
454 This value denotes start offset of DSP CCSR space.
455
Priyanka Jainb1359912013-12-17 14:25:52 +0530456 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
457 Single Source Clock is clocking mode present in some of FSL SoC's.
458 In this mode, a single differential clock is used to supply
459 clocks to the sysclock, ddrclock and usbclock.
460
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530461 CONFIG_SYS_CPC_REINIT_F
462 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800463 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530464
Tang Yuantianaade2002014-04-17 15:33:46 +0800465 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800466 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800467 supported, core will start to execute uboot when wakes up.
468
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000469- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700470 CONFIG_SYS_GENERIC_GLOBAL_DATA
471 Defines global data is initialized in generic board board_init_f().
472 If this macro is defined, global data is created and cleared in
473 generic board board_init_f(). Without this macro, architecture/board
474 should initialize global data before calling board_init_f().
475
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000476 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
477
478 Defines the endianess of the CPU. Implementation of those
479 values is arch specific.
480
York Sun5614e712013-09-30 09:22:09 -0700481 CONFIG_SYS_FSL_DDR
482 Freescale DDR driver in use. This type of DDR controller is
483 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
484 SoCs.
485
486 CONFIG_SYS_FSL_DDR_ADDR
487 Freescale DDR memory-mapped register base.
488
489 CONFIG_SYS_FSL_DDR_EMU
490 Specify emulator support for DDR. Some DDR features such as
491 deskew training are not available.
492
493 CONFIG_SYS_FSL_DDRC_GEN1
494 Freescale DDR1 controller.
495
496 CONFIG_SYS_FSL_DDRC_GEN2
497 Freescale DDR2 controller.
498
499 CONFIG_SYS_FSL_DDRC_GEN3
500 Freescale DDR3 controller.
501
York Sun34e026f2014-03-27 17:54:47 -0700502 CONFIG_SYS_FSL_DDRC_GEN4
503 Freescale DDR4 controller.
504
York Sun9ac4ffb2013-09-30 14:20:51 -0700505 CONFIG_SYS_FSL_DDRC_ARM_GEN3
506 Freescale DDR3 controller for ARM-based SoCs.
507
York Sun5614e712013-09-30 09:22:09 -0700508 CONFIG_SYS_FSL_DDR1
509 Board config to use DDR1. It can be enabled for SoCs with
510 Freescale DDR1 or DDR2 controllers, depending on the board
511 implemetation.
512
513 CONFIG_SYS_FSL_DDR2
514 Board config to use DDR2. It can be eanbeld for SoCs with
515 Freescale DDR2 or DDR3 controllers, depending on the board
516 implementation.
517
518 CONFIG_SYS_FSL_DDR3
519 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700520 Freescale DDR3 or DDR3L controllers.
521
522 CONFIG_SYS_FSL_DDR3L
523 Board config to use DDR3L. It can be enabled for SoCs with
524 DDR3L controllers.
525
526 CONFIG_SYS_FSL_DDR4
527 Board config to use DDR4. It can be enabled for SoCs with
528 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700529
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530530 CONFIG_SYS_FSL_IFC_BE
531 Defines the IFC controller register space as Big Endian
532
533 CONFIG_SYS_FSL_IFC_LE
534 Defines the IFC controller register space as Little Endian
535
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530536 CONFIG_SYS_FSL_PBL_PBI
537 It enables addition of RCW (Power on reset configuration) in built image.
538 Please refer doc/README.pblimage for more details
539
540 CONFIG_SYS_FSL_PBL_RCW
541 It adds PBI(pre-boot instructions) commands in u-boot build image.
542 PBI commands can be used to configure SoC before it starts the execution.
543 Please refer doc/README.pblimage for more details
544
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530545 CONFIG_SPL_FSL_PBL
546 It adds a target to create boot binary having SPL binary in PBI format
547 concatenated with u-boot binary.
548
York Sun4e5b1bd2014-02-10 13:59:42 -0800549 CONFIG_SYS_FSL_DDR_BE
550 Defines the DDR controller register space as Big Endian
551
552 CONFIG_SYS_FSL_DDR_LE
553 Defines the DDR controller register space as Little Endian
554
York Sun6b9e3092014-02-10 13:59:43 -0800555 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
556 Physical address from the view of DDR controllers. It is the
557 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
558 it could be different for ARM SoCs.
559
York Sun6b1e1252014-02-10 13:59:44 -0800560 CONFIG_SYS_FSL_DDR_INTLV_256B
561 DDR controller interleaving on 256-byte. This is a special
562 interleaving mode, handled by Dickens for Freescale layerscape
563 SoCs with ARM core.
564
York Sun1d71efb2014-08-01 15:51:00 -0700565 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
566 Number of controllers used as main memory.
567
568 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
569 Number of controllers used for other than main memory.
570
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530571 CONFIG_SYS_FSL_HAS_DP_DDR
572 Defines the SoC has DP-DDR used for DPAA.
573
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530574 CONFIG_SYS_FSL_SEC_BE
575 Defines the SEC controller register space as Big Endian
576
577 CONFIG_SYS_FSL_SEC_LE
578 Defines the SEC controller register space as Little Endian
579
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100580- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200581 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100582
583 Defines the Monahans run mode to oscillator
584 ratio. Valid values are 8, 16, 24, 31. The core
585 frequency is this value multiplied by 13 MHz.
586
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200587 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200588
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100589 Defines the Monahans turbo mode to oscillator
590 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200591 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100592 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200593
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200594- MIPS CPU options:
595 CONFIG_SYS_INIT_SP_OFFSET
596
597 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
598 pointer. This is needed for the temporary stack before
599 relocation.
600
601 CONFIG_SYS_MIPS_CACHE_MODE
602
603 Cache operation mode for the MIPS CPU.
604 See also arch/mips/include/asm/mipsregs.h.
605 Possible values are:
606 CONF_CM_CACHABLE_NO_WA
607 CONF_CM_CACHABLE_WA
608 CONF_CM_UNCACHED
609 CONF_CM_CACHABLE_NONCOHERENT
610 CONF_CM_CACHABLE_CE
611 CONF_CM_CACHABLE_COW
612 CONF_CM_CACHABLE_CUW
613 CONF_CM_CACHABLE_ACCELERATED
614
615 CONFIG_SYS_XWAY_EBU_BOOTCFG
616
617 Special option for Lantiq XWAY SoCs for booting from NOR flash.
618 See also arch/mips/cpu/mips32/start.S.
619
620 CONFIG_XWAY_SWAP_BYTES
621
622 Enable compilation of tools/xway-swap-bytes needed for Lantiq
623 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
624 be swapped if a flash programmer is used.
625
Christian Rieschb67d8812012-02-02 00:44:39 +0000626- ARM options:
627 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
628
629 Select high exception vectors of the ARM core, e.g., do not
630 clear the V bit of the c1 register of CP15.
631
Aneesh V5356f542012-03-08 07:20:19 +0000632 CONFIG_SYS_THUMB_BUILD
633
634 Use this flag to build U-Boot using the Thumb instruction
635 set for ARM architectures. Thumb instruction set provides
636 better code density. For ARM architectures that support
637 Thumb2 this flag will result in Thumb2 code generated by
638 GCC.
639
Stephen Warrenc5d47522013-03-04 13:29:40 +0000640 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000641 CONFIG_ARM_ERRATA_742230
642 CONFIG_ARM_ERRATA_743622
643 CONFIG_ARM_ERRATA_751472
Nitin Gargb7588e32014-04-02 08:55:02 -0500644 CONFIG_ARM_ERRATA_761320
Ian Campbelle392b922015-09-29 10:27:09 +0100645 CONFIG_ARM_ERRATA_773022
646 CONFIG_ARM_ERRATA_774769
647 CONFIG_ARM_ERRATA_794072
Stephen Warren06785872013-02-26 12:28:27 +0000648
649 If set, the workarounds for these ARM errata are applied early
650 during U-Boot startup. Note that these options force the
651 workarounds to be applied; no CPU-type/version detection
652 exists, unlike the similar options in the Linux kernel. Do not
653 set these options unless they apply!
654
York Sun207774b2015-03-20 19:28:08 -0700655 COUNTER_FREQUENCY
656 Generic timer clock source frequency.
657
658 COUNTER_FREQUENCY_REAL
659 Generic timer clock source frequency if the real clock is
660 different from COUNTER_FREQUENCY, and can only be determined
661 at run time.
662
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500663 NOTE: The following can be machine specific errata. These
664 do have ability to provide rudimentary version and machine
665 specific checks, but expect no product checks.
Nishanth Menon5902f4c2015-03-09 17:12:01 -0500666 CONFIG_ARM_ERRATA_430973
Nishanth Menonb45c48a2015-03-09 17:12:00 -0500667 CONFIG_ARM_ERRATA_454179
Nishanth Menon9b4d65f2015-03-09 17:12:02 -0500668 CONFIG_ARM_ERRATA_621766
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500669 CONFIG_ARM_ERRATA_798870
Nishanth Menona615d0b2015-07-27 16:26:05 -0500670 CONFIG_ARM_ERRATA_801819
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500671
Stephen Warren73c38932015-01-19 16:25:52 -0700672- Tegra SoC options:
673 CONFIG_TEGRA_SUPPORT_NON_SECURE
674
675 Support executing U-Boot in non-secure (NS) mode. Certain
676 impossible actions will be skipped if the CPU is in NS mode,
677 such as ARM architectural timer initialization.
678
wdenk5da627a2003-10-09 20:09:04 +0000679- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000680 CONFIG_CLOCKS_IN_MHZ
681
682 U-Boot stores all clock information in Hz
683 internally. For binary compatibility with older Linux
684 kernels (which expect the clocks passed in the
685 bd_info data to be in MHz) the environment variable
686 "clocks_in_mhz" can be defined so that U-Boot
687 converts clock data to MHZ before passing it to the
688 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000689 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100690 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000691 default environment.
692
wdenk5da627a2003-10-09 20:09:04 +0000693 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
694
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800695 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000696 expect it to be in bytes, others in MB.
697 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
698
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400699 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200700
701 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400702 passed using flattened device trees (based on open firmware
703 concepts).
704
705 CONFIG_OF_LIBFDT
706 * New libfdt-based support
707 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500708 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400709
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200710 OF_CPU - The proper name of the cpus node (only required for
711 MPC512X and MPC5xxx based boards).
712 OF_SOC - The proper name of the soc node (only required for
713 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200714 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600715 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200716
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200717 boards with QUICC Engines require OF_QE to set UCC MAC
718 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500719
Kumar Gala4e253132006-01-11 13:54:17 -0600720 CONFIG_OF_BOARD_SETUP
721
722 Board code has addition modification that it wants to make
723 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000724
Simon Glassc654b512014-10-23 18:58:54 -0600725 CONFIG_OF_SYSTEM_SETUP
726
727 Other code has addition modification that it wants to make
728 to the flat device tree before handing it off to the kernel.
729 This causes ft_system_setup() to be called before booting
730 the kernel.
731
Matthew McClintock02677682006-06-28 10:41:37 -0500732 CONFIG_OF_BOOT_CPU
733
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200734 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500735 param header, the default value is zero if undefined.
736
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200737 CONFIG_OF_IDE_FIXUP
738
739 U-Boot can detect if an IDE device is present or not.
740 If not, and this new config option is activated, U-Boot
741 removes the ATA node from the DTS before booting Linux,
742 so the Linux IDE driver does not probe the device and
743 crash. This is needed for buggy hardware (uc101) where
744 no pull down resistor is connected to the signal IDE5V_DD7.
745
Igor Grinberg7eb29392011-07-14 05:45:07 +0000746 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
747
748 This setting is mandatory for all boards that have only one
749 machine type and must be used to specify the machine type
750 number as it appears in the ARM machine registry
751 (see http://www.arm.linux.org.uk/developer/machines/).
752 Only boards that have multiple machine types supported
753 in a single configuration file and the machine type is
754 runtime discoverable, do not have to use this setting.
755
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100756- vxWorks boot parameters:
757
758 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700759 environments variables: bootdev, bootfile, ipaddr, netmask,
760 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100761 It loads the vxWorks image pointed bootfile.
762
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100763 Note: If a "bootargs" environment is defined, it will overwride
764 the defaults discussed just above.
765
Aneesh V2c451f72011-06-16 23:30:47 +0000766- Cache Configuration:
767 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
768 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
769 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
770
Aneesh V93bc2192011-06-16 23:30:51 +0000771- Cache Configuration for ARM:
772 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
773 controller
774 CONFIG_SYS_PL310_BASE - Physical base address of PL310
775 controller register space
776
wdenk6705d812004-08-02 23:22:59 +0000777- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200778 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000779
780 Define this if you want support for Amba PrimeCell PL010 UARTs.
781
Andreas Engel48d01922008-09-08 14:30:53 +0200782 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000783
784 Define this if you want support for Amba PrimeCell PL011 UARTs.
785
786 CONFIG_PL011_CLOCK
787
788 If you have Amba PrimeCell PL011 UARTs, set this variable to
789 the clock speed of the UARTs.
790
791 CONFIG_PL01x_PORTS
792
793 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
794 define this to a list of base addresses for each (supported)
795 port. See e.g. include/configs/versatile.h
796
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400797 CONFIG_SERIAL_HW_FLOW_CONTROL
798
799 Define this variable to enable hw flow control in serial driver.
800 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000801
wdenkc6097192002-11-03 00:24:07 +0000802- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000803 Depending on board, define exactly one serial port
804 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
805 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
806 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000807
808 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
809 port routines must be defined elsewhere
810 (i.e. serial_init(), serial_getc(), ...)
811
812 CONFIG_CFB_CONSOLE
813 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000814 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000815 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
816 (default big endian)
817 VIDEO_HW_RECTFILL graphic chip supports
818 rectangle fill
819 (cf. smiLynxEM)
820 VIDEO_HW_BITBLT graphic chip supports
821 bit-blit (cf. smiLynxEM)
822 VIDEO_VISIBLE_COLS visible pixel columns
823 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000824 VIDEO_VISIBLE_ROWS visible pixel rows
825 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000826 VIDEO_DATA_FORMAT graphic data format
827 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000828 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000829 VIDEO_KBD_INIT_FCT keyboard int fct
Simon Glass39f615e2015-11-11 10:05:47 -0700830 (i.e. rx51_kp_init())
wdenkc6097192002-11-03 00:24:07 +0000831 VIDEO_TSTC_FCT test char fct
Simon Glass39f615e2015-11-11 10:05:47 -0700832 (i.e. rx51_kp_tstc)
wdenkc6097192002-11-03 00:24:07 +0000833 VIDEO_GETC_FCT get char fct
Simon Glass39f615e2015-11-11 10:05:47 -0700834 (i.e. rx51_kp_getc)
wdenkc6097192002-11-03 00:24:07 +0000835 CONFIG_VIDEO_LOGO display Linux logo in
836 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000837 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
838 linux_logo.h for logo.
839 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000840 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200841 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000842 the logo
843
Pali Rohár33a35bb2012-10-19 13:30:09 +0000844 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
845 a limited number of ANSI escape sequences (cursor control,
846 erase functions and limited graphics rendition control).
847
wdenk43d96162003-03-06 00:02:04 +0000848 When CONFIG_CFB_CONSOLE is defined, video console is
849 default i/o. Serial console can be forced with
850 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000851
wdenkd4ca31c2004-01-02 14:00:00 +0000852 When CONFIG_SILENT_CONSOLE is defined, all console
853 messages (by U-Boot and Linux!) can be silenced with
854 the "silent" environment variable. See
855 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000856
Heiko Schocher45ae2542013-10-22 11:06:06 +0200857 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
858 is 0x00.
859 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
860 is 0xa0.
861
wdenkc6097192002-11-03 00:24:07 +0000862- Console Baudrate:
863 CONFIG_BAUDRATE - in bps
864 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200865 CONFIG_SYS_BAUDRATE_TABLE, see below.
866 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000867
Heiko Schocherc92fac92009-01-30 12:55:38 +0100868- Console Rx buffer length
869 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
870 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100871 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100872 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
873 must be defined, to setup the maximum idle timeout for
874 the SMC.
875
Graeme Russ9558b482011-09-01 00:48:27 +0000876- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200877 Prior to the console being initialised (i.e. serial UART
878 initialised etc) all console output is silently discarded.
879 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
880 buffer any console messages prior to the console being
881 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
882 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
883 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200884 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200885 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000886
Hans de Goedea8552c72015-05-05 13:13:36 +0200887 Note that when printing the buffer a copy is made on the
888 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
889
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200890 'Sane' compilers will generate smaller code if
891 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000892
wdenkc6097192002-11-03 00:24:07 +0000893- Autoboot Command:
894 CONFIG_BOOTCOMMAND
895 Only needed when CONFIG_BOOTDELAY is enabled;
896 define a command string that is automatically executed
897 when no character is read on the console interface
898 within "Boot Delay" after reset.
899
900 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000901 This can be used to pass arguments to the bootm
902 command. The value of CONFIG_BOOTARGS goes into the
903 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000904
905 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000906 The value of these goes into the environment as
907 "ramboot" and "nfsboot" respectively, and can be used
908 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200909 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000910
Heiko Schochereda0ba32013-11-04 14:04:59 +0100911- Bootcount:
912 CONFIG_BOOTCOUNT_LIMIT
913 Implements a mechanism for detecting a repeating reboot
914 cycle, see:
915 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
916
917 CONFIG_BOOTCOUNT_ENV
918 If no softreset save registers are found on the hardware
919 "bootcount" is stored in the environment. To prevent a
920 saveenv on all reboots, the environment variable
921 "upgrade_available" is used. If "upgrade_available" is
922 0, "bootcount" is always 0, if "upgrade_available" is
923 1 "bootcount" is incremented in the environment.
924 So the Userspace Applikation must set the "upgrade_available"
925 and "bootcount" variable to 0, if a boot was successfully.
926
wdenkc6097192002-11-03 00:24:07 +0000927- Pre-Boot Commands:
928 CONFIG_PREBOOT
929
930 When this option is #defined, the existence of the
931 environment variable "preboot" will be checked
932 immediately before starting the CONFIG_BOOTDELAY
933 countdown and/or running the auto-boot command resp.
934 entering interactive mode.
935
936 This feature is especially useful when "preboot" is
937 automatically generated or modified. For an example
938 see the LWMON board specific code: here "preboot" is
939 modified when the user holds down a certain
940 combination of keys on the (special) keyboard when
941 booting the systems
942
943- Serial Download Echo Mode:
944 CONFIG_LOADS_ECHO
945 If defined to 1, all characters received during a
946 serial download (using the "loads" command) are
947 echoed back. This might be needed by some terminal
948 emulations (like "cu"), but may as well just take
949 time on others. This setting #define's the initial
950 value of the "loads_echo" environment variable.
951
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500952- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000953 CONFIG_KGDB_BAUDRATE
954 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200955 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000956
957- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500958 Monitor commands can be included or excluded
959 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000960 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500961 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000962
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500963 The default command configuration includes all commands
964 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000965
Marek Vasutb401b732014-03-05 19:58:39 +0100966 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500967 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500968 CONFIG_CMD_BDI bdinfo
969 CONFIG_CMD_BEDBUG * Include BedBug Debugger
970 CONFIG_CMD_BMP * BMP support
971 CONFIG_CMD_BSP * Board specific commands
972 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400973 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500974 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800975 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500976 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500977 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500978 CONFIG_CMD_DATE * support for RTC, date/time...
979 CONFIG_CMD_DHCP * DHCP support
980 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600981 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
982 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
983 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
984 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500985 CONFIG_CMD_DTT * Digital Therm and Thermostat
986 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500987 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500988 CONFIG_CMD_EEPROM * EEPROM read/write support
Nikita Kiryanovaa9e6042016-04-16 17:55:03 +0300989 CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500990 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600991 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600992 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500993 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500994 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000995 CONFIG_CMD_EXT2 * ext2 command support
996 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700997 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
998 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +0100999 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001000 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001001 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001002 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001003 CONFIG_CMD_FLASH flinfo, erase, protect
1004 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001005 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001006 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001007 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001008 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001009 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001010 CONFIG_CMD_I2C * I2C serial bus support
1011 CONFIG_CMD_IDE * IDE harddisk support
1012 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001013 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001014 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001015 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001016 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001017 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001018 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001019 CONFIG_CMD_IRQ * irqinfo
1020 CONFIG_CMD_ITEST Integer/string test of 2 values
1021 CONFIG_CMD_JFFS2 * JFFS2 Support
1022 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001023 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001024 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1025 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001026 CONFIG_CMD_LOADB loadb
1027 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001028 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001029 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001030 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001031 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001032 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001033 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001034 CONFIG_CMD_MISC Misc functions like sleep etc
1035 CONFIG_CMD_MMC * MMC memory mapped support
1036 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001037 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001038 CONFIG_CMD_NAND * NAND support
1039 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001040 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001041 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001042 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001043 CONFIG_CMD_PCI * pciinfo
1044 CONFIG_CMD_PCMCIA * PCMCIA support
1045 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1046 host
1047 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001048 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001049 CONFIG_CMD_REGINFO * Register dump
1050 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001051 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001052 CONFIG_CMD_SAVES * save S record dump
Simon Glassc649e3c2016-05-01 11:36:02 -06001053 CONFIG_SCSI * SCSI Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001054 CONFIG_CMD_SDRAM * print SDRAM configuration information
1055 (requires CONFIG_CMD_I2C)
1056 CONFIG_CMD_SETGETDCR Support for DCR Register access
1057 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001058 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001059 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001060 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001061 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001062 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001063 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001064 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001065 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001066 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1067 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001068 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001070 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001071 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001072 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001073
1074 EXAMPLE: If you want all functions except of network
1075 support you can write:
1076
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001077 #include "config_cmd_all.h"
1078 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001079
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001080 Other Commands:
1081 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001082
1083 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001084 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001085 what you (and your U-Boot users) are doing. Data
1086 cache cannot be enabled on systems like the 8xx or
1087 8260 (where accesses to the IMMR region must be
1088 uncached), and it cannot be disabled on all other
1089 systems where we (mis-) use the data cache to hold an
1090 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001091
1092
1093 XXX - this list needs to get updated!
1094
Simon Glass302a6482016-03-13 19:07:28 -06001095- Removal of commands
1096 If no commands are needed to boot, you can disable
1097 CONFIG_CMDLINE to remove them. In this case, the command line
1098 will not be available, and when U-Boot wants to execute the
1099 boot command (on start-up) it will call board_run_command()
1100 instead. This can reduce image size significantly for very
1101 simple boot procedures.
1102
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001103- Regular expression support:
1104 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001105 If this variable is defined, U-Boot is linked against
1106 the SLRE (Super Light Regular Expression) library,
1107 which adds regex support to some commands, as for
1108 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001109
Simon Glass45ba8072011-10-15 05:48:20 +00001110- Device tree:
1111 CONFIG_OF_CONTROL
1112 If this variable is defined, U-Boot will use a device tree
1113 to configure its devices, instead of relying on statically
1114 compiled #defines in the board file. This option is
1115 experimental and only available on a few boards. The device
1116 tree is available in the global data as gd->fdt_blob.
1117
Simon Glass2c0f79e2011-10-24 19:15:31 +00001118 U-Boot needs to get its device tree from somewhere. This can
1119 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001120
1121 CONFIG_OF_EMBED
1122 If this variable is defined, U-Boot will embed a device tree
1123 binary in its image. This device tree file should be in the
1124 board directory and called <soc>-<board>.dts. The binary file
1125 is then picked up in board_init_f() and made available through
1126 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001127
Simon Glass2c0f79e2011-10-24 19:15:31 +00001128 CONFIG_OF_SEPARATE
1129 If this variable is defined, U-Boot will build a device tree
1130 binary. It will be called u-boot.dtb. Architecture-specific
1131 code will locate it at run-time. Generally this works by:
1132
1133 cat u-boot.bin u-boot.dtb >image.bin
1134
1135 and in fact, U-Boot does this for you, creating a file called
1136 u-boot-dtb.bin which is useful in the common case. You can
1137 still use the individual files if you need something more
1138 exotic.
1139
wdenkc6097192002-11-03 00:24:07 +00001140- Watchdog:
1141 CONFIG_WATCHDOG
1142 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001143 support for the SoC. There must be support in the SoC
1144 specific code for a watchdog. For the 8xx and 8260
1145 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1146 register. When supported for a specific SoC is
1147 available, then no further board specific code should
1148 be needed to use it.
1149
1150 CONFIG_HW_WATCHDOG
1151 When using a watchdog circuitry external to the used
1152 SoC, then define this variable and provide board
1153 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001154
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001155 CONFIG_AT91_HW_WDT_TIMEOUT
1156 specify the timeout in seconds. default 2 seconds.
1157
stroesec1551ea2003-04-04 15:53:41 +00001158- U-Boot Version:
1159 CONFIG_VERSION_VARIABLE
1160 If this variable is defined, an environment variable
1161 named "ver" is created by U-Boot showing the U-Boot
1162 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001163 Any change to this variable will be reverted at the
1164 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001165
wdenkc6097192002-11-03 00:24:07 +00001166- Real-Time Clock:
1167
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001168 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001169 has to be selected, too. Define exactly one of the
1170 following options:
1171
1172 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1173 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001174 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001175 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001176 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001177 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001178 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001179 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001180 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001181 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001182 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001183 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001184 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1185 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001186
wdenkb37c7e52003-06-30 16:24:52 +00001187 Note that if the RTC uses I2C, then the I2C interface
1188 must also be configured. See I2C Support, below.
1189
Peter Tysere92739d2008-12-17 16:36:21 -06001190- GPIO Support:
1191 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001192
Chris Packham5dec49c2010-12-19 10:12:13 +00001193 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1194 chip-ngpio pairs that tell the PCA953X driver the number of
1195 pins supported by a particular chip.
1196
Peter Tysere92739d2008-12-17 16:36:21 -06001197 Note that if the GPIO device uses I2C, then the I2C interface
1198 must also be configured. See I2C Support, below.
1199
Simon Glassaa532332014-06-11 23:29:41 -06001200- I/O tracing:
1201 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1202 accesses and can checksum them or write a list of them out
1203 to memory. See the 'iotrace' command for details. This is
1204 useful for testing device drivers since it can confirm that
1205 the driver behaves the same way before and after a code
1206 change. Currently this is supported on sandbox and arm. To
1207 add support for your architecture, add '#include <iotrace.h>'
1208 to the bottom of arch/<arch>/include/asm/io.h and test.
1209
1210 Example output from the 'iotrace stats' command is below.
1211 Note that if the trace buffer is exhausted, the checksum will
1212 still continue to operate.
1213
1214 iotrace is enabled
1215 Start: 10000000 (buffer start address)
1216 Size: 00010000 (buffer size)
1217 Offset: 00000120 (current buffer offset)
1218 Output: 10000120 (start + offset)
1219 Count: 00000018 (number of trace records)
1220 CRC32: 9526fb66 (CRC32 of all trace records)
1221
wdenkc6097192002-11-03 00:24:07 +00001222- Timestamp Support:
1223
wdenk43d96162003-03-06 00:02:04 +00001224 When CONFIG_TIMESTAMP is selected, the timestamp
1225 (date and time) of an image is printed by image
1226 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001227 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001228
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001229- Partition Labels (disklabels) Supported:
1230 Zero or more of the following:
1231 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1232 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1233 Intel architecture, USB sticks, etc.
1234 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1235 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1236 bootloader. Note 2TB partition limit; see
1237 disk/part_efi.c
1238 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001239
Wolfgang Denk218ca722008-03-26 10:40:12 +01001240 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -06001241 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001242 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001243
1244- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001245 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1246 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001247
wdenk4d13cba2004-03-14 14:09:05 +00001248 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1249 be performed by calling the function
1250 ide_set_reset(int reset)
1251 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001252
1253- ATAPI Support:
1254 CONFIG_ATAPI
1255
1256 Set this to enable ATAPI support.
1257
wdenkc40b2952004-03-13 23:29:43 +00001258- LBA48 Support
1259 CONFIG_LBA48
1260
1261 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001262 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001263 Whithout these , LBA48 support uses 32bit variables and will 'only'
1264 support disks up to 2.1TB.
1265
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001266 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001267 When enabled, makes the IDE subsystem use 64bit sector addresses.
1268 Default is 32bit.
1269
wdenkc6097192002-11-03 00:24:07 +00001270- SCSI Support:
1271 At the moment only there is only support for the
1272 SYM53C8XX SCSI controller; define
1273 CONFIG_SCSI_SYM53C8XX to enable it.
1274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001275 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1276 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1277 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001278 maximum numbers of LUNs, SCSI ID's and target
1279 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001280 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001281
Wolfgang Denk93e14592013-10-04 17:43:24 +02001282 The environment variable 'scsidevs' is set to the number of
1283 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001284
wdenkc6097192002-11-03 00:24:07 +00001285- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001286 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001287 Support for Intel 8254x/8257x gigabit chips.
1288
1289 CONFIG_E1000_SPI
1290 Utility code for direct access to the SPI bus on Intel 8257x.
1291 This does not do anything useful unless you set at least one
1292 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1293
1294 CONFIG_E1000_SPI_GENERIC
1295 Allow generic access to the SPI bus on the Intel 8257x, for
1296 example with the "sspi" command.
1297
1298 CONFIG_CMD_E1000
1299 Management command for E1000 devices. When used on devices
1300 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001301
wdenkc6097192002-11-03 00:24:07 +00001302 CONFIG_EEPRO100
1303 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001304 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001305 write routine for first time initialisation.
1306
1307 CONFIG_TULIP
1308 Support for Digital 2114x chips.
1309 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1310 modem chip initialisation (KS8761/QS6611).
1311
1312 CONFIG_NATSEMI
1313 Support for National dp83815 chips.
1314
1315 CONFIG_NS8382X
1316 Support for National dp8382[01] gigabit chips.
1317
wdenk45219c42003-05-12 21:50:16 +00001318- NETWORK Support (other):
1319
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001320 CONFIG_DRIVER_AT91EMAC
1321 Support for AT91RM9200 EMAC.
1322
1323 CONFIG_RMII
1324 Define this to use reduced MII inteface
1325
1326 CONFIG_DRIVER_AT91EMAC_QUIET
1327 If this defined, the driver is quiet.
1328 The driver doen't show link status messages.
1329
Rob Herringefdd7312011-12-15 11:15:49 +00001330 CONFIG_CALXEDA_XGMAC
1331 Support for the Calxeda XGMAC device
1332
Ashok3bb46d22012-10-15 06:20:47 +00001333 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001334 Support for SMSC's LAN91C96 chips.
1335
1336 CONFIG_LAN91C96_BASE
1337 Define this to hold the physical address
1338 of the LAN91C96's I/O space
1339
1340 CONFIG_LAN91C96_USE_32_BIT
1341 Define this to enable 32 bit addressing
1342
Ashok3bb46d22012-10-15 06:20:47 +00001343 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001344 Support for SMSC's LAN91C111 chip
1345
1346 CONFIG_SMC91111_BASE
1347 Define this to hold the physical address
1348 of the device (I/O space)
1349
1350 CONFIG_SMC_USE_32_BIT
1351 Define this if data bus is 32 bits
1352
1353 CONFIG_SMC_USE_IOFUNCS
1354 Define this to use i/o functions instead of macros
1355 (some hardware wont work with macros)
1356
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001357 CONFIG_DRIVER_TI_EMAC
1358 Support for davinci emac
1359
1360 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1361 Define this if you have more then 3 PHYs.
1362
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001363 CONFIG_FTGMAC100
1364 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1365
1366 CONFIG_FTGMAC100_EGIGA
1367 Define this to use GE link update with gigabit PHY.
1368 Define this if FTGMAC100 is connected to gigabit PHY.
1369 If your system has 10/100 PHY only, it might not occur
1370 wrong behavior. Because PHY usually return timeout or
1371 useless data when polling gigabit status and gigabit
1372 control registers. This behavior won't affect the
1373 correctnessof 10/100 link speed update.
1374
Mike Rapoportc2fff332009-11-11 10:03:03 +02001375 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001376 Support for SMSC's LAN911x and LAN921x chips
1377
Mike Rapoportc2fff332009-11-11 10:03:03 +02001378 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001379 Define this to hold the physical address
1380 of the device (I/O space)
1381
Mike Rapoportc2fff332009-11-11 10:03:03 +02001382 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001383 Define this if data bus is 32 bits
1384
Mike Rapoportc2fff332009-11-11 10:03:03 +02001385 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001386 Define this if data bus is 16 bits. If your processor
1387 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001388 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001389
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001390 CONFIG_SH_ETHER
1391 Support for Renesas on-chip Ethernet controller
1392
1393 CONFIG_SH_ETHER_USE_PORT
1394 Define the number of ports to be used
1395
1396 CONFIG_SH_ETHER_PHY_ADDR
1397 Define the ETH PHY's address
1398
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001399 CONFIG_SH_ETHER_CACHE_WRITEBACK
1400 If this option is set, the driver enables cache flush.
1401
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001402- PWM Support:
1403 CONFIG_PWM_IMX
1404 Support for PWM modul on the imx6.
1405
Vadim Bendebury5e124722011-10-17 08:36:14 +00001406- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001407 CONFIG_TPM
1408 Support TPM devices.
1409
Christophe Ricard0766ad22015-10-06 22:54:41 +02001410 CONFIG_TPM_TIS_INFINEON
1411 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001412 per system is supported at this time.
1413
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001414 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1415 Define the burst count bytes upper limit
1416
Christophe Ricard3aa74082016-01-21 23:27:13 +01001417 CONFIG_TPM_ST33ZP24
1418 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1419
1420 CONFIG_TPM_ST33ZP24_I2C
1421 Support for STMicroelectronics ST33ZP24 I2C devices.
1422 Requires TPM_ST33ZP24 and I2C.
1423
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001424 CONFIG_TPM_ST33ZP24_SPI
1425 Support for STMicroelectronics ST33ZP24 SPI devices.
1426 Requires TPM_ST33ZP24 and SPI.
1427
Dirk Eibachc01939c2013-06-26 15:55:15 +02001428 CONFIG_TPM_ATMEL_TWI
1429 Support for Atmel TWI TPM device. Requires I2C support.
1430
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001431 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001432 Support for generic parallel port TPM devices. Only one device
1433 per system is supported at this time.
1434
1435 CONFIG_TPM_TIS_BASE_ADDRESS
1436 Base address where the generic TPM device is mapped
1437 to. Contemporary x86 systems usually map it at
1438 0xfed40000.
1439
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001440 CONFIG_CMD_TPM
1441 Add tpm monitor functions.
1442 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1443 provides monitor access to authorized functions.
1444
1445 CONFIG_TPM
1446 Define this to enable the TPM support library which provides
1447 functional interfaces to some TPM commands.
1448 Requires support for a TPM device.
1449
1450 CONFIG_TPM_AUTH_SESSIONS
1451 Define this to enable authorized functions in the TPM library.
1452 Requires CONFIG_TPM and CONFIG_SHA1.
1453
wdenkc6097192002-11-03 00:24:07 +00001454- USB Support:
1455 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001456 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001457 CONFIG_USB_UHCI to enable it.
1458 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001459 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001460 storage devices.
1461 Note:
1462 Supported are USB Keyboards and USB Floppy drives
1463 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001464 MPC5200 USB requires additional defines:
1465 CONFIG_USB_CLOCK
1466 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001467 CONFIG_PSC3_USB
1468 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001469 CONFIG_USB_CONFIG
1470 for differential drivers: 0x00001000
1471 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001472 for differential drivers on PSC3: 0x00000100
1473 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001474 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001475 May be defined to allow interrupt polling
1476 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001477
Simon Glass9ab4ce22012-02-27 10:52:47 +00001478 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1479 txfilltuning field in the EHCI controller on reset.
1480
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001481 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1482 HW module registers.
1483
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001484- USB Device:
1485 Define the below if you wish to use the USB console.
1486 Once firmware is rebuilt from a serial console issue the
1487 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001488 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001489 it has found a new device. The environment variable usbtty
1490 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001491 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001492 Common Device Class Abstract Control Model serial device.
1493 If you select usbtty = gserial you should be able to enumerate
1494 a Linux host by
1495 # modprobe usbserial vendor=0xVendorID product=0xProductID
1496 else if using cdc_acm, simply setting the environment
1497 variable usbtty to be cdc_acm should suffice. The following
1498 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001499
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001500 CONFIG_USB_DEVICE
1501 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001502
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001503 CONFIG_USB_TTY
1504 Define this to have a tty type of device available to
1505 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001506
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301507 CONFIG_USBD_HS
1508 Define this to enable the high speed support for usb
1509 device and usbtty. If this feature is enabled, a routine
1510 int is_usbd_high_speed(void)
1511 also needs to be defined by the driver to dynamically poll
1512 whether the enumeration has succeded at high speed or full
1513 speed.
1514
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001515 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001516 Define this if you want stdin, stdout &/or stderr to
1517 be set to usbtty.
1518
1519 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001520 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001521 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001522 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001523
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001524 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001525 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001526 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001527
Wolfgang Denk386eda02006-06-14 18:14:56 +02001528 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001529 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001530 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001531 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1532 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1533 should pretend to be a Linux device to it's target host.
1534
1535 CONFIG_USBD_MANUFACTURER
1536 Define this string as the name of your company for
1537 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001538
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001539 CONFIG_USBD_PRODUCT_NAME
1540 Define this string as the name of your product
1541 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1542
1543 CONFIG_USBD_VENDORID
1544 Define this as your assigned Vendor ID from the USB
1545 Implementors Forum. This *must* be a genuine Vendor ID
1546 to avoid polluting the USB namespace.
1547 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001548
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001549 CONFIG_USBD_PRODUCTID
1550 Define this as the unique Product ID
1551 for your device
1552 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001553
Igor Grinbergd70a5602011-12-12 12:08:35 +02001554- ULPI Layer Support:
1555 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1556 the generic ULPI layer. The generic layer accesses the ULPI PHY
1557 via the platform viewport, so you need both the genric layer and
1558 the viewport enabled. Currently only Chipidea/ARC based
1559 viewport is supported.
1560 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1561 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001562 If your ULPI phy needs a different reference clock than the
1563 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1564 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001565
1566- MMC Support:
1567 The MMC controller on the Intel PXA is supported. To
1568 enable this define CONFIG_MMC. The MMC can be
1569 accessed from the boot prompt by mapping the device
1570 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001571 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1572 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001573
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001574 CONFIG_SH_MMCIF
1575 Support for Renesas on-chip MMCIF controller
1576
1577 CONFIG_SH_MMCIF_ADDR
1578 Define the base address of MMCIF registers
1579
1580 CONFIG_SH_MMCIF_CLK
1581 Define the clock frequency for MMCIF
1582
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001583 CONFIG_GENERIC_MMC
1584 Enable the generic MMC driver
1585
1586 CONFIG_SUPPORT_EMMC_BOOT
1587 Enable some additional features of the eMMC boot partitions.
1588
1589 CONFIG_SUPPORT_EMMC_RPMB
1590 Enable the commands for reading, writing and programming the
1591 key for the Replay Protection Memory Block partition in eMMC.
1592
Tom Rinib3ba6e92013-03-14 05:32:47 +00001593- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001594 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001595 This enables the USB portion of the DFU USB class
1596
1597 CONFIG_CMD_DFU
1598 This enables the command "dfu" which is used to have
1599 U-Boot create a DFU class device via USB. This command
1600 requires that the "dfu_alt_info" environment variable be
1601 set and define the alt settings to expose to the host.
1602
1603 CONFIG_DFU_MMC
1604 This enables support for exposing (e)MMC devices via DFU.
1605
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001606 CONFIG_DFU_NAND
1607 This enables support for exposing NAND devices via DFU.
1608
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301609 CONFIG_DFU_RAM
1610 This enables support for exposing RAM via DFU.
1611 Note: DFU spec refer to non-volatile memory usage, but
1612 allow usages beyond the scope of spec - here RAM usage,
1613 one that would help mostly the developer.
1614
Heiko Schochere7e75c72013-06-12 06:05:51 +02001615 CONFIG_SYS_DFU_DATA_BUF_SIZE
1616 Dfu transfer uses a buffer before writing data to the
1617 raw storage device. Make the size (in bytes) of this buffer
1618 configurable. The size of this buffer is also configurable
1619 through the "dfu_bufsiz" environment variable.
1620
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001621 CONFIG_SYS_DFU_MAX_FILE_SIZE
1622 When updating files rather than the raw storage device,
1623 we use a static buffer to copy the file into and then write
1624 the buffer once we've been given the whole file. Define
1625 this to the maximum filesize (in bytes) for the buffer.
1626 Default is 4 MiB if undefined.
1627
Heiko Schocher001a8312014-03-18 08:09:56 +01001628 DFU_DEFAULT_POLL_TIMEOUT
1629 Poll timeout [ms], is the timeout a device can send to the
1630 host. The host must wait for this timeout before sending
1631 a subsequent DFU_GET_STATUS request to the device.
1632
1633 DFU_MANIFEST_POLL_TIMEOUT
1634 Poll timeout [ms], which the device sends to the host when
1635 entering dfuMANIFEST state. Host waits this timeout, before
1636 sending again an USB request to the device.
1637
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001638- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001639 CONFIG_USB_FUNCTION_FASTBOOT
1640 This enables the USB part of the fastboot gadget
1641
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001642 CONFIG_CMD_FASTBOOT
1643 This enables the command "fastboot" which enables the Android
1644 fastboot mode for the platform's USB device. Fastboot is a USB
1645 protocol for downloading images, flashing and device control
1646 used on Android devices.
1647 See doc/README.android-fastboot for more information.
1648
1649 CONFIG_ANDROID_BOOT_IMAGE
1650 This enables support for booting images which use the Android
1651 image format header.
1652
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001653 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001654 The fastboot protocol requires a large memory buffer for
1655 downloads. Define this to the starting RAM address to use for
1656 downloaded images.
1657
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001658 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001659 The fastboot protocol requires a large memory buffer for
1660 downloads. This buffer should be as large as possible for a
1661 platform. Define this to the size available RAM for fastboot.
1662
Steve Raed1b5ed02014-08-26 11:47:28 -07001663 CONFIG_FASTBOOT_FLASH
1664 The fastboot protocol includes a "flash" command for writing
1665 the downloaded image to a non-volatile storage device. Define
1666 this to enable the "fastboot flash" command.
1667
1668 CONFIG_FASTBOOT_FLASH_MMC_DEV
1669 The fastboot "flash" command requires additional information
1670 regarding the non-volatile storage device. Define this to
1671 the eMMC device that fastboot should use to store the image.
1672
Steve Rae0ff7e582014-12-12 15:51:54 -08001673 CONFIG_FASTBOOT_GPT_NAME
1674 The fastboot "flash" command supports writing the downloaded
1675 image to the Protective MBR and the Primary GUID Partition
1676 Table. (Additionally, this downloaded image is post-processed
1677 to generate and write the Backup GUID Partition Table.)
1678 This occurs when the specified "partition name" on the
1679 "fastboot flash" command line matches this value.
1680 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1681
wdenk6705d812004-08-02 23:22:59 +00001682- Journaling Flash filesystem support:
1683 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1684 CONFIG_JFFS2_NAND_DEV
1685 Define these for a default partition on a NAND device
1686
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001687 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1688 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001689 Define these for a default partition on a NOR device
1690
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001691 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001692 Define this to create an own partition. You have to provide a
1693 function struct part_info* jffs2_part_info(int part_num)
1694
1695 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001696 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001697 to disable the command chpart. This is the default when you
1698 have not defined a custom partition
1699
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001700- FAT(File Allocation Table) filesystem write function support:
1701 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001702
1703 Define this to enable support for saving memory data as a
1704 file in FAT formatted partition.
1705
1706 This will also enable the command "fatwrite" enabling the
1707 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001708
Gabe Black84cd9322012-10-12 14:26:11 +00001709CBFS (Coreboot Filesystem) support
1710 CONFIG_CMD_CBFS
1711
1712 Define this to enable support for reading from a Coreboot
1713 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1714 and cbfsload.
1715
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301716- FAT(File Allocation Table) filesystem cluster size:
1717 CONFIG_FS_FAT_MAX_CLUSTSIZE
1718
1719 Define the max cluster size for fat operations else
1720 a default value of 65536 will be defined.
1721
wdenkc6097192002-11-03 00:24:07 +00001722- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001723 See Kconfig help for available keyboard drivers.
1724
1725 CONFIG_KEYBOARD
1726
1727 Define this to enable a custom keyboard support.
1728 This simply calls drv_keyboard_init() which must be
1729 defined in your board-specific files. This option is deprecated
1730 and is only used by novena. For new boards, use driver model
1731 instead.
wdenkc6097192002-11-03 00:24:07 +00001732
1733- Video support:
1734 CONFIG_VIDEO
1735
1736 Define this to enable video support (for output to
1737 video).
1738
1739 CONFIG_VIDEO_CT69000
1740
1741 Enable Chips & Technologies 69000 Video chip
1742
1743 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001744 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001745 video output is selected via environment 'videoout'
1746 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1747 assumed.
wdenkc6097192002-11-03 00:24:07 +00001748
wdenkb79a11c2004-03-25 15:14:43 +00001749 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001750 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001751 are possible:
1752 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001753 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001754
1755 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1756 -------------+---------------------------------------------
1757 8 bits | 0x301* 0x303 0x305 0x161 0x307
1758 15 bits | 0x310 0x313 0x316 0x162 0x319
1759 16 bits | 0x311 0x314 0x317 0x163 0x31A
1760 24 bits | 0x312 0x315 0x318 ? 0x31B
1761 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001762 (i.e. setenv videomode 317; saveenv; reset;)
1763
wdenkb79a11c2004-03-25 15:14:43 +00001764 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001765 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001766
1767
stroesec1551ea2003-04-04 15:53:41 +00001768 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001769 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001770 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1771 or CONFIG_VIDEO_SED13806_16BPP
1772
Timur Tabi7d3053f2011-02-15 17:09:19 -06001773 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001774 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001775 SOCs that have a DIU should define this macro to enable DIU
1776 support, and should also define these other macros:
1777
1778 CONFIG_SYS_DIU_ADDR
1779 CONFIG_VIDEO
1780 CONFIG_CMD_BMP
1781 CONFIG_CFB_CONSOLE
1782 CONFIG_VIDEO_SW_CURSOR
1783 CONFIG_VGA_AS_SINGLE_DEVICE
1784 CONFIG_VIDEO_LOGO
1785 CONFIG_VIDEO_BMP_LOGO
1786
Timur Tabiba8e76b2011-04-11 14:18:22 -05001787 The DIU driver will look for the 'video-mode' environment
1788 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001789 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001790 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001791
wdenkc6097192002-11-03 00:24:07 +00001792- LCD Support: CONFIG_LCD
1793
1794 Define this to enable LCD support (for output to LCD
1795 display); also select one of the supported displays
1796 by defining one of these:
1797
Stelian Pop39cf4802008-05-09 21:57:18 +02001798 CONFIG_ATMEL_LCD:
1799
1800 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1801
wdenkfd3103b2003-11-25 16:55:19 +00001802 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001803
wdenkfd3103b2003-11-25 16:55:19 +00001804 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001805
wdenkfd3103b2003-11-25 16:55:19 +00001806 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001807
wdenkfd3103b2003-11-25 16:55:19 +00001808 NEC NL6448BC20-08. 6.5", 640x480.
1809 Active, color, single scan.
1810
1811 CONFIG_NEC_NL6448BC33_54
1812
1813 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001814 Active, color, single scan.
1815
1816 CONFIG_SHARP_16x9
1817
1818 Sharp 320x240. Active, color, single scan.
1819 It isn't 16x9, and I am not sure what it is.
1820
1821 CONFIG_SHARP_LQ64D341
1822
1823 Sharp LQ64D341 display, 640x480.
1824 Active, color, single scan.
1825
1826 CONFIG_HLD1045
1827
1828 HLD1045 display, 640x480.
1829 Active, color, single scan.
1830
1831 CONFIG_OPTREX_BW
1832
1833 Optrex CBL50840-2 NF-FW 99 22 M5
1834 or
1835 Hitachi LMG6912RPFC-00T
1836 or
1837 Hitachi SP14Q002
1838
1839 320x240. Black & white.
1840
1841 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001842 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001843
Simon Glass676d3192012-10-17 13:24:54 +00001844 CONFIG_LCD_ALIGNMENT
1845
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001846 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001847 defined then the LCD will be aligned to this value instead.
1848 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1849 here, since it is cheaper to change data cache settings on
1850 a per-section basis.
1851
Simon Glass0d89efe2012-10-17 13:24:59 +00001852 CONFIG_CONSOLE_SCROLL_LINES
1853
1854 When the console need to be scrolled, this is the number of
1855 lines to scroll by. It defaults to 1. Increasing this makes
1856 the console jump but can help speed up operation when scrolling
1857 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001858
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001859 CONFIG_LCD_ROTATION
1860
1861 Sometimes, for example if the display is mounted in portrait
1862 mode or even if it's mounted landscape but rotated by 180degree,
1863 we need to rotate our content of the display relative to the
1864 framebuffer, so that user can read the messages which are
1865 printed out.
1866 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1867 initialized with a given rotation from "vl_rot" out of
1868 "vidinfo_t" which is provided by the board specific code.
1869 The value for vl_rot is coded as following (matching to
1870 fbcon=rotate:<n> linux-kernel commandline):
1871 0 = no rotation respectively 0 degree
1872 1 = 90 degree rotation
1873 2 = 180 degree rotation
1874 3 = 270 degree rotation
1875
1876 If CONFIG_LCD_ROTATION is not defined, the console will be
1877 initialized with 0degree rotation.
1878
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001879 CONFIG_LCD_BMP_RLE8
1880
1881 Support drawing of RLE8-compressed bitmaps on the LCD.
1882
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001883 CONFIG_I2C_EDID
1884
1885 Enables an 'i2c edid' command which can read EDID
1886 information over I2C from an attached LCD display.
1887
wdenk7152b1d2003-09-05 23:19:14 +00001888- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001889
wdenk8bde7f72003-06-27 21:31:46 +00001890 If this option is set, the environment is checked for
1891 a variable "splashimage". If found, the usual display
1892 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001893 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001894 specified in "splashimage" is loaded instead. The
1895 console is redirected to the "nulldev", too. This
1896 allows for a "silent" boot where a splash screen is
1897 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001898
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001899 CONFIG_SPLASHIMAGE_GUARD
1900
1901 If this option is set, then U-Boot will prevent the environment
1902 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001903 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001904 This option is useful for targets where, due to alignment
1905 restrictions, an improperly aligned BMP image will cause a data
1906 abort. If you think you will not have problems with unaligned
1907 accesses (for example because your toolchain prevents them)
1908 there is no need to set this option.
1909
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001910 CONFIG_SPLASH_SCREEN_ALIGN
1911
1912 If this option is set the splash image can be freely positioned
1913 on the screen. Environment variable "splashpos" specifies the
1914 position as "x,y". If a positive number is given it is used as
1915 number of pixel from left/top. If a negative number is given it
1916 is used as number of pixel from right/bottom. You can also
1917 specify 'm' for centering the image.
1918
1919 Example:
1920 setenv splashpos m,m
1921 => image at center of screen
1922
1923 setenv splashpos 30,20
1924 => image at x = 30 and y = 20
1925
1926 setenv splashpos -10,m
1927 => vertically centered image
1928 at x = dspWidth - bmpWidth - 9
1929
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001930- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1931
1932 If this option is set, additionally to standard BMP
1933 images, gzipped BMP images can be displayed via the
1934 splashscreen support or the bmp command.
1935
Anatolij Gustschind5011762010-03-15 14:50:25 +01001936- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1937
1938 If this option is set, 8-bit RLE compressed BMP images
1939 can be displayed via the splashscreen support or the
1940 bmp command.
1941
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001942- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00001943 CONFIG_CMD_ZIP
1944
1945 If this option is set, it would use zlib deflate method
1946 to compress the specified memory at its best effort.
1947
wdenkc29fdfc2003-08-29 20:57:53 +00001948- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001949 CONFIG_GZIP
1950
1951 Enabled by default to support gzip compressed images.
1952
wdenkc29fdfc2003-08-29 20:57:53 +00001953 CONFIG_BZIP2
1954
1955 If this option is set, support for bzip2 compressed
1956 images is included. If not, only uncompressed and gzip
1957 compressed images are supported.
1958
wdenk42d1f032003-10-15 23:53:47 +00001959 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001960 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001961 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001962
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001963 CONFIG_LZMA
1964
1965 If this option is set, support for lzma compressed
1966 images is included.
1967
1968 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1969 requires an amount of dynamic memory that is given by the
1970 formula:
1971
1972 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1973
1974 Where lc and lp stand for, respectively, Literal context bits
1975 and Literal pos bits.
1976
1977 This value is upper-bounded by 14MB in the worst case. Anyway,
1978 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1979 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1980 a very small buffer.
1981
1982 Use the lzmainfo tool to determinate the lc and lp values and
1983 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001984 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001985
Kees Cook8ef70472013-08-16 07:59:12 -07001986 CONFIG_LZO
1987
1988 If this option is set, support for LZO compressed images
1989 is included.
1990
wdenk17ea1172004-06-06 21:51:03 +00001991- MII/PHY support:
1992 CONFIG_PHY_ADDR
1993
1994 The address of PHY on MII bus.
1995
1996 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1997
1998 The clock frequency of the MII bus
1999
2000 CONFIG_PHY_GIGE
2001
2002 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002003 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002004
2005 CONFIG_PHY_RESET_DELAY
2006
2007 Some PHY like Intel LXT971A need extra delay after
2008 reset before any MII register access is possible.
2009 For such PHY, set this option to the usec delay
2010 required. (minimum 300usec for LXT971A)
2011
2012 CONFIG_PHY_CMD_DELAY (ppc4xx)
2013
2014 Some PHY like Intel LXT971A need extra delay after
2015 command issued before MII status register can be read
2016
wdenkc6097192002-11-03 00:24:07 +00002017- IP address:
2018 CONFIG_IPADDR
2019
2020 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002021 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002022 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002023 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002024
2025- Server IP address:
2026 CONFIG_SERVERIP
2027
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002028 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002029 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002030 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002031
Robin Getz97cfe862009-07-21 12:15:28 -04002032 CONFIG_KEEP_SERVERADDR
2033
2034 Keeps the server's MAC address, in the env 'serveraddr'
2035 for passing to bootargs (like Linux's netconsole option)
2036
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002037- Gateway IP address:
2038 CONFIG_GATEWAYIP
2039
2040 Defines a default value for the IP address of the
2041 default router where packets to other networks are
2042 sent to.
2043 (Environment variable "gatewayip")
2044
2045- Subnet mask:
2046 CONFIG_NETMASK
2047
2048 Defines a default value for the subnet mask (or
2049 routing prefix) which is used to determine if an IP
2050 address belongs to the local subnet or needs to be
2051 forwarded through a router.
2052 (Environment variable "netmask")
2053
David Updegraff53a5c422007-06-11 10:41:07 -05002054- Multicast TFTP Mode:
2055 CONFIG_MCAST_TFTP
2056
2057 Defines whether you want to support multicast TFTP as per
2058 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002059 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002060 driver in use must provide a function: mcast() to join/leave a
2061 multicast group.
2062
wdenkc6097192002-11-03 00:24:07 +00002063- BOOTP Recovery Mode:
2064 CONFIG_BOOTP_RANDOM_DELAY
2065
2066 If you have many targets in a network that try to
2067 boot using BOOTP, you may want to avoid that all
2068 systems send out BOOTP requests at precisely the same
2069 moment (which would happen for instance at recovery
2070 from a power failure, when all systems will try to
2071 boot, thus flooding the BOOTP server. Defining
2072 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2073 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002074 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002075
2076 1st BOOTP request: delay 0 ... 1 sec
2077 2nd BOOTP request: delay 0 ... 2 sec
2078 3rd BOOTP request: delay 0 ... 4 sec
2079 4th and following
2080 BOOTP requests: delay 0 ... 8 sec
2081
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002082 CONFIG_BOOTP_ID_CACHE_SIZE
2083
2084 BOOTP packets are uniquely identified using a 32-bit ID. The
2085 server will copy the ID from client requests to responses and
2086 U-Boot will use this to determine if it is the destination of
2087 an incoming response. Some servers will check that addresses
2088 aren't in use before handing them out (usually using an ARP
2089 ping) and therefore take up to a few hundred milliseconds to
2090 respond. Network congestion may also influence the time it
2091 takes for a response to make it back to the client. If that
2092 time is too long, U-Boot will retransmit requests. In order
2093 to allow earlier responses to still be accepted after these
2094 retransmissions, U-Boot's BOOTP client keeps a small cache of
2095 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2096 cache. The default is to keep IDs for up to four outstanding
2097 requests. Increasing this will allow U-Boot to accept offers
2098 from a BOOTP client in networks with unusually high latency.
2099
stroesefe389a82003-08-28 14:17:32 +00002100- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002101 You can fine tune the DHCP functionality by defining
2102 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002103
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002104 CONFIG_BOOTP_SUBNETMASK
2105 CONFIG_BOOTP_GATEWAY
2106 CONFIG_BOOTP_HOSTNAME
2107 CONFIG_BOOTP_NISDOMAIN
2108 CONFIG_BOOTP_BOOTPATH
2109 CONFIG_BOOTP_BOOTFILESIZE
2110 CONFIG_BOOTP_DNS
2111 CONFIG_BOOTP_DNS2
2112 CONFIG_BOOTP_SEND_HOSTNAME
2113 CONFIG_BOOTP_NTPSERVER
2114 CONFIG_BOOTP_TIMEOFFSET
2115 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002116 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002117
Wilson Callan5d110f02007-07-28 10:56:13 -04002118 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2119 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002120
Joe Hershberger2c00e092012-05-23 07:59:19 +00002121 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2122 after the configured retry count, the call will fail
2123 instead of starting over. This can be used to fail over
2124 to Link-local IP address configuration if the DHCP server
2125 is not available.
2126
stroesefe389a82003-08-28 14:17:32 +00002127 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2128 serverip from a DHCP server, it is possible that more
2129 than one DNS serverip is offered to the client.
2130 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2131 serverip will be stored in the additional environment
2132 variable "dnsip2". The first DNS serverip is always
2133 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002134 is defined.
stroesefe389a82003-08-28 14:17:32 +00002135
2136 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2137 to do a dynamic update of a DNS server. To do this, they
2138 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002139 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002140 of the "hostname" environment variable is passed as
2141 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002142
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002143 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2144
2145 A 32bit value in microseconds for a delay between
2146 receiving a "DHCP Offer" and sending the "DHCP Request".
2147 This fixes a problem with certain DHCP servers that don't
2148 respond 100% of the time to a "DHCP request". E.g. On an
2149 AT91RM9200 processor running at 180MHz, this delay needed
2150 to be *at least* 15,000 usec before a Windows Server 2003
2151 DHCP server would reply 100% of the time. I recommend at
2152 least 50,000 usec to be safe. The alternative is to hope
2153 that one of the retries will be successful but note that
2154 the DHCP timeout and retry process takes a longer than
2155 this delay.
2156
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002157 - Link-local IP address negotiation:
2158 Negotiate with other link-local clients on the local network
2159 for an address that doesn't require explicit configuration.
2160 This is especially useful if a DHCP server cannot be guaranteed
2161 to exist in all environments that the device must operate.
2162
2163 See doc/README.link-local for more information.
2164
wdenka3d991b2004-04-15 21:48:45 +00002165 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002166 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002167
2168 The device id used in CDP trigger frames.
2169
2170 CONFIG_CDP_DEVICE_ID_PREFIX
2171
2172 A two character string which is prefixed to the MAC address
2173 of the device.
2174
2175 CONFIG_CDP_PORT_ID
2176
2177 A printf format string which contains the ascii name of
2178 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002179 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002180
2181 CONFIG_CDP_CAPABILITIES
2182
2183 A 32bit integer which indicates the device capabilities;
2184 0x00000010 for a normal host which does not forwards.
2185
2186 CONFIG_CDP_VERSION
2187
2188 An ascii string containing the version of the software.
2189
2190 CONFIG_CDP_PLATFORM
2191
2192 An ascii string containing the name of the platform.
2193
2194 CONFIG_CDP_TRIGGER
2195
2196 A 32bit integer sent on the trigger.
2197
2198 CONFIG_CDP_POWER_CONSUMPTION
2199
2200 A 16bit integer containing the power consumption of the
2201 device in .1 of milliwatts.
2202
2203 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2204
2205 A byte containing the id of the VLAN.
2206
wdenkc6097192002-11-03 00:24:07 +00002207- Status LED: CONFIG_STATUS_LED
2208
2209 Several configurations allow to display the current
2210 status using a LED. For instance, the LED will blink
2211 fast while running U-Boot code, stop blinking as
2212 soon as a reply to a BOOTP request was received, and
2213 start blinking slow once the Linux kernel is running
2214 (supported by a status LED driver in the Linux
2215 kernel). Defining CONFIG_STATUS_LED enables this
2216 feature in U-Boot.
2217
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002218 Additional options:
2219
2220 CONFIG_GPIO_LED
2221 The status LED can be connected to a GPIO pin.
2222 In such cases, the gpio_led driver can be used as a
2223 status LED backend implementation. Define CONFIG_GPIO_LED
2224 to include the gpio_led driver in the U-Boot binary.
2225
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002226 CONFIG_GPIO_LED_INVERTED_TABLE
2227 Some GPIO connected LEDs may have inverted polarity in which
2228 case the GPIO high value corresponds to LED off state and
2229 GPIO low value corresponds to LED on state.
2230 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2231 with a list of GPIO LEDs that have inverted polarity.
2232
wdenkc6097192002-11-03 00:24:07 +00002233- CAN Support: CONFIG_CAN_DRIVER
2234
2235 Defining CONFIG_CAN_DRIVER enables CAN driver support
2236 on those systems that support this (optional)
2237 feature, like the TQM8xxL modules.
2238
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002239- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002240
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002241 This enable the NEW i2c subsystem, and will allow you to use
2242 i2c commands at the u-boot command line (as long as you set
2243 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2244 based realtime clock chips or other i2c devices. See
2245 common/cmd_i2c.c for a description of the command line
2246 interface.
2247
2248 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002249 - drivers/i2c/soft_i2c.c:
2250 - activate first bus with CONFIG_SYS_I2C_SOFT define
2251 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2252 for defining speed and slave address
2253 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2254 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2255 for defining speed and slave address
2256 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2257 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2258 for defining speed and slave address
2259 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2260 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2261 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002262
Heiko Schocher00f792e2012-10-24 13:48:22 +02002263 - drivers/i2c/fsl_i2c.c:
2264 - activate i2c driver with CONFIG_SYS_I2C_FSL
2265 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2266 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2267 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2268 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002269 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002270 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2271 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2272 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2273 second bus.
2274
Simon Glass1f2ba722012-10-30 07:28:53 +00002275 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002276 - activate this driver with CONFIG_SYS_I2C_TEGRA
2277 - This driver adds 4 i2c buses with a fix speed from
2278 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002279
Dirk Eibach880540d2013-04-25 02:40:01 +00002280 - drivers/i2c/ppc4xx_i2c.c
2281 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2282 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2283 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2284
tremfac96402013-09-21 18:13:35 +02002285 - drivers/i2c/i2c_mxc.c
2286 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002287 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2288 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2289 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2290 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002291 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2292 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2293 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2294 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2295 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2296 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002297 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2298 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002299 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002300 for speed, and 0 for slave.
2301
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002302 - drivers/i2c/rcar_i2c.c:
2303 - activate this driver with CONFIG_SYS_I2C_RCAR
2304 - This driver adds 4 i2c buses
2305
2306 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2307 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2308 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2309 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2310 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2311 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2312 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2313 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2314 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2315
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002316 - drivers/i2c/sh_i2c.c:
2317 - activate this driver with CONFIG_SYS_I2C_SH
2318 - This driver adds from 2 to 5 i2c buses
2319
2320 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2321 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2322 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2323 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2324 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2325 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2326 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2327 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2328 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2329 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2330 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2331 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002332 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002333
Heiko Schocher6789e842013-10-22 11:03:18 +02002334 - drivers/i2c/omap24xx_i2c.c
2335 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2336 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2337 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2338 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2339 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2340 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2341 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2342 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2343 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2344 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2345 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2346
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002347 - drivers/i2c/zynq_i2c.c
2348 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2349 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2350 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2351
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302352 - drivers/i2c/s3c24x0_i2c.c:
2353 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2354 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2355 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2356 with a fix speed from 100000 and the slave addr 0!
2357
Dirk Eibachb46226b2014-07-03 09:28:18 +02002358 - drivers/i2c/ihs_i2c.c
2359 - activate this driver with CONFIG_SYS_I2C_IHS
2360 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2361 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2362 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2363 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2364 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2365 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2366 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2367 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2368 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2369 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2370 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2371 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002372 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2373 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2374 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2375 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2376 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2377 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2378 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2379 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2380 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002381
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002382 additional defines:
2383
2384 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002385 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002386 don't use/have i2c muxes on your i2c bus, this
2387 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2388 omit this define.
2389
2390 CONFIG_SYS_I2C_DIRECT_BUS
2391 define this, if you don't use i2c muxes on your hardware.
2392 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2393 omit this define.
2394
2395 CONFIG_SYS_I2C_MAX_HOPS
2396 define how many muxes are maximal consecutively connected
2397 on one i2c bus. If you not use i2c muxes, omit this
2398 define.
2399
2400 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002401 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002402 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2403 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2404 CONFIG_SYS_NUM_I2C_BUSES = 9:
2405
2406 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2407 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2408 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2409 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2410 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2411 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2412 {1, {I2C_NULL_HOP}}, \
2413 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2414 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2415 }
2416
2417 which defines
2418 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002419 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2420 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2421 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2422 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2423 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002424 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002425 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2426 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002427
2428 If you do not have i2c muxes on your board, omit this define.
2429
Heiko Schocherea818db2013-01-29 08:53:15 +01002430- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002431
2432 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2433 provides the following compelling advantages:
2434
2435 - more than one i2c adapter is usable
2436 - approved multibus support
2437 - better i2c mux support
2438
2439 ** Please consider updating your I2C driver now. **
2440
Heiko Schocherea818db2013-01-29 08:53:15 +01002441 These enable legacy I2C serial bus commands. Defining
2442 CONFIG_HARD_I2C will include the appropriate I2C driver
2443 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002444
wdenk945af8d2003-07-16 21:53:01 +00002445 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002446 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002447 CONFIG_COMMANDS) and communicate with i2c based realtime
2448 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002449 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002450
Ben Warrenbb99ad62006-09-07 16:50:54 -04002451 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002452
wdenk945af8d2003-07-16 21:53:01 +00002453 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002454 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002455
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002456 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002457 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002458 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002459 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002460
Peter Tyser8d321b82010-04-12 22:28:21 -05002461 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002462 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002463 and so its address should therefore be cleared to 0 (See,
2464 eg, MPC823e User's Manual p.16-473). So, set
2465 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002466
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002467 CONFIG_SYS_I2C_INIT_MPC5XXX
2468
2469 When a board is reset during an i2c bus transfer
2470 chips might think that the current transfer is still
2471 in progress. Reset the slave devices by sending start
2472 commands until the slave device responds.
2473
wdenk945af8d2003-07-16 21:53:01 +00002474 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002475
Heiko Schocherea818db2013-01-29 08:53:15 +01002476 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002477 then the following macros need to be defined (examples are
2478 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002479
2480 I2C_INIT
2481
wdenkb37c7e52003-06-30 16:24:52 +00002482 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002483 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002484
wdenkba56f622004-02-06 23:19:44 +00002485 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002486
wdenkc6097192002-11-03 00:24:07 +00002487 I2C_PORT
2488
wdenk43d96162003-03-06 00:02:04 +00002489 (Only for MPC8260 CPU). The I/O port to use (the code
2490 assumes both bits are on the same port). Valid values
2491 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002492
2493 I2C_ACTIVE
2494
2495 The code necessary to make the I2C data line active
2496 (driven). If the data line is open collector, this
2497 define can be null.
2498
wdenkb37c7e52003-06-30 16:24:52 +00002499 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2500
wdenkc6097192002-11-03 00:24:07 +00002501 I2C_TRISTATE
2502
2503 The code necessary to make the I2C data line tri-stated
2504 (inactive). If the data line is open collector, this
2505 define can be null.
2506
wdenkb37c7e52003-06-30 16:24:52 +00002507 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2508
wdenkc6097192002-11-03 00:24:07 +00002509 I2C_READ
2510
York Sun472d5462013-04-01 11:29:11 -07002511 Code that returns true if the I2C data line is high,
2512 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002513
wdenkb37c7e52003-06-30 16:24:52 +00002514 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2515
wdenkc6097192002-11-03 00:24:07 +00002516 I2C_SDA(bit)
2517
York Sun472d5462013-04-01 11:29:11 -07002518 If <bit> is true, sets the I2C data line high. If it
2519 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002520
wdenkb37c7e52003-06-30 16:24:52 +00002521 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002522 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002523 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002524
wdenkc6097192002-11-03 00:24:07 +00002525 I2C_SCL(bit)
2526
York Sun472d5462013-04-01 11:29:11 -07002527 If <bit> is true, sets the I2C clock line high. If it
2528 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002529
wdenkb37c7e52003-06-30 16:24:52 +00002530 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002531 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002532 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002533
wdenkc6097192002-11-03 00:24:07 +00002534 I2C_DELAY
2535
2536 This delay is invoked four times per clock cycle so this
2537 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002538 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002539 like:
2540
wdenkb37c7e52003-06-30 16:24:52 +00002541 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002542
Mike Frysinger793b5722010-07-21 13:38:02 -04002543 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2544
2545 If your arch supports the generic GPIO framework (asm/gpio.h),
2546 then you may alternatively define the two GPIOs that are to be
2547 used as SCL / SDA. Any of the previous I2C_xxx macros will
2548 have GPIO-based defaults assigned to them as appropriate.
2549
2550 You should define these to the GPIO value as given directly to
2551 the generic GPIO functions.
2552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002553 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002554
wdenk8bde7f72003-06-27 21:31:46 +00002555 When a board is reset during an i2c bus transfer
2556 chips might think that the current transfer is still
2557 in progress. On some boards it is possible to access
2558 the i2c SCLK line directly, either by using the
2559 processor pin as a GPIO or by having a second pin
2560 connected to the bus. If this option is defined a
2561 custom i2c_init_board() routine in boards/xxx/board.c
2562 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00002563
Richard Retanubun26a33502010-04-12 15:08:17 -04002564 CONFIG_SYS_I2C_BOARD_LATE_INIT
2565
2566 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
2567 defined a custom i2c_board_late_init() routine in
2568 boards/xxx/board.c is run AFTER the operations in i2c_init()
2569 is completed. This callpoint can be used to unreset i2c bus
2570 using CPU i2c controller register accesses for CPUs whose i2c
2571 controller provide such a method. It is called at the end of
2572 i2c_init() to allow i2c_init operations to setup the i2c bus
2573 controller on the CPU (e.g. setting bus speed & slave address).
2574
wdenk17ea1172004-06-06 21:51:03 +00002575 CONFIG_I2CFAST (PPC405GP|PPC405EP only)
2576
2577 This option enables configuration of bi_iic_fast[] flags
2578 in u-boot bd_info structure based on u-boot environment
2579 variable "i2cfast". (see also i2cfast)
2580
Ben Warrenbb99ad62006-09-07 16:50:54 -04002581 CONFIG_I2C_MULTI_BUS
2582
2583 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002584 must have a controller. At any point in time, only one bus is
2585 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04002586 Note that bus numbering is zero-based.
2587
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002588 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04002589
2590 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002591 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05002592 is set, specify a list of bus-device pairs. Otherwise, specify
2593 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04002594
2595 e.g.
2596 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002597 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002598
2599 will skip addresses 0x50 and 0x68 on a board with one I2C bus
2600
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002601 #define CONFIG_I2C_MULTI_BUS
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002602 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04002603
2604 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2605
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002606 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06002607
2608 If defined, then this indicates the I2C bus number for DDR SPD.
2609 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2610
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002611 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002612
2613 If defined, then this indicates the I2C bus number for the RTC.
2614 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
2615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002616 CONFIG_SYS_DTT_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01002617
2618 If defined, then this indicates the I2C bus number for the DTT.
2619 If not defined, then U-Boot assumes that DTT is on I2C bus 0.
2620
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002621 CONFIG_SYS_I2C_DTT_ADDR:
Victor Gallardo9ebbb542008-09-09 15:13:29 -07002622
2623 If defined, specifies the I2C address of the DTT device.
2624 If not defined, then U-Boot uses predefined value for
2625 specified DTT device.
2626
Andrew Dyer2ac69852008-12-29 17:36:01 -06002627 CONFIG_SOFT_I2C_READ_REPEATED_START
2628
2629 defining this will force the i2c_read() function in
2630 the soft_i2c driver to perform an I2C repeated start
2631 between writing the address pointer and reading the
2632 data. If this define is omitted the default behaviour
2633 of doing a stop-start sequence will be used. Most I2C
2634 devices can use either method, but some require one or
2635 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06002636
wdenkc6097192002-11-03 00:24:07 +00002637- SPI Support: CONFIG_SPI
2638
2639 Enables SPI driver (so far only tested with
2640 SPI EEPROM, also an instance works with Crystal A/D and
2641 D/As on the SACSng board)
2642
Yoshihiro Shimoda66395622011-01-31 16:50:43 +09002643 CONFIG_SH_SPI
2644
2645 Enables the driver for SPI controller on SuperH. Currently
2646 only SH7757 is supported.
2647
wdenkc6097192002-11-03 00:24:07 +00002648 CONFIG_SOFT_SPI
2649
wdenk43d96162003-03-06 00:02:04 +00002650 Enables a software (bit-bang) SPI driver rather than
2651 using hardware support. This is a general purpose
2652 driver that only requires three general I/O port pins
2653 (two outputs, one input) to function. If this is
2654 defined, the board configuration must define several
2655 SPI configuration items (port pins to use, etc). For
2656 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00002657
Ben Warren04a9e112008-01-16 22:37:35 -05002658 CONFIG_HARD_SPI
2659
2660 Enables a hardware SPI driver for general-purpose reads
2661 and writes. As with CONFIG_SOFT_SPI, the board configuration
2662 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002663 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05002664 example, see include/configs/mpc8349emds.h.
2665
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002666 CONFIG_MXC_SPI
2667
2668 Enables the driver for the SPI controllers on i.MX and MXC
Fabio Estevam2e3cd1c2011-10-28 08:57:46 +00002669 SoCs. Currently i.MX31/35/51 are supported.
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +02002670
Heiko Schocherf659b572014-07-14 10:22:11 +02002671 CONFIG_SYS_SPI_MXC_WAIT
2672 Timeout for waiting until spi transfer completed.
2673 default: (CONFIG_SYS_HZ/100) /* 10 ms */
2674
Matthias Fuchs01335022007-12-27 17:12:34 +01002675- FPGA Support: CONFIG_FPGA
2676
2677 Enables FPGA subsystem.
2678
2679 CONFIG_FPGA_<vendor>
2680
2681 Enables support for specific chip vendors.
2682 (ALTERA, XILINX)
2683
2684 CONFIG_FPGA_<family>
2685
2686 Enables support for FPGA family.
2687 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
2688
2689 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00002690
wdenk43d96162003-03-06 00:02:04 +00002691 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00002692
Siva Durga Prasad Paladugu64e809a2014-03-14 16:35:38 +05302693 CONFIG_CMD_FPGA_LOADMK
2694
2695 Enable support for fpga loadmk command
2696
Michal Simek67193862014-05-02 13:43:39 +02002697 CONFIG_CMD_FPGA_LOADP
2698
2699 Enable support for fpga loadp command - load partial bitstream
2700
2701 CONFIG_CMD_FPGA_LOADBP
2702
2703 Enable support for fpga loadbp command - load partial bitstream
2704 (Xilinx only)
2705
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002706 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00002707
wdenk8bde7f72003-06-27 21:31:46 +00002708 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00002709
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002710 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002711
wdenk43d96162003-03-06 00:02:04 +00002712 Enable checks on FPGA configuration interface busy
2713 status by the configuration function. This option
2714 will require a board or device specific function to
2715 be written.
wdenkc6097192002-11-03 00:24:07 +00002716
2717 CONFIG_FPGA_DELAY
2718
2719 If defined, a function that provides delays in the FPGA
2720 configuration driver.
2721
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002722 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002723 Allow Control-C to interrupt FPGA configuration
2724
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002725 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002726
wdenk43d96162003-03-06 00:02:04 +00002727 Check for configuration errors during FPGA bitfile
2728 loading. For example, abort during Virtex II
2729 configuration if the INIT_B line goes low (which
2730 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002731
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002732 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002733
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002734 Maximum time to wait for the INIT_B line to de-assert
2735 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002736 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002737 ms.
wdenkc6097192002-11-03 00:24:07 +00002738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002739 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002740
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002741 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002742 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002743
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002744 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002745
wdenk43d96162003-03-06 00:02:04 +00002746 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002747 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002748
2749- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002750 CONFIG_BUILD_TARGET
2751
2752 Some SoCs need special image types (e.g. U-Boot binary
2753 with a special header) as build targets. By defining
2754 CONFIG_BUILD_TARGET in the SoC / board header, this
2755 special image will be automatically built upon calling
2756 make / MAKEALL.
2757
wdenkc6097192002-11-03 00:24:07 +00002758 CONFIG_IDENT_STRING
2759
wdenk43d96162003-03-06 00:02:04 +00002760 If defined, this string will be added to the U-Boot
2761 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002762
2763- Vendor Parameter Protection:
2764
wdenk43d96162003-03-06 00:02:04 +00002765 U-Boot considers the values of the environment
2766 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002767 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002768 are set once by the board vendor / manufacturer, and
2769 protects these variables from casual modification by
2770 the user. Once set, these variables are read-only,
2771 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002772 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002773
2774 If CONFIG_ENV_OVERWRITE is #defined in your config
2775 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002776 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002777 these parameters.
2778
Joe Hershberger92ac5202015-05-04 14:55:14 -05002779 Alternatively, if you define _both_ an ethaddr in the
2780 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002781 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002782 which can be changed exactly ONCE by the user. [The
2783 serial# is unaffected by this, i. e. it remains
2784 read-only.]
2785
Joe Hershberger25980902012-12-11 22:16:31 -06002786 The same can be accomplished in a more flexible way
2787 for any variable by configuring the type of access
2788 to allow for those variables in the ".flags" variable
2789 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2790
wdenkc6097192002-11-03 00:24:07 +00002791- Protected RAM:
2792 CONFIG_PRAM
2793
2794 Define this variable to enable the reservation of
2795 "protected RAM", i. e. RAM which is not overwritten
2796 by U-Boot. Define CONFIG_PRAM to hold the number of
2797 kB you want to reserve for pRAM. You can overwrite
2798 this default value by defining an environment
2799 variable "pram" to the number of kB you want to
2800 reserve. Note that the board info structure will
2801 still show the full amount of RAM. If pRAM is
2802 reserved, a new environment variable "mem" will
2803 automatically be defined to hold the amount of
2804 remaining RAM in a form that can be passed as boot
2805 argument to Linux, for instance like that:
2806
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002807 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002808 saveenv
2809
2810 This way you can tell Linux not to use this memory,
2811 either, which results in a memory region that will
2812 not be affected by reboots.
2813
2814 *WARNING* If your board configuration uses automatic
2815 detection of the RAM size, you must make sure that
2816 this memory test is non-destructive. So far, the
2817 following board configurations are known to be
2818 "pRAM-clean":
2819
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002820 IVMS8, IVML24, SPD8xx, TQM8xxL,
2821 HERMES, IP860, RPXlite, LWMON,
Wolfgang Denk544d97e2010-10-05 22:54:53 +02002822 FLAGADM, TQM8260
wdenkc6097192002-11-03 00:24:07 +00002823
Gabe Black40fef042012-12-02 04:55:18 +00002824- Access to physical memory region (> 4GB)
2825 Some basic support is provided for operations on memory not
2826 normally accessible to U-Boot - e.g. some architectures
2827 support access to more than 4GB of memory on 32-bit
2828 machines using physical address extension or similar.
2829 Define CONFIG_PHYSMEM to access this basic support, which
2830 currently only supports clearing the memory.
2831
wdenkc6097192002-11-03 00:24:07 +00002832- Error Recovery:
2833 CONFIG_PANIC_HANG
2834
2835 Define this variable to stop the system in case of a
2836 fatal error, so that you have to reset it manually.
2837 This is probably NOT a good idea for an embedded
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002838 system where you want the system to reboot
wdenkc6097192002-11-03 00:24:07 +00002839 automatically as fast as possible, but it may be
2840 useful during development since you can try to debug
2841 the conditions that lead to the situation.
2842
2843 CONFIG_NET_RETRY_COUNT
2844
wdenk43d96162003-03-06 00:02:04 +00002845 This variable defines the number of retries for
2846 network operations like ARP, RARP, TFTP, or BOOTP
2847 before giving up the operation. If not defined, a
2848 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002849
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002850 CONFIG_ARP_TIMEOUT
2851
2852 Timeout waiting for an ARP reply in milliseconds.
2853
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002854 CONFIG_NFS_TIMEOUT
2855
2856 Timeout in milliseconds used in NFS protocol.
2857 If you encounter "ERROR: Cannot umount" in nfs command,
2858 try longer timeout such as
2859 #define CONFIG_NFS_TIMEOUT 10000UL
2860
wdenkc6097192002-11-03 00:24:07 +00002861- Command Interpreter:
Wolfgang Denk8078f1a2006-10-28 02:28:02 +02002862 CONFIG_AUTO_COMPLETE
wdenk04a85b32004-04-15 18:22:41 +00002863
2864 Enable auto completion of commands using TAB.
2865
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002866 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002867
2868 This defines the secondary prompt string, which is
2869 printed when the command interpreter needs more input
2870 to complete a command. Usually "> ".
2871
2872 Note:
2873
wdenk8bde7f72003-06-27 21:31:46 +00002874 In the current implementation, the local variables
2875 space and global environment variables space are
2876 separated. Local variables are those you define by
2877 simply typing `name=value'. To access a local
2878 variable later on, you have write `$name' or
2879 `${name}'; to execute the contents of a variable
2880 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002881
wdenk43d96162003-03-06 00:02:04 +00002882 Global environment variables are those you use
2883 setenv/printenv to work with. To run a command stored
2884 in such a variable, you need to use the run command,
2885 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002886
2887 To store commands and special characters in a
2888 variable, please use double quotation marks
2889 surrounding the whole text of the variable, instead
2890 of the backslashes before semicolons and special
2891 symbols.
2892
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002893- Command Line Editing and History:
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002894 CONFIG_CMDLINE_EDITING
2895
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002896 Enable editing and History functions for interactive
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002897 command line input operations
Wolfgang Denkaa0c71a2006-07-21 11:35:21 +02002898
Marek Vasutf3b267b2016-01-27 04:47:55 +01002899- Command Line PS1/PS2 support:
2900 CONFIG_CMDLINE_PS_SUPPORT
2901
2902 Enable support for changing the command prompt string
2903 at run-time. Only static string is supported so far.
2904 The string is obtained from environment variables PS1
2905 and PS2.
2906
wdenka8c7c702003-12-06 19:49:23 +00002907- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002908 CONFIG_EXTRA_ENV_SETTINGS
2909
wdenk43d96162003-03-06 00:02:04 +00002910 Define this to contain any number of null terminated
2911 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002912 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002913
wdenk43d96162003-03-06 00:02:04 +00002914 For example, place something like this in your
2915 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002916
2917 #define CONFIG_EXTRA_ENV_SETTINGS \
2918 "myvar1=value1\0" \
2919 "myvar2=value2\0"
2920
wdenk43d96162003-03-06 00:02:04 +00002921 Warning: This method is based on knowledge about the
2922 internal format how the environment is stored by the
2923 U-Boot code. This is NOT an official, exported
2924 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002925 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002926 You better know what you are doing here.
2927
wdenk43d96162003-03-06 00:02:04 +00002928 Note: overly (ab)use of the default environment is
2929 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002930 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002931 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002932
Stephen Warren5e724ca2012-05-22 09:21:54 +00002933 CONFIG_ENV_VARS_UBOOT_CONFIG
2934
2935 Define this in order to add variables describing the
2936 U-Boot build configuration to the default environment.
2937 These will be named arch, cpu, board, vendor, and soc.
2938
2939 Enabling this option will cause the following to be defined:
2940
2941 - CONFIG_SYS_ARCH
2942 - CONFIG_SYS_CPU
2943 - CONFIG_SYS_BOARD
2944 - CONFIG_SYS_VENDOR
2945 - CONFIG_SYS_SOC
2946
Tom Rini7e27f892012-10-24 07:28:16 +00002947 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
2948
2949 Define this in order to add variables describing certain
2950 run-time determined information about the hardware to the
2951 environment. These will be named board_name, board_rev.
2952
Simon Glass06fd8532012-11-30 13:01:17 +00002953 CONFIG_DELAY_ENVIRONMENT
2954
2955 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002956 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002957 that so that the environment is not available until
2958 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2959 this is instead controlled by the value of
2960 /config/load-environment.
2961
Chris Packham3b10cf12015-06-19 20:25:59 +12002962- Parallel Flash support:
2963 CONFIG_SYS_NO_FLASH
2964
Bin Menga1875592016-02-05 19:30:11 -08002965 Traditionally U-Boot was run on systems with parallel NOR
Chris Packham3b10cf12015-06-19 20:25:59 +12002966 flash. This option is used to disable support for parallel NOR
2967 flash. This option should be defined if the board does not have
2968 parallel flash.
2969
2970 If this option is not defined one of the generic flash drivers
2971 (e.g. CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
2972 selected or the board must provide an implementation of the
2973 flash API (see include/flash.h).
2974
wdenka8c7c702003-12-06 19:49:23 +00002975- DataFlash Support:
wdenk2abbe072003-06-16 23:50:08 +00002976 CONFIG_HAS_DATAFLASH
2977
wdenk8bde7f72003-06-27 21:31:46 +00002978 Defining this option enables DataFlash features and
2979 allows to read/write in Dataflash via the standard
2980 commands cp, md...
wdenk2abbe072003-06-16 23:50:08 +00002981
Eric Nelsonf61ec452012-01-31 10:52:08 -07002982- Serial Flash support
2983 CONFIG_CMD_SF
2984
2985 Defining this option enables SPI flash commands
2986 'sf probe/read/write/erase/update'.
2987
2988 Usage requires an initial 'probe' to define the serial
2989 flash parameters, followed by read/write/erase/update
2990 commands.
2991
2992 The following defaults may be provided by the platform
2993 to handle the common case when only a single serial
2994 flash is present on the system.
2995
2996 CONFIG_SF_DEFAULT_BUS Bus identifier
2997 CONFIG_SF_DEFAULT_CS Chip-select
2998 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2999 CONFIG_SF_DEFAULT_SPEED in Hz
3000
Simon Glass24007272012-10-08 13:16:02 +00003001 CONFIG_CMD_SF_TEST
3002
3003 Define this option to include a destructive SPI flash
3004 test ('sf test').
3005
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303006 CONFIG_SF_DUAL_FLASH Dual flash memories
3007
3008 Define this option to use dual flash support where two flash
3009 memories can be connected with a given cs line.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003010 Currently Xilinx Zynq qspi supports these type of connections.
Jagannadha Sutradharudu Tekib902e072014-01-11 15:25:04 +05303011
wdenk3f85ce22004-02-23 16:11:30 +00003012- SystemACE Support:
3013 CONFIG_SYSTEMACE
3014
3015 Adding this option adds support for Xilinx SystemACE
3016 chips attached via some sort of local bus. The address
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003017 of the chip must also be defined in the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003018 CONFIG_SYS_SYSTEMACE_BASE macro. For example:
wdenk3f85ce22004-02-23 16:11:30 +00003019
3020 #define CONFIG_SYSTEMACE
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003021 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
wdenk3f85ce22004-02-23 16:11:30 +00003022
3023 When SystemACE support is added, the "ace" device type
3024 becomes available to the fat commands, i.e. fatls.
3025
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003026- TFTP Fixed UDP Port:
3027 CONFIG_TFTP_PORT
3028
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003029 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003030 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003031 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003032 number generator is used.
3033
Wolfgang Denk28cb9372005-09-24 23:25:46 +02003034 Also, the environment variable tftpdstp is used to supply
3035 the TFTP UDP destination port value. If tftpdstp isn't
3036 defined, the normal port 69 is used.
3037
3038 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02003039 blindly start the TFTP transfer using the pre-configured
3040 target IP address and UDP port. This has the effect of
3041 "punching through" the (Windows XP) firewall, allowing
3042 the remainder of the TFTP transfer to proceed normally.
3043 A better solution is to properly configure the firewall,
3044 but sometimes that is not allowed.
3045
Simon Glassbf36c5d2012-12-05 14:46:38 +00003046- Hashing support:
3047 CONFIG_CMD_HASH
3048
3049 This enables a generic 'hash' command which can produce
3050 hashes / digests from a few algorithms (e.g. SHA1, SHA256).
3051
3052 CONFIG_HASH_VERIFY
3053
3054 Enable the hash verify command (hash -v). This adds to code
3055 size a little.
3056
gaurav rana94e3c8c2015-02-20 12:51:46 +05303057 CONFIG_SHA1 - This option enables support of hashing using SHA1
3058 algorithm. The hash is calculated in software.
3059 CONFIG_SHA256 - This option enables support of hashing using
3060 SHA256 algorithm. The hash is calculated in software.
3061 CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
3062 for SHA1/SHA256 hashing.
3063 This affects the 'hash' command and also the
3064 hash_lookup_algo() function.
3065 CONFIG_SHA_PROG_HW_ACCEL - This option enables
3066 hardware-acceleration for SHA1/SHA256 progressive hashing.
3067 Data can be streamed in a block at a time and the hashing
3068 is performed in hardware.
Simon Glassbf36c5d2012-12-05 14:46:38 +00003069
3070 Note: There is also a sha1sum command, which should perhaps
3071 be deprecated in favour of 'hash sha1'.
3072
Robert Winklera11f1872013-07-24 17:57:06 -07003073- Freescale i.MX specific commands:
3074 CONFIG_CMD_HDMIDETECT
3075 This enables 'hdmidet' command which returns true if an
3076 HDMI monitor is detected. This command is i.MX 6 specific.
3077
3078 CONFIG_CMD_BMODE
3079 This enables the 'bmode' (bootmode) command for forcing
3080 a boot from specific media.
3081
3082 This is useful for forcing the ROM's usb downloader to
3083 activate upon a watchdog reset which is nice when iterating
3084 on U-Boot. Using the reset button or running bmode normal
3085 will set it back to normal. This command currently
3086 supports i.MX53 and i.MX6.
3087
Heiko Schocher9e50c402014-01-25 07:27:13 +01003088- bootcount support:
3089 CONFIG_BOOTCOUNT_LIMIT
3090
3091 This enables the bootcounter support, see:
3092 http://www.denx.de/wiki/DULG/UBootBootCountLimit
3093
3094 CONFIG_AT91SAM9XE
3095 enable special bootcounter support on at91sam9xe based boards.
3096 CONFIG_BLACKFIN
3097 enable special bootcounter support on blackfin based boards.
3098 CONFIG_SOC_DA8XX
3099 enable special bootcounter support on da850 based boards.
3100 CONFIG_BOOTCOUNT_RAM
3101 enable support for the bootcounter in RAM
3102 CONFIG_BOOTCOUNT_I2C
3103 enable support for the bootcounter on an i2c (like RTC) device.
3104 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
3105 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
3106 the bootcounter.
3107 CONFIG_BOOTCOUNT_ALEN = address len
Simon Glass19c402a2013-06-13 15:10:02 -07003108
wdenka8c7c702003-12-06 19:49:23 +00003109- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00003110 CONFIG_SHOW_BOOT_PROGRESS
3111
wdenk43d96162003-03-06 00:02:04 +00003112 Defining this option allows to add some board-
3113 specific code (calling a user-provided function
3114 "show_boot_progress(int)") that enables you to show
3115 the system's boot progress on some display (for
3116 example, some LED's) on your board. At the moment,
3117 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00003118
Simon Glass94fd1312012-09-28 08:56:37 +00003119
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003120Legacy uImage format:
3121
wdenkc6097192002-11-03 00:24:07 +00003122 Arg Where When
3123 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00003124 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00003125 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00003126 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003127 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00003128 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00003129 4 common/cmd_bootm.c Image data has correct checksum
3130 -4 common/cmd_bootm.c Image is for unsupported architecture
3131 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003132 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00003133 6 common/cmd_bootm.c Image Type check OK
3134 -6 common/cmd_bootm.c gunzip uncompression error
3135 -7 common/cmd_bootm.c Unimplemented compression type
3136 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003137 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00003138 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003139
3140 9 common/image.c Start initial ramdisk verification
3141 -10 common/image.c Ramdisk header has bad magic number
3142 -11 common/image.c Ramdisk header has bad checksum
3143 10 common/image.c Ramdisk header is OK
3144 -12 common/image.c Ramdisk data has bad checksum
3145 11 common/image.c Ramdisk data has correct checksum
3146 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003147 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003148 13 common/image.c Start multifile image verification
3149 14 common/image.c No initial ramdisk, no multifile, continue.
3150
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003151 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00003152
Stefan Roesea47a12b2010-04-15 16:07:28 +02003153 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00003154 -31 post/post.c POST test failed, detected by post_output_backlog()
3155 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00003156
Heiko Schocher566a4942007-06-22 19:11:54 +02003157 34 common/cmd_doc.c before loading a Image from a DOC device
3158 -35 common/cmd_doc.c Bad usage of "doc" command
3159 35 common/cmd_doc.c correct usage of "doc" command
3160 -36 common/cmd_doc.c No boot device
3161 36 common/cmd_doc.c correct boot device
3162 -37 common/cmd_doc.c Unknown Chip ID on boot device
3163 37 common/cmd_doc.c correct chip ID found, device available
3164 -38 common/cmd_doc.c Read Error on boot device
3165 38 common/cmd_doc.c reading Image header from DOC device OK
3166 -39 common/cmd_doc.c Image header has bad magic number
3167 39 common/cmd_doc.c Image header has correct magic number
3168 -40 common/cmd_doc.c Error reading Image from DOC device
3169 40 common/cmd_doc.c Image header has correct magic number
3170 41 common/cmd_ide.c before loading a Image from a IDE device
3171 -42 common/cmd_ide.c Bad usage of "ide" command
3172 42 common/cmd_ide.c correct usage of "ide" command
3173 -43 common/cmd_ide.c No boot device
3174 43 common/cmd_ide.c boot device found
3175 -44 common/cmd_ide.c Device not available
3176 44 common/cmd_ide.c Device available
3177 -45 common/cmd_ide.c wrong partition selected
3178 45 common/cmd_ide.c partition selected
3179 -46 common/cmd_ide.c Unknown partition table
3180 46 common/cmd_ide.c valid partition table found
3181 -47 common/cmd_ide.c Invalid partition type
3182 47 common/cmd_ide.c correct partition type
3183 -48 common/cmd_ide.c Error reading Image Header on boot device
3184 48 common/cmd_ide.c reading Image Header from IDE device OK
3185 -49 common/cmd_ide.c Image header has bad magic number
3186 49 common/cmd_ide.c Image header has correct magic number
3187 -50 common/cmd_ide.c Image header has bad checksum
3188 50 common/cmd_ide.c Image header has correct checksum
3189 -51 common/cmd_ide.c Error reading Image from IDE device
3190 51 common/cmd_ide.c reading Image from IDE device OK
3191 52 common/cmd_nand.c before loading a Image from a NAND device
3192 -53 common/cmd_nand.c Bad usage of "nand" command
3193 53 common/cmd_nand.c correct usage of "nand" command
3194 -54 common/cmd_nand.c No boot device
3195 54 common/cmd_nand.c boot device found
3196 -55 common/cmd_nand.c Unknown Chip ID on boot device
3197 55 common/cmd_nand.c correct chip ID found, device available
3198 -56 common/cmd_nand.c Error reading Image Header on boot device
3199 56 common/cmd_nand.c reading Image Header from NAND device OK
3200 -57 common/cmd_nand.c Image header has bad magic number
3201 57 common/cmd_nand.c Image header has correct magic number
3202 -58 common/cmd_nand.c Error reading Image from NAND device
3203 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00003204
Heiko Schocher566a4942007-06-22 19:11:54 +02003205 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00003206
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003207 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02003208 -64 net/eth.c no Ethernet found.
3209 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00003210
Heiko Schocher566a4942007-06-22 19:11:54 +02003211 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05003212 80 common/cmd_net.c before calling net_loop()
3213 -81 common/cmd_net.c some error in net_loop() occurred
3214 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02003215 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
3216 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02003217 83 common/cmd_net.c running "source" command
3218 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02003219 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00003220
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003221FIT uImage format:
3222
3223 Arg Where When
3224 100 common/cmd_bootm.c Kernel FIT Image has correct format
3225 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
3226 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
3227 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
3228 102 common/cmd_bootm.c Kernel unit name specified
3229 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01003230 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003231 104 common/cmd_bootm.c Got kernel subimage node offset
3232 -104 common/cmd_bootm.c Kernel subimage hash verification failed
3233 105 common/cmd_bootm.c Kernel subimage hash verification OK
3234 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
3235 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003236 -106 common/cmd_bootm.c Kernel subimage has wrong type
3237 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003238 -107 common/cmd_bootm.c Can't get kernel subimage data/size
3239 108 common/cmd_bootm.c Got kernel subimage data/size
3240 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
3241 -109 common/cmd_bootm.c Can't get kernel subimage type
3242 -110 common/cmd_bootm.c Can't get kernel subimage comp
3243 -111 common/cmd_bootm.c Can't get kernel subimage os
3244 -112 common/cmd_bootm.c Can't get kernel subimage load address
3245 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
3246
3247 120 common/image.c Start initial ramdisk verification
3248 -120 common/image.c Ramdisk FIT image has incorrect format
3249 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003250 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003251 -122 common/image.c Can't get configuration for ramdisk subimage
3252 123 common/image.c Ramdisk unit name specified
3253 -124 common/image.c Can't get ramdisk subimage node offset
3254 125 common/image.c Got ramdisk subimage node offset
3255 -125 common/image.c Ramdisk subimage hash verification failed
3256 126 common/image.c Ramdisk subimage hash verification OK
3257 -126 common/image.c Ramdisk subimage for unsupported architecture
3258 127 common/image.c Architecture check OK
3259 -127 common/image.c Can't get ramdisk subimage data/size
3260 128 common/image.c Got ramdisk subimage data/size
3261 129 common/image.c Can't get ramdisk load address
3262 -129 common/image.c Got ramdisk load address
3263
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003264 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003265 131 common/cmd_doc.c FIT image format OK
3266
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003267 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003268 141 common/cmd_ide.c FIT image format OK
3269
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003270 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003271 151 common/cmd_nand.c FIT image format OK
3272
Heiko Schocher21d29f72014-05-28 11:33:33 +02003273- legacy image format:
3274 CONFIG_IMAGE_FORMAT_LEGACY
3275 enables the legacy image format support in U-Boot.
3276
3277 Default:
3278 enabled if CONFIG_FIT_SIGNATURE is not defined.
3279
3280 CONFIG_DISABLE_IMAGE_LEGACY
3281 disable the legacy image format
3282
3283 This define is introduced, as the legacy image format is
3284 enabled per default for backward compatibility.
3285
Gabe Blackd95f6ec2012-10-25 16:31:10 +00003286- FIT image support:
Dirk Eibach9a4f4792014-07-03 09:28:26 +02003287 CONFIG_FIT_DISABLE_SHA256
3288 Supporting SHA256 hashes has quite an impact on binary size.
3289 For constrained systems sha256 hash support can be disabled
3290 with this option.
3291
Simon Glass73223f02016-02-22 22:55:43 -07003292 TODO(sjg@chromium.org): Adjust this option to be positive,
3293 and move it to Kconfig
3294
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003295- Standalone program support:
3296 CONFIG_STANDALONE_LOAD_ADDR
3297
Wolfgang Denk6feff892011-10-09 21:06:34 +02003298 This option defines a board specific value for the
3299 address where standalone program gets loaded, thus
3300 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003301 settings.
3302
3303- Frame Buffer Address:
3304 CONFIG_FB_ADDR
3305
3306 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00003307 address for frame buffer. This is typically the case
3308 when using a graphics controller has separate video
3309 memory. U-Boot will then place the frame buffer at
3310 the given address instead of dynamically reserving it
3311 in system RAM by calling lcd_setmem(), which grabs
3312 the memory for the frame buffer depending on the
3313 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02003314
3315 Please see board_init_f function.
3316
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01003317- Automatic software updates via TFTP server
3318 CONFIG_UPDATE_TFTP
3319 CONFIG_UPDATE_TFTP_CNT_MAX
3320 CONFIG_UPDATE_TFTP_MSEC_MAX
3321
3322 These options enable and control the auto-update feature;
3323 for a more detailed description refer to doc/README.update.
3324
3325- MTD Support (mtdparts command, UBI support)
3326 CONFIG_MTD_DEVICE
3327
3328 Adds the MTD device infrastructure from the Linux kernel.
3329 Needed for mtdparts command support.
3330
3331 CONFIG_MTD_PARTITIONS
3332
3333 Adds the MTD partitioning infrastructure from the Linux
3334 kernel. Needed for UBI support.
3335
Joe Hershberger70c219c2013-04-08 10:32:48 +00003336- UBI support
3337 CONFIG_CMD_UBI
3338
3339 Adds commands for interacting with MTD partitions formatted
3340 with the UBI flash translation layer
3341
3342 Requires also defining CONFIG_RBTREE
3343
Joe Hershberger147162d2013-04-08 10:32:49 +00003344 CONFIG_UBI_SILENCE_MSG
3345
3346 Make the verbose messages from UBI stop printing. This leaves
3347 warnings and errors enabled.
3348
Heiko Schocherff94bc42014-06-24 10:10:04 +02003349
3350 CONFIG_MTD_UBI_WL_THRESHOLD
3351 This parameter defines the maximum difference between the highest
3352 erase counter value and the lowest erase counter value of eraseblocks
3353 of UBI devices. When this threshold is exceeded, UBI starts performing
3354 wear leveling by means of moving data from eraseblock with low erase
3355 counter to eraseblocks with high erase counter.
3356
3357 The default value should be OK for SLC NAND flashes, NOR flashes and
3358 other flashes which have eraseblock life-cycle 100000 or more.
3359 However, in case of MLC NAND flashes which typically have eraseblock
3360 life-cycle less than 10000, the threshold should be lessened (e.g.,
3361 to 128 or 256, although it does not have to be power of 2).
3362
3363 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06003364
Heiko Schocherff94bc42014-06-24 10:10:04 +02003365 CONFIG_MTD_UBI_BEB_LIMIT
3366 This option specifies the maximum bad physical eraseblocks UBI
3367 expects on the MTD device (per 1024 eraseblocks). If the
3368 underlying flash does not admit of bad eraseblocks (e.g. NOR
3369 flash), this value is ignored.
3370
3371 NAND datasheets often specify the minimum and maximum NVM
3372 (Number of Valid Blocks) for the flashes' endurance lifetime.
3373 The maximum expected bad eraseblocks per 1024 eraseblocks
3374 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
3375 which gives 20 for most NANDs (MaxNVB is basically the total
3376 count of eraseblocks on the chip).
3377
3378 To put it differently, if this value is 20, UBI will try to
3379 reserve about 1.9% of physical eraseblocks for bad blocks
3380 handling. And that will be 1.9% of eraseblocks on the entire
3381 NAND chip, not just the MTD partition UBI attaches. This means
3382 that if you have, say, a NAND flash chip admits maximum 40 bad
3383 eraseblocks, and it is split on two MTD partitions of the same
3384 size, UBI will reserve 40 eraseblocks when attaching a
3385 partition.
3386
3387 default: 20
3388
3389 CONFIG_MTD_UBI_FASTMAP
3390 Fastmap is a mechanism which allows attaching an UBI device
3391 in nearly constant time. Instead of scanning the whole MTD device it
3392 only has to locate a checkpoint (called fastmap) on the device.
3393 The on-flash fastmap contains all information needed to attach
3394 the device. Using fastmap makes only sense on large devices where
3395 attaching by scanning takes long. UBI will not automatically install
3396 a fastmap on old images, but you can set the UBI parameter
3397 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
3398 that fastmap-enabled images are still usable with UBI implementations
3399 without fastmap support. On typical flash devices the whole fastmap
3400 fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
3401
3402 CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
3403 Set this parameter to enable fastmap automatically on images
3404 without a fastmap.
3405 default: 0
3406
Heiko Schocher0195a7b2015-10-22 06:19:21 +02003407 CONFIG_MTD_UBI_FM_DEBUG
3408 Enable UBI fastmap debug
3409 default: 0
3410
Joe Hershberger70c219c2013-04-08 10:32:48 +00003411- UBIFS support
3412 CONFIG_CMD_UBIFS
3413
3414 Adds commands for interacting with UBI volumes formatted as
3415 UBIFS. UBIFS is read-only in u-boot.
3416
3417 Requires UBI support as well as CONFIG_LZO
3418
Joe Hershberger147162d2013-04-08 10:32:49 +00003419 CONFIG_UBIFS_SILENCE_MSG
3420
3421 Make the verbose messages from UBIFS stop printing. This leaves
3422 warnings and errors enabled.
3423
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003424- SPL framework
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003425 CONFIG_SPL
3426 Enable building of SPL globally.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003427
Tom Rini95579792012-02-14 07:29:40 +00003428 CONFIG_SPL_LDSCRIPT
3429 LDSCRIPT for linking the SPL binary.
3430
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003431 CONFIG_SPL_MAX_FOOTPRINT
3432 Maximum size in memory allocated to the SPL, BSS included.
3433 When defined, the linker checks that the actual memory
3434 used by SPL from _start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003435 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003436 must not be both defined at the same time.
3437
Tom Rini95579792012-02-14 07:29:40 +00003438 CONFIG_SPL_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003439 Maximum size of the SPL image (text, data, rodata, and
3440 linker lists sections), BSS excluded.
3441 When defined, the linker checks that the actual size does
3442 not exceed it.
Tom Rini95579792012-02-14 07:29:40 +00003443
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003444 CONFIG_SPL_TEXT_BASE
3445 TEXT_BASE for linking the SPL binary.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003446
Scott Wood94a45bb2012-09-20 19:05:12 -05003447 CONFIG_SPL_RELOC_TEXT_BASE
3448 Address to relocate to. If unspecified, this is equal to
3449 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
3450
Tom Rini95579792012-02-14 07:29:40 +00003451 CONFIG_SPL_BSS_START_ADDR
3452 Link address for the BSS within the SPL binary.
3453
3454 CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003455 Maximum size in memory allocated to the SPL BSS.
3456 When defined, the linker checks that the actual memory used
3457 by SPL from __bss_start to __bss_end does not exceed it.
Albert ARIBAUD8960af82013-04-14 04:48:38 +00003458 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
Albert ARIBAUD6ebc3462013-04-12 05:14:30 +00003459 must not be both defined at the same time.
Tom Rini95579792012-02-14 07:29:40 +00003460
3461 CONFIG_SPL_STACK
3462 Adress of the start of the stack SPL will use
3463
Albert ARIBAUD \(3ADEV\)8c80eb32015-03-31 11:40:50 +02003464 CONFIG_SPL_PANIC_ON_RAW_IMAGE
3465 When defined, SPL will panic() if the image it has
3466 loaded does not have a signature.
3467 Defining this is useful when code which loads images
3468 in SPL cannot guarantee that absolutely all read errors
3469 will be caught.
3470 An example is the LPC32XX MLC NAND driver, which will
3471 consider that a completely unreadable NAND block is bad,
3472 and thus should be skipped silently.
3473
Marek Vasute0727512016-04-29 00:44:55 +02003474 CONFIG_SPL_ABORT_ON_RAW_IMAGE
3475 When defined, SPL will proceed to another boot method
3476 if the image it has loaded does not have a signature.
3477
Scott Wood94a45bb2012-09-20 19:05:12 -05003478 CONFIG_SPL_RELOC_STACK
3479 Adress of the start of the stack SPL will use after
3480 relocation. If unspecified, this is equal to
3481 CONFIG_SPL_STACK.
3482
Tom Rini95579792012-02-14 07:29:40 +00003483 CONFIG_SYS_SPL_MALLOC_START
3484 Starting address of the malloc pool used in SPL.
Fabio Estevam9ac4fc82015-11-12 12:30:19 -02003485 When this option is set the full malloc is used in SPL and
3486 it is set up by spl_init() and before that, the simple malloc()
3487 can be used if CONFIG_SYS_MALLOC_F is defined.
Tom Rini95579792012-02-14 07:29:40 +00003488
3489 CONFIG_SYS_SPL_MALLOC_SIZE
3490 The size of the malloc pool used in SPL.
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003491
Tom Rini47f7bca2012-08-13 12:03:19 -07003492 CONFIG_SPL_FRAMEWORK
3493 Enable the SPL framework under common/. This framework
3494 supports MMC, NAND and YMODEM loading of U-Boot and NAND
3495 NAND loading of the Linux Kernel.
3496
Tom Rini9607faf2014-03-28 12:03:39 -04003497 CONFIG_SPL_OS_BOOT
3498 Enable booting directly to an OS from SPL.
3499 See also: doc/README.falcon
3500
Tom Rini861a86f2012-08-13 11:37:56 -07003501 CONFIG_SPL_DISPLAY_PRINT
3502 For ARM, enable an optional function to print more information
3503 about the running system.
3504
Scott Wood4b919722012-09-20 16:35:21 -05003505 CONFIG_SPL_INIT_MINIMAL
3506 Arch init code should be built for a very small image
3507
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003508 CONFIG_SPL_LIBCOMMON_SUPPORT
3509 Support for common/libcommon.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003510
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003511 CONFIG_SPL_LIBDISK_SUPPORT
3512 Support for disk/libdisk.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003513
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003514 CONFIG_SPL_I2C_SUPPORT
3515 Support for drivers/i2c/libi2c.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003516
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003517 CONFIG_SPL_GPIO_SUPPORT
3518 Support for drivers/gpio/libgpio.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003519
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003520 CONFIG_SPL_MMC_SUPPORT
3521 Support for drivers/mmc/libmmc.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003522
Tom Rini95579792012-02-14 07:29:40 +00003523 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
3524 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003525 Address and partition on the MMC to load U-Boot from
Tom Rini95579792012-02-14 07:29:40 +00003526 when the MMC is being used in raw mode.
3527
Paul Kocialkowskib97300b2014-11-08 23:14:56 +01003528 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3529 Partition on the MMC to load U-Boot from when the MMC is being
3530 used in raw mode
3531
Peter Korsgaard2b75b0a2013-05-13 08:36:29 +00003532 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
3533 Sector to load kernel uImage from when MMC is being
3534 used in raw mode (for Falcon mode)
3535
3536 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
3537 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
3538 Sector and number of sectors to load kernel argument
3539 parameters from when MMC is being used in raw mode
3540 (for falcon mode)
3541
Paul Kocialkowskie2ccdf82014-11-08 23:14:55 +01003542 CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3543 Partition on the MMC to load U-Boot from when the MMC is being
3544 used in fs mode
3545
Tom Rini95579792012-02-14 07:29:40 +00003546 CONFIG_SPL_FAT_SUPPORT
3547 Support for fs/fat/libfat.o in SPL binary
3548
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003549 CONFIG_SPL_EXT_SUPPORT
3550 Support for EXT filesystem in SPL binary
Tom Rini95579792012-02-14 07:29:40 +00003551
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003552 CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3553 Filename to read to load U-Boot when reading from filesystem
3554
3555 CONFIG_SPL_FS_LOAD_KERNEL_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003556 Filename to read to load kernel uImage when reading
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003557 from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003558
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003559 CONFIG_SPL_FS_LOAD_ARGS_NAME
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003560 Filename to read to load kernel argument parameters
Guillaume GARDETfae81c72014-10-15 17:53:13 +02003561 when reading from filesystem (for Falcon mode)
Peter Korsgaard7ad2cc72013-05-13 08:36:27 +00003562
Scott Wood06f60ae2012-12-06 13:33:17 +00003563 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
3564 Set this for NAND SPL on PPC mpc83xx targets, so that
3565 start.S waits for the rest of the SPL to load before
3566 continuing (the hardware starts execution after just
3567 loading the first page rather than the full 4K).
3568
Prabhakar Kushwaha651fcf62014-04-08 19:12:31 +05303569 CONFIG_SPL_SKIP_RELOCATE
3570 Avoid SPL relocation
3571
Scott Wood6f2f01b2012-09-20 19:09:07 -05003572 CONFIG_SPL_NAND_BASE
3573 Include nand_base.c in the SPL. Requires
3574 CONFIG_SPL_NAND_DRIVERS.
3575
3576 CONFIG_SPL_NAND_DRIVERS
3577 SPL uses normal NAND drivers, not minimal drivers.
3578
3579 CONFIG_SPL_NAND_ECC
3580 Include standard software ECC in the SPL
3581
Tom Rini95579792012-02-14 07:29:40 +00003582 CONFIG_SPL_NAND_SIMPLE
Scott Wood7d4b7952012-09-21 18:35:27 -05003583 Support for NAND boot using simple NAND drivers that
3584 expose the cmd_ctrl() interface.
Tom Rini95579792012-02-14 07:29:40 +00003585
Tom Rini6dd3b562014-03-28 12:03:36 -04003586 CONFIG_SPL_MTD_SUPPORT
3587 Support for the MTD subsystem within SPL. Useful for
3588 environment on NAND support within SPL.
3589
Heiko Schocher0c3117b2014-10-31 08:31:00 +01003590 CONFIG_SPL_NAND_RAW_ONLY
3591 Support to boot only raw u-boot.bin images. Use this only
3592 if you need to save space.
3593
Ying Zhangbb0dc102013-08-16 15:16:11 +08003594 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
3595 Set for the SPL on PPC mpc8xxx targets, support for
York Sun5614e712013-09-30 09:22:09 -07003596 drivers/ddr/fsl/libddr.o in SPL binary.
Ying Zhangbb0dc102013-08-16 15:16:11 +08003597
Ying Zhang7c8eea52013-08-16 15:16:12 +08003598 CONFIG_SPL_COMMON_INIT_DDR
3599 Set for common ddr init with serial presence detect in
3600 SPL binary.
3601
Tom Rini95579792012-02-14 07:29:40 +00003602 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
3603 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
3604 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
3605 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
3606 CONFIG_SYS_NAND_ECCBYTES
3607 Defines the size and behavior of the NAND that SPL uses
Scott Wood7d4b7952012-09-21 18:35:27 -05003608 to read U-Boot
Tom Rini95579792012-02-14 07:29:40 +00003609
Prabhakar Kushwahafbe76ae2013-12-11 12:42:11 +05303610 CONFIG_SPL_NAND_BOOT
3611 Add support NAND boot
3612
Tom Rini95579792012-02-14 07:29:40 +00003613 CONFIG_SYS_NAND_U_BOOT_OFFS
Scott Wood7d4b7952012-09-21 18:35:27 -05003614 Location in NAND to read U-Boot from
3615
3616 CONFIG_SYS_NAND_U_BOOT_DST
3617 Location in memory to load U-Boot to
3618
3619 CONFIG_SYS_NAND_U_BOOT_SIZE
3620 Size of image to load
Tom Rini95579792012-02-14 07:29:40 +00003621
3622 CONFIG_SYS_NAND_U_BOOT_START
Scott Wood7d4b7952012-09-21 18:35:27 -05003623 Entry point in loaded image to jump to
Tom Rini95579792012-02-14 07:29:40 +00003624
3625 CONFIG_SYS_NAND_HW_ECC_OOBFIRST
3626 Define this if you need to first read the OOB and then the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003627 data. This is used, for example, on davinci platforms.
Tom Rini95579792012-02-14 07:29:40 +00003628
3629 CONFIG_SPL_OMAP3_ID_NAND
3630 Support for an OMAP3-specific set of functions to return the
3631 ID and MFR of the first attached NAND chip, if present.
3632
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003633 CONFIG_SPL_SERIAL_SUPPORT
3634 Support for drivers/serial/libserial.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003635
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003636 CONFIG_SPL_SPI_FLASH_SUPPORT
3637 Support for drivers/mtd/spi/libspi_flash.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003638
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003639 CONFIG_SPL_SPI_SUPPORT
3640 Support for drivers/spi/libspi.o in SPL binary
Daniel Schwierzeck6a11cf42011-07-18 07:48:07 +00003641
Pavel Machekc57b9532012-08-30 22:42:11 +02003642 CONFIG_SPL_RAM_DEVICE
3643 Support for running image already present in ram, in SPL binary
3644
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02003645 CONFIG_SPL_LIBGENERIC_SUPPORT
3646 Support for lib/libgeneric.o in SPL binary
Marian Balakowicz1372cce2008-03-12 10:33:01 +01003647
Ying Zhangba1bee42013-05-20 14:07:25 +08003648 CONFIG_SPL_ENV_SUPPORT
3649 Support for the environment operating in SPL binary
3650
3651 CONFIG_SPL_NET_SUPPORT
3652 Support for the net/libnet.o in SPL binary.
3653 It conflicts with SPL env from storage medium specified by
3654 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
3655
Scott Wood74752ba2012-12-06 13:33:16 +00003656 CONFIG_SPL_PAD_TO
Benoît Thébaudeau6113d3f2013-04-11 09:35:49 +00003657 Image offset to which the SPL should be padded before appending
3658 the SPL payload. By default, this is defined as
3659 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3660 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3661 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Scott Wood74752ba2012-12-06 13:33:16 +00003662
Scott Woodca2fca22012-09-21 16:27:32 -05003663 CONFIG_SPL_TARGET
3664 Final target image containing SPL and payload. Some SPLs
3665 use an arch-specific makefile fragment instead, for
3666 example if more than one image needs to be produced.
3667
Simon Glass87ebee32013-05-08 08:05:59 +00003668 CONFIG_FIT_SPL_PRINT
3669 Printing information about a FIT image adds quite a bit of
3670 code to SPL. So this is normally disabled in SPL. Use this
3671 option to re-enable it. This will affect the output of the
3672 bootm command when booting a FIT image.
3673
Ying Zhang3aa29de2013-08-16 15:16:15 +08003674- TPL framework
3675 CONFIG_TPL
3676 Enable building of TPL globally.
3677
3678 CONFIG_TPL_PAD_TO
3679 Image offset to which the TPL should be padded before appending
3680 the TPL payload. By default, this is defined as
Wolfgang Denk93e14592013-10-04 17:43:24 +02003681 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
3682 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
3683 payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
Ying Zhang3aa29de2013-08-16 15:16:15 +08003684
wdenka8c7c702003-12-06 19:49:23 +00003685- Interrupt support (PPC):
3686
wdenkd4ca31c2004-01-02 14:00:00 +00003687 There are common interrupt_init() and timer_interrupt()
3688 for all PPC archs. interrupt_init() calls interrupt_init_cpu()
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003689 for CPU specific initialization. interrupt_init_cpu()
wdenkd4ca31c2004-01-02 14:00:00 +00003690 should set decrementer_count to appropriate value. If
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003691 CPU resets decrementer automatically after interrupt
wdenkd4ca31c2004-01-02 14:00:00 +00003692 (ppc4xx) it should set decrementer_count to zero.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003693 timer_interrupt() calls timer_interrupt_cpu() for CPU
wdenkd4ca31c2004-01-02 14:00:00 +00003694 specific handling. If board has watchdog / status_led
3695 / other_activity_monitor it works automatically from
3696 general timer_interrupt().
wdenka8c7c702003-12-06 19:49:23 +00003697
wdenkc6097192002-11-03 00:24:07 +00003698
Helmut Raiger9660e442011-10-20 04:19:47 +00003699Board initialization settings:
3700------------------------------
3701
3702During Initialization u-boot calls a number of board specific functions
3703to allow the preparation of board specific prerequisites, e.g. pin setup
3704before drivers are initialized. To enable these callbacks the
3705following configuration macros have to be defined. Currently this is
3706architecture specific, so please check arch/your_architecture/lib/board.c
3707typically in board_init_f() and board_init_r().
3708
3709- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
3710- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
3711- CONFIG_BOARD_LATE_INIT: Call board_late_init()
3712- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
wdenkc6097192002-11-03 00:24:07 +00003713
wdenkc6097192002-11-03 00:24:07 +00003714Configuration Settings:
3715-----------------------
3716
York Sun4d1fd7f2014-02-26 17:03:19 -08003717- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
3718 Optionally it can be defined to support 64-bit memory commands.
3719
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003720- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
wdenkc6097192002-11-03 00:24:07 +00003721 undefine this when you're short of memory.
3722
Peter Tyser2fb26042009-01-27 18:03:12 -06003723- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
3724 width of the commands listed in the 'help' command output.
3725
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003726- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to
wdenkc6097192002-11-03 00:24:07 +00003727 prompt for user input.
3728
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003729- CONFIG_SYS_CBSIZE: Buffer size for input from the Console
wdenkc6097192002-11-03 00:24:07 +00003730
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003731- CONFIG_SYS_PBSIZE: Buffer size for Console output
wdenkc6097192002-11-03 00:24:07 +00003732
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003733- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands
wdenkc6097192002-11-03 00:24:07 +00003734
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003735- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
wdenkc6097192002-11-03 00:24:07 +00003736 the application (usually a Linux kernel) when it is
3737 booted
3738
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003739- CONFIG_SYS_BAUDRATE_TABLE:
wdenkc6097192002-11-03 00:24:07 +00003740 List of legal baudrate settings for this board.
3741
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003742- CONFIG_SYS_CONSOLE_INFO_QUIET
wdenk8bde7f72003-06-27 21:31:46 +00003743 Suppress display of console information at boot.
wdenkc6097192002-11-03 00:24:07 +00003744
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003745- CONFIG_SYS_CONSOLE_IS_IN_ENV
wdenk8bde7f72003-06-27 21:31:46 +00003746 If the board specific function
3747 extern int overwrite_console (void);
3748 returns 1, the stdin, stderr and stdout are switched to the
wdenkc6097192002-11-03 00:24:07 +00003749 serial port, else the settings in the environment are used.
3750
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003751- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
wdenk8bde7f72003-06-27 21:31:46 +00003752 Enable the call to overwrite_console().
wdenkc6097192002-11-03 00:24:07 +00003753
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003754- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
wdenkc6097192002-11-03 00:24:07 +00003755 Enable overwrite of previous console environment settings.
3756
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003757- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
wdenkc6097192002-11-03 00:24:07 +00003758 Begin and End addresses of the area used by the
3759 simple memory test.
3760
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003761- CONFIG_SYS_ALT_MEMTEST:
wdenk8bde7f72003-06-27 21:31:46 +00003762 Enable an alternate, more extensive memory test.
wdenkc6097192002-11-03 00:24:07 +00003763
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003764- CONFIG_SYS_MEMTEST_SCRATCH:
wdenk5f535fe2003-09-18 09:21:33 +00003765 Scratch address used by the alternate memory test
3766 You only need to set this if address zero isn't writeable
3767
York Sune8149522015-12-04 11:57:07 -08003768- CONFIG_SYS_MEM_RESERVE_SECURE
3769 If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3770 is substracted from total RAM and won't be reported to OS.
3771 This memory can be used as secure memory. A variable
3772 gd->secure_ram is used to track the location. In systems
3773 the RAM base is not zero, or RAM is divided into banks,
3774 this variable needs to be recalcuated to get the address.
3775
York Sunaabd7dd2015-12-07 11:05:29 -08003776- CONFIG_SYS_MEM_TOP_HIDE:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003777 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
Stefan Roese14f73ca2008-03-26 10:14:11 +01003778 this specified memory area will get subtracted from the top
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003779 (end) of RAM and won't get "touched" at all by U-Boot. By
Stefan Roese14f73ca2008-03-26 10:14:11 +01003780 fixing up gd->ram_size the Linux kernel should gets passed
3781 the now "corrected" memory size and won't touch it either.
3782 This should work for arch/ppc and arch/powerpc. Only Linux
Stefan Roese5e12e752008-03-28 11:02:53 +01003783 board ports in arch/powerpc with bootwrapper support that
Stefan Roese14f73ca2008-03-26 10:14:11 +01003784 recalculate the memory size from the SDRAM controller setup
Stefan Roese5e12e752008-03-28 11:02:53 +01003785 will have to get fixed in Linux additionally.
Stefan Roese14f73ca2008-03-26 10:14:11 +01003786
3787 This option can be used as a workaround for the 440EPx/GRx
3788 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
3789 be touched.
3790
3791 WARNING: Please make sure that this value is a multiple of
3792 the Linux page size (normally 4k). If this is not the case,
3793 then the end address of the Linux memory will be located at a
3794 non page size aligned address and this could cause major
3795 problems.
3796
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003797- CONFIG_SYS_LOADS_BAUD_CHANGE:
wdenkc6097192002-11-03 00:24:07 +00003798 Enable temporary baudrate change while serial download
3799
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003800- CONFIG_SYS_SDRAM_BASE:
wdenkc6097192002-11-03 00:24:07 +00003801 Physical start address of SDRAM. _Must_ be 0 here.
3802
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003803- CONFIG_SYS_MBIO_BASE:
wdenkc6097192002-11-03 00:24:07 +00003804 Physical start address of Motherboard I/O (if using a
3805 Cogent motherboard)
3806
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003807- CONFIG_SYS_FLASH_BASE:
wdenkc6097192002-11-03 00:24:07 +00003808 Physical start address of Flash memory.
3809
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003810- CONFIG_SYS_MONITOR_BASE:
wdenkc6097192002-11-03 00:24:07 +00003811 Physical start address of boot monitor code (set by
3812 make config files to be same as the text base address
Wolfgang Denk14d0a022010-10-07 21:51:12 +02003813 (CONFIG_SYS_TEXT_BASE) used when linking) - same as
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003814 CONFIG_SYS_FLASH_BASE when booting from flash.
wdenkc6097192002-11-03 00:24:07 +00003815
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003816- CONFIG_SYS_MONITOR_LEN:
wdenk8bde7f72003-06-27 21:31:46 +00003817 Size of memory reserved for monitor code, used to
3818 determine _at_compile_time_ (!) if the environment is
3819 embedded within the U-Boot image, or in a separate
3820 flash sector.
wdenkc6097192002-11-03 00:24:07 +00003821
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003822- CONFIG_SYS_MALLOC_LEN:
wdenkc6097192002-11-03 00:24:07 +00003823 Size of DRAM reserved for malloc() use.
3824
Simon Glassd59476b2014-07-10 22:23:28 -06003825- CONFIG_SYS_MALLOC_F_LEN
3826 Size of the malloc() pool for use before relocation. If
3827 this is defined, then a very simple malloc() implementation
3828 will become available before relocation. The address is just
3829 below the global data, and the stack is moved down to make
3830 space.
3831
3832 This feature allocates regions with increasing addresses
3833 within the region. calloc() is supported, but realloc()
3834 is not available. free() is supported but does nothing.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003835 The memory will be freed (or in fact just forgotten) when
Simon Glassd59476b2014-07-10 22:23:28 -06003836 U-Boot relocates itself.
3837
Simon Glasse7b14e92014-09-15 06:33:18 -06003838 Pre-relocation malloc() is only supported on ARM and sandbox
Simon Glass29afe9e2014-07-10 22:23:31 -06003839 at present but is fairly easy to enable for other archs.
3840
Simon Glass38687ae2014-11-10 17:16:54 -07003841- CONFIG_SYS_MALLOC_SIMPLE
3842 Provides a simple and small malloc() and calloc() for those
3843 boards which do not use the full malloc in SPL (which is
3844 enabled with CONFIG_SYS_SPL_MALLOC_START).
3845
Thierry Reding1dfdd9b2014-12-09 22:25:22 -07003846- CONFIG_SYS_NONCACHED_MEMORY:
3847 Size of non-cached memory area. This area of memory will be
3848 typically located right below the malloc() area and mapped
3849 uncached in the MMU. This is useful for drivers that would
3850 otherwise require a lot of explicit cache maintenance. For
3851 some drivers it's also impossible to properly maintain the
3852 cache. For example if the regions that need to be flushed
3853 are not a multiple of the cache-line size, *and* padding
3854 cannot be allocated between the regions to align them (i.e.
3855 if the HW requires a contiguous array of regions, and the
3856 size of each region is not cache-aligned), then a flush of
3857 one region may result in overwriting data that hardware has
3858 written to another region in the same cache-line. This can
3859 happen for example in network drivers where descriptors for
3860 buffers are typically smaller than the CPU cache-line (e.g.
3861 16 bytes vs. 32 or 64 bytes).
3862
3863 Non-cached memory is only supported on 32-bit ARM at present.
3864
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003865- CONFIG_SYS_BOOTM_LEN:
Stefan Roese15940c92006-03-13 11:16:36 +01003866 Normally compressed uImages are limited to an
3867 uncompressed size of 8 MBytes. If this is not enough,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003868 you can define CONFIG_SYS_BOOTM_LEN in your board config file
Stefan Roese15940c92006-03-13 11:16:36 +01003869 to adjust this setting to your needs.
3870
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003871- CONFIG_SYS_BOOTMAPSZ:
wdenkc6097192002-11-03 00:24:07 +00003872 Maximum size of memory mapped by the startup code of
3873 the Linux kernel; all data that must be processed by
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003874 the Linux kernel (bd_info, boot arguments, FDT blob if
3875 used) must be put below this limit, unless "bootm_low"
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003876 environment variable is defined and non-zero. In such case
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02003877 all data for the Linux kernel must be between "bootm_low"
Wolfgang Denkc0f40852011-10-26 10:21:21 +00003878 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment
Grant Likelyc3624e62011-03-28 09:58:43 +00003879 variable "bootm_mapsize" will override the value of
3880 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined,
3881 then the value in "bootm_size" will be used instead.
wdenkc6097192002-11-03 00:24:07 +00003882
John Rigbyfca43cc2010-10-13 13:57:35 -06003883- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3884 Enable initrd_high functionality. If defined then the
3885 initrd_high feature is enabled and the bootm ramdisk subcommand
3886 is enabled.
3887
3888- CONFIG_SYS_BOOT_GET_CMDLINE:
3889 Enables allocating and saving kernel cmdline in space between
3890 "bootm_low" and "bootm_low" + BOOTMAPSZ.
3891
3892- CONFIG_SYS_BOOT_GET_KBD:
3893 Enables allocating and saving a kernel copy of the bd_info in
3894 space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3895
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003896- CONFIG_SYS_MAX_FLASH_BANKS:
wdenkc6097192002-11-03 00:24:07 +00003897 Max number of Flash memory banks
3898
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003899- CONFIG_SYS_MAX_FLASH_SECT:
wdenkc6097192002-11-03 00:24:07 +00003900 Max number of sectors on a Flash chip
3901
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003902- CONFIG_SYS_FLASH_ERASE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003903 Timeout for Flash erase operations (in ms)
3904
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003905- CONFIG_SYS_FLASH_WRITE_TOUT:
wdenkc6097192002-11-03 00:24:07 +00003906 Timeout for Flash write operations (in ms)
3907
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003908- CONFIG_SYS_FLASH_LOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003909 Timeout for Flash set sector lock bit operation (in ms)
3910
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003911- CONFIG_SYS_FLASH_UNLOCK_TOUT
wdenk8564acf2003-07-14 22:13:32 +00003912 Timeout for Flash clear lock bits operation (in ms)
3913
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003914- CONFIG_SYS_FLASH_PROTECTION
wdenk8564acf2003-07-14 22:13:32 +00003915 If defined, hardware flash sectors protection is used
3916 instead of U-Boot software protection.
3917
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003918- CONFIG_SYS_DIRECT_FLASH_TFTP:
wdenkc6097192002-11-03 00:24:07 +00003919
3920 Enable TFTP transfers directly to flash memory;
3921 without this option such a download has to be
3922 performed in two steps: (1) download to RAM, and (2)
3923 copy from RAM to flash.
3924
3925 The two-step approach is usually more reliable, since
3926 you can check if the download worked before you erase
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003927 the flash, but in some situations (when system RAM is
3928 too limited to allow for a temporary copy of the
wdenkc6097192002-11-03 00:24:07 +00003929 downloaded image) this option may be very useful.
3930
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003931- CONFIG_SYS_FLASH_CFI:
wdenk43d96162003-03-06 00:02:04 +00003932 Define if the flash driver uses extra elements in the
wdenk5653fc32004-02-08 22:55:38 +00003933 common flash structure for storing flash geometry.
3934
Jean-Christophe PLAGNIOL-VILLARD00b18832008-08-13 01:40:42 +02003935- CONFIG_FLASH_CFI_DRIVER
wdenk5653fc32004-02-08 22:55:38 +00003936 This option also enables the building of the cfi_flash driver
3937 in the drivers directory
wdenkc6097192002-11-03 00:24:07 +00003938
Piotr Ziecik91809ed2008-11-17 15:57:58 +01003939- CONFIG_FLASH_CFI_MTD
3940 This option enables the building of the cfi_mtd driver
3941 in the drivers directory. The driver exports CFI flash
3942 to the MTD layer.
3943
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003944- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
Guennadi Liakhovetski96ef8312008-04-03 13:36:02 +02003945 Use buffered writes to flash.
3946
3947- CONFIG_FLASH_SPANSION_S29WS_N
3948 s29ws-n MirrorBit flash has non-standard addresses for buffered
3949 write commands.
3950
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003951- CONFIG_SYS_FLASH_QUIET_TEST
Stefan Roese5568e612005-11-22 13:20:42 +01003952 If this option is defined, the common CFI flash doesn't
3953 print it's warning upon not recognized FLASH banks. This
3954 is useful, if some of the configured banks are only
3955 optionally available.
3956
Jerry Van Baren9a042e92008-03-08 13:48:01 -05003957- CONFIG_FLASH_SHOW_PROGRESS
3958 If defined (must be an integer), print out countdown
3959 digits and dots. Recommended value: 45 (9..1) for 80
3960 column displays, 15 (3..1) for 40 column displays.
3961
Stefan Roese352ef3f2013-04-04 15:53:14 +02003962- CONFIG_FLASH_VERIFY
3963 If defined, the content of the flash (destination) is compared
3964 against the source after the write operation. An error message
3965 will be printed when the contents are not identical.
3966 Please note that this option is useless in nearly all cases,
3967 since such flash programming errors usually are detected earlier
3968 while unprotecting/erasing/programming. Please only enable
3969 this option if you really know what you are doing.
3970
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02003971- CONFIG_SYS_RX_ETH_BUFFER:
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003972 Defines the number of Ethernet receive buffers. On some
3973 Ethernet controllers it is recommended to set this value
stroese53cf9432003-06-05 15:39:44 +00003974 to 8 or even higher (EEPRO100 or 405 EMAC), since all
3975 buffers can be full shortly after enabling the interface
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02003976 on high Ethernet traffic.
stroese53cf9432003-06-05 15:39:44 +00003977 Defaults to 4 if not defined.
3978
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003979- CONFIG_ENV_MAX_ENTRIES
3980
Wolfgang Denk071bc922010-10-27 22:48:30 +02003981 Maximum number of entries in the hash table that is used
3982 internally to store the environment settings. The default
3983 setting is supposed to be generous and should work in most
3984 cases. This setting can be used to tune behaviour; see
3985 lib/hashtable.c for details.
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003986
Joe Hershberger25980902012-12-11 22:16:31 -06003987- CONFIG_ENV_FLAGS_LIST_DEFAULT
3988- CONFIG_ENV_FLAGS_LIST_STATIC
Robert P. J. Day1bce2ae2013-09-16 07:15:45 -04003989 Enable validation of the values given to environment variables when
Joe Hershberger25980902012-12-11 22:16:31 -06003990 calling env set. Variables can be restricted to only decimal,
3991 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined,
3992 the variables can also be restricted to IP address or MAC address.
3993
3994 The format of the list is:
3995 type_attribute = [s|d|x|b|i|m]
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08003996 access_attribute = [a|r|o|c]
3997 attributes = type_attribute[access_attribute]
Joe Hershberger25980902012-12-11 22:16:31 -06003998 entry = variable_name[:attributes]
3999 list = entry[,list]
4000
4001 The type attributes are:
4002 s - String (default)
4003 d - Decimal
4004 x - Hexadecimal
4005 b - Boolean ([1yYtT|0nNfF])
4006 i - IP address
4007 m - MAC address
4008
Joe Hershberger267541f2012-12-11 22:16:34 -06004009 The access attributes are:
4010 a - Any (default)
4011 r - Read-only
4012 o - Write-once
4013 c - Change-default
4014
Joe Hershberger25980902012-12-11 22:16:31 -06004015 - CONFIG_ENV_FLAGS_LIST_DEFAULT
4016 Define this to a list (string) to define the ".flags"
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004017 environment variable in the default or embedded environment.
Joe Hershberger25980902012-12-11 22:16:31 -06004018
4019 - CONFIG_ENV_FLAGS_LIST_STATIC
4020 Define this to a list (string) to define validation that
4021 should be done if an entry is not found in the ".flags"
4022 environment variable. To override a setting in the static
4023 list, simply add an entry for the same variable name to the
4024 ".flags" variable.
4025
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05004026 If CONFIG_REGEX is defined, the variable_name above is evaluated as a
4027 regular expression. This allows multiple variables to define the same
4028 flags without explicitly listing them for each variable.
4029
Joe Hershberger267541f2012-12-11 22:16:34 -06004030- CONFIG_ENV_ACCESS_IGNORE_FORCE
4031 If defined, don't allow the -f switch to env set override variable
4032 access flags.
4033
Lokesh Vutla0b1b60c2013-04-17 20:49:40 +00004034- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
4035 This is set by OMAP boards for the max time that reset should
4036 be asserted. See doc/README.omap-reset-time for details on how
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004037 the value can be calculated on a given board.
Simon Glass632efa72013-03-11 07:06:48 +00004038
Gabe Black0d296cc2014-10-15 04:38:30 -06004039- CONFIG_USE_STDINT
4040 If stdint.h is available with your toolchain you can define this
4041 option to enable it. You can provide option 'USE_STDINT=1' when
4042 building U-Boot to enable this.
4043
wdenkc6097192002-11-03 00:24:07 +00004044The following definitions that deal with the placement and management
4045of environment data (variable area); in general, we support the
4046following configurations:
4047
Mike Frysingerc3eb3fe2011-07-08 10:44:25 +00004048- CONFIG_BUILD_ENVCRC:
4049
4050 Builds up envcrc with the target environment so that external utils
4051 may easily extract it and embed it in final U-Boot images.
4052
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004053- CONFIG_ENV_IS_IN_FLASH:
wdenkc6097192002-11-03 00:24:07 +00004054
4055 Define this if the environment is in flash memory.
4056
4057 a) The environment occupies one whole flash sector, which is
4058 "embedded" in the text segment with the U-Boot code. This
4059 happens usually with "bottom boot sector" or "top boot
4060 sector" type flash chips, which have several smaller
4061 sectors at the start or the end. For instance, such a
4062 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
4063 such a case you would place the environment in one of the
4064 4 kB sectors - with U-Boot code before and after it. With
4065 "top boot sector" type flash chips, you would put the
4066 environment in one of the last sectors, leaving a gap
4067 between U-Boot and the environment.
4068
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004069 - CONFIG_ENV_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004070
4071 Offset of environment data (variable area) to the
4072 beginning of flash memory; for instance, with bottom boot
4073 type flash chips the second sector can be used: the offset
4074 for this sector is given here.
4075
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004076 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
wdenkc6097192002-11-03 00:24:07 +00004077
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004078 - CONFIG_ENV_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004079
4080 This is just another way to specify the start address of
4081 the flash sector containing the environment (instead of
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004082 CONFIG_ENV_OFFSET).
wdenkc6097192002-11-03 00:24:07 +00004083
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004084 - CONFIG_ENV_SECT_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004085
4086 Size of the sector containing the environment.
4087
4088
4089 b) Sometimes flash chips have few, equal sized, BIG sectors.
4090 In such a case you don't want to spend a whole sector for
4091 the environment.
4092
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004093 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004094
Jean-Christophe PLAGNIOL-VILLARD5a1aceb2008-09-10 22:48:04 +02004095 If you use this in combination with CONFIG_ENV_IS_IN_FLASH
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004096 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
wdenkc6097192002-11-03 00:24:07 +00004097 of this flash sector for the environment. This saves
4098 memory for the RAM copy of the environment.
4099
4100 It may also save flash memory if you decide to use this
4101 when your environment is "embedded" within U-Boot code,
4102 since then the remainder of the flash sector could be used
4103 for U-Boot code. It should be pointed out that this is
4104 STRONGLY DISCOURAGED from a robustness point of view:
4105 updating the environment in flash makes it always
4106 necessary to erase the WHOLE sector. If something goes
4107 wrong before the contents has been restored from a copy in
4108 RAM, your target system will be dead.
4109
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004110 - CONFIG_ENV_ADDR_REDUND
4111 CONFIG_ENV_SIZE_REDUND
wdenkc6097192002-11-03 00:24:07 +00004112
wdenk43d96162003-03-06 00:02:04 +00004113 These settings describe a second storage area used to hold
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004114 a redundant copy of the environment data, so that there is
wdenk3e386912003-04-05 00:53:31 +00004115 a valid backup copy in case there is a power failure during
wdenk43d96162003-03-06 00:02:04 +00004116 a "saveenv" operation.
wdenkc6097192002-11-03 00:24:07 +00004117
4118BE CAREFUL! Any changes to the flash layout, and some changes to the
4119source code will make it necessary to adapt <board>/u-boot.lds*
4120accordingly!
4121
4122
Jean-Christophe PLAGNIOL-VILLARD9314cee2008-09-10 22:47:59 +02004123- CONFIG_ENV_IS_IN_NVRAM:
wdenkc6097192002-11-03 00:24:07 +00004124
4125 Define this if you have some non-volatile memory device
4126 (NVRAM, battery buffered SRAM) which you want to use for the
4127 environment.
4128
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004129 - CONFIG_ENV_ADDR:
4130 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004131
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004132 These two #defines are used to determine the memory area you
wdenkc6097192002-11-03 00:24:07 +00004133 want to use for environment. It is assumed that this memory
4134 can just be read and written to, without any special
4135 provision.
4136
4137BE CAREFUL! The first access to the environment happens quite early
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004138in U-Boot initialization (when we try to get the setting of for the
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004139console baudrate). You *MUST* have mapped your NVRAM area then, or
wdenkc6097192002-11-03 00:24:07 +00004140U-Boot will hang.
4141
4142Please note that even with NVRAM we still use a copy of the
4143environment in RAM: we could work on NVRAM directly, but we want to
4144keep settings there always unmodified except somebody uses "saveenv"
4145to save the current settings.
4146
4147
Jean-Christophe PLAGNIOL-VILLARDbb1f8b42008-09-05 09:19:30 +02004148- CONFIG_ENV_IS_IN_EEPROM:
wdenkc6097192002-11-03 00:24:07 +00004149
4150 Use this if you have an EEPROM or similar serial access
4151 device and a driver for it.
4152
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004153 - CONFIG_ENV_OFFSET:
4154 - CONFIG_ENV_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004155
4156 These two #defines specify the offset and size of the
4157 environment area within the total memory of your EEPROM.
4158
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004159 - CONFIG_SYS_I2C_EEPROM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004160 If defined, specified the chip address of the EEPROM device.
4161 The default address is zero.
4162
Christian Gmeiner189d2572015-02-11 15:19:31 +01004163 - CONFIG_SYS_I2C_EEPROM_BUS:
4164 If defined, specified the i2c bus of the EEPROM device.
4165
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004166 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
wdenkc6097192002-11-03 00:24:07 +00004167 If defined, the number of bits used to address bytes in a
4168 single page in the EEPROM device. A 64 byte page, for example
4169 would require six bits.
4170
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004171 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
wdenkc6097192002-11-03 00:24:07 +00004172 If defined, the number of milliseconds to delay between
wdenkba56f622004-02-06 23:19:44 +00004173 page writes. The default is zero milliseconds.
wdenkc6097192002-11-03 00:24:07 +00004174
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004175 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
wdenkc6097192002-11-03 00:24:07 +00004176 The length in bytes of the EEPROM memory array address. Note
4177 that this is NOT the chip address length!
4178
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004179 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
wdenk5cf91d62004-04-23 20:32:05 +00004180 EEPROM chips that implement "address overflow" are ones
4181 like Catalyst 24WC04/08/16 which has 9/10/11 bits of
4182 address and the extra bits end up in the "chip address" bit
4183 slots. This makes a 24WC08 (1Kbyte) chip look like four 256
4184 byte chips.
4185
4186 Note that we consider the length of the address field to
4187 still be one byte because the extra address bits are hidden
4188 in the chip address.
4189
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004190 - CONFIG_SYS_EEPROM_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004191 The size in bytes of the EEPROM device.
4192
Heiko Schocher548738b2010-01-07 08:55:40 +01004193 - CONFIG_ENV_EEPROM_IS_ON_I2C
4194 define this, if you have I2C and SPI activated, and your
4195 EEPROM, which holds the environment, is on the I2C bus.
4196
4197 - CONFIG_I2C_ENV_EEPROM_BUS
4198 if you have an Environment on an EEPROM reached over
4199 I2C muxes, you can define here, how to reach this
4200 EEPROM. For example:
4201
Heiko Schocherea818db2013-01-29 08:53:15 +01004202 #define CONFIG_I2C_ENV_EEPROM_BUS 1
Heiko Schocher548738b2010-01-07 08:55:40 +01004203
4204 EEPROM which holds the environment, is reached over
4205 a pca9547 i2c mux with address 0x70, channel 3.
wdenkc6097192002-11-03 00:24:07 +00004206
Jean-Christophe PLAGNIOL-VILLARD057c8492008-09-10 22:47:58 +02004207- CONFIG_ENV_IS_IN_DATAFLASH:
wdenk5779d8d2003-12-06 23:55:10 +00004208
wdenkd4ca31c2004-01-02 14:00:00 +00004209 Define this if you have a DataFlash memory device which you
wdenk5779d8d2003-12-06 23:55:10 +00004210 want to use for the environment.
4211
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004212 - CONFIG_ENV_OFFSET:
4213 - CONFIG_ENV_ADDR:
4214 - CONFIG_ENV_SIZE:
wdenk5779d8d2003-12-06 23:55:10 +00004215
4216 These three #defines specify the offset and size of the
4217 environment area within the total memory of your DataFlash placed
4218 at the specified address.
4219
Wu, Joshbd83b592014-07-01 19:30:13 +08004220- CONFIG_ENV_IS_IN_SPI_FLASH:
4221
4222 Define this if you have a SPI Flash memory device which you
4223 want to use for the environment.
4224
4225 - CONFIG_ENV_OFFSET:
4226 - CONFIG_ENV_SIZE:
4227
4228 These two #defines specify the offset and size of the
4229 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
4230 aligned to an erase sector boundary.
4231
4232 - CONFIG_ENV_SECT_SIZE:
4233
4234 Define the SPI flash's sector size.
4235
4236 - CONFIG_ENV_OFFSET_REDUND (optional):
4237
4238 This setting describes a second storage area of CONFIG_ENV_SIZE
4239 size used to hold a redundant copy of the environment data, so
4240 that there is a valid backup copy in case there is a power failure
4241 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
4242 aligned to an erase sector boundary.
4243
4244 - CONFIG_ENV_SPI_BUS (optional):
4245 - CONFIG_ENV_SPI_CS (optional):
4246
4247 Define the SPI bus and chip select. If not defined they will be 0.
4248
4249 - CONFIG_ENV_SPI_MAX_HZ (optional):
4250
4251 Define the SPI max work clock. If not defined then use 1MHz.
4252
4253 - CONFIG_ENV_SPI_MODE (optional):
4254
4255 Define the SPI work mode. If not defined then use SPI_MODE_3.
4256
Liu Gang0a85a9e2012-03-08 00:33:20 +00004257- CONFIG_ENV_IS_IN_REMOTE:
4258
4259 Define this if you have a remote memory space which you
4260 want to use for the local device's environment.
4261
4262 - CONFIG_ENV_ADDR:
4263 - CONFIG_ENV_SIZE:
4264
4265 These two #defines specify the address and size of the
4266 environment area within the remote memory space. The
4267 local device can get the environment from remote memory
Liu Gangfc54c7f2012-08-09 05:10:01 +00004268 space by SRIO or PCIE links.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004269
4270BE CAREFUL! For some special cases, the local device can not use
4271"saveenv" command. For example, the local device will get the
Liu Gangfc54c7f2012-08-09 05:10:01 +00004272environment stored in a remote NOR flash by SRIO or PCIE link,
4273but it can not erase, write this NOR flash by SRIO or PCIE interface.
Liu Gang0a85a9e2012-03-08 00:33:20 +00004274
Jean-Christophe PLAGNIOL-VILLARD51bfee12008-09-10 22:47:58 +02004275- CONFIG_ENV_IS_IN_NAND:
wdenk13a56952004-06-09 14:58:14 +00004276
4277 Define this if you have a NAND device which you want to use
4278 for the environment.
4279
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004280 - CONFIG_ENV_OFFSET:
4281 - CONFIG_ENV_SIZE:
wdenk13a56952004-06-09 14:58:14 +00004282
4283 These two #defines specify the offset and size of the environment
Scott Woodfdd813d2010-09-17 14:38:37 -05004284 area within the first NAND device. CONFIG_ENV_OFFSET must be
4285 aligned to an erase block boundary.
wdenk5779d8d2003-12-06 23:55:10 +00004286
Scott Woodfdd813d2010-09-17 14:38:37 -05004287 - CONFIG_ENV_OFFSET_REDUND (optional):
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004288
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +02004289 This setting describes a second storage area of CONFIG_ENV_SIZE
Scott Woodfdd813d2010-09-17 14:38:37 -05004290 size used to hold a redundant copy of the environment data, so
4291 that there is a valid backup copy in case there is a power failure
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004292 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be
Scott Woodfdd813d2010-09-17 14:38:37 -05004293 aligned to an erase block boundary.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004294
Scott Woodfdd813d2010-09-17 14:38:37 -05004295 - CONFIG_ENV_RANGE (optional):
4296
4297 Specifies the length of the region in which the environment
4298 can be written. This should be a multiple of the NAND device's
4299 block size. Specifying a range with more erase blocks than
4300 are needed to hold CONFIG_ENV_SIZE allows bad blocks within
4301 the range to be avoided.
4302
4303 - CONFIG_ENV_OFFSET_OOB (optional):
4304
4305 Enables support for dynamically retrieving the offset of the
4306 environment from block zero's out-of-band data. The
4307 "nand env.oob" command can be used to record this offset.
4308 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
4309 using CONFIG_ENV_OFFSET_OOB.
Markus Klotzbuechere443c942006-03-20 18:02:44 +01004310
Guennadi Liakhovetskib74ab732009-05-18 16:07:22 +02004311- CONFIG_NAND_ENV_DST
4312
4313 Defines address in RAM to which the nand_spl code should copy the
4314 environment. If redundant environment is used, it will be copied to
4315 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
4316
Joe Hershberger2b744332013-04-08 10:32:51 +00004317- CONFIG_ENV_IS_IN_UBI:
4318
4319 Define this if you have an UBI volume that you want to use for the
4320 environment. This has the benefit of wear-leveling the environment
4321 accesses, which is important on NAND.
4322
4323 - CONFIG_ENV_UBI_PART:
4324
4325 Define this to a string that is the mtd partition containing the UBI.
4326
4327 - CONFIG_ENV_UBI_VOLUME:
4328
4329 Define this to the name of the volume that you want to store the
4330 environment in.
4331
Joe Hershberger785881f2013-04-08 10:32:52 +00004332 - CONFIG_ENV_UBI_VOLUME_REDUND:
4333
4334 Define this to the name of another volume to store a second copy of
4335 the environment in. This will enable redundant environments in UBI.
4336 It is assumed that both volumes are in the same MTD partition.
4337
Joe Hershberger2b744332013-04-08 10:32:51 +00004338 - CONFIG_UBI_SILENCE_MSG
4339 - CONFIG_UBIFS_SILENCE_MSG
4340
4341 You will probably want to define these to avoid a really noisy system
4342 when storing the env in UBI.
4343
Wu, Joshd1db76f2014-06-24 17:31:03 +08004344- CONFIG_ENV_IS_IN_FAT:
4345 Define this if you want to use the FAT file system for the environment.
4346
4347 - FAT_ENV_INTERFACE:
4348
4349 Define this to a string that is the name of the block device.
4350
4351 - FAT_ENV_DEV_AND_PART:
4352
4353 Define this to a string to specify the partition of the device. It can
4354 be as following:
4355
4356 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
4357 - "D:P": device D partition P. Error occurs if device D has no
4358 partition table.
4359 - "D:0": device D.
4360 - "D" or "D:": device D partition 1 if device D has partition
4361 table, or the whole device D if has no partition
4362 table.
4363 - "D:auto": first partition in device D with bootable flag set.
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004364 If none, first valid partition in device D. If no
Wu, Joshd1db76f2014-06-24 17:31:03 +08004365 partition table then means device D.
4366
4367 - FAT_ENV_FILE:
4368
4369 It's a string of the FAT file name. This file use to store the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004370 environment.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004371
4372 - CONFIG_FAT_WRITE:
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004373 This should be defined. Otherwise it cannot save the environment file.
Wu, Joshd1db76f2014-06-24 17:31:03 +08004374
Stephen Warren06e4ae52013-06-11 15:14:00 -06004375- CONFIG_ENV_IS_IN_MMC:
4376
4377 Define this if you have an MMC device which you want to use for the
4378 environment.
4379
4380 - CONFIG_SYS_MMC_ENV_DEV:
4381
4382 Specifies which MMC device the environment is stored in.
4383
4384 - CONFIG_SYS_MMC_ENV_PART (optional):
4385
4386 Specifies which MMC partition the environment is stored in. If not
4387 set, defaults to partition 0, the user area. Common values might be
4388 1 (first MMC boot partition), 2 (second MMC boot partition).
4389
4390 - CONFIG_ENV_OFFSET:
4391 - CONFIG_ENV_SIZE:
4392
4393 These two #defines specify the offset and size of the environment
4394 area within the specified MMC device.
4395
Stephen Warren5c088ee2013-06-11 15:14:02 -06004396 If offset is positive (the usual case), it is treated as relative to
4397 the start of the MMC partition. If offset is negative, it is treated
4398 as relative to the end of the MMC partition. This can be useful if
4399 your board may be fitted with different MMC devices, which have
4400 different sizes for the MMC partitions, and you always want the
4401 environment placed at the very end of the partition, to leave the
4402 maximum possible space before it, to store other data.
4403
Stephen Warren06e4ae52013-06-11 15:14:00 -06004404 These two values are in units of bytes, but must be aligned to an
4405 MMC sector boundary.
4406
4407 - CONFIG_ENV_OFFSET_REDUND (optional):
4408
4409 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
4410 hold a redundant copy of the environment data. This provides a
4411 valid backup copy in case the other copy is corrupted, e.g. due
4412 to a power failure during a "saveenv" operation.
4413
Stephen Warren5c088ee2013-06-11 15:14:02 -06004414 This value may also be positive or negative; this is handled in the
4415 same way as CONFIG_ENV_OFFSET.
4416
Stephen Warren06e4ae52013-06-11 15:14:00 -06004417 This value is also in units of bytes, but must also be aligned to
4418 an MMC sector boundary.
4419
4420 - CONFIG_ENV_SIZE_REDUND (optional):
4421
4422 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
4423 set. If this value is set, it must be set to the same value as
4424 CONFIG_ENV_SIZE.
4425
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004426- CONFIG_SYS_SPI_INIT_OFFSET
wdenkc6097192002-11-03 00:24:07 +00004427
4428 Defines offset to the initial SPI buffer area in DPRAM. The
4429 area is used at an early stage (ROM part) if the environment
4430 is configured to reside in the SPI EEPROM: We need a 520 byte
4431 scratch DPRAM area. It is used between the two initialization
4432 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
4433 to be a good choice since it makes it far enough from the
4434 start of the data area as well as from the stack pointer.
4435
Bruce Adlere881cb52007-11-02 13:15:42 -07004436Please note that the environment is read-only until the monitor
wdenkc6097192002-11-03 00:24:07 +00004437has been relocated to RAM and a RAM copy of the environment has been
Wolfgang Denkcdb74972010-07-24 21:55:43 +02004438created; also, when using EEPROM you will have to use getenv_f()
wdenkc6097192002-11-03 00:24:07 +00004439until then to read environment variables.
4440
wdenk85ec0bc2003-03-31 16:34:49 +00004441The environment is protected by a CRC32 checksum. Before the monitor
4442is relocated into RAM, as a result of a bad CRC you will be working
4443with the compiled-in default environment - *silently*!!! [This is
4444necessary, because the first environment variable we need is the
4445"baudrate" setting for the console - if we have a bad CRC, we don't
4446have any device yet where we could complain.]
wdenkc6097192002-11-03 00:24:07 +00004447
4448Note: once the monitor has been relocated, then it will complain if
4449the default environment is used; a new CRC is computed as soon as you
wdenk85ec0bc2003-03-31 16:34:49 +00004450use the "saveenv" command to store a valid environment.
wdenkc6097192002-11-03 00:24:07 +00004451
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004452- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
wdenk42d1f032003-10-15 23:53:47 +00004453 Echo the inverted Ethernet link state to the fault LED.
wdenkfc3e2162003-10-08 22:33:00 +00004454
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004455 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
wdenkfc3e2162003-10-08 22:33:00 +00004456 also needs to be defined.
4457
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004458- CONFIG_SYS_FAULT_MII_ADDR:
wdenk42d1f032003-10-15 23:53:47 +00004459 MII address of the PHY to check for the Ethernet link state.
wdenkc6097192002-11-03 00:24:07 +00004460
Ron Madridf5675aa2009-02-18 14:30:44 -08004461- CONFIG_NS16550_MIN_FUNCTIONS:
4462 Define this if you desire to only have use of the NS16550_init
4463 and NS16550_putc functions for the serial driver located at
4464 drivers/serial/ns16550.c. This option is useful for saving
4465 space for already greatly restricted images, including but not
4466 limited to NAND_SPL configurations.
4467
Simon Glassb2b92f52012-11-30 13:01:18 +00004468- CONFIG_DISPLAY_BOARDINFO
4469 Display information about the board that U-Boot is running on
4470 when U-Boot starts up. The board function checkboard() is called
4471 to do this.
4472
Simon Glasse2e3e2b2012-11-30 13:01:19 +00004473- CONFIG_DISPLAY_BOARDINFO_LATE
4474 Similar to the previous option, but display this information
4475 later, once stdio is running and output goes to the LCD, if
4476 present.
4477
Sascha Silbefeb85802013-08-11 16:40:43 +02004478- CONFIG_BOARD_SIZE_LIMIT:
4479 Maximum size of the U-Boot image. When defined, the
4480 build system checks that the actual size does not
4481 exceed it.
4482
wdenkc6097192002-11-03 00:24:07 +00004483Low Level (hardware related) configuration options:
wdenkdc7c9a12003-03-26 06:55:25 +00004484---------------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00004485
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004486- CONFIG_SYS_CACHELINE_SIZE:
wdenkc6097192002-11-03 00:24:07 +00004487 Cache Line Size of the CPU.
4488
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004489- CONFIG_SYS_DEFAULT_IMMR:
wdenkc6097192002-11-03 00:24:07 +00004490 Default address of the IMMR after system reset.
wdenk2535d602003-07-17 23:16:40 +00004491
wdenk42d1f032003-10-15 23:53:47 +00004492 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
4493 and RPXsuper) to be able to adjust the position of
4494 the IMMR register after a reset.
wdenkc6097192002-11-03 00:24:07 +00004495
Timur Tabie46fedf2011-08-04 18:03:41 -05004496- CONFIG_SYS_CCSRBAR_DEFAULT:
4497 Default (power-on reset) physical address of CCSR on Freescale
4498 PowerPC SOCs.
4499
4500- CONFIG_SYS_CCSRBAR:
4501 Virtual address of CCSR. On a 32-bit build, this is typically
4502 the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
4503
4504 CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
4505 for cross-platform code that uses that macro instead.
4506
4507- CONFIG_SYS_CCSRBAR_PHYS:
4508 Physical address of CCSR. CCSR can be relocated to a new
4509 physical address, if desired. In this case, this macro should
Wolfgang Denkc0f40852011-10-26 10:21:21 +00004510 be set to that address. Otherwise, it should be set to the
Timur Tabie46fedf2011-08-04 18:03:41 -05004511 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR
4512 is typically relocated on 36-bit builds. It is recommended
4513 that this macro be defined via the _HIGH and _LOW macros:
4514
4515 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
4516 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
4517
4518- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
Wolfgang Denk4cf26092011-10-07 09:58:21 +02004519 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically
4520 either 0 (32-bit build) or 0xF (36-bit build). This macro is
Timur Tabie46fedf2011-08-04 18:03:41 -05004521 used in assembly code, so it must not contain typecasts or
4522 integer size suffixes (e.g. "ULL").
4523
4524- CONFIG_SYS_CCSRBAR_PHYS_LOW:
4525 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is
4526 used in assembly code, so it must not contain typecasts or
4527 integer size suffixes (e.g. "ULL").
4528
4529- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
4530 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
4531 forced to a value that ensures that CCSR is not relocated.
4532
wdenk7f6c2cb2002-11-10 22:06:23 +00004533- Floppy Disk Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004534 CONFIG_SYS_FDC_DRIVE_NUMBER
wdenk7f6c2cb2002-11-10 22:06:23 +00004535
4536 the default drive number (default value 0)
4537
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004538 CONFIG_SYS_ISA_IO_STRIDE
wdenk7f6c2cb2002-11-10 22:06:23 +00004539
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004540 defines the spacing between FDC chipset registers
wdenk7f6c2cb2002-11-10 22:06:23 +00004541 (default value 1)
4542
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004543 CONFIG_SYS_ISA_IO_OFFSET
wdenk7f6c2cb2002-11-10 22:06:23 +00004544
wdenk43d96162003-03-06 00:02:04 +00004545 defines the offset of register from address. It
4546 depends on which part of the data bus is connected to
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02004547 the FDC chipset. (default value 0)
wdenk7f6c2cb2002-11-10 22:06:23 +00004548
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004549 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
4550 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
wdenk43d96162003-03-06 00:02:04 +00004551 default value.
wdenk7f6c2cb2002-11-10 22:06:23 +00004552
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004553 if CONFIG_SYS_FDC_HW_INIT is defined, then the function
wdenk43d96162003-03-06 00:02:04 +00004554 fdc_hw_init() is called at the beginning of the FDC
4555 setup. fdc_hw_init() must be provided by the board
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004556 source code. It is used to make hardware-dependent
wdenk43d96162003-03-06 00:02:04 +00004557 initializations.
wdenk7f6c2cb2002-11-10 22:06:23 +00004558
Macpaul Lin0abddf82011-04-11 20:45:32 +00004559- CONFIG_IDE_AHB:
4560 Most IDE controllers were designed to be connected with PCI
4561 interface. Only few of them were designed for AHB interface.
4562 When software is doing ATA command and data transfer to
4563 IDE devices through IDE-AHB controller, some additional
4564 registers accessing to these kind of IDE-AHB controller
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004565 is required.
Macpaul Lin0abddf82011-04-11 20:45:32 +00004566
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004567- CONFIG_SYS_IMMR: Physical address of the Internal Memory.
wdenkefe2a4d2004-12-16 21:44:03 +00004568 DO NOT CHANGE unless you know exactly what you're
wdenk25d67122004-12-10 11:40:40 +00004569 doing! (11-4) [MPC8xx/82xx systems only]
wdenkc6097192002-11-03 00:24:07 +00004570
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004571- CONFIG_SYS_INIT_RAM_ADDR:
wdenkc6097192002-11-03 00:24:07 +00004572
wdenk7152b1d2003-09-05 23:19:14 +00004573 Start address of memory area that can be used for
wdenkc6097192002-11-03 00:24:07 +00004574 initial data and stack; please note that this must be
4575 writable memory that is working WITHOUT special
4576 initialization, i. e. you CANNOT use normal RAM which
4577 will become available only after programming the
4578 memory controller and running certain initialization
4579 sequences.
4580
4581 U-Boot uses the following memory types:
4582 - MPC8xx and MPC8260: IMMR (internal memory of the CPU)
4583 - MPC824X: data cache
4584 - PPC4xx: data cache
4585
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004586- CONFIG_SYS_GBL_DATA_OFFSET:
wdenkc6097192002-11-03 00:24:07 +00004587
4588 Offset of the initial data structure in the memory
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004589 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
4590 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
wdenkc6097192002-11-03 00:24:07 +00004591 data is located at the end of the available space
Wolfgang Denk553f0982010-10-26 13:32:32 +02004592 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004593 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
4594 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
4595 CONFIG_SYS_GBL_DATA_OFFSET) downward.
wdenkc6097192002-11-03 00:24:07 +00004596
4597 Note:
4598 On the MPC824X (or other systems that use the data
4599 cache for initial memory) the address chosen for
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004600 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
wdenkc6097192002-11-03 00:24:07 +00004601 point to an otherwise UNUSED address space between
4602 the top of RAM and the start of the PCI space.
4603
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004604- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6)
wdenkc6097192002-11-03 00:24:07 +00004605
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004606- CONFIG_SYS_SYPCR: System Protection Control (11-9)
wdenkc6097192002-11-03 00:24:07 +00004607
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004608- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26)
wdenkc6097192002-11-03 00:24:07 +00004609
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004610- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31)
wdenkc6097192002-11-03 00:24:07 +00004611
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004612- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30)
wdenkc6097192002-11-03 00:24:07 +00004613
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004614- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27)
wdenkc6097192002-11-03 00:24:07 +00004615
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004616- CONFIG_SYS_OR_TIMING_SDRAM:
wdenkc6097192002-11-03 00:24:07 +00004617 SDRAM timing
4618
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004619- CONFIG_SYS_MAMR_PTA:
wdenkc6097192002-11-03 00:24:07 +00004620 periodic timer for refresh
4621
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004622- CONFIG_SYS_DER: Debug Event Register (37-47)
wdenkc6097192002-11-03 00:24:07 +00004623
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004624- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
4625 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
4626 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
4627 CONFIG_SYS_BR1_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004628 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4629
4630- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004631 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
4632 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
wdenkc6097192002-11-03 00:24:07 +00004633 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4634
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004635- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
4636 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
wdenkc6097192002-11-03 00:24:07 +00004637 Machine Mode Register and Memory Periodic Timer
4638 Prescaler definitions (SDRAM timing)
4639
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004640- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004641 enable I2C microcode relocation patch (MPC8xx);
4642 define relocation offset in DPRAM [DSP2]
4643
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004644- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
Heiko Schocherb423d052008-01-11 01:12:07 +01004645 enable SMC microcode relocation patch (MPC8xx);
4646 define relocation offset in DPRAM [SMC1]
4647
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004648- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
wdenkc6097192002-11-03 00:24:07 +00004649 enable SPI microcode relocation patch (MPC8xx);
4650 define relocation offset in DPRAM [SCC4]
4651
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004652- CONFIG_SYS_USE_OSCCLK:
wdenkc6097192002-11-03 00:24:07 +00004653 Use OSCM clock mode on MBX8xx board. Be careful,
4654 wrong setting might damage your board. Read
4655 doc/README.MBX before setting this variable!
4656
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004657- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
wdenk43d96162003-03-06 00:02:04 +00004658 Offset of the bootmode word in DPRAM used by post
4659 (Power On Self Tests). This definition overrides
4660 #define'd default value in commproc.h resp.
4661 cpm_8260.h.
wdenkea909b72002-11-21 23:11:29 +00004662
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004663- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
4664 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
4665 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
4666 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
4667 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
4668 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
4669 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
4670 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
Stefan Roesea47a12b2010-04-15 16:07:28 +02004671 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
wdenk5d232d02003-05-22 22:52:13 +00004672
Dirk Eibach9cacf4f2009-02-09 08:18:34 +01004673- CONFIG_PCI_DISABLE_PCIE:
4674 Disable PCI-Express on systems where it is supported but not
4675 required.
4676
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004677- CONFIG_PCI_ENUM_ONLY
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08004678 Only scan through and get the devices on the buses.
Andrew Sharp69fd2d32012-08-29 14:16:32 +00004679 Don't do any setup work, presumably because someone or
4680 something has already done it, and we don't need to do it
4681 a second time. Useful for platforms that are pre-booted
4682 by coreboot or similar.
4683
Gabor Juhos842033e2013-05-30 07:06:12 +00004684- CONFIG_PCI_INDIRECT_BRIDGE:
4685 Enable support for indirect PCI bridges.
4686
Kumar Galaa09b9b62010-12-30 12:09:53 -06004687- CONFIG_SYS_SRIO:
4688 Chip has SRIO or not
4689
4690- CONFIG_SRIO1:
4691 Board has SRIO 1 port available
4692
4693- CONFIG_SRIO2:
4694 Board has SRIO 2 port available
4695
Liu Gangc8b28152013-05-07 16:30:46 +08004696- CONFIG_SRIO_PCIE_BOOT_MASTER
4697 Board can support master function for Boot from SRIO and PCIE
4698
Kumar Galaa09b9b62010-12-30 12:09:53 -06004699- CONFIG_SYS_SRIOn_MEM_VIRT:
4700 Virtual Address of SRIO port 'n' memory region
4701
4702- CONFIG_SYS_SRIOn_MEM_PHYS:
4703 Physical Address of SRIO port 'n' memory region
4704
4705- CONFIG_SYS_SRIOn_MEM_SIZE:
4706 Size of SRIO port 'n' memory region
4707
Fabio Estevam66bd1842013-04-11 09:35:34 +00004708- CONFIG_SYS_NAND_BUSWIDTH_16BIT
4709 Defined to tell the NAND controller that the NAND chip is using
4710 a 16 bit bus.
4711 Not all NAND drivers use this symbol.
Fabio Estevama430e912013-04-11 09:35:35 +00004712 Example of drivers that use it:
Fabio Estevam66bd1842013-04-11 09:35:34 +00004713 - drivers/mtd/nand/ndfc.c
Fabio Estevama430e912013-04-11 09:35:35 +00004714 - drivers/mtd/nand/mxc_nand.c
Alex Watermaneced4622011-05-19 15:08:36 -04004715
4716- CONFIG_SYS_NDFC_EBC0_CFG
4717 Sets the EBC0_CFG register for the NDFC. If not defined
4718 a default value will be used.
4719
Ben Warrenbb99ad62006-09-07 16:50:54 -04004720- CONFIG_SPD_EEPROM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004721 Get DDR timing information from an I2C EEPROM. Common
4722 with pluggable memory modules such as SODIMMs
4723
Ben Warrenbb99ad62006-09-07 16:50:54 -04004724 SPD_EEPROM_ADDRESS
4725 I2C address of the SPD EEPROM
4726
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004727- CONFIG_SYS_SPD_BUS_NUM
Wolfgang Denk218ca722008-03-26 10:40:12 +01004728 If SPD EEPROM is on an I2C bus other than the first
4729 one, specify here. Note that the value must resolve
4730 to something your driver can deal with.
Ben Warrenbb99ad62006-09-07 16:50:54 -04004731
York Sun1b3e3c42011-06-07 09:42:16 +08004732- CONFIG_SYS_DDR_RAW_TIMING
4733 Get DDR timing information from other than SPD. Common with
4734 soldered DDR chips onboard without SPD. DDR raw timing
4735 parameters are extracted from datasheet and hard-coded into
4736 header files or board specific files.
4737
York Sun6f5e1dc2011-09-16 13:21:35 -07004738- CONFIG_FSL_DDR_INTERACTIVE
4739 Enable interactive DDR debugging. See doc/README.fsl-ddr.
4740
York Sune32d59a2015-01-06 13:18:55 -08004741- CONFIG_FSL_DDR_SYNC_REFRESH
4742 Enable sync of refresh for multiple controllers.
4743
York Sun4516ff82015-03-19 09:30:28 -07004744- CONFIG_FSL_DDR_BIST
4745 Enable built-in memory test for Freescale DDR controllers.
4746
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02004747- CONFIG_SYS_83XX_DDR_USES_CS0
Wolfgang Denk218ca722008-03-26 10:40:12 +01004748 Only for 83xx systems. If specified, then DDR should
4749 be configured using CS0 and CS1 instead of CS2 and CS3.
Timur Tabi2ad6b512006-10-31 18:44:42 -06004750
wdenkc26e4542004-04-18 10:13:26 +00004751- CONFIG_ETHER_ON_FEC[12]
4752 Define to enable FEC[12] on a 8xx series processor.
4753
4754- CONFIG_FEC[12]_PHY
4755 Define to the hardcoded PHY address which corresponds
wdenk6e592382004-04-18 17:39:38 +00004756 to the given FEC; i. e.
4757 #define CONFIG_FEC1_PHY 4
wdenkc26e4542004-04-18 10:13:26 +00004758 means that the PHY with address 4 is connected to FEC1
4759
4760 When set to -1, means to probe for first available.
4761
4762- CONFIG_FEC[12]_PHY_NORXERR
4763 The PHY does not have a RXERR line (RMII only).
4764 (so program the FEC to ignore it).
4765
4766- CONFIG_RMII
4767 Enable RMII mode for all FECs.
4768 Note that this is a global option, we can't
4769 have one FEC in standard MII mode and another in RMII mode.
4770
wdenk5cf91d62004-04-23 20:32:05 +00004771- CONFIG_CRC32_VERIFY
4772 Add a verify option to the crc32 command.
4773 The syntax is:
4774
4775 => crc32 -v <address> <count> <crc32>
4776
4777 Where address/count indicate a memory area
4778 and crc32 is the correct crc32 which the
4779 area should have.
4780
wdenk56523f12004-07-11 17:40:54 +00004781- CONFIG_LOOPW
4782 Add the "loopw" memory command. This only takes effect if
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004783 the memory commands are activated globally (CONFIG_CMD_MEM).
wdenk56523f12004-07-11 17:40:54 +00004784
stroese7b466642004-12-16 18:46:55 +00004785- CONFIG_MX_CYCLIC
4786 Add the "mdc" and "mwc" memory commands. These are cyclic
4787 "md/mw" commands.
4788 Examples:
4789
wdenkefe2a4d2004-12-16 21:44:03 +00004790 => mdc.b 10 4 500
stroese7b466642004-12-16 18:46:55 +00004791 This command will print 4 bytes (10,11,12,13) each 500 ms.
4792
wdenkefe2a4d2004-12-16 21:44:03 +00004793 => mwc.l 100 12345678 10
stroese7b466642004-12-16 18:46:55 +00004794 This command will write 12345678 to address 100 all 10 ms.
4795
wdenkefe2a4d2004-12-16 21:44:03 +00004796 This only takes effect if the memory commands are activated
Jon Loeliger602ad3b2007-06-11 19:03:39 -05004797 globally (CONFIG_CMD_MEM).
stroese7b466642004-12-16 18:46:55 +00004798
wdenk8aa1a2d2005-04-04 12:44:11 +00004799- CONFIG_SKIP_LOWLEVEL_INIT
Macpaul Linafc1ce82011-10-19 20:41:11 +00004800 [ARM, NDS32, MIPS only] If this variable is defined, then certain
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004801 low level initializations (like setting up the memory
4802 controller) are omitted and/or U-Boot does not
4803 relocate itself into RAM.
wdenk8aa1a2d2005-04-04 12:44:11 +00004804
Wolfgang Denk844f07d2010-11-27 23:30:56 +01004805 Normally this variable MUST NOT be defined. The only
4806 exception is when U-Boot is loaded (to RAM) by some
4807 other boot loader or by a debugger which performs
4808 these initializations itself.
wdenk8aa1a2d2005-04-04 12:44:11 +00004809
Simon Glassb5bd0982016-05-05 07:28:06 -06004810- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4811 [ARM926EJ-S only] This allows just the call to lowlevel_init()
4812 to be skipped. The normal CPU15 init (such as enabling the
4813 instruction cache) is still performed.
4814
Aneesh V401bb302011-07-13 05:11:07 +00004815- CONFIG_SPL_BUILD
Magnus Liljadf812382009-06-13 20:50:00 +02004816 Modifies the behaviour of start.S when compiling a loader
4817 that is executed before the actual U-Boot. E.g. when
4818 compiling a NAND SPL.
wdenk400558b2005-04-02 23:52:25 +00004819
Ying Zhang3aa29de2013-08-16 15:16:15 +08004820- CONFIG_TPL_BUILD
4821 Modifies the behaviour of start.S when compiling a loader
4822 that is executed after the SPL and before the actual U-Boot.
4823 It is loaded by the SPL.
4824
Ying Zhang5df572f2013-05-20 14:07:23 +08004825- CONFIG_SYS_MPC85XX_NO_RESETVEC
4826 Only for 85xx systems. If this variable is specified, the section
4827 .resetvec is not kept and the section .bootpg is placed in the
4828 previous 4k of the .text section.
4829
Simon Glass4213fc22013-02-24 17:33:14 +00004830- CONFIG_ARCH_MAP_SYSMEM
4831 Generally U-Boot (and in particular the md command) uses
4832 effective address. It is therefore not necessary to regard
4833 U-Boot address as virtual addresses that need to be translated
4834 to physical addresses. However, sandbox requires this, since
4835 it maintains its own little RAM buffer which contains all
4836 addressable memory. This option causes some memory accesses
4837 to be mapped through map_sysmem() / unmap_sysmem().
4838
Matthias Weisserd8834a12011-03-10 21:36:32 +00004839- CONFIG_USE_ARCH_MEMCPY
4840 CONFIG_USE_ARCH_MEMSET
4841 If these options are used a optimized version of memcpy/memset will
4842 be used if available. These functions may be faster under some
4843 conditions but may increase the binary size.
4844
Simon Glass588a13f2013-02-14 04:18:54 +00004845- CONFIG_X86_RESET_VECTOR
4846 If defined, the x86 reset vector code is included. This is not
4847 needed when U-Boot is running from Coreboot.
Gabe Blackb16f5212012-11-27 21:08:06 +00004848
Mark Jacksonfc337052013-03-04 01:27:20 +00004849- CONFIG_SYS_MPUCLK
4850 Defines the MPU clock speed (in MHz).
4851
4852 NOTE : currently only supported on AM335x platforms.
Gabe Black5b5ece92012-11-29 16:23:41 +00004853
Heiko Schocher16678eb2013-11-04 14:05:00 +01004854- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
4855 Enables the RTC32K OSC on AM33xx based plattforms
4856
Karicheri, Muralidharan999d7d32014-04-04 13:16:50 -04004857- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4858 Option to disable subpage write in NAND driver
4859 driver that uses this:
4860 drivers/mtd/nand/davinci_nand.c
4861
Timur Tabif2717b42011-11-22 09:21:25 -06004862Freescale QE/FMAN Firmware Support:
4863-----------------------------------
4864
4865The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4866loading of "firmware", which is encoded in the QE firmware binary format.
4867This firmware often needs to be loaded during U-Boot booting, so macros
4868are used to identify the storage device (NOR flash, SPI, etc) and the address
4869within that device.
4870
Zhao Qiangdcf1d772014-03-21 16:21:44 +08004871- CONFIG_SYS_FMAN_FW_ADDR
4872 The address in the storage device where the FMAN microcode is located. The
4873 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4874 is also specified.
4875
4876- CONFIG_SYS_QE_FW_ADDR
4877 The address in the storage device where the QE microcode is located. The
Timur Tabif2717b42011-11-22 09:21:25 -06004878 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4879 is also specified.
4880
4881- CONFIG_SYS_QE_FMAN_FW_LENGTH
4882 The maximum possible size of the firmware. The firmware binary format
4883 has a field that specifies the actual size of the firmware, but it
4884 might not be possible to read any part of the firmware unless some
4885 local storage is allocated to hold the entire firmware first.
4886
4887- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4888 Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4889 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the
4890 virtual address in NOR flash.
4891
4892- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4893 Specifies that QE/FMAN firmware is located in NAND flash.
4894 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4895
4896- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4897 Specifies that QE/FMAN firmware is located on the primary SD/MMC
4898 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4899
4900- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
4901 Specifies that QE/FMAN firmware is located on the primary SPI
4902 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4903
Liu Gang292dc6c2012-03-08 00:33:18 +00004904- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4905 Specifies that QE/FMAN firmware is located in the remote (master)
4906 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
Liu Gangfc54c7f2012-08-09 05:10:01 +00004907 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4908 window->master inbound window->master LAW->the ucode address in
4909 master's memory space.
Timur Tabif2717b42011-11-22 09:21:25 -06004910
J. German Riverab940ca62014-06-23 15:15:55 -07004911Freescale Layerscape Management Complex Firmware Support:
4912---------------------------------------------------------
4913The Freescale Layerscape Management Complex (MC) supports the loading of
4914"firmware".
4915This firmware often needs to be loaded during U-Boot booting, so macros
4916are used to identify the storage device (NOR flash, SPI, etc) and the address
4917within that device.
4918
4919- CONFIG_FSL_MC_ENET
4920 Enable the MC driver for Layerscape SoCs.
4921
4922- CONFIG_SYS_LS_MC_FW_ADDR
4923 The address in the storage device where the firmware is located. The
4924 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
4925 is also specified.
4926
4927- CONFIG_SYS_LS_MC_FW_LENGTH
4928 The maximum possible size of the firmware. The firmware binary format
4929 has a field that specifies the actual size of the firmware, but it
4930 might not be possible to read any part of the firmware unless some
4931 local storage is allocated to hold the entire firmware first.
4932
4933- CONFIG_SYS_LS_MC_FW_IN_NOR
4934 Specifies that MC firmware is located in NOR flash, mapped as
4935 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
4936 virtual address in NOR flash.
4937
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304938Freescale Layerscape Debug Server Support:
4939-------------------------------------------
4940The Freescale Layerscape Debug Server Support supports the loading of
4941"Debug Server firmware" and triggering SP boot-rom.
4942This firmware often needs to be loaded during U-Boot booting.
4943
4944- CONFIG_FSL_DEBUG_SERVER
4945 Enable the Debug Server for Layerscape SoCs.
4946
4947- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
4948 Define minimum DDR size required for debug server image
4949
York Sunc0492142015-12-07 11:08:58 -08004950- CONFIG_SYS_MC_RSV_MEM_ALIGN
4951 Define alignment of reserved memory MC requires
Prabhakar Kushwaha5c055082015-06-02 10:55:52 +05304952
Paul Kocialkowskif3f431a2015-07-26 18:48:15 +02004953Reproducible builds
4954-------------------
4955
4956In order to achieve reproducible builds, timestamps used in the U-Boot build
4957process have to be set to a fixed value.
4958
4959This is done using the SOURCE_DATE_EPOCH environment variable.
4960SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4961option for U-Boot or an environment variable in U-Boot.
4962
4963SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4964
wdenkc6097192002-11-03 00:24:07 +00004965Building the Software:
4966======================
4967
Wolfgang Denk218ca722008-03-26 10:40:12 +01004968Building U-Boot has been tested in several native build environments
4969and in many different cross environments. Of course we cannot support
4970all possibly existing versions of cross development tools in all
4971(potentially obsolete) versions. In case of tool chain problems we
4972recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4973which is extensively used to build and test U-Boot.
wdenkc6097192002-11-03 00:24:07 +00004974
Wolfgang Denk218ca722008-03-26 10:40:12 +01004975If you are not using a native environment, it is assumed that you
4976have GNU cross compiling tools available in your path. In this case,
4977you must set the environment variable CROSS_COMPILE in your shell.
4978Note that no changes to the Makefile or any other source files are
4979necessary. For example using the ELDK on a 4xx CPU, please enter:
wdenkc6097192002-11-03 00:24:07 +00004980
Wolfgang Denk218ca722008-03-26 10:40:12 +01004981 $ CROSS_COMPILE=ppc_4xx-
4982 $ export CROSS_COMPILE
wdenkc6097192002-11-03 00:24:07 +00004983
Peter Tyser2f8d3962009-03-13 18:54:51 -05004984Note: If you wish to generate Windows versions of the utilities in
4985 the tools directory you can use the MinGW toolchain
4986 (http://www.mingw.org). Set your HOST tools to the MinGW
4987 toolchain and execute 'make tools'. For example:
4988
4989 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
4990
4991 Binaries such as tools/mkimage.exe will be created which can
4992 be executed on computers running Windows.
4993
Wolfgang Denk218ca722008-03-26 10:40:12 +01004994U-Boot is intended to be simple to build. After installing the
4995sources you must configure U-Boot for one specific board type. This
wdenkc6097192002-11-03 00:24:07 +00004996is done by typing:
4997
Holger Freytherab584d62014-08-04 09:26:05 +02004998 make NAME_defconfig
wdenkc6097192002-11-03 00:24:07 +00004999
Holger Freytherab584d62014-08-04 09:26:05 +02005000where "NAME_defconfig" is the name of one of the existing configu-
Michael Jones4d675ae2012-03-15 22:48:10 +00005001rations; see boards.cfg for supported names.
wdenk54387ac2003-10-08 22:45:44 +00005002
wdenk2729af92004-05-03 20:45:30 +00005003Note: for some board special configuration names may exist; check if
5004 additional information is available from the board vendor; for
5005 instance, the TQM823L systems are available without (standard)
5006 or with LCD support. You can select such additional "features"
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005007 when choosing the configuration, i. e.
wdenkc6097192002-11-03 00:24:07 +00005008
Holger Freytherab584d62014-08-04 09:26:05 +02005009 make TQM823L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005010 - will configure for a plain TQM823L, i. e. no LCD support
wdenkc6097192002-11-03 00:24:07 +00005011
Holger Freytherab584d62014-08-04 09:26:05 +02005012 make TQM823L_LCD_defconfig
wdenk2729af92004-05-03 20:45:30 +00005013 - will configure for a TQM823L with U-Boot console on LCD
wdenkc6097192002-11-03 00:24:07 +00005014
wdenk2729af92004-05-03 20:45:30 +00005015 etc.
wdenkc6097192002-11-03 00:24:07 +00005016
wdenkc6097192002-11-03 00:24:07 +00005017
wdenk2729af92004-05-03 20:45:30 +00005018Finally, type "make all", and you should get some working U-Boot
5019images ready for download to / installation on your system:
wdenkc6097192002-11-03 00:24:07 +00005020
wdenk2729af92004-05-03 20:45:30 +00005021- "u-boot.bin" is a raw binary image
5022- "u-boot" is an image in ELF binary format
5023- "u-boot.srec" is in Motorola S-Record format
wdenkc6097192002-11-03 00:24:07 +00005024
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005025By default the build is performed locally and the objects are saved
5026in the source directory. One of the two methods can be used to change
5027this behavior and build U-Boot to some external directory:
5028
50291. Add O= to the make command line invocations:
5030
5031 make O=/tmp/build distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005032 make O=/tmp/build NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005033 make O=/tmp/build all
5034
Timo Ketolaadbba992014-11-06 14:39:05 +020050352. Set environment variable KBUILD_OUTPUT to point to the desired location:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005036
Timo Ketolaadbba992014-11-06 14:39:05 +02005037 export KBUILD_OUTPUT=/tmp/build
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005038 make distclean
Holger Freytherab584d62014-08-04 09:26:05 +02005039 make NAME_defconfig
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005040 make all
5041
Timo Ketolaadbba992014-11-06 14:39:05 +02005042Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005043variable.
5044
wdenkc6097192002-11-03 00:24:07 +00005045
wdenk2729af92004-05-03 20:45:30 +00005046Please be aware that the Makefiles assume you are using GNU make, so
5047for instance on NetBSD you might need to use "gmake" instead of
5048native "make".
wdenkc6097192002-11-03 00:24:07 +00005049
wdenkc6097192002-11-03 00:24:07 +00005050
wdenk2729af92004-05-03 20:45:30 +00005051If the system board that you have is not listed, then you will need
5052to port U-Boot to your hardware platform. To do this, follow these
5053steps:
wdenkc6097192002-11-03 00:24:07 +00005054
Phil Sutter3c1496c2015-12-25 14:41:18 +010050551. Create a new directory to hold your board specific code. Add any
wdenk2729af92004-05-03 20:45:30 +00005056 files you need. In your board directory, you will need at least
Phil Sutter3c1496c2015-12-25 14:41:18 +01005057 the "Makefile" and a "<board>.c".
50582. Create a new configuration file "include/configs/<board>.h" for
5059 your board.
wdenk2729af92004-05-03 20:45:30 +000050603. If you're porting U-Boot to a new CPU, then also create a new
5061 directory to hold your CPU specific code. Add any files you need.
Holger Freytherab584d62014-08-04 09:26:05 +020050624. Run "make <board>_defconfig" with your new name.
wdenk2729af92004-05-03 20:45:30 +000050635. Type "make", and you should get a working "u-boot.srec" file
5064 to be installed on your target system.
50656. Debug and solve any problems that might arise.
5066 [Of course, this last step is much harder than it sounds.]
wdenkc6097192002-11-03 00:24:07 +00005067
wdenkc6097192002-11-03 00:24:07 +00005068
wdenk2729af92004-05-03 20:45:30 +00005069Testing of U-Boot Modifications, Ports to New Hardware, etc.:
5070==============================================================
wdenkc6097192002-11-03 00:24:07 +00005071
Wolfgang Denk218ca722008-03-26 10:40:12 +01005072If you have modified U-Boot sources (for instance added a new board
5073or support for new devices, a new CPU, etc.) you are expected to
wdenk2729af92004-05-03 20:45:30 +00005074provide feedback to the other developers. The feedback normally takes
5075the form of a "patch", i. e. a context diff against a certain (latest
Wolfgang Denk218ca722008-03-26 10:40:12 +01005076official or latest in the git repository) version of U-Boot sources.
wdenkc6097192002-11-03 00:24:07 +00005077
Wolfgang Denk218ca722008-03-26 10:40:12 +01005078But before you submit such a patch, please verify that your modifi-
5079cation did not break existing code. At least make sure that *ALL* of
wdenk2729af92004-05-03 20:45:30 +00005080the supported boards compile WITHOUT ANY compiler warnings. To do so,
5081just run the "MAKEALL" script, which will configure and build U-Boot
Wolfgang Denk218ca722008-03-26 10:40:12 +01005082for ALL supported system. Be warned, this will take a while. You can
5083select which (cross) compiler to use by passing a `CROSS_COMPILE'
5084environment variable to the script, i. e. to use the ELDK cross tools
5085you can type
wdenkc6097192002-11-03 00:24:07 +00005086
wdenk2729af92004-05-03 20:45:30 +00005087 CROSS_COMPILE=ppc_8xx- MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005088
wdenk2729af92004-05-03 20:45:30 +00005089or to build on a native PowerPC system you can type
wdenkc6097192002-11-03 00:24:07 +00005090
wdenk2729af92004-05-03 20:45:30 +00005091 CROSS_COMPILE=' ' MAKEALL
wdenkc6097192002-11-03 00:24:07 +00005092
Wolfgang Denk218ca722008-03-26 10:40:12 +01005093When using the MAKEALL script, the default behaviour is to build
5094U-Boot in the source directory. This location can be changed by
5095setting the BUILD_DIR environment variable. Also, for each target
5096built, the MAKEALL script saves two log files (<target>.ERR and
5097<target>.MAKEALL) in the <source dir>/LOG directory. This default
5098location can be changed by setting the MAKEALL_LOGDIR environment
5099variable. For example:
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005100
5101 export BUILD_DIR=/tmp/build
5102 export MAKEALL_LOGDIR=/tmp/log
5103 CROSS_COMPILE=ppc_8xx- MAKEALL
5104
Wolfgang Denk218ca722008-03-26 10:40:12 +01005105With the above settings build objects are saved in the /tmp/build,
5106log files are saved in the /tmp/log and the source tree remains clean
5107during the whole build process.
Marian Balakowiczbaf31242006-09-07 17:25:40 +02005108
5109
wdenk2729af92004-05-03 20:45:30 +00005110See also "U-Boot Porting Guide" below.
wdenkc6097192002-11-03 00:24:07 +00005111
wdenkc6097192002-11-03 00:24:07 +00005112
wdenk2729af92004-05-03 20:45:30 +00005113Monitor Commands - Overview:
5114============================
wdenkc6097192002-11-03 00:24:07 +00005115
wdenk2729af92004-05-03 20:45:30 +00005116go - start application at address 'addr'
5117run - run commands in an environment variable
5118bootm - boot application image from memory
5119bootp - boot image via network using BootP/TFTP protocol
Marek Vasut44f074c2012-03-14 21:52:45 +00005120bootz - boot zImage from memory
wdenk2729af92004-05-03 20:45:30 +00005121tftpboot- boot image via network using TFTP protocol
5122 and env variables "ipaddr" and "serverip"
5123 (and eventually "gatewayip")
Simon Glass1fb7cd42011-10-24 18:00:07 +00005124tftpput - upload a file via network using TFTP protocol
wdenk2729af92004-05-03 20:45:30 +00005125rarpboot- boot image via network using RARP/TFTP protocol
5126diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd'
5127loads - load S-Record file over serial line
5128loadb - load binary file over serial line (kermit mode)
5129md - memory display
5130mm - memory modify (auto-incrementing)
5131nm - memory modify (constant address)
5132mw - memory write (fill)
5133cp - memory copy
5134cmp - memory compare
5135crc32 - checksum calculation
Peter Tyser0f89c542009-04-18 22:34:03 -05005136i2c - I2C sub-system
wdenk2729af92004-05-03 20:45:30 +00005137sspi - SPI utility commands
5138base - print or set address offset
5139printenv- print environment variables
5140setenv - set environment variables
5141saveenv - save environment variables to persistent storage
5142protect - enable or disable FLASH write protection
5143erase - erase FLASH memory
5144flinfo - print FLASH memory information
Karl O. Pinc10635af2012-08-03 05:57:21 +00005145nand - NAND memory operations (see doc/README.nand)
wdenk2729af92004-05-03 20:45:30 +00005146bdinfo - print Board Info structure
5147iminfo - print header information for application image
5148coninfo - print console devices and informations
5149ide - IDE sub-system
5150loop - infinite loop on address range
wdenk56523f12004-07-11 17:40:54 +00005151loopw - infinite write loop on address range
wdenk2729af92004-05-03 20:45:30 +00005152mtest - simple RAM test
5153icache - enable or disable instruction cache
5154dcache - enable or disable data cache
5155reset - Perform RESET of the CPU
5156echo - echo args to console
5157version - print monitor version
5158help - print online help
5159? - alias for 'help'
wdenkc6097192002-11-03 00:24:07 +00005160
wdenkc6097192002-11-03 00:24:07 +00005161
wdenk2729af92004-05-03 20:45:30 +00005162Monitor Commands - Detailed Description:
5163========================================
wdenkc6097192002-11-03 00:24:07 +00005164
wdenk2729af92004-05-03 20:45:30 +00005165TODO.
wdenkc6097192002-11-03 00:24:07 +00005166
wdenk2729af92004-05-03 20:45:30 +00005167For now: just type "help <command>".
wdenkc6097192002-11-03 00:24:07 +00005168
5169
wdenk2729af92004-05-03 20:45:30 +00005170Environment Variables:
5171======================
wdenkc6097192002-11-03 00:24:07 +00005172
wdenk2729af92004-05-03 20:45:30 +00005173U-Boot supports user configuration using Environment Variables which
5174can be made persistent by saving to Flash memory.
wdenkc6097192002-11-03 00:24:07 +00005175
wdenk2729af92004-05-03 20:45:30 +00005176Environment Variables are set using "setenv", printed using
5177"printenv", and saved to Flash using "saveenv". Using "setenv"
5178without a value can be used to delete a variable from the
5179environment. As long as you don't save the environment you are
5180working with an in-memory copy. In case the Flash area containing the
5181environment is erased by accident, a default environment is provided.
wdenkc6097192002-11-03 00:24:07 +00005182
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005183Some configuration options can be set using Environment Variables.
5184
5185List of environment variables (most likely not complete):
wdenkc6097192002-11-03 00:24:07 +00005186
wdenk2729af92004-05-03 20:45:30 +00005187 baudrate - see CONFIG_BAUDRATE
wdenkc6097192002-11-03 00:24:07 +00005188
wdenk2729af92004-05-03 20:45:30 +00005189 bootdelay - see CONFIG_BOOTDELAY
wdenkc6097192002-11-03 00:24:07 +00005190
wdenk2729af92004-05-03 20:45:30 +00005191 bootcmd - see CONFIG_BOOTCOMMAND
wdenkc6097192002-11-03 00:24:07 +00005192
wdenk2729af92004-05-03 20:45:30 +00005193 bootargs - Boot arguments when booting an RTOS image
wdenkc6097192002-11-03 00:24:07 +00005194
wdenk2729af92004-05-03 20:45:30 +00005195 bootfile - Name of the image to load with TFTP
wdenkc6097192002-11-03 00:24:07 +00005196
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005197 bootm_low - Memory range available for image processing in the bootm
5198 command can be restricted. This variable is given as
5199 a hexadecimal number and defines lowest address allowed
5200 for use by the bootm command. See also "bootm_size"
5201 environment variable. Address defined by "bootm_low" is
5202 also the base of the initial memory mapping for the Linux
Grant Likelyc3624e62011-03-28 09:58:43 +00005203 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
5204 bootm_mapsize.
5205
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005206 bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
Grant Likelyc3624e62011-03-28 09:58:43 +00005207 This variable is given as a hexadecimal number and it
5208 defines the size of the memory region starting at base
5209 address bootm_low that is accessible by the Linux kernel
5210 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used
5211 as the default value if it is defined, and bootm_size is
5212 used otherwise.
Bartlomiej Sieka7d721e32008-04-14 15:44:16 +02005213
5214 bootm_size - Memory range available for image processing in the bootm
5215 command can be restricted. This variable is given as
5216 a hexadecimal number and defines the size of the region
5217 allowed for use by the bootm command. See also "bootm_low"
5218 environment variable.
5219
Bartlomiej Sieka4bae9092008-10-01 15:26:31 +02005220 updatefile - Location of the software update file on a TFTP server, used
5221 by the automatic software update feature. Please refer to
5222 documentation in doc/README.update for more details.
5223
wdenk2729af92004-05-03 20:45:30 +00005224 autoload - if set to "no" (any string beginning with 'n'),
5225 "bootp" will just load perform a lookup of the
5226 configuration from the BOOTP server, but not try to
5227 load any image using TFTP
wdenkc6097192002-11-03 00:24:07 +00005228
wdenk2729af92004-05-03 20:45:30 +00005229 autostart - if set to "yes", an image loaded using the "bootp",
5230 "rarpboot", "tftpboot" or "diskboot" commands will
5231 be automatically started (by internally calling
5232 "bootm")
wdenkc6097192002-11-03 00:24:07 +00005233
wdenk2729af92004-05-03 20:45:30 +00005234 If set to "no", a standalone image passed to the
5235 "bootm" command will be copied to the load address
5236 (and eventually uncompressed), but NOT be started.
5237 This can be used to load and uncompress arbitrary
5238 data.
wdenkc6097192002-11-03 00:24:07 +00005239
David A. Longa28afca2011-07-09 16:40:19 -04005240 fdt_high - if set this restricts the maximum address that the
5241 flattened device tree will be copied into upon boot.
Shawn Guofa34f6b2012-01-09 21:54:08 +00005242 For example, if you have a system with 1 GB memory
5243 at physical address 0x10000000, while Linux kernel
5244 only recognizes the first 704 MB as low memory, you
5245 may need to set fdt_high as 0x3C000000 to have the
5246 device tree blob be copied to the maximum address
5247 of the 704 MB low memory, so that Linux kernel can
5248 access it during the boot procedure.
5249
David A. Longa28afca2011-07-09 16:40:19 -04005250 If this is set to the special value 0xFFFFFFFF then
5251 the fdt will not be copied at all on boot. For this
5252 to work it must reside in writable memory, have
5253 sufficient padding on the end of it for u-boot to
5254 add the information it needs into it, and the memory
5255 must be accessible by the kernel.
5256
Simon Glasseea63e02011-10-24 19:15:34 +00005257 fdtcontroladdr- if set this is the address of the control flattened
5258 device tree used by U-Boot when CONFIG_OF_CONTROL is
5259 defined.
5260
wdenk17ea1172004-06-06 21:51:03 +00005261 i2cfast - (PPC405GP|PPC405EP only)
5262 if set to 'y' configures Linux I2C driver for fast
5263 mode (400kHZ). This environment variable is used in
5264 initialization code. So, for changes to be effective
5265 it must be saved and board must be reset.
5266
wdenk2729af92004-05-03 20:45:30 +00005267 initrd_high - restrict positioning of initrd images:
5268 If this variable is not set, initrd images will be
5269 copied to the highest possible address in RAM; this
5270 is usually what you want since it allows for
5271 maximum initrd size. If for some reason you want to
5272 make sure that the initrd image is loaded below the
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005273 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
wdenk2729af92004-05-03 20:45:30 +00005274 variable to a value of "no" or "off" or "0".
5275 Alternatively, you can set it to a maximum upper
5276 address to use (U-Boot will still check that it
5277 does not overwrite the U-Boot stack and data).
wdenkc6097192002-11-03 00:24:07 +00005278
wdenk2729af92004-05-03 20:45:30 +00005279 For instance, when you have a system with 16 MB
5280 RAM, and want to reserve 4 MB from use by Linux,
5281 you can do this by adding "mem=12M" to the value of
5282 the "bootargs" variable. However, now you must make
5283 sure that the initrd image is placed in the first
5284 12 MB as well - this can be done with
wdenkc6097192002-11-03 00:24:07 +00005285
wdenk2729af92004-05-03 20:45:30 +00005286 setenv initrd_high 00c00000
wdenkc6097192002-11-03 00:24:07 +00005287
wdenk2729af92004-05-03 20:45:30 +00005288 If you set initrd_high to 0xFFFFFFFF, this is an
5289 indication to U-Boot that all addresses are legal
5290 for the Linux kernel, including addresses in flash
5291 memory. In this case U-Boot will NOT COPY the
5292 ramdisk at all. This may be useful to reduce the
5293 boot time on your system, but requires that this
5294 feature is supported by your Linux kernel.
wdenk4a6fd342003-04-12 23:38:12 +00005295
wdenk2729af92004-05-03 20:45:30 +00005296 ipaddr - IP address; needed for tftpboot command
wdenkc6097192002-11-03 00:24:07 +00005297
wdenk2729af92004-05-03 20:45:30 +00005298 loadaddr - Default load address for commands like "bootp",
5299 "rarpboot", "tftpboot", "loadb" or "diskboot"
wdenkc6097192002-11-03 00:24:07 +00005300
wdenk2729af92004-05-03 20:45:30 +00005301 loads_echo - see CONFIG_LOADS_ECHO
wdenkc6097192002-11-03 00:24:07 +00005302
wdenk2729af92004-05-03 20:45:30 +00005303 serverip - TFTP server IP address; needed for tftpboot command
wdenk38b99262003-05-23 23:18:21 +00005304
wdenk2729af92004-05-03 20:45:30 +00005305 bootretry - see CONFIG_BOOT_RETRY_TIME
wdenkc6097192002-11-03 00:24:07 +00005306
wdenk2729af92004-05-03 20:45:30 +00005307 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR
wdenkc6097192002-11-03 00:24:07 +00005308
wdenk2729af92004-05-03 20:45:30 +00005309 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +00005310
Mike Frysingere2a53452011-10-02 10:01:27 +00005311 ethprime - controls which interface is used first.
wdenkc6097192002-11-03 00:24:07 +00005312
Mike Frysingere2a53452011-10-02 10:01:27 +00005313 ethact - controls which interface is currently active.
5314 For example you can do the following
wdenkc6097192002-11-03 00:24:07 +00005315
Heiko Schocher48690d82010-07-20 17:45:02 +02005316 => setenv ethact FEC
5317 => ping 192.168.0.1 # traffic sent on FEC
5318 => setenv ethact SCC
5319 => ping 10.0.0.1 # traffic sent on SCC
wdenkc6097192002-11-03 00:24:07 +00005320
Matthias Fuchse1692572008-01-17 07:45:05 +01005321 ethrotate - When set to "no" U-Boot does not go through all
5322 available network interfaces.
5323 It just stays at the currently selected interface.
5324
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005325 netretry - When set to "no" each network operation will
wdenk2729af92004-05-03 20:45:30 +00005326 either succeed or fail without retrying.
5327 When set to "once" the network operation will
5328 fail when all the available network interfaces
5329 are tried once without success.
5330 Useful on scripts which control the retry operation
5331 themselves.
wdenkc6097192002-11-03 00:24:07 +00005332
Jean-Christophe PLAGNIOL-VILLARDb4e2f892009-01-31 09:53:39 +01005333 npe_ucode - set load address for the NPE microcode
Jean-Christophe PLAGNIOL-VILLARDa1cf0272008-01-07 08:41:34 +01005334
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005335 silent_linux - If set then Linux will be told to boot silently, by
Simon Glass8d51aac2013-07-16 20:10:00 -07005336 changing the console to be empty. If "yes" it will be
5337 made silent. If "no" it will not be made silent. If
5338 unset, then it will be made silent if the U-Boot console
5339 is silent.
5340
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005341 tftpsrcp - If this is set, the value is used for TFTP's
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02005342 UDP source port.
5343
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005344 tftpdstp - If this is set, the value is used for TFTP's UDP
Wolfgang Denk28cb9372005-09-24 23:25:46 +02005345 destination port instead of the Well Know Port 69.
5346
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005347 tftpblocksize - Block size to use for TFTP transfers; if not set,
5348 we use the TFTP server's default block size
5349
5350 tftptimeout - Retransmission timeout for TFTP packets (in milli-
5351 seconds, minimum value is 1000 = 1 second). Defines
5352 when a packet is considered to be lost so it has to
5353 be retransmitted. The default is 5000 = 5 seconds.
5354 Lowering this value may make downloads succeed
5355 faster in networks with high packet loss rates or
5356 with unreliable TFTP servers.
5357
Albert ARIBAUD \(3ADEV\)f5fb7342015-10-12 00:02:57 +02005358 tftptimeoutcountmax - maximum count of TFTP timeouts (no
5359 unit, minimum value = 0). Defines how many timeouts
5360 can happen during a single file transfer before that
5361 transfer is aborted. The default is 10, and 0 means
5362 'no timeouts allowed'. Increasing this value may help
5363 downloads succeed with high packet loss rates, or with
5364 unreliable TFTP servers or client hardware.
5365
Wolfgang Denkc96f86e2010-01-17 23:55:53 +01005366 vlan - When set to a value < 4095 the traffic over
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005367 Ethernet is encapsulated/received over 802.1q
wdenk2729af92004-05-03 20:45:30 +00005368 VLAN tagged frames.
wdenka3d991b2004-04-15 21:48:45 +00005369
Alexandre Messier50768f52016-02-01 17:08:57 -05005370 bootpretryperiod - Period during which BOOTP/DHCP sends retries.
5371 Unsigned value, in milliseconds. If not set, the period will
5372 be either the default (28000), or a value based on
5373 CONFIG_NET_RETRY_COUNT, if defined. This value has
5374 precedence over the valu based on CONFIG_NET_RETRY_COUNT.
5375
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005376The following image location variables contain the location of images
5377used in booting. The "Image" column gives the role of the image and is
5378not an environment variable name. The other columns are environment
5379variable names. "File Name" gives the name of the file on a TFTP
5380server, "RAM Address" gives the location in RAM the image will be
5381loaded to, and "Flash Location" gives the image's address in NOR
5382flash or offset in NAND flash.
5383
5384*Note* - these variables don't have to be defined for all boards, some
Fabio Estevamaed9fed2015-04-25 18:53:10 -03005385boards currently use other variables for these purposes, and some
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005386boards use these variables for other purposes.
5387
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005388Image File Name RAM Address Flash Location
5389----- --------- ----------- --------------
5390u-boot u-boot u-boot_addr_r u-boot_addr
5391Linux kernel bootfile kernel_addr_r kernel_addr
5392device tree blob fdtfile fdt_addr_r fdt_addr
5393ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr
Jason Hobbsdc0b7b02011-08-31 05:37:28 +00005394
wdenk2729af92004-05-03 20:45:30 +00005395The following environment variables may be used and automatically
5396updated by the network boot commands ("bootp" and "rarpboot"),
5397depending the information provided by your boot server:
wdenka3d991b2004-04-15 21:48:45 +00005398
wdenk2729af92004-05-03 20:45:30 +00005399 bootfile - see above
5400 dnsip - IP address of your Domain Name Server
5401 dnsip2 - IP address of your secondary Domain Name Server
5402 gatewayip - IP address of the Gateway (Router) to use
5403 hostname - Target hostname
5404 ipaddr - see above
5405 netmask - Subnet Mask
5406 rootpath - Pathname of the root filesystem on the NFS server
5407 serverip - see above
wdenka3d991b2004-04-15 21:48:45 +00005408
wdenka3d991b2004-04-15 21:48:45 +00005409
wdenk2729af92004-05-03 20:45:30 +00005410There are two special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005411
wdenk2729af92004-05-03 20:45:30 +00005412 serial# - contains hardware identification information such
5413 as type string and/or serial number
5414 ethaddr - Ethernet address
wdenkc6097192002-11-03 00:24:07 +00005415
wdenk2729af92004-05-03 20:45:30 +00005416These variables can be set only once (usually during manufacturing of
5417the board). U-Boot refuses to delete or overwrite these variables
5418once they have been set once.
wdenkc6097192002-11-03 00:24:07 +00005419
5420
wdenk2729af92004-05-03 20:45:30 +00005421Further special Environment Variables:
wdenkc6097192002-11-03 00:24:07 +00005422
wdenk2729af92004-05-03 20:45:30 +00005423 ver - Contains the U-Boot version string as printed
5424 with the "version" command. This variable is
5425 readonly (see CONFIG_VERSION_VARIABLE).
wdenkc6097192002-11-03 00:24:07 +00005426
wdenkc6097192002-11-03 00:24:07 +00005427
wdenk2729af92004-05-03 20:45:30 +00005428Please note that changes to some configuration parameters may take
5429only effect after the next boot (yes, that's just like Windoze :-).
wdenkc6097192002-11-03 00:24:07 +00005430
stroesec1551ea2003-04-04 15:53:41 +00005431
Joe Hershberger170ab112012-12-11 22:16:24 -06005432Callback functions for environment variables:
5433---------------------------------------------
5434
5435For some environment variables, the behavior of u-boot needs to change
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005436when their values are changed. This functionality allows functions to
Joe Hershberger170ab112012-12-11 22:16:24 -06005437be associated with arbitrary variables. On creation, overwrite, or
5438deletion, the callback will provide the opportunity for some side
5439effect to happen or for the change to be rejected.
5440
5441The callbacks are named and associated with a function using the
5442U_BOOT_ENV_CALLBACK macro in your board or driver code.
5443
5444These callbacks are associated with variables in one of two ways. The
5445static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
5446in the board configuration to a string that defines a list of
5447associations. The list must be in the following format:
5448
5449 entry = variable_name[:callback_name]
5450 list = entry[,list]
5451
5452If the callback name is not specified, then the callback is deleted.
5453Spaces are also allowed anywhere in the list.
5454
5455Callbacks can also be associated by defining the ".callbacks" variable
5456with the same list format above. Any association in ".callbacks" will
5457override any association in the static list. You can define
5458CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08005459".callbacks" environment variable in the default or embedded environment.
Joe Hershberger170ab112012-12-11 22:16:24 -06005460
Joe Hershbergerbdf1fe42015-05-20 14:27:20 -05005461If CONFIG_REGEX is defined, the variable_name above is evaluated as a
5462regular expression. This allows multiple variables to be connected to
5463the same callback without explicitly listing them all out.
5464
Joe Hershberger170ab112012-12-11 22:16:24 -06005465
wdenk2729af92004-05-03 20:45:30 +00005466Command Line Parsing:
5467=====================
stroesec1551ea2003-04-04 15:53:41 +00005468
wdenk2729af92004-05-03 20:45:30 +00005469There are two different command line parsers available with U-Boot:
5470the old "simple" one, and the much more powerful "hush" shell:
stroesec1551ea2003-04-04 15:53:41 +00005471
wdenk2729af92004-05-03 20:45:30 +00005472Old, simple command line parser:
5473--------------------------------
wdenkc6097192002-11-03 00:24:07 +00005474
wdenk2729af92004-05-03 20:45:30 +00005475- supports environment variables (through setenv / saveenv commands)
5476- several commands on one line, separated by ';'
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005477- variable substitution using "... ${name} ..." syntax
wdenk2729af92004-05-03 20:45:30 +00005478- special characters ('$', ';') can be escaped by prefixing with '\',
5479 for example:
Wolfgang Denkfe126d82005-11-20 21:40:11 +01005480 setenv bootcmd bootm \${address}
wdenk2729af92004-05-03 20:45:30 +00005481- You can also escape text by enclosing in single apostrophes, for example:
5482 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
wdenkc6097192002-11-03 00:24:07 +00005483
wdenk2729af92004-05-03 20:45:30 +00005484Hush shell:
5485-----------
wdenkf07771c2003-05-28 08:06:31 +00005486
wdenk2729af92004-05-03 20:45:30 +00005487- similar to Bourne shell, with control structures like
5488 if...then...else...fi, for...do...done; while...do...done,
5489 until...do...done, ...
5490- supports environment ("global") variables (through setenv / saveenv
5491 commands) and local shell variables (through standard shell syntax
5492 "name=value"); only environment variables can be used with "run"
5493 command
wdenkf07771c2003-05-28 08:06:31 +00005494
wdenk2729af92004-05-03 20:45:30 +00005495General rules:
5496--------------
wdenkf07771c2003-05-28 08:06:31 +00005497
wdenk2729af92004-05-03 20:45:30 +00005498(1) If a command line (or an environment variable executed by a "run"
5499 command) contains several commands separated by semicolon, and
5500 one of these commands fails, then the remaining commands will be
5501 executed anyway.
wdenkf07771c2003-05-28 08:06:31 +00005502
wdenk2729af92004-05-03 20:45:30 +00005503(2) If you execute several variables with one call to run (i. e.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005504 calling run with a list of variables as arguments), any failing
wdenk2729af92004-05-03 20:45:30 +00005505 command will cause "run" to terminate, i. e. the remaining
5506 variables are not executed.
wdenkf07771c2003-05-28 08:06:31 +00005507
wdenk2729af92004-05-03 20:45:30 +00005508Note for Redundant Ethernet Interfaces:
5509=======================================
wdenkf07771c2003-05-28 08:06:31 +00005510
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005511Some boards come with redundant Ethernet interfaces; U-Boot supports
wdenk2729af92004-05-03 20:45:30 +00005512such configurations and is capable of automatic selection of a
5513"working" interface when needed. MAC assignment works as follows:
wdenkf07771c2003-05-28 08:06:31 +00005514
wdenk2729af92004-05-03 20:45:30 +00005515Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
5516MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
5517"eth1addr" (=>eth1), "eth2addr", ...
wdenkf07771c2003-05-28 08:06:31 +00005518
wdenk2729af92004-05-03 20:45:30 +00005519If the network interface stores some valid MAC address (for instance
5520in SROM), this is used as default address if there is NO correspon-
5521ding setting in the environment; if the corresponding environment
5522variable is set, this overrides the settings in the card; that means:
wdenkf07771c2003-05-28 08:06:31 +00005523
wdenk2729af92004-05-03 20:45:30 +00005524o If the SROM has a valid MAC address, and there is no address in the
5525 environment, the SROM's address is used.
wdenkc6097192002-11-03 00:24:07 +00005526
wdenk2729af92004-05-03 20:45:30 +00005527o If there is no valid address in the SROM, and a definition in the
5528 environment exists, then the value from the environment variable is
5529 used.
wdenkc6097192002-11-03 00:24:07 +00005530
wdenk2729af92004-05-03 20:45:30 +00005531o If both the SROM and the environment contain a MAC address, and
5532 both addresses are the same, this MAC address is used.
wdenkc6097192002-11-03 00:24:07 +00005533
wdenk2729af92004-05-03 20:45:30 +00005534o If both the SROM and the environment contain a MAC address, and the
5535 addresses differ, the value from the environment is used and a
5536 warning is printed.
wdenkc6097192002-11-03 00:24:07 +00005537
wdenk2729af92004-05-03 20:45:30 +00005538o If neither SROM nor the environment contain a MAC address, an error
Joe Hershbergerbef10142015-05-04 14:55:13 -05005539 is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
5540 a random, locally-assigned MAC is used.
wdenkc6097192002-11-03 00:24:07 +00005541
Ben Warrenecee9322010-04-26 11:11:46 -07005542If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
Wolfgang Denkc0f40852011-10-26 10:21:21 +00005543will be programmed into hardware as part of the initialization process. This
Ben Warrenecee9322010-04-26 11:11:46 -07005544may be skipped by setting the appropriate 'ethmacskip' environment variable.
5545The naming convention is as follows:
5546"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
wdenkc6097192002-11-03 00:24:07 +00005547
wdenk2729af92004-05-03 20:45:30 +00005548Image Formats:
5549==============
wdenkc6097192002-11-03 00:24:07 +00005550
Marian Balakowicz3310c542008-03-12 12:13:13 +01005551U-Boot is capable of booting (and performing other auxiliary operations on)
5552images in two formats:
5553
5554New uImage format (FIT)
5555-----------------------
5556
5557Flexible and powerful format based on Flattened Image Tree -- FIT (similar
5558to Flattened Device Tree). It allows the use of images with multiple
5559components (several kernels, ramdisks, etc.), with contents protected by
5560SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
5561
5562
5563Old uImage format
5564-----------------
5565
5566Old image format is based on binary files which can be basically anything,
5567preceded by a special header; see the definitions in include/image.h for
5568details; basically, the header defines the following image properties:
wdenkc6097192002-11-03 00:24:07 +00005569
wdenk2729af92004-05-03 20:45:30 +00005570* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
5571 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
Peter Tyserf5ed9e32008-09-08 14:56:49 -05005572 LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
5573 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
5574 INTEGRITY).
Wolfgang Denk7b64fef2006-10-24 14:21:16 +02005575* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
Macpaul Linafc1ce82011-10-19 20:41:11 +00005576 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
5577 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
wdenk2729af92004-05-03 20:45:30 +00005578* Compression Type (uncompressed, gzip, bzip2)
5579* Load Address
5580* Entry Point
5581* Image Name
5582* Image Timestamp
wdenkc6097192002-11-03 00:24:07 +00005583
wdenk2729af92004-05-03 20:45:30 +00005584The header is marked by a special Magic Number, and both the header
5585and the data portions of the image are secured against corruption by
5586CRC32 checksums.
wdenkc6097192002-11-03 00:24:07 +00005587
wdenkc6097192002-11-03 00:24:07 +00005588
wdenk2729af92004-05-03 20:45:30 +00005589Linux Support:
5590==============
wdenkc6097192002-11-03 00:24:07 +00005591
wdenk2729af92004-05-03 20:45:30 +00005592Although U-Boot should support any OS or standalone application
5593easily, the main focus has always been on Linux during the design of
5594U-Boot.
wdenkc6097192002-11-03 00:24:07 +00005595
wdenk2729af92004-05-03 20:45:30 +00005596U-Boot includes many features that so far have been part of some
5597special "boot loader" code within the Linux kernel. Also, any
5598"initrd" images to be used are no longer part of one big Linux image;
5599instead, kernel and "initrd" are separate images. This implementation
5600serves several purposes:
wdenkc6097192002-11-03 00:24:07 +00005601
wdenk2729af92004-05-03 20:45:30 +00005602- the same features can be used for other OS or standalone
5603 applications (for instance: using compressed images to reduce the
5604 Flash memory footprint)
wdenkc6097192002-11-03 00:24:07 +00005605
wdenk2729af92004-05-03 20:45:30 +00005606- it becomes much easier to port new Linux kernel versions because
5607 lots of low-level, hardware dependent stuff are done by U-Boot
wdenkc6097192002-11-03 00:24:07 +00005608
wdenk2729af92004-05-03 20:45:30 +00005609- the same Linux kernel image can now be used with different "initrd"
5610 images; of course this also means that different kernel images can
5611 be run with the same "initrd". This makes testing easier (you don't
5612 have to build a new "zImage.initrd" Linux image when you just
5613 change a file in your "initrd"). Also, a field-upgrade of the
5614 software is easier now.
wdenkc6097192002-11-03 00:24:07 +00005615
wdenkc6097192002-11-03 00:24:07 +00005616
wdenk2729af92004-05-03 20:45:30 +00005617Linux HOWTO:
5618============
wdenkc6097192002-11-03 00:24:07 +00005619
wdenk2729af92004-05-03 20:45:30 +00005620Porting Linux to U-Boot based systems:
5621---------------------------------------
wdenkc6097192002-11-03 00:24:07 +00005622
wdenk2729af92004-05-03 20:45:30 +00005623U-Boot cannot save you from doing all the necessary modifications to
5624configure the Linux device drivers for use with your target hardware
5625(no, we don't intend to provide a full virtual machine interface to
5626Linux :-).
wdenkc6097192002-11-03 00:24:07 +00005627
Stefan Roesea47a12b2010-04-15 16:07:28 +02005628But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
wdenkc6097192002-11-03 00:24:07 +00005629
wdenk2729af92004-05-03 20:45:30 +00005630Just make sure your machine specific header file (for instance
5631include/asm-ppc/tqm8xx.h) includes the same definition of the Board
Markus Heidelberg1dc30692008-09-07 20:18:27 +02005632Information structure as we define in include/asm-<arch>/u-boot.h,
5633and make sure that your definition of IMAP_ADDR uses the same value
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02005634as your U-Boot configuration in CONFIG_SYS_IMMR.
wdenkc6097192002-11-03 00:24:07 +00005635
Simon Glass2eb31b12014-06-11 23:29:46 -06005636Note that U-Boot now has a driver model, a unified model for drivers.
5637If you are adding a new driver, plumb it into driver model. If there
5638is no uclass available, you are encouraged to create one. See
5639doc/driver-model.
5640
wdenkc6097192002-11-03 00:24:07 +00005641
wdenk2729af92004-05-03 20:45:30 +00005642Configuring the Linux kernel:
5643-----------------------------
wdenkc6097192002-11-03 00:24:07 +00005644
wdenk2729af92004-05-03 20:45:30 +00005645No specific requirements for U-Boot. Make sure you have some root
5646device (initial ramdisk, NFS) for your target system.
wdenkc6097192002-11-03 00:24:07 +00005647
wdenkc6097192002-11-03 00:24:07 +00005648
wdenk2729af92004-05-03 20:45:30 +00005649Building a Linux Image:
5650-----------------------
wdenkc6097192002-11-03 00:24:07 +00005651
wdenk2729af92004-05-03 20:45:30 +00005652With U-Boot, "normal" build targets like "zImage" or "bzImage" are
5653not used. If you use recent kernel source, a new build target
5654"uImage" will exist which automatically builds an image usable by
5655U-Boot. Most older kernels also have support for a "pImage" target,
5656which was introduced for our predecessor project PPCBoot and uses a
5657100% compatible format.
wdenkc6097192002-11-03 00:24:07 +00005658
wdenk2729af92004-05-03 20:45:30 +00005659Example:
wdenkc6097192002-11-03 00:24:07 +00005660
Holger Freytherab584d62014-08-04 09:26:05 +02005661 make TQM850L_defconfig
wdenk2729af92004-05-03 20:45:30 +00005662 make oldconfig
5663 make dep
5664 make uImage
wdenkc6097192002-11-03 00:24:07 +00005665
wdenk2729af92004-05-03 20:45:30 +00005666The "uImage" build target uses a special tool (in 'tools/mkimage') to
5667encapsulate a compressed Linux kernel image with header information,
5668CRC32 checksum etc. for use with U-Boot. This is what we are doing:
wdenkc6097192002-11-03 00:24:07 +00005669
wdenk2729af92004-05-03 20:45:30 +00005670* build a standard "vmlinux" kernel image (in ELF binary format):
wdenkc6097192002-11-03 00:24:07 +00005671
wdenk2729af92004-05-03 20:45:30 +00005672* convert the kernel into a raw binary image:
wdenkc6097192002-11-03 00:24:07 +00005673
wdenk2729af92004-05-03 20:45:30 +00005674 ${CROSS_COMPILE}-objcopy -O binary \
5675 -R .note -R .comment \
5676 -S vmlinux linux.bin
wdenkc6097192002-11-03 00:24:07 +00005677
wdenk2729af92004-05-03 20:45:30 +00005678* compress the binary image:
wdenkc6097192002-11-03 00:24:07 +00005679
wdenk2729af92004-05-03 20:45:30 +00005680 gzip -9 linux.bin
wdenkc6097192002-11-03 00:24:07 +00005681
wdenk2729af92004-05-03 20:45:30 +00005682* package compressed binary image for U-Boot:
wdenk24ee89b2002-11-03 17:56:27 +00005683
wdenk2729af92004-05-03 20:45:30 +00005684 mkimage -A ppc -O linux -T kernel -C gzip \
5685 -a 0 -e 0 -n "Linux Kernel Image" \
5686 -d linux.bin.gz uImage
wdenk24ee89b2002-11-03 17:56:27 +00005687
wdenk24ee89b2002-11-03 17:56:27 +00005688
wdenk2729af92004-05-03 20:45:30 +00005689The "mkimage" tool can also be used to create ramdisk images for use
5690with U-Boot, either separated from the Linux kernel image, or
5691combined into one file. "mkimage" encapsulates the images with a 64
5692byte header containing information about target architecture,
5693operating system, image type, compression method, entry points, time
5694stamp, CRC32 checksums, etc.
wdenk24ee89b2002-11-03 17:56:27 +00005695
wdenk2729af92004-05-03 20:45:30 +00005696"mkimage" can be called in two ways: to verify existing images and
5697print the header information, or to build new images.
wdenk24ee89b2002-11-03 17:56:27 +00005698
wdenk2729af92004-05-03 20:45:30 +00005699In the first form (with "-l" option) mkimage lists the information
5700contained in the header of an existing U-Boot image; this includes
5701checksum verification:
wdenk24ee89b2002-11-03 17:56:27 +00005702
wdenk2729af92004-05-03 20:45:30 +00005703 tools/mkimage -l image
5704 -l ==> list image header information
wdenk24ee89b2002-11-03 17:56:27 +00005705
wdenk2729af92004-05-03 20:45:30 +00005706The second form (with "-d" option) is used to build a U-Boot image
5707from a "data file" which is used as image payload:
wdenk24ee89b2002-11-03 17:56:27 +00005708
wdenk2729af92004-05-03 20:45:30 +00005709 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5710 -n name -d data_file image
5711 -A ==> set architecture to 'arch'
5712 -O ==> set operating system to 'os'
5713 -T ==> set image type to 'type'
5714 -C ==> set compression type 'comp'
5715 -a ==> set load address to 'addr' (hex)
5716 -e ==> set entry point to 'ep' (hex)
5717 -n ==> set image name to 'name'
5718 -d ==> use image data from 'datafile'
wdenk24ee89b2002-11-03 17:56:27 +00005719
wdenk69459792004-05-29 16:53:29 +00005720Right now, all Linux kernels for PowerPC systems use the same load
5721address (0x00000000), but the entry point address depends on the
5722kernel version:
wdenkc6097192002-11-03 00:24:07 +00005723
wdenk2729af92004-05-03 20:45:30 +00005724- 2.2.x kernels have the entry point at 0x0000000C,
5725- 2.3.x and later kernels have the entry point at 0x00000000.
wdenkc6097192002-11-03 00:24:07 +00005726
wdenk2729af92004-05-03 20:45:30 +00005727So a typical call to build a U-Boot image would read:
wdenkc6097192002-11-03 00:24:07 +00005728
wdenk2729af92004-05-03 20:45:30 +00005729 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5730 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005731 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
wdenk2729af92004-05-03 20:45:30 +00005732 > examples/uImage.TQM850L
5733 Image Name: 2.4.4 kernel for TQM850L
5734 Created: Wed Jul 19 02:34:59 2000
5735 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5736 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5737 Load Address: 0x00000000
5738 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005739
wdenk2729af92004-05-03 20:45:30 +00005740To verify the contents of the image (or check for corruption):
wdenkc6097192002-11-03 00:24:07 +00005741
wdenk2729af92004-05-03 20:45:30 +00005742 -> tools/mkimage -l examples/uImage.TQM850L
5743 Image Name: 2.4.4 kernel for TQM850L
5744 Created: Wed Jul 19 02:34:59 2000
5745 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5746 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB
5747 Load Address: 0x00000000
5748 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005749
wdenk2729af92004-05-03 20:45:30 +00005750NOTE: for embedded systems where boot time is critical you can trade
5751speed for memory and install an UNCOMPRESSED image instead: this
5752needs more space in Flash, but boots much faster since it does not
5753need to be uncompressed:
wdenkc6097192002-11-03 00:24:07 +00005754
Stefan Roesea47a12b2010-04-15 16:07:28 +02005755 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
wdenk2729af92004-05-03 20:45:30 +00005756 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \
5757 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \
Stefan Roesea47a12b2010-04-15 16:07:28 +02005758 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
wdenk2729af92004-05-03 20:45:30 +00005759 > examples/uImage.TQM850L-uncompressed
5760 Image Name: 2.4.4 kernel for TQM850L
5761 Created: Wed Jul 19 02:34:59 2000
5762 Image Type: PowerPC Linux Kernel Image (uncompressed)
5763 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB
5764 Load Address: 0x00000000
5765 Entry Point: 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005766
wdenkc6097192002-11-03 00:24:07 +00005767
wdenk2729af92004-05-03 20:45:30 +00005768Similar you can build U-Boot images from a 'ramdisk.image.gz' file
5769when your kernel is intended to use an initial ramdisk:
wdenkdb01a2e2004-04-15 23:14:49 +00005770
wdenk2729af92004-05-03 20:45:30 +00005771 -> tools/mkimage -n 'Simple Ramdisk Image' \
5772 > -A ppc -O linux -T ramdisk -C gzip \
5773 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5774 Image Name: Simple Ramdisk Image
5775 Created: Wed Jan 12 14:01:50 2000
5776 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5777 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB
5778 Load Address: 0x00000000
5779 Entry Point: 0x00000000
wdenkdb01a2e2004-04-15 23:14:49 +00005780
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005781The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5782option performs the converse operation of the mkimage's second form (the "-d"
5783option). Given an image built by mkimage, the dumpimage extracts a "data file"
5784from the image:
5785
Guilherme Maciel Ferreiraf41f5b72015-01-15 02:54:40 -02005786 tools/dumpimage -i image -T type -p position data_file
5787 -i ==> extract from the 'image' a specific 'data_file'
5788 -T ==> set image type to 'type'
5789 -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
Guilherme Maciel Ferreiraa804b5c2013-12-01 12:43:11 -07005790
wdenkdb01a2e2004-04-15 23:14:49 +00005791
wdenk2729af92004-05-03 20:45:30 +00005792Installing a Linux Image:
5793-------------------------
wdenkdb01a2e2004-04-15 23:14:49 +00005794
wdenk2729af92004-05-03 20:45:30 +00005795To downloading a U-Boot image over the serial (console) interface,
5796you must convert the image to S-Record format:
wdenkdb01a2e2004-04-15 23:14:49 +00005797
wdenk2729af92004-05-03 20:45:30 +00005798 objcopy -I binary -O srec examples/image examples/image.srec
wdenkdb01a2e2004-04-15 23:14:49 +00005799
wdenk2729af92004-05-03 20:45:30 +00005800The 'objcopy' does not understand the information in the U-Boot
5801image header, so the resulting S-Record file will be relative to
5802address 0x00000000. To load it to a given address, you need to
5803specify the target address as 'offset' parameter with the 'loads'
5804command.
wdenkc6097192002-11-03 00:24:07 +00005805
wdenk2729af92004-05-03 20:45:30 +00005806Example: install the image to address 0x40100000 (which on the
5807TQM8xxL is in the first Flash bank):
wdenkc6097192002-11-03 00:24:07 +00005808
wdenk2729af92004-05-03 20:45:30 +00005809 => erase 40100000 401FFFFF
wdenkc6097192002-11-03 00:24:07 +00005810
wdenk2729af92004-05-03 20:45:30 +00005811 .......... done
5812 Erased 8 sectors
wdenkc6097192002-11-03 00:24:07 +00005813
wdenk2729af92004-05-03 20:45:30 +00005814 => loads 40100000
5815 ## Ready for S-Record download ...
5816 ~>examples/image.srec
5817 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5818 ...
5819 15989 15990 15991 15992
5820 [file transfer complete]
5821 [connected]
5822 ## Start Addr = 0x00000000
wdenkc6097192002-11-03 00:24:07 +00005823
5824
wdenk2729af92004-05-03 20:45:30 +00005825You can check the success of the download using the 'iminfo' command;
Wolfgang Denk218ca722008-03-26 10:40:12 +01005826this includes a checksum verification so you can be sure no data
wdenk2729af92004-05-03 20:45:30 +00005827corruption happened:
wdenkc6097192002-11-03 00:24:07 +00005828
wdenk2729af92004-05-03 20:45:30 +00005829 => imi 40100000
wdenkc6097192002-11-03 00:24:07 +00005830
wdenk2729af92004-05-03 20:45:30 +00005831 ## Checking Image at 40100000 ...
5832 Image Name: 2.2.13 for initrd on TQM850L
5833 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5834 Data Size: 335725 Bytes = 327 kB = 0 MB
5835 Load Address: 00000000
5836 Entry Point: 0000000c
5837 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005838
5839
wdenk2729af92004-05-03 20:45:30 +00005840Boot Linux:
5841-----------
wdenkc6097192002-11-03 00:24:07 +00005842
wdenk2729af92004-05-03 20:45:30 +00005843The "bootm" command is used to boot an application that is stored in
5844memory (RAM or Flash). In case of a Linux kernel image, the contents
5845of the "bootargs" environment variable is passed to the kernel as
5846parameters. You can check and modify this variable using the
5847"printenv" and "setenv" commands:
wdenkc6097192002-11-03 00:24:07 +00005848
5849
wdenk2729af92004-05-03 20:45:30 +00005850 => printenv bootargs
5851 bootargs=root=/dev/ram
wdenkc6097192002-11-03 00:24:07 +00005852
wdenk2729af92004-05-03 20:45:30 +00005853 => 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 +00005854
wdenk2729af92004-05-03 20:45:30 +00005855 => printenv bootargs
5856 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 +00005857
wdenk2729af92004-05-03 20:45:30 +00005858 => bootm 40020000
5859 ## Booting Linux kernel at 40020000 ...
5860 Image Name: 2.2.13 for NFS on TQM850L
5861 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5862 Data Size: 381681 Bytes = 372 kB = 0 MB
5863 Load Address: 00000000
5864 Entry Point: 0000000c
5865 Verifying Checksum ... OK
5866 Uncompressing Kernel Image ... OK
5867 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
5868 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5869 time_init: decrementer frequency = 187500000/60
5870 Calibrating delay loop... 49.77 BogoMIPS
5871 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5872 ...
wdenkc6097192002-11-03 00:24:07 +00005873
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02005874If you want to boot a Linux kernel with initial RAM disk, you pass
wdenk2729af92004-05-03 20:45:30 +00005875the memory addresses of both the kernel and the initrd image (PPBCOOT
5876format!) to the "bootm" command:
wdenkc6097192002-11-03 00:24:07 +00005877
wdenk2729af92004-05-03 20:45:30 +00005878 => imi 40100000 40200000
wdenkc6097192002-11-03 00:24:07 +00005879
wdenk2729af92004-05-03 20:45:30 +00005880 ## Checking Image at 40100000 ...
5881 Image Name: 2.2.13 for initrd on TQM850L
5882 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5883 Data Size: 335725 Bytes = 327 kB = 0 MB
5884 Load Address: 00000000
5885 Entry Point: 0000000c
5886 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005887
wdenk2729af92004-05-03 20:45:30 +00005888 ## Checking Image at 40200000 ...
5889 Image Name: Simple Ramdisk Image
5890 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5891 Data Size: 566530 Bytes = 553 kB = 0 MB
5892 Load Address: 00000000
5893 Entry Point: 00000000
5894 Verifying Checksum ... OK
wdenkc6097192002-11-03 00:24:07 +00005895
wdenk2729af92004-05-03 20:45:30 +00005896 => bootm 40100000 40200000
5897 ## Booting Linux kernel at 40100000 ...
5898 Image Name: 2.2.13 for initrd on TQM850L
5899 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5900 Data Size: 335725 Bytes = 327 kB = 0 MB
5901 Load Address: 00000000
5902 Entry Point: 0000000c
5903 Verifying Checksum ... OK
5904 Uncompressing Kernel Image ... OK
5905 ## Loading RAMDisk Image at 40200000 ...
5906 Image Name: Simple Ramdisk Image
5907 Image Type: PowerPC Linux RAMDisk Image (gzip compressed)
5908 Data Size: 566530 Bytes = 553 kB = 0 MB
5909 Load Address: 00000000
5910 Entry Point: 00000000
5911 Verifying Checksum ... OK
5912 Loading Ramdisk ... OK
5913 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
5914 Boot arguments: root=/dev/ram
5915 time_init: decrementer frequency = 187500000/60
5916 Calibrating delay loop... 49.77 BogoMIPS
5917 ...
5918 RAMDISK: Compressed image found at block 0
5919 VFS: Mounted root (ext2 filesystem).
wdenkc6097192002-11-03 00:24:07 +00005920
wdenk2729af92004-05-03 20:45:30 +00005921 bash#
wdenkc6097192002-11-03 00:24:07 +00005922
Matthew McClintock02677682006-06-28 10:41:37 -05005923Boot Linux and pass a flat device tree:
5924-----------
5925
5926First, U-Boot must be compiled with the appropriate defines. See the section
5927titled "Linux Kernel Interface" above for a more in depth explanation. The
5928following is an example of how to start a kernel and pass an updated
5929flat device tree:
5930
5931=> print oftaddr
5932oftaddr=0x300000
5933=> print oft
5934oft=oftrees/mpc8540ads.dtb
5935=> tftp $oftaddr $oft
5936Speed: 1000, full duplex
5937Using TSEC0 device
5938TFTP from server 192.168.1.1; our IP address is 192.168.1.101
5939Filename 'oftrees/mpc8540ads.dtb'.
5940Load address: 0x300000
5941Loading: #
5942done
5943Bytes transferred = 4106 (100a hex)
5944=> tftp $loadaddr $bootfile
5945Speed: 1000, full duplex
5946Using TSEC0 device
5947TFTP from server 192.168.1.1; our IP address is 192.168.1.2
5948Filename 'uImage'.
5949Load address: 0x200000
5950Loading:############
5951done
5952Bytes transferred = 1029407 (fb51f hex)
5953=> print loadaddr
5954loadaddr=200000
5955=> print oftaddr
5956oftaddr=0x300000
5957=> bootm $loadaddr - $oftaddr
5958## Booting image at 00200000 ...
Wolfgang Denka9398e02006-11-27 15:32:42 +01005959 Image Name: Linux-2.6.17-dirty
5960 Image Type: PowerPC Linux Kernel Image (gzip compressed)
5961 Data Size: 1029343 Bytes = 1005.2 kB
Matthew McClintock02677682006-06-28 10:41:37 -05005962 Load Address: 00000000
Wolfgang Denka9398e02006-11-27 15:32:42 +01005963 Entry Point: 00000000
Matthew McClintock02677682006-06-28 10:41:37 -05005964 Verifying Checksum ... OK
5965 Uncompressing Kernel Image ... OK
5966Booting using flat device tree at 0x300000
5967Using MPC85xx ADS machine description
5968Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
5969[snip]
5970
5971
wdenk2729af92004-05-03 20:45:30 +00005972More About U-Boot Image Types:
5973------------------------------
wdenk6069ff22003-02-28 00:49:47 +00005974
wdenk2729af92004-05-03 20:45:30 +00005975U-Boot supports the following image types:
wdenk6069ff22003-02-28 00:49:47 +00005976
wdenk2729af92004-05-03 20:45:30 +00005977 "Standalone Programs" are directly runnable in the environment
5978 provided by U-Boot; it is expected that (if they behave
5979 well) you can continue to work in U-Boot after return from
5980 the Standalone Program.
5981 "OS Kernel Images" are usually images of some Embedded OS which
5982 will take over control completely. Usually these programs
5983 will install their own set of exception handlers, device
5984 drivers, set up the MMU, etc. - this means, that you cannot
5985 expect to re-enter U-Boot except by resetting the CPU.
5986 "RAMDisk Images" are more or less just data blocks, and their
5987 parameters (address, size) are passed to an OS kernel that is
5988 being started.
5989 "Multi-File Images" contain several images, typically an OS
5990 (Linux) kernel image and one or more data images like
5991 RAMDisks. This construct is useful for instance when you want
5992 to boot over the network using BOOTP etc., where the boot
5993 server provides just a single image file, but you want to get
5994 for instance an OS kernel and a RAMDisk image.
stroesec1551ea2003-04-04 15:53:41 +00005995
wdenk2729af92004-05-03 20:45:30 +00005996 "Multi-File Images" start with a list of image sizes, each
5997 image size (in bytes) specified by an "uint32_t" in network
5998 byte order. This list is terminated by an "(uint32_t)0".
5999 Immediately after the terminating 0 follow the images, one by
6000 one, all aligned on "uint32_t" boundaries (size rounded up to
6001 a multiple of 4 bytes).
stroesec1551ea2003-04-04 15:53:41 +00006002
wdenk2729af92004-05-03 20:45:30 +00006003 "Firmware Images" are binary images containing firmware (like
6004 U-Boot or FPGA images) which usually will be programmed to
6005 flash memory.
stroesec1551ea2003-04-04 15:53:41 +00006006
wdenk2729af92004-05-03 20:45:30 +00006007 "Script files" are command sequences that will be executed by
6008 U-Boot's command interpreter; this feature is especially
6009 useful when you configure U-Boot to use a real shell (hush)
6010 as command interpreter.
wdenk6069ff22003-02-28 00:49:47 +00006011
Marek Vasut44f074c2012-03-14 21:52:45 +00006012Booting the Linux zImage:
6013-------------------------
6014
6015On some platforms, it's possible to boot Linux zImage. This is done
6016using the "bootz" command. The syntax of "bootz" command is the same
6017as the syntax of "bootm" command.
6018
Tom Rini8ac28562013-05-16 11:40:11 -04006019Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
Marek Vasut017e1f32012-03-18 11:47:58 +00006020kernel with raw initrd images. The syntax is slightly different, the
6021address of the initrd must be augmented by it's size, in the following
6022format: "<initrd addres>:<initrd size>".
6023
wdenkc6097192002-11-03 00:24:07 +00006024
wdenk2729af92004-05-03 20:45:30 +00006025Standalone HOWTO:
6026=================
wdenkc6097192002-11-03 00:24:07 +00006027
wdenk2729af92004-05-03 20:45:30 +00006028One of the features of U-Boot is that you can dynamically load and
6029run "standalone" applications, which can use some resources of
6030U-Boot like console I/O functions or interrupt services.
wdenkc6097192002-11-03 00:24:07 +00006031
wdenk2729af92004-05-03 20:45:30 +00006032Two simple examples are included with the sources:
wdenkc6097192002-11-03 00:24:07 +00006033
wdenk2729af92004-05-03 20:45:30 +00006034"Hello World" Demo:
6035-------------------
wdenkc6097192002-11-03 00:24:07 +00006036
wdenk2729af92004-05-03 20:45:30 +00006037'examples/hello_world.c' contains a small "Hello World" Demo
6038application; it is automatically compiled when you build U-Boot.
6039It's configured to run at address 0x00040004, so you can play with it
6040like that:
wdenkc6097192002-11-03 00:24:07 +00006041
wdenk2729af92004-05-03 20:45:30 +00006042 => loads
6043 ## Ready for S-Record download ...
6044 ~>examples/hello_world.srec
6045 1 2 3 4 5 6 7 8 9 10 11 ...
6046 [file transfer complete]
6047 [connected]
6048 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006049
wdenk2729af92004-05-03 20:45:30 +00006050 => go 40004 Hello World! This is a test.
6051 ## Starting application at 0x00040004 ...
6052 Hello World
6053 argc = 7
6054 argv[0] = "40004"
6055 argv[1] = "Hello"
6056 argv[2] = "World!"
6057 argv[3] = "This"
6058 argv[4] = "is"
6059 argv[5] = "a"
6060 argv[6] = "test."
6061 argv[7] = "<NULL>"
6062 Hit any key to exit ...
wdenkc6097192002-11-03 00:24:07 +00006063
wdenk2729af92004-05-03 20:45:30 +00006064 ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006065
wdenk2729af92004-05-03 20:45:30 +00006066Another example, which demonstrates how to register a CPM interrupt
6067handler with the U-Boot code, can be found in 'examples/timer.c'.
6068Here, a CPM timer is set up to generate an interrupt every second.
6069The interrupt service routine is trivial, just printing a '.'
6070character, but this is just a demo program. The application can be
6071controlled by the following keys:
wdenkc6097192002-11-03 00:24:07 +00006072
wdenk2729af92004-05-03 20:45:30 +00006073 ? - print current values og the CPM Timer registers
6074 b - enable interrupts and start timer
6075 e - stop timer and disable interrupts
6076 q - quit application
wdenkc6097192002-11-03 00:24:07 +00006077
wdenk2729af92004-05-03 20:45:30 +00006078 => loads
6079 ## Ready for S-Record download ...
6080 ~>examples/timer.srec
6081 1 2 3 4 5 6 7 8 9 10 11 ...
6082 [file transfer complete]
6083 [connected]
6084 ## Start Addr = 0x00040004
wdenkc6097192002-11-03 00:24:07 +00006085
wdenk2729af92004-05-03 20:45:30 +00006086 => go 40004
6087 ## Starting application at 0x00040004 ...
6088 TIMERS=0xfff00980
6089 Using timer 1
6090 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
wdenkc6097192002-11-03 00:24:07 +00006091
wdenk2729af92004-05-03 20:45:30 +00006092Hit 'b':
6093 [q, b, e, ?] Set interval 1000000 us
6094 Enabling timer
6095Hit '?':
6096 [q, b, e, ?] ........
6097 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
6098Hit '?':
6099 [q, b, e, ?] .
6100 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
6101Hit '?':
6102 [q, b, e, ?] .
6103 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
6104Hit '?':
6105 [q, b, e, ?] .
6106 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
6107Hit 'e':
6108 [q, b, e, ?] ...Stopping timer
6109Hit 'q':
6110 [q, b, e, ?] ## Application terminated, rc = 0x0
wdenkc6097192002-11-03 00:24:07 +00006111
6112
wdenk2729af92004-05-03 20:45:30 +00006113Minicom warning:
6114================
wdenk85ec0bc2003-03-31 16:34:49 +00006115
wdenk2729af92004-05-03 20:45:30 +00006116Over time, many people have reported problems when trying to use the
6117"minicom" terminal emulation program for serial download. I (wd)
6118consider minicom to be broken, and recommend not to use it. Under
6119Unix, I recommend to use C-Kermit for general purpose use (and
6120especially for kermit binary protocol download ("loadb" command), and
Karl O. Pince53515a2012-10-01 05:11:56 +00006121use "cu" for S-Record download ("loads" command). See
6122http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
6123for help with kermit.
6124
wdenk85ec0bc2003-03-31 16:34:49 +00006125
wdenk2729af92004-05-03 20:45:30 +00006126Nevertheless, if you absolutely want to use it try adding this
6127configuration to your "File transfer protocols" section:
wdenk52f52c12003-06-19 23:04:19 +00006128
wdenk2729af92004-05-03 20:45:30 +00006129 Name Program Name U/D FullScr IO-Red. Multi
6130 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N
6131 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N
wdenk52f52c12003-06-19 23:04:19 +00006132
6133
wdenk2729af92004-05-03 20:45:30 +00006134NetBSD Notes:
6135=============
wdenkc6097192002-11-03 00:24:07 +00006136
wdenk2729af92004-05-03 20:45:30 +00006137Starting at version 0.9.2, U-Boot supports NetBSD both as host
6138(build U-Boot) and target system (boots NetBSD/mpc8xx).
wdenkc6097192002-11-03 00:24:07 +00006139
wdenk2729af92004-05-03 20:45:30 +00006140Building requires a cross environment; it is known to work on
6141NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
6142need gmake since the Makefiles are not compatible with BSD make).
6143Note that the cross-powerpc package does not install include files;
6144attempting to build U-Boot will fail because <machine/ansi.h> is
6145missing. This file has to be installed and patched manually:
wdenkc6097192002-11-03 00:24:07 +00006146
wdenk2729af92004-05-03 20:45:30 +00006147 # cd /usr/pkg/cross/powerpc-netbsd/include
6148 # mkdir powerpc
6149 # ln -s powerpc machine
6150 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
6151 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST
wdenkc6097192002-11-03 00:24:07 +00006152
wdenk2729af92004-05-03 20:45:30 +00006153Native builds *don't* work due to incompatibilities between native
6154and U-Boot include files.
wdenkc6097192002-11-03 00:24:07 +00006155
wdenk2729af92004-05-03 20:45:30 +00006156Booting assumes that (the first part of) the image booted is a
6157stage-2 loader which in turn loads and then invokes the kernel
6158proper. Loader sources will eventually appear in the NetBSD source
6159tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
wdenk2a8af182005-04-13 10:02:42 +00006160meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
wdenkc6097192002-11-03 00:24:07 +00006161
6162
wdenk2729af92004-05-03 20:45:30 +00006163Implementation Internals:
6164=========================
wdenkc6097192002-11-03 00:24:07 +00006165
wdenk2729af92004-05-03 20:45:30 +00006166The following is not intended to be a complete description of every
6167implementation detail. However, it should help to understand the
6168inner workings of U-Boot and make it easier to port it to custom
6169hardware.
wdenkc6097192002-11-03 00:24:07 +00006170
6171
wdenk2729af92004-05-03 20:45:30 +00006172Initial Stack, Global Data:
6173---------------------------
wdenkc6097192002-11-03 00:24:07 +00006174
wdenk2729af92004-05-03 20:45:30 +00006175The implementation of U-Boot is complicated by the fact that U-Boot
6176starts running out of ROM (flash memory), usually without access to
6177system RAM (because the memory controller is not initialized yet).
6178This means that we don't have writable Data or BSS segments, and BSS
6179is not initialized as zero. To be able to get a C environment working
6180at all, we have to allocate at least a minimal stack. Implementation
6181options for this are defined and restricted by the CPU used: Some CPU
6182models provide on-chip memory (like the IMMR area on MPC8xx and
6183MPC826x processors), on others (parts of) the data cache can be
6184locked as (mis-) used as memory, etc.
wdenkc6097192002-11-03 00:24:07 +00006185
Wolfgang Denk218ca722008-03-26 10:40:12 +01006186 Chris Hallinan posted a good summary of these issues to the
Wolfgang Denk06682362008-12-30 22:56:11 +01006187 U-Boot mailing list:
wdenk43d96162003-03-06 00:02:04 +00006188
wdenk2729af92004-05-03 20:45:30 +00006189 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
6190 From: "Chris Hallinan" <clh@net1plus.com>
6191 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
6192 ...
wdenk43d96162003-03-06 00:02:04 +00006193
wdenk2729af92004-05-03 20:45:30 +00006194 Correct me if I'm wrong, folks, but the way I understand it
6195 is this: Using DCACHE as initial RAM for Stack, etc, does not
6196 require any physical RAM backing up the cache. The cleverness
6197 is that the cache is being used as a temporary supply of
6198 necessary storage before the SDRAM controller is setup. It's
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006199 beyond the scope of this list to explain the details, but you
wdenk2729af92004-05-03 20:45:30 +00006200 can see how this works by studying the cache architecture and
6201 operation in the architecture and processor-specific manuals.
wdenk43d96162003-03-06 00:02:04 +00006202
wdenk2729af92004-05-03 20:45:30 +00006203 OCM is On Chip Memory, which I believe the 405GP has 4K. It
6204 is another option for the system designer to use as an
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006205 initial stack/RAM area prior to SDRAM being available. Either
wdenk2729af92004-05-03 20:45:30 +00006206 option should work for you. Using CS 4 should be fine if your
6207 board designers haven't used it for something that would
6208 cause you grief during the initial boot! It is frequently not
6209 used.
wdenk43d96162003-03-06 00:02:04 +00006210
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006211 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
wdenk2729af92004-05-03 20:45:30 +00006212 with your processor/board/system design. The default value
6213 you will find in any recent u-boot distribution in
Stefan Roese8a316c92005-08-01 16:49:12 +02006214 walnut.h should work for you. I'd set it to a value larger
wdenk2729af92004-05-03 20:45:30 +00006215 than your SDRAM module. If you have a 64MB SDRAM module, set
6216 it above 400_0000. Just make sure your board has no resources
6217 that are supposed to respond to that address! That code in
6218 start.S has been around a while and should work as is when
6219 you get the config right.
wdenk43d96162003-03-06 00:02:04 +00006220
wdenk2729af92004-05-03 20:45:30 +00006221 -Chris Hallinan
6222 DS4.COM, Inc.
wdenk43d96162003-03-06 00:02:04 +00006223
wdenk2729af92004-05-03 20:45:30 +00006224It is essential to remember this, since it has some impact on the C
6225code for the initialization procedures:
wdenkc6097192002-11-03 00:24:07 +00006226
wdenk2729af92004-05-03 20:45:30 +00006227* Initialized global data (data segment) is read-only. Do not attempt
6228 to write it.
wdenkc6097192002-11-03 00:24:07 +00006229
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006230* Do not use any uninitialized global data (or implicitly initialized
wdenk2729af92004-05-03 20:45:30 +00006231 as zero data - BSS segment) at all - this is undefined, initiali-
6232 zation is performed later (when relocating to RAM).
wdenkc6097192002-11-03 00:24:07 +00006233
wdenk2729af92004-05-03 20:45:30 +00006234* Stack space is very limited. Avoid big data buffers or things like
6235 that.
wdenkc6097192002-11-03 00:24:07 +00006236
wdenk2729af92004-05-03 20:45:30 +00006237Having only the stack as writable memory limits means we cannot use
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006238normal global data to share information between the code. But it
wdenk2729af92004-05-03 20:45:30 +00006239turned out that the implementation of U-Boot can be greatly
6240simplified by making a global data structure (gd_t) available to all
6241functions. We could pass a pointer to this data as argument to _all_
6242functions, but this would bloat the code. Instead we use a feature of
6243the GCC compiler (Global Register Variables) to share the data: we
6244place a pointer (gd) to the global data into a register which we
6245reserve for this purpose.
wdenkc6097192002-11-03 00:24:07 +00006246
wdenk2729af92004-05-03 20:45:30 +00006247When choosing a register for such a purpose we are restricted by the
6248relevant (E)ABI specifications for the current architecture, and by
6249GCC's implementation.
wdenkc6097192002-11-03 00:24:07 +00006250
wdenk2729af92004-05-03 20:45:30 +00006251For PowerPC, the following registers have specific use:
6252 R1: stack pointer
Wolfgang Denke7670f62008-02-14 22:43:22 +01006253 R2: reserved for system use
wdenk2729af92004-05-03 20:45:30 +00006254 R3-R4: parameter passing and return values
6255 R5-R10: parameter passing
6256 R13: small data area pointer
6257 R30: GOT pointer
6258 R31: frame pointer
wdenkc6097192002-11-03 00:24:07 +00006259
Joakim Tjernlunde6bee802010-01-19 14:41:58 +01006260 (U-Boot also uses R12 as internal GOT pointer. r12
6261 is a volatile register so r12 needs to be reset when
6262 going back and forth between asm and C)
wdenkc6097192002-11-03 00:24:07 +00006263
Wolfgang Denke7670f62008-02-14 22:43:22 +01006264 ==> U-Boot will use R2 to hold a pointer to the global data
wdenkc6097192002-11-03 00:24:07 +00006265
wdenk2729af92004-05-03 20:45:30 +00006266 Note: on PPC, we could use a static initializer (since the
6267 address of the global data structure is known at compile time),
6268 but it turned out that reserving a register results in somewhat
6269 smaller code - although the code savings are not that big (on
6270 average for all boards 752 bytes for the whole U-Boot image,
6271 624 text + 127 data).
wdenkc6097192002-11-03 00:24:07 +00006272
Robin Getzc4db3352009-08-17 15:23:02 +00006273On Blackfin, the normal C ABI (except for P3) is followed as documented here:
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006274 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
6275
Robin Getzc4db3352009-08-17 15:23:02 +00006276 ==> U-Boot will use P3 to hold a pointer to the global data
Mike Frysinger4c58eb52008-02-04 19:26:54 -05006277
wdenk2729af92004-05-03 20:45:30 +00006278On ARM, the following registers are used:
wdenkc6097192002-11-03 00:24:07 +00006279
wdenk2729af92004-05-03 20:45:30 +00006280 R0: function argument word/integer result
6281 R1-R3: function argument word
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006282 R9: platform specific
6283 R10: stack limit (used only if stack checking is enabled)
wdenk2729af92004-05-03 20:45:30 +00006284 R11: argument (frame) pointer
6285 R12: temporary workspace
6286 R13: stack pointer
6287 R14: link register
6288 R15: program counter
wdenkc6097192002-11-03 00:24:07 +00006289
Jeroen Hofstee12eba1b2013-09-21 14:04:42 +02006290 ==> U-Boot will use R9 to hold a pointer to the global data
6291
6292 Note: on ARM, only R_ARM_RELATIVE relocations are supported.
wdenkc6097192002-11-03 00:24:07 +00006293
Thomas Chou0df01fd2010-05-21 11:08:03 +08006294On Nios II, the ABI is documented here:
6295 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
6296
6297 ==> U-Boot will use gp to hold a pointer to the global data
6298
6299 Note: on Nios II, we give "-G0" option to gcc and don't use gp
6300 to access small data sections, so gp is free.
6301
Macpaul Linafc1ce82011-10-19 20:41:11 +00006302On NDS32, the following registers are used:
6303
6304 R0-R1: argument/return
6305 R2-R5: argument
6306 R15: temporary register for assembler
6307 R16: trampoline register
6308 R28: frame pointer (FP)
6309 R29: global pointer (GP)
6310 R30: link register (LP)
6311 R31: stack pointer (SP)
6312 PC: program counter (PC)
6313
6314 ==> U-Boot will use R10 to hold a pointer to the global data
6315
Wolfgang Denkd87080b2006-03-31 18:32:53 +02006316NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
6317or current versions of GCC may "optimize" the code too much.
wdenkc6097192002-11-03 00:24:07 +00006318
wdenk2729af92004-05-03 20:45:30 +00006319Memory Management:
6320------------------
wdenkc6097192002-11-03 00:24:07 +00006321
wdenk2729af92004-05-03 20:45:30 +00006322U-Boot runs in system state and uses physical addresses, i.e. the
6323MMU is not used either for address mapping nor for memory protection.
wdenkc6097192002-11-03 00:24:07 +00006324
wdenk2729af92004-05-03 20:45:30 +00006325The available memory is mapped to fixed addresses using the memory
6326controller. In this process, a contiguous block is formed for each
6327memory type (Flash, SDRAM, SRAM), even when it consists of several
6328physical memory banks.
wdenkc6097192002-11-03 00:24:07 +00006329
wdenk2729af92004-05-03 20:45:30 +00006330U-Boot is installed in the first 128 kB of the first Flash bank (on
6331TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
6332booting and sizing and initializing DRAM, the code relocates itself
6333to the upper end of DRAM. Immediately below the U-Boot code some
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02006334memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
wdenk2729af92004-05-03 20:45:30 +00006335configuration setting]. Below that, a structure with global Board
6336Info data is placed, followed by the stack (growing downward).
wdenkc6097192002-11-03 00:24:07 +00006337
wdenk2729af92004-05-03 20:45:30 +00006338Additionally, some exception handler code is copied to the low 8 kB
6339of DRAM (0x00000000 ... 0x00001FFF).
wdenkc6097192002-11-03 00:24:07 +00006340
wdenk2729af92004-05-03 20:45:30 +00006341So a typical memory configuration with 16 MB of DRAM could look like
6342this:
wdenkc6097192002-11-03 00:24:07 +00006343
wdenk2729af92004-05-03 20:45:30 +00006344 0x0000 0000 Exception Vector code
6345 :
6346 0x0000 1FFF
6347 0x0000 2000 Free for Application Use
6348 :
6349 :
wdenkc6097192002-11-03 00:24:07 +00006350
wdenk2729af92004-05-03 20:45:30 +00006351 :
6352 :
6353 0x00FB FF20 Monitor Stack (Growing downward)
6354 0x00FB FFAC Board Info Data and permanent copy of global data
6355 0x00FC 0000 Malloc Arena
6356 :
6357 0x00FD FFFF
6358 0x00FE 0000 RAM Copy of Monitor Code
6359 ... eventually: LCD or video framebuffer
6360 ... eventually: pRAM (Protected RAM - unchanged by reset)
6361 0x00FF FFFF [End of RAM]
wdenkc6097192002-11-03 00:24:07 +00006362
6363
wdenk2729af92004-05-03 20:45:30 +00006364System Initialization:
6365----------------------
wdenkc6097192002-11-03 00:24:07 +00006366
wdenk2729af92004-05-03 20:45:30 +00006367In the reset configuration, U-Boot starts at the reset entry point
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02006368(on most PowerPC systems at address 0x00000100). Because of the reset
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006369configuration for CS0# this is a mirror of the on board Flash memory.
wdenk2729af92004-05-03 20:45:30 +00006370To be able to re-map memory U-Boot then jumps to its link address.
6371To be able to implement the initialization code in C, a (small!)
6372initial stack is set up in the internal Dual Ported RAM (in case CPUs
6373which provide such a feature like MPC8xx or MPC8260), or in a locked
6374part of the data cache. After that, U-Boot initializes the CPU core,
6375the caches and the SIU.
wdenkc6097192002-11-03 00:24:07 +00006376
wdenk2729af92004-05-03 20:45:30 +00006377Next, all (potentially) available memory banks are mapped using a
6378preliminary mapping. For example, we put them on 512 MB boundaries
6379(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
6380on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
6381programmed for SDRAM access. Using the temporary configuration, a
6382simple memory test is run that determines the size of the SDRAM
6383banks.
wdenkc6097192002-11-03 00:24:07 +00006384
wdenk2729af92004-05-03 20:45:30 +00006385When there is more than one SDRAM bank, and the banks are of
6386different size, the largest is mapped first. For equal size, the first
6387bank (CS2#) is mapped first. The first mapping is always for address
63880x00000000, with any additional banks following immediately to create
6389contiguous memory starting from 0.
wdenkc6097192002-11-03 00:24:07 +00006390
wdenk2729af92004-05-03 20:45:30 +00006391Then, the monitor installs itself at the upper end of the SDRAM area
6392and allocates memory for use by malloc() and for the global Board
6393Info data; also, the exception vector code is copied to the low RAM
6394pages, and the final stack is set up.
wdenkc6097192002-11-03 00:24:07 +00006395
wdenk2729af92004-05-03 20:45:30 +00006396Only after this relocation will you have a "normal" C environment;
6397until that you are restricted in several ways, mostly because you are
6398running from ROM, and because the code will have to be relocated to a
6399new address in RAM.
wdenkc6097192002-11-03 00:24:07 +00006400
6401
wdenk2729af92004-05-03 20:45:30 +00006402U-Boot Porting Guide:
6403----------------------
wdenkc6097192002-11-03 00:24:07 +00006404
wdenk2729af92004-05-03 20:45:30 +00006405[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
6406list, October 2002]
wdenkc6097192002-11-03 00:24:07 +00006407
6408
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006409int main(int argc, char *argv[])
wdenk2729af92004-05-03 20:45:30 +00006410{
6411 sighandler_t no_more_time;
wdenkc6097192002-11-03 00:24:07 +00006412
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006413 signal(SIGALRM, no_more_time);
6414 alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
wdenkc6097192002-11-03 00:24:07 +00006415
wdenk2729af92004-05-03 20:45:30 +00006416 if (available_money > available_manpower) {
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006417 Pay consultant to port U-Boot;
wdenkc6097192002-11-03 00:24:07 +00006418 return 0;
6419 }
6420
wdenk2729af92004-05-03 20:45:30 +00006421 Download latest U-Boot source;
6422
Wolfgang Denk06682362008-12-30 22:56:11 +01006423 Subscribe to u-boot mailing list;
wdenk2729af92004-05-03 20:45:30 +00006424
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006425 if (clueless)
6426 email("Hi, I am new to U-Boot, how do I get started?");
wdenkc6097192002-11-03 00:24:07 +00006427
wdenk2729af92004-05-03 20:45:30 +00006428 while (learning) {
6429 Read the README file in the top level directory;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006430 Read http://www.denx.de/twiki/bin/view/DULG/Manual;
6431 Read applicable doc/*.README;
wdenk2729af92004-05-03 20:45:30 +00006432 Read the source, Luke;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006433 /* find . -name "*.[chS]" | xargs grep -i <keyword> */
wdenk2729af92004-05-03 20:45:30 +00006434 }
wdenkc6097192002-11-03 00:24:07 +00006435
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006436 if (available_money > toLocalCurrency ($2500))
6437 Buy a BDI3000;
6438 else
wdenk2729af92004-05-03 20:45:30 +00006439 Add a lot of aggravation and time;
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006440
6441 if (a similar board exists) { /* hopefully... */
6442 cp -a board/<similar> board/<myboard>
6443 cp include/configs/<similar>.h include/configs/<myboard>.h
6444 } else {
6445 Create your own board support subdirectory;
6446 Create your own board include/configs/<myboard>.h file;
wdenk2729af92004-05-03 20:45:30 +00006447 }
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006448 Edit new board/<myboard> files
6449 Edit new include/configs/<myboard>.h
wdenkc6097192002-11-03 00:24:07 +00006450
Jerry Van Baren6c3fef22009-07-15 20:42:59 -04006451 while (!accepted) {
6452 while (!running) {
6453 do {
6454 Add / modify source code;
6455 } until (compiles);
6456 Debug;
6457 if (clueless)
6458 email("Hi, I am having problems...");
6459 }
6460 Send patch file to the U-Boot email list;
6461 if (reasonable critiques)
6462 Incorporate improvements from email list code review;
6463 else
6464 Defend code as written;
wdenk2729af92004-05-03 20:45:30 +00006465 }
wdenkc6097192002-11-03 00:24:07 +00006466
wdenk2729af92004-05-03 20:45:30 +00006467 return 0;
6468}
6469
6470void no_more_time (int sig)
6471{
6472 hire_a_guru();
6473}
wdenkc6097192002-11-03 00:24:07 +00006474
6475
wdenk2729af92004-05-03 20:45:30 +00006476Coding Standards:
6477-----------------
wdenkc6097192002-11-03 00:24:07 +00006478
wdenk2729af92004-05-03 20:45:30 +00006479All contributions to U-Boot should conform to the Linux kernel
Detlev Zundel2c051652006-09-01 15:39:02 +02006480coding style; see the file "Documentation/CodingStyle" and the script
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006481"scripts/Lindent" in your Linux kernel source directory.
wdenk2729af92004-05-03 20:45:30 +00006482
Detlev Zundel2c051652006-09-01 15:39:02 +02006483Source files originating from a different project (for example the
6484MTD subsystem) are generally exempt from these guidelines and are not
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08006485reformatted to ease subsequent migration to newer versions of those
Detlev Zundel2c051652006-09-01 15:39:02 +02006486sources.
6487
6488Please note that U-Boot is implemented in C (and to some small parts in
6489Assembler); no C++ is used, so please do not use C++ style comments (//)
6490in your code.
wdenk2729af92004-05-03 20:45:30 +00006491
6492Please also stick to the following formatting rules:
6493- remove any trailing white space
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006494- use TAB characters for indentation and vertical alignment, not spaces
wdenk2729af92004-05-03 20:45:30 +00006495- make sure NOT to use DOS '\r\n' line feeds
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006496- do not add more than 2 consecutive empty lines to source files
wdenk2729af92004-05-03 20:45:30 +00006497- do not add trailing empty lines to source files
6498
6499Submissions which do not conform to the standards may be returned
6500with a request to reformat the changes.
wdenkc6097192002-11-03 00:24:07 +00006501
6502
wdenk2729af92004-05-03 20:45:30 +00006503Submitting Patches:
6504-------------------
wdenkc6097192002-11-03 00:24:07 +00006505
wdenk2729af92004-05-03 20:45:30 +00006506Since the number of patches for U-Boot is growing, we need to
6507establish some rules. Submissions which do not conform to these rules
6508may be rejected, even when they contain important and valuable stuff.
wdenkc6097192002-11-03 00:24:07 +00006509
Magnus Lilja0d28f342008-08-06 19:32:33 +02006510Please see http://www.denx.de/wiki/U-Boot/Patches for details.
Wolfgang Denk218ca722008-03-26 10:40:12 +01006511
Wolfgang Denk06682362008-12-30 22:56:11 +01006512Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
6513see http://lists.denx.de/mailman/listinfo/u-boot
6514
wdenk2729af92004-05-03 20:45:30 +00006515When you send a patch, please include the following information with
6516it:
wdenkc6097192002-11-03 00:24:07 +00006517
wdenk2729af92004-05-03 20:45:30 +00006518* For bug fixes: a description of the bug and how your patch fixes
6519 this bug. Please try to include a way of demonstrating that the
6520 patch actually fixes something.
wdenkc6097192002-11-03 00:24:07 +00006521
wdenk2729af92004-05-03 20:45:30 +00006522* For new features: a description of the feature and your
6523 implementation.
wdenkc6097192002-11-03 00:24:07 +00006524
wdenk2729af92004-05-03 20:45:30 +00006525* A CHANGELOG entry as plaintext (separate from the patch)
6526
Robert P. J. Day7207b362015-12-19 07:16:10 -05006527* For major contributions, add a MAINTAINERS file with your
6528 information and associated file and directory references.
wdenk2729af92004-05-03 20:45:30 +00006529
Albert ARIBAUD27af9302013-09-11 15:52:51 +02006530* When you add support for a new board, don't forget to add a
6531 maintainer e-mail address to the boards.cfg file, too.
wdenk2729af92004-05-03 20:45:30 +00006532
6533* If your patch adds new configuration options, don't forget to
6534 document these in the README file.
6535
Wolfgang Denk218ca722008-03-26 10:40:12 +01006536* The patch itself. If you are using git (which is *strongly*
6537 recommended) you can easily generate the patch using the
Wolfgang Denk7ca92962011-07-27 10:59:55 +00006538 "git format-patch". If you then use "git send-email" to send it to
Wolfgang Denk218ca722008-03-26 10:40:12 +01006539 the U-Boot mailing list, you will avoid most of the common problems
6540 with some other mail clients.
wdenk2729af92004-05-03 20:45:30 +00006541
Wolfgang Denk218ca722008-03-26 10:40:12 +01006542 If you cannot use git, use "diff -purN OLD NEW". If your version of
6543 diff does not support these options, then get the latest version of
6544 GNU diff.
wdenk2729af92004-05-03 20:45:30 +00006545
Wolfgang Denk218ca722008-03-26 10:40:12 +01006546 The current directory when running this command shall be the parent
6547 directory of the U-Boot source tree (i. e. please make sure that
6548 your patch includes sufficient directory information for the
6549 affected files).
6550
6551 We prefer patches as plain text. MIME attachments are discouraged,
6552 and compressed attachments must not be used.
wdenk2729af92004-05-03 20:45:30 +00006553
6554* If one logical set of modifications affects or creates several
6555 files, all these changes shall be submitted in a SINGLE patch file.
6556
6557* Changesets that contain different, unrelated modifications shall be
6558 submitted as SEPARATE patches, one patch per changeset.
6559
6560
6561Notes:
6562
6563* Before sending the patch, run the MAKEALL script on your patched
6564 source tree and make sure that no errors or warnings are reported
6565 for any of the boards.
6566
6567* Keep your modifications to the necessary minimum: A patch
6568 containing several unrelated changes or arbitrary reformats will be
6569 returned with a request to re-formatting / split it.
6570
6571* If you modify existing code, make sure that your new code does not
6572 add to the memory footprint of the code ;-) Small is beautiful!
6573 When adding new features, these should compile conditionally only
6574 (using #ifdef), and the resulting code with the new feature
6575 disabled must not need more memory than the old code without your
6576 modification.
wdenk90dc6702005-05-03 14:12:25 +00006577
Wolfgang Denk06682362008-12-30 22:56:11 +01006578* Remember that there is a size limit of 100 kB per message on the
6579 u-boot mailing list. Bigger patches will be moderated. If they are
6580 reasonable and not too big, they will be acknowledged. But patches
6581 bigger than the size limit should be avoided.