blob: 48ed3e06ecf056485221e1a7016360b4b5d1f4a7 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02003# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00004# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkc6097192002-11-03 00:24:07 +00005
6Summary:
7========
8
wdenk24ee89b2002-11-03 17:56:27 +00009This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000010Embedded boards based on PowerPC, ARM, MIPS and several other
11processors, which can be installed in a boot ROM and used to
12initialize and test the hardware or to download and run application
13code.
wdenkc6097192002-11-03 00:24:07 +000014
15The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000016the source code originate in the Linux source tree, we have some
17header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000018support booting of Linux images.
19
20Some attention has been paid to make this software easily
21configurable and extendable. For instance, all monitor commands are
22implemented with the same call interface, so that it's very easy to
23add new commands. Also, instead of permanently adding rarely used
24code (for instance hardware test utilities) to the monitor, you can
25load and run it dynamically.
26
27
28Status:
29=======
30
31In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000032Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000033"working". In fact, many of them are used in production systems.
34
Robert P. J. Day7207b362015-12-19 07:16:10 -050035In case of problems see the CHANGELOG file to find out who contributed
36the specific port. In addition, there are various MAINTAINERS files
37scattered throughout the U-Boot source identifying the people or
38companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000039
Robert P. J. Day7207b362015-12-19 07:16:10 -050040Note: As of August, 2010, there is no longer a CHANGELOG file in the
41actual U-Boot source tree; however, it can be created dynamically
42from the Git log using:
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000043
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
Robert P. J. Day7207b362015-12-19 07:16:10 -050051U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
Robert P. J. Day7207b362015-12-19 07:16:10 -050061The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-03-26 10:40:12 +010062git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
Jelle van der Waa0de21ec2016-10-30 17:30:30 +0100128 U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500136 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500137 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000140 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400142 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200143 /powerpc Files generic to PowerPC architecture
Rick Chen3fafced2017-12-26 13:55:59 +0800144 /riscv Files generic to RISC-V architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500145 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /sh Files generic to SH architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400147 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500148/api Machine/arch independent API for external apps
149/board Board dependent files
Xu Ziyuan740f7e52016-08-26 19:54:49 +0800150/cmd U-Boot commands functions
Peter Tyser8d321b82010-04-12 22:28:21 -0500151/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500152/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500153/disk Code for disk drive partition handling
154/doc Documentation (don't expect too much)
155/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400156/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500157/examples Example code for standalone applications, etc.
158/fs Filesystem code (cramfs, ext2, jffs2, etc.)
159/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500160/lib Library routines generic to all architectures
161/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500162/net Networking code
163/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500164/scripts Various build scripts and Makefiles
165/test Various unit test files
Peter Tyser8d321b82010-04-12 22:28:21 -0500166/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000167
wdenkc6097192002-11-03 00:24:07 +0000168Software Configuration:
169=======================
170
171Configuration is usually done using C preprocessor defines; the
172rationale behind that is to avoid dead code whenever possible.
173
174There are two classes of configuration variables:
175
176* Configuration _OPTIONS_:
177 These are selectable by the user and have names beginning with
178 "CONFIG_".
179
180* Configuration _SETTINGS_:
181 These depend on the hardware etc. and should not be meddled with if
182 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200183 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000184
Robert P. J. Day7207b362015-12-19 07:16:10 -0500185Previously, all configuration was done by hand, which involved creating
186symbolic links and editing configuration files manually. More recently,
187U-Boot has added the Kbuild infrastructure used by the Linux kernel,
188allowing you to use the "make menuconfig" command to configure your
189build.
wdenkc6097192002-11-03 00:24:07 +0000190
191
192Selection of Processor Architecture and Board Type:
193---------------------------------------------------
194
195For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200196configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000197
198Example: For a TQM823L module type:
199
200 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200201 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000202
Robert P. J. Day7207b362015-12-19 07:16:10 -0500203Note: If you're looking for the default configuration file for a board
204you're sure used to be there but is now missing, check the file
205doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000206
Simon Glass75b3c3a2014-03-22 17:12:59 -0600207Sandbox Environment:
208--------------------
209
210U-Boot can be built natively to run on a Linux host using the 'sandbox'
211board. This allows feature development which is not board- or architecture-
212specific to be undertaken on a native platform. The sandbox is also used to
213run some of U-Boot's tests.
214
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530215See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600216
217
Simon Glassdb910352015-03-03 08:03:00 -0700218Board Initialisation Flow:
219--------------------------
220
221This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500222SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700223
Robert P. J. Day7207b362015-12-19 07:16:10 -0500224Note: "SPL" stands for "Secondary Program Loader," which is explained in
225more detail later in this file.
226
227At present, SPL mostly uses a separate code path, but the function names
228and roles of each function are the same. Some boards or architectures
229may not conform to this. At least most ARM boards which use
230CONFIG_SPL_FRAMEWORK conform to this.
231
232Execution typically starts with an architecture-specific (and possibly
233CPU-specific) start.S file, such as:
234
235 - arch/arm/cpu/armv7/start.S
236 - arch/powerpc/cpu/mpc83xx/start.S
237 - arch/mips/cpu/start.S
238
239and so on. From there, three functions are called; the purpose and
240limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700241
242lowlevel_init():
243 - purpose: essential init to permit execution to reach board_init_f()
244 - no global_data or BSS
245 - there is no stack (ARMv7 may have one but it will soon be removed)
246 - must not set up SDRAM or use console
247 - must only do the bare minimum to allow execution to continue to
248 board_init_f()
249 - this is almost never needed
250 - return normally from this function
251
252board_init_f():
253 - purpose: set up the machine ready for running board_init_r():
254 i.e. SDRAM and serial UART
255 - global_data is available
256 - stack is in SRAM
257 - BSS is not available, so you cannot use global/static variables,
258 only stack variables and global_data
259
260 Non-SPL-specific notes:
261 - dram_init() is called to set up DRAM. If already done in SPL this
262 can do nothing
263
264 SPL-specific notes:
265 - you can override the entire board_init_f() function with your own
266 version as needed.
267 - preloader_console_init() can be called here in extremis
268 - should set up SDRAM, and anything needed to make the UART work
269 - these is no need to clear BSS, it will be done by crt0.S
270 - must return normally from this function (don't call board_init_r()
271 directly)
272
273Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
274this point the stack and global_data are relocated to below
275CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
276memory.
277
278board_init_r():
279 - purpose: main execution, common code
280 - global_data is available
281 - SDRAM is available
282 - BSS is available, all static/global variables can be used
283 - execution eventually continues to main_loop()
284
285 Non-SPL-specific notes:
286 - U-Boot is relocated to the top of memory and is now running from
287 there.
288
289 SPL-specific notes:
290 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
291 CONFIG_SPL_STACK_R_ADDR points into SDRAM
292 - preloader_console_init() can be called here - typically this is
Ley Foon Tan0680f1b2017-05-03 17:13:32 +0800293 done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
Simon Glassdb910352015-03-03 08:03:00 -0700294 spl_board_init() function containing this call
295 - loads U-Boot or (in falcon mode) Linux
296
297
298
wdenkc6097192002-11-03 00:24:07 +0000299Configuration Options:
300----------------------
301
302Configuration depends on the combination of board and CPU type; all
303such information is kept in a configuration file
304"include/configs/<board_name>.h".
305
306Example: For a TQM823L module, all configuration settings are in
307"include/configs/TQM823L.h".
308
309
wdenk7f6c2cb2002-11-10 22:06:23 +0000310Many of the options are named exactly as the corresponding Linux
311kernel configuration options. The intention is to make it easier to
312build a config tool - later.
313
Ashish Kumar63b23162017-08-11 11:09:14 +0530314- ARM Platform Bus Type(CCI):
315 CoreLink Cache Coherent Interconnect (CCI) is ARM BUS which
316 provides full cache coherency between two clusters of multi-core
317 CPUs and I/O coherency for devices and I/O masters
318
319 CONFIG_SYS_FSL_HAS_CCI400
320
321 Defined For SoC that has cache coherent interconnect
322 CCN-400
wdenk7f6c2cb2002-11-10 22:06:23 +0000323
Ashish Kumarc055cee2017-08-18 10:54:36 +0530324 CONFIG_SYS_FSL_HAS_CCN504
325
326 Defined for SoC that has cache coherent interconnect CCN-504
327
wdenkc6097192002-11-03 00:24:07 +0000328The following options need to be configured:
329
Kim Phillips26281142007-08-10 13:28:25 -0500330- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000331
Kim Phillips26281142007-08-10 13:28:25 -0500332- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200333
Lei Wencf946c62011-02-09 18:06:58 +0530334- Marvell Family Member
335 CONFIG_SYS_MVFS - define it if you want to enable
336 multiple fs option at one time
337 for marvell soc family
338
Kumar Gala66412c62011-02-18 05:40:54 -0600339- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000340 CONFIG_SYS_PPC64
341
342 Specifies that the core is a 64-bit PowerPC implementation (implements
343 the "64" category of the Power ISA). This is necessary for ePAPR
344 compliance, among other possible reasons.
345
Kumar Gala66412c62011-02-18 05:40:54 -0600346 CONFIG_SYS_FSL_TBCLK_DIV
347
348 Defines the core time base clock divider ratio compared to the
349 system clock. On most PQ3 devices this is 8, on newer QorIQ
350 devices it can be 16 or 32. The ratio varies from SoC to Soc.
351
Kumar Gala8f290842011-05-20 00:39:21 -0500352 CONFIG_SYS_FSL_PCIE_COMPAT
353
354 Defines the string to utilize when trying to match PCIe device
355 tree nodes for the given platform.
356
Scott Wood33eee332012-08-14 10:14:53 +0000357 CONFIG_SYS_FSL_ERRATUM_A004510
358
359 Enables a workaround for erratum A004510. If set,
360 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
361 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
362
363 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
364 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
365
366 Defines one or two SoC revisions (low 8 bits of SVR)
367 for which the A004510 workaround should be applied.
368
369 The rest of SVR is either not relevant to the decision
370 of whether the erratum is present (e.g. p2040 versus
371 p2041) or is implied by the build target, which controls
372 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
373
374 See Freescale App Note 4493 for more information about
375 this erratum.
376
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530377 CONFIG_A003399_NOR_WORKAROUND
378 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800379 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530380
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530381 CONFIG_A008044_WORKAROUND
382 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800383 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530384
Scott Wood33eee332012-08-14 10:14:53 +0000385 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
386
387 This is the value to write into CCSR offset 0x18600
388 according to the A004510 workaround.
389
Priyanka Jain64501c62013-07-02 09:21:04 +0530390 CONFIG_SYS_FSL_DSP_DDR_ADDR
391 This value denotes start offset of DDR memory which is
392 connected exclusively to the DSP cores.
393
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530394 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
395 This value denotes start offset of M2 memory
396 which is directly connected to the DSP core.
397
Priyanka Jain64501c62013-07-02 09:21:04 +0530398 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
399 This value denotes start offset of M3 memory which is directly
400 connected to the DSP core.
401
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530402 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
403 This value denotes start offset of DSP CCSR space.
404
Priyanka Jainb1359912013-12-17 14:25:52 +0530405 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
406 Single Source Clock is clocking mode present in some of FSL SoC's.
407 In this mode, a single differential clock is used to supply
408 clocks to the sysclock, ddrclock and usbclock.
409
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530410 CONFIG_SYS_CPC_REINIT_F
411 This CONFIG is defined when the CPC is configured as SRAM at the
Bin Menga1875592016-02-05 19:30:11 -0800412 time of U-Boot entry and is required to be re-initialized.
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530413
Tang Yuantianaade2002014-04-17 15:33:46 +0800414 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800415 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800416 supported, core will start to execute uboot when wakes up.
417
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000418- Generic CPU options:
419 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
420
421 Defines the endianess of the CPU. Implementation of those
422 values is arch specific.
423
York Sun5614e712013-09-30 09:22:09 -0700424 CONFIG_SYS_FSL_DDR
425 Freescale DDR driver in use. This type of DDR controller is
426 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
427 SoCs.
428
429 CONFIG_SYS_FSL_DDR_ADDR
430 Freescale DDR memory-mapped register base.
431
432 CONFIG_SYS_FSL_DDR_EMU
433 Specify emulator support for DDR. Some DDR features such as
434 deskew training are not available.
435
436 CONFIG_SYS_FSL_DDRC_GEN1
437 Freescale DDR1 controller.
438
439 CONFIG_SYS_FSL_DDRC_GEN2
440 Freescale DDR2 controller.
441
442 CONFIG_SYS_FSL_DDRC_GEN3
443 Freescale DDR3 controller.
444
York Sun34e026f2014-03-27 17:54:47 -0700445 CONFIG_SYS_FSL_DDRC_GEN4
446 Freescale DDR4 controller.
447
York Sun9ac4ffb2013-09-30 14:20:51 -0700448 CONFIG_SYS_FSL_DDRC_ARM_GEN3
449 Freescale DDR3 controller for ARM-based SoCs.
450
York Sun5614e712013-09-30 09:22:09 -0700451 CONFIG_SYS_FSL_DDR1
452 Board config to use DDR1. It can be enabled for SoCs with
453 Freescale DDR1 or DDR2 controllers, depending on the board
454 implemetation.
455
456 CONFIG_SYS_FSL_DDR2
Robert P. J. Day62a3b7d2016-07-15 13:44:45 -0400457 Board config to use DDR2. It can be enabled for SoCs with
York Sun5614e712013-09-30 09:22:09 -0700458 Freescale DDR2 or DDR3 controllers, depending on the board
459 implementation.
460
461 CONFIG_SYS_FSL_DDR3
462 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700463 Freescale DDR3 or DDR3L controllers.
464
465 CONFIG_SYS_FSL_DDR3L
466 Board config to use DDR3L. It can be enabled for SoCs with
467 DDR3L controllers.
468
469 CONFIG_SYS_FSL_DDR4
470 Board config to use DDR4. It can be enabled for SoCs with
471 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700472
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530473 CONFIG_SYS_FSL_IFC_BE
474 Defines the IFC controller register space as Big Endian
475
476 CONFIG_SYS_FSL_IFC_LE
477 Defines the IFC controller register space as Little Endian
478
Prabhakar Kushwaha1c407072017-02-02 15:01:26 +0530479 CONFIG_SYS_FSL_IFC_CLK_DIV
480 Defines divider of platform clock(clock input to IFC controller).
481
Prabhakar Kushwahaadd63f92017-02-02 15:02:00 +0530482 CONFIG_SYS_FSL_LBC_CLK_DIV
483 Defines divider of platform clock(clock input to eLBC controller).
484
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530485 CONFIG_SYS_FSL_PBL_PBI
486 It enables addition of RCW (Power on reset configuration) in built image.
487 Please refer doc/README.pblimage for more details
488
489 CONFIG_SYS_FSL_PBL_RCW
490 It adds PBI(pre-boot instructions) commands in u-boot build image.
491 PBI commands can be used to configure SoC before it starts the execution.
492 Please refer doc/README.pblimage for more details
493
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530494 CONFIG_SPL_FSL_PBL
495 It adds a target to create boot binary having SPL binary in PBI format
496 concatenated with u-boot binary.
497
York Sun4e5b1bd2014-02-10 13:59:42 -0800498 CONFIG_SYS_FSL_DDR_BE
499 Defines the DDR controller register space as Big Endian
500
501 CONFIG_SYS_FSL_DDR_LE
502 Defines the DDR controller register space as Little Endian
503
York Sun6b9e3092014-02-10 13:59:43 -0800504 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
505 Physical address from the view of DDR controllers. It is the
506 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
507 it could be different for ARM SoCs.
508
York Sun6b1e1252014-02-10 13:59:44 -0800509 CONFIG_SYS_FSL_DDR_INTLV_256B
510 DDR controller interleaving on 256-byte. This is a special
511 interleaving mode, handled by Dickens for Freescale layerscape
512 SoCs with ARM core.
513
York Sun1d71efb2014-08-01 15:51:00 -0700514 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
515 Number of controllers used as main memory.
516
517 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
518 Number of controllers used for other than main memory.
519
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530520 CONFIG_SYS_FSL_HAS_DP_DDR
521 Defines the SoC has DP-DDR used for DPAA.
522
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530523 CONFIG_SYS_FSL_SEC_BE
524 Defines the SEC controller register space as Big Endian
525
526 CONFIG_SYS_FSL_SEC_LE
527 Defines the SEC controller register space as Little Endian
528
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200529- MIPS CPU options:
530 CONFIG_SYS_INIT_SP_OFFSET
531
532 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
533 pointer. This is needed for the temporary stack before
534 relocation.
535
536 CONFIG_SYS_MIPS_CACHE_MODE
537
538 Cache operation mode for the MIPS CPU.
539 See also arch/mips/include/asm/mipsregs.h.
540 Possible values are:
541 CONF_CM_CACHABLE_NO_WA
542 CONF_CM_CACHABLE_WA
543 CONF_CM_UNCACHED
544 CONF_CM_CACHABLE_NONCOHERENT
545 CONF_CM_CACHABLE_CE
546 CONF_CM_CACHABLE_COW
547 CONF_CM_CACHABLE_CUW
548 CONF_CM_CACHABLE_ACCELERATED
549
550 CONFIG_SYS_XWAY_EBU_BOOTCFG
551
552 Special option for Lantiq XWAY SoCs for booting from NOR flash.
553 See also arch/mips/cpu/mips32/start.S.
554
555 CONFIG_XWAY_SWAP_BYTES
556
557 Enable compilation of tools/xway-swap-bytes needed for Lantiq
558 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
559 be swapped if a flash programmer is used.
560
Christian Rieschb67d8812012-02-02 00:44:39 +0000561- ARM options:
562 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
563
564 Select high exception vectors of the ARM core, e.g., do not
565 clear the V bit of the c1 register of CP15.
566
York Sun207774b2015-03-20 19:28:08 -0700567 COUNTER_FREQUENCY
568 Generic timer clock source frequency.
569
570 COUNTER_FREQUENCY_REAL
571 Generic timer clock source frequency if the real clock is
572 different from COUNTER_FREQUENCY, and can only be determined
573 at run time.
574
Stephen Warren73c38932015-01-19 16:25:52 -0700575- Tegra SoC options:
576 CONFIG_TEGRA_SUPPORT_NON_SECURE
577
578 Support executing U-Boot in non-secure (NS) mode. Certain
579 impossible actions will be skipped if the CPU is in NS mode,
580 such as ARM architectural timer initialization.
581
wdenk5da627a2003-10-09 20:09:04 +0000582- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000583 CONFIG_CLOCKS_IN_MHZ
584
585 U-Boot stores all clock information in Hz
586 internally. For binary compatibility with older Linux
587 kernels (which expect the clocks passed in the
588 bd_info data to be in MHz) the environment variable
589 "clocks_in_mhz" can be defined so that U-Boot
590 converts clock data to MHZ before passing it to the
591 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000592 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100593 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000594 default environment.
595
wdenk5da627a2003-10-09 20:09:04 +0000596 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
597
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800598 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000599 expect it to be in bytes, others in MB.
600 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
601
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400602 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200603
604 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400605 passed using flattened device trees (based on open firmware
606 concepts).
607
608 CONFIG_OF_LIBFDT
609 * New libfdt-based support
610 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500611 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400612
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200613 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600614 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200615
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200616 boards with QUICC Engines require OF_QE to set UCC MAC
617 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500618
Kumar Gala4e253132006-01-11 13:54:17 -0600619 CONFIG_OF_BOARD_SETUP
620
621 Board code has addition modification that it wants to make
622 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000623
Simon Glassc654b512014-10-23 18:58:54 -0600624 CONFIG_OF_SYSTEM_SETUP
625
626 Other code has addition modification that it wants to make
627 to the flat device tree before handing it off to the kernel.
628 This causes ft_system_setup() to be called before booting
629 the kernel.
630
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200631 CONFIG_OF_IDE_FIXUP
632
633 U-Boot can detect if an IDE device is present or not.
634 If not, and this new config option is activated, U-Boot
635 removes the ATA node from the DTS before booting Linux,
636 so the Linux IDE driver does not probe the device and
637 crash. This is needed for buggy hardware (uc101) where
638 no pull down resistor is connected to the signal IDE5V_DD7.
639
Igor Grinberg7eb29392011-07-14 05:45:07 +0000640 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
641
642 This setting is mandatory for all boards that have only one
643 machine type and must be used to specify the machine type
644 number as it appears in the ARM machine registry
645 (see http://www.arm.linux.org.uk/developer/machines/).
646 Only boards that have multiple machine types supported
647 in a single configuration file and the machine type is
648 runtime discoverable, do not have to use this setting.
649
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100650- vxWorks boot parameters:
651
652 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700653 environments variables: bootdev, bootfile, ipaddr, netmask,
654 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100655 It loads the vxWorks image pointed bootfile.
656
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100657 Note: If a "bootargs" environment is defined, it will overwride
658 the defaults discussed just above.
659
Aneesh V2c451f72011-06-16 23:30:47 +0000660- Cache Configuration:
661 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
662 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
663 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
664
Aneesh V93bc2192011-06-16 23:30:51 +0000665- Cache Configuration for ARM:
666 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
667 controller
668 CONFIG_SYS_PL310_BASE - Physical base address of PL310
669 controller register space
670
wdenk6705d812004-08-02 23:22:59 +0000671- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200672 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000673
674 Define this if you want support for Amba PrimeCell PL010 UARTs.
675
Andreas Engel48d01922008-09-08 14:30:53 +0200676 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000677
678 Define this if you want support for Amba PrimeCell PL011 UARTs.
679
680 CONFIG_PL011_CLOCK
681
682 If you have Amba PrimeCell PL011 UARTs, set this variable to
683 the clock speed of the UARTs.
684
685 CONFIG_PL01x_PORTS
686
687 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
688 define this to a list of base addresses for each (supported)
689 port. See e.g. include/configs/versatile.h
690
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400691 CONFIG_SERIAL_HW_FLOW_CONTROL
692
693 Define this variable to enable hw flow control in serial driver.
694 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000695
wdenkc6097192002-11-03 00:24:07 +0000696- Console Baudrate:
697 CONFIG_BAUDRATE - in bps
698 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200699 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000700
wdenkc6097192002-11-03 00:24:07 +0000701- Autoboot Command:
702 CONFIG_BOOTCOMMAND
703 Only needed when CONFIG_BOOTDELAY is enabled;
704 define a command string that is automatically executed
705 when no character is read on the console interface
706 within "Boot Delay" after reset.
707
wdenkc6097192002-11-03 00:24:07 +0000708 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000709 The value of these goes into the environment as
710 "ramboot" and "nfsboot" respectively, and can be used
711 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200712 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000713
714- Pre-Boot Commands:
715 CONFIG_PREBOOT
716
717 When this option is #defined, the existence of the
718 environment variable "preboot" will be checked
719 immediately before starting the CONFIG_BOOTDELAY
720 countdown and/or running the auto-boot command resp.
721 entering interactive mode.
722
723 This feature is especially useful when "preboot" is
724 automatically generated or modified. For an example
725 see the LWMON board specific code: here "preboot" is
726 modified when the user holds down a certain
727 combination of keys on the (special) keyboard when
728 booting the systems
729
730- Serial Download Echo Mode:
731 CONFIG_LOADS_ECHO
732 If defined to 1, all characters received during a
733 serial download (using the "loads" command) are
734 echoed back. This might be needed by some terminal
735 emulations (like "cu"), but may as well just take
736 time on others. This setting #define's the initial
737 value of the "loads_echo" environment variable.
738
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500739- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000740 CONFIG_KGDB_BAUDRATE
741 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200742 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000743
Simon Glass302a6482016-03-13 19:07:28 -0600744- Removal of commands
745 If no commands are needed to boot, you can disable
746 CONFIG_CMDLINE to remove them. In this case, the command line
747 will not be available, and when U-Boot wants to execute the
748 boot command (on start-up) it will call board_run_command()
749 instead. This can reduce image size significantly for very
750 simple boot procedures.
751
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000752- Regular expression support:
753 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +0200754 If this variable is defined, U-Boot is linked against
755 the SLRE (Super Light Regular Expression) library,
756 which adds regex support to some commands, as for
757 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +0000758
Simon Glass45ba8072011-10-15 05:48:20 +0000759- Device tree:
760 CONFIG_OF_CONTROL
761 If this variable is defined, U-Boot will use a device tree
762 to configure its devices, instead of relying on statically
763 compiled #defines in the board file. This option is
764 experimental and only available on a few boards. The device
765 tree is available in the global data as gd->fdt_blob.
766
Simon Glass2c0f79e2011-10-24 19:15:31 +0000767 U-Boot needs to get its device tree from somewhere. This can
Alex Deymo82f766d2017-04-02 01:25:20 -0700768 be done using one of the three options below:
Simon Glassbbb0b122011-10-15 05:48:21 +0000769
770 CONFIG_OF_EMBED
771 If this variable is defined, U-Boot will embed a device tree
772 binary in its image. This device tree file should be in the
773 board directory and called <soc>-<board>.dts. The binary file
774 is then picked up in board_init_f() and made available through
Nobuhiro Iwamatsueb3eb602017-08-26 07:34:14 +0900775 the global data structure as gd->fdt_blob.
Simon Glass45ba8072011-10-15 05:48:20 +0000776
Simon Glass2c0f79e2011-10-24 19:15:31 +0000777 CONFIG_OF_SEPARATE
778 If this variable is defined, U-Boot will build a device tree
779 binary. It will be called u-boot.dtb. Architecture-specific
780 code will locate it at run-time. Generally this works by:
781
782 cat u-boot.bin u-boot.dtb >image.bin
783
784 and in fact, U-Boot does this for you, creating a file called
785 u-boot-dtb.bin which is useful in the common case. You can
786 still use the individual files if you need something more
787 exotic.
788
Alex Deymo82f766d2017-04-02 01:25:20 -0700789 CONFIG_OF_BOARD
790 If this variable is defined, U-Boot will use the device tree
791 provided by the board at runtime instead of embedding one with
792 the image. Only boards defining board_fdt_blob_setup() support
793 this option (see include/fdtdec.h file).
794
wdenkc6097192002-11-03 00:24:07 +0000795- Watchdog:
796 CONFIG_WATCHDOG
797 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000798 support for the SoC. There must be support in the SoC
Christophe Leroy907208c2017-07-06 10:23:22 +0200799 specific code for a watchdog. For the 8xx
800 CPUs, the SIU Watchdog feature is enabled in the SYPCR
801 register. When supported for a specific SoC is
802 available, then no further board specific code should
803 be needed to use it.
Detlev Zundel6abe6fb2011-04-27 05:25:59 +0000804
805 CONFIG_HW_WATCHDOG
806 When using a watchdog circuitry external to the used
807 SoC, then define this variable and provide board
808 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +0000809
Heiko Schocher7bae0d62015-01-21 08:38:22 +0100810 CONFIG_AT91_HW_WDT_TIMEOUT
811 specify the timeout in seconds. default 2 seconds.
812
wdenkc6097192002-11-03 00:24:07 +0000813- Real-Time Clock:
814
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500815 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +0000816 has to be selected, too. Define exactly one of the
817 following options:
818
wdenkc6097192002-11-03 00:24:07 +0000819 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +0000820 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +0000821 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +0000822 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +0000823 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +0000824 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +0200825 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +0000826 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +0100827 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +0000828 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Chris Packham2bd3cab2017-05-30 12:03:33 +1200829 CONFIG_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +0200830 CONFIG_SYS_RV3029_TCR - enable trickle charger on
831 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +0000832
wdenkb37c7e52003-06-30 16:24:52 +0000833 Note that if the RTC uses I2C, then the I2C interface
834 must also be configured. See I2C Support, below.
835
Peter Tysere92739d2008-12-17 16:36:21 -0600836- GPIO Support:
837 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -0600838
Chris Packham5dec49c2010-12-19 10:12:13 +0000839 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
840 chip-ngpio pairs that tell the PCA953X driver the number of
841 pins supported by a particular chip.
842
Peter Tysere92739d2008-12-17 16:36:21 -0600843 Note that if the GPIO device uses I2C, then the I2C interface
844 must also be configured. See I2C Support, below.
845
Simon Glassaa532332014-06-11 23:29:41 -0600846- I/O tracing:
847 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
848 accesses and can checksum them or write a list of them out
849 to memory. See the 'iotrace' command for details. This is
850 useful for testing device drivers since it can confirm that
851 the driver behaves the same way before and after a code
852 change. Currently this is supported on sandbox and arm. To
853 add support for your architecture, add '#include <iotrace.h>'
854 to the bottom of arch/<arch>/include/asm/io.h and test.
855
856 Example output from the 'iotrace stats' command is below.
857 Note that if the trace buffer is exhausted, the checksum will
858 still continue to operate.
859
860 iotrace is enabled
861 Start: 10000000 (buffer start address)
862 Size: 00010000 (buffer size)
863 Offset: 00000120 (current buffer offset)
864 Output: 10000120 (start + offset)
865 Count: 00000018 (number of trace records)
866 CRC32: 9526fb66 (CRC32 of all trace records)
867
wdenkc6097192002-11-03 00:24:07 +0000868- Timestamp Support:
869
wdenk43d96162003-03-06 00:02:04 +0000870 When CONFIG_TIMESTAMP is selected, the timestamp
871 (date and time) of an image is printed by image
872 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500873 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +0000874
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000875- Partition Labels (disklabels) Supported:
876 Zero or more of the following:
877 CONFIG_MAC_PARTITION Apple's MacOS partition table.
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000878 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
879 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
880 bootloader. Note 2TB partition limit; see
881 disk/part_efi.c
882 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +0000883
Simon Glassfc843a02017-05-17 03:25:30 -0600884 If IDE or SCSI support is enabled (CONFIG_IDE or
Simon Glassc649e3c2016-05-01 11:36:02 -0600885 CONFIG_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +0000886 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +0000887
888- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +0000889 CONFIG_IDE_RESET_ROUTINE - this is defined in several
890 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +0000891
wdenk4d13cba2004-03-14 14:09:05 +0000892 CONFIG_IDE_RESET - is this is defined, IDE Reset will
893 be performed by calling the function
894 ide_set_reset(int reset)
895 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +0000896
897- ATAPI Support:
898 CONFIG_ATAPI
899
900 Set this to enable ATAPI support.
901
wdenkc40b2952004-03-13 23:29:43 +0000902- LBA48 Support
903 CONFIG_LBA48
904
905 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +0100906 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +0000907 Whithout these , LBA48 support uses 32bit variables and will 'only'
908 support disks up to 2.1TB.
909
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200910 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +0000911 When enabled, makes the IDE subsystem use 64bit sector addresses.
912 Default is 32bit.
913
wdenkc6097192002-11-03 00:24:07 +0000914- SCSI Support:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200915 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
916 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
917 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +0000918 maximum numbers of LUNs, SCSI ID's and target
919 devices.
wdenkc6097192002-11-03 00:24:07 +0000920
Wolfgang Denk93e14592013-10-04 17:43:24 +0200921 The environment variable 'scsidevs' is set to the number of
922 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +0000923
wdenkc6097192002-11-03 00:24:07 +0000924- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +0000925 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +0000926 Support for Intel 8254x/8257x gigabit chips.
927
928 CONFIG_E1000_SPI
929 Utility code for direct access to the SPI bus on Intel 8257x.
930 This does not do anything useful unless you set at least one
931 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
932
933 CONFIG_E1000_SPI_GENERIC
934 Allow generic access to the SPI bus on the Intel 8257x, for
935 example with the "sspi" command.
936
wdenkc6097192002-11-03 00:24:07 +0000937 CONFIG_EEPRO100
938 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200939 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +0000940 write routine for first time initialisation.
941
942 CONFIG_TULIP
943 Support for Digital 2114x chips.
944 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
945 modem chip initialisation (KS8761/QS6611).
946
947 CONFIG_NATSEMI
948 Support for National dp83815 chips.
949
950 CONFIG_NS8382X
951 Support for National dp8382[01] gigabit chips.
952
wdenk45219c42003-05-12 21:50:16 +0000953- NETWORK Support (other):
954
Jens Scharsigc041e9d2010-01-23 12:03:45 +0100955 CONFIG_DRIVER_AT91EMAC
956 Support for AT91RM9200 EMAC.
957
958 CONFIG_RMII
959 Define this to use reduced MII inteface
960
961 CONFIG_DRIVER_AT91EMAC_QUIET
962 If this defined, the driver is quiet.
963 The driver doen't show link status messages.
964
Rob Herringefdd7312011-12-15 11:15:49 +0000965 CONFIG_CALXEDA_XGMAC
966 Support for the Calxeda XGMAC device
967
Ashok3bb46d22012-10-15 06:20:47 +0000968 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +0000969 Support for SMSC's LAN91C96 chips.
970
wdenk45219c42003-05-12 21:50:16 +0000971 CONFIG_LAN91C96_USE_32_BIT
972 Define this to enable 32 bit addressing
973
Ashok3bb46d22012-10-15 06:20:47 +0000974 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +0000975 Support for SMSC's LAN91C111 chip
976
977 CONFIG_SMC91111_BASE
978 Define this to hold the physical address
979 of the device (I/O space)
980
981 CONFIG_SMC_USE_32_BIT
982 Define this if data bus is 32 bits
983
984 CONFIG_SMC_USE_IOFUNCS
985 Define this to use i/o functions instead of macros
986 (some hardware wont work with macros)
987
Heiko Schocherdc02bad2011-11-15 10:00:04 -0500988 CONFIG_DRIVER_TI_EMAC
989 Support for davinci emac
990
991 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
992 Define this if you have more then 3 PHYs.
993
Macpaul Linb3dbf4a52010-12-21 16:59:46 +0800994 CONFIG_FTGMAC100
995 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
996
997 CONFIG_FTGMAC100_EGIGA
998 Define this to use GE link update with gigabit PHY.
999 Define this if FTGMAC100 is connected to gigabit PHY.
1000 If your system has 10/100 PHY only, it might not occur
1001 wrong behavior. Because PHY usually return timeout or
1002 useless data when polling gigabit status and gigabit
1003 control registers. This behavior won't affect the
1004 correctnessof 10/100 link speed update.
1005
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001006 CONFIG_SH_ETHER
1007 Support for Renesas on-chip Ethernet controller
1008
1009 CONFIG_SH_ETHER_USE_PORT
1010 Define the number of ports to be used
1011
1012 CONFIG_SH_ETHER_PHY_ADDR
1013 Define the ETH PHY's address
1014
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001015 CONFIG_SH_ETHER_CACHE_WRITEBACK
1016 If this option is set, the driver enables cache flush.
1017
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001018- PWM Support:
1019 CONFIG_PWM_IMX
Robert P. J. Day5052e812016-09-13 08:35:18 -04001020 Support for PWM module on the imx6.
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001021
Vadim Bendebury5e124722011-10-17 08:36:14 +00001022- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001023 CONFIG_TPM
1024 Support TPM devices.
1025
Christophe Ricard0766ad22015-10-06 22:54:41 +02001026 CONFIG_TPM_TIS_INFINEON
1027 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001028 per system is supported at this time.
1029
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001030 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1031 Define the burst count bytes upper limit
1032
Christophe Ricard3aa74082016-01-21 23:27:13 +01001033 CONFIG_TPM_ST33ZP24
1034 Support for STMicroelectronics TPM devices. Requires DM_TPM support.
1035
1036 CONFIG_TPM_ST33ZP24_I2C
1037 Support for STMicroelectronics ST33ZP24 I2C devices.
1038 Requires TPM_ST33ZP24 and I2C.
1039
Christophe Ricardb75fdc12016-01-21 23:27:14 +01001040 CONFIG_TPM_ST33ZP24_SPI
1041 Support for STMicroelectronics ST33ZP24 SPI devices.
1042 Requires TPM_ST33ZP24 and SPI.
1043
Dirk Eibachc01939c2013-06-26 15:55:15 +02001044 CONFIG_TPM_ATMEL_TWI
1045 Support for Atmel TWI TPM device. Requires I2C support.
1046
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001047 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001048 Support for generic parallel port TPM devices. Only one device
1049 per system is supported at this time.
1050
1051 CONFIG_TPM_TIS_BASE_ADDRESS
1052 Base address where the generic TPM device is mapped
1053 to. Contemporary x86 systems usually map it at
1054 0xfed40000.
1055
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001056 CONFIG_TPM
1057 Define this to enable the TPM support library which provides
1058 functional interfaces to some TPM commands.
1059 Requires support for a TPM device.
1060
1061 CONFIG_TPM_AUTH_SESSIONS
1062 Define this to enable authorized functions in the TPM library.
1063 Requires CONFIG_TPM and CONFIG_SHA1.
1064
wdenkc6097192002-11-03 00:24:07 +00001065- USB Support:
1066 At the moment only the UHCI host controller is
Heiko Schocher064b55c2017-06-14 05:49:40 +02001067 supported (PIP405, MIP405); define
wdenkc6097192002-11-03 00:24:07 +00001068 CONFIG_USB_UHCI to enable it.
1069 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001070 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001071 storage devices.
1072 Note:
1073 Supported are USB Keyboards and USB Floppy drives
1074 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001075
Simon Glass9ab4ce22012-02-27 10:52:47 +00001076 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1077 txfilltuning field in the EHCI controller on reset.
1078
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001079 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1080 HW module registers.
1081
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001082- USB Device:
1083 Define the below if you wish to use the USB console.
1084 Once firmware is rebuilt from a serial console issue the
1085 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001086 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001087 it has found a new device. The environment variable usbtty
1088 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001089 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001090 Common Device Class Abstract Control Model serial device.
1091 If you select usbtty = gserial you should be able to enumerate
1092 a Linux host by
1093 # modprobe usbserial vendor=0xVendorID product=0xProductID
1094 else if using cdc_acm, simply setting the environment
1095 variable usbtty to be cdc_acm should suffice. The following
1096 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001097
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001098 CONFIG_USB_DEVICE
1099 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001100
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001101 CONFIG_USB_TTY
1102 Define this to have a tty type of device available to
1103 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001104
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301105 CONFIG_USBD_HS
1106 Define this to enable the high speed support for usb
1107 device and usbtty. If this feature is enabled, a routine
1108 int is_usbd_high_speed(void)
1109 also needs to be defined by the driver to dynamically poll
1110 whether the enumeration has succeded at high speed or full
1111 speed.
1112
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001113 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001114 Define this if you want stdin, stdout &/or stderr to
1115 be set to usbtty.
1116
Wolfgang Denk386eda02006-06-14 18:14:56 +02001117 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001118 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001119 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001120 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1121 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1122 should pretend to be a Linux device to it's target host.
1123
1124 CONFIG_USBD_MANUFACTURER
1125 Define this string as the name of your company for
1126 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001127
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001128 CONFIG_USBD_PRODUCT_NAME
1129 Define this string as the name of your product
1130 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1131
1132 CONFIG_USBD_VENDORID
1133 Define this as your assigned Vendor ID from the USB
1134 Implementors Forum. This *must* be a genuine Vendor ID
1135 to avoid polluting the USB namespace.
1136 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001137
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001138 CONFIG_USBD_PRODUCTID
1139 Define this as the unique Product ID
1140 for your device
1141 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001142
Igor Grinbergd70a5602011-12-12 12:08:35 +02001143- ULPI Layer Support:
1144 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1145 the generic ULPI layer. The generic layer accesses the ULPI PHY
1146 via the platform viewport, so you need both the genric layer and
1147 the viewport enabled. Currently only Chipidea/ARC based
1148 viewport is supported.
1149 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1150 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001151 If your ULPI phy needs a different reference clock than the
1152 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1153 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001154
1155- MMC Support:
1156 The MMC controller on the Intel PXA is supported. To
1157 enable this define CONFIG_MMC. The MMC can be
1158 accessed from the boot prompt by mapping the device
1159 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001160 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1161 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001162
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001163 CONFIG_SH_MMCIF
1164 Support for Renesas on-chip MMCIF controller
1165
1166 CONFIG_SH_MMCIF_ADDR
1167 Define the base address of MMCIF registers
1168
1169 CONFIG_SH_MMCIF_CLK
1170 Define the clock frequency for MMCIF
1171
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001172 CONFIG_SUPPORT_EMMC_BOOT
1173 Enable some additional features of the eMMC boot partitions.
1174
Tom Rinib3ba6e92013-03-14 05:32:47 +00001175- USB Device Firmware Update (DFU) class support:
Marek Vasutbb4059a2018-02-16 16:41:18 +01001176 CONFIG_DFU_OVER_USB
Tom Rinib3ba6e92013-03-14 05:32:47 +00001177 This enables the USB portion of the DFU USB class
1178
Tom Rinib3ba6e92013-03-14 05:32:47 +00001179 CONFIG_DFU_MMC
1180 This enables support for exposing (e)MMC devices via DFU.
1181
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001182 CONFIG_DFU_NAND
1183 This enables support for exposing NAND devices via DFU.
1184
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301185 CONFIG_DFU_RAM
1186 This enables support for exposing RAM via DFU.
1187 Note: DFU spec refer to non-volatile memory usage, but
1188 allow usages beyond the scope of spec - here RAM usage,
1189 one that would help mostly the developer.
1190
Heiko Schochere7e75c72013-06-12 06:05:51 +02001191 CONFIG_SYS_DFU_DATA_BUF_SIZE
1192 Dfu transfer uses a buffer before writing data to the
1193 raw storage device. Make the size (in bytes) of this buffer
1194 configurable. The size of this buffer is also configurable
1195 through the "dfu_bufsiz" environment variable.
1196
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001197 CONFIG_SYS_DFU_MAX_FILE_SIZE
1198 When updating files rather than the raw storage device,
1199 we use a static buffer to copy the file into and then write
1200 the buffer once we've been given the whole file. Define
1201 this to the maximum filesize (in bytes) for the buffer.
1202 Default is 4 MiB if undefined.
1203
Heiko Schocher001a8312014-03-18 08:09:56 +01001204 DFU_DEFAULT_POLL_TIMEOUT
1205 Poll timeout [ms], is the timeout a device can send to the
1206 host. The host must wait for this timeout before sending
1207 a subsequent DFU_GET_STATUS request to the device.
1208
1209 DFU_MANIFEST_POLL_TIMEOUT
1210 Poll timeout [ms], which the device sends to the host when
1211 entering dfuMANIFEST state. Host waits this timeout, before
1212 sending again an USB request to the device.
1213
wdenk6705d812004-08-02 23:22:59 +00001214- Journaling Flash filesystem support:
Simon Glassb2482df2016-10-02 18:00:59 -06001215 CONFIG_JFFS2_NAND
wdenk6705d812004-08-02 23:22:59 +00001216 Define these for a default partition on a NAND device
1217
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001218 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1219 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001220 Define these for a default partition on a NOR device
1221
wdenkc6097192002-11-03 00:24:07 +00001222- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001223 See Kconfig help for available keyboard drivers.
1224
1225 CONFIG_KEYBOARD
1226
1227 Define this to enable a custom keyboard support.
1228 This simply calls drv_keyboard_init() which must be
1229 defined in your board-specific files. This option is deprecated
1230 and is only used by novena. For new boards, use driver model
1231 instead.
wdenkc6097192002-11-03 00:24:07 +00001232
1233- Video support:
Timur Tabi7d3053f2011-02-15 17:09:19 -06001234 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001235 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001236 SOCs that have a DIU should define this macro to enable DIU
1237 support, and should also define these other macros:
1238
1239 CONFIG_SYS_DIU_ADDR
1240 CONFIG_VIDEO
Timur Tabi7d3053f2011-02-15 17:09:19 -06001241 CONFIG_CFB_CONSOLE
1242 CONFIG_VIDEO_SW_CURSOR
1243 CONFIG_VGA_AS_SINGLE_DEVICE
1244 CONFIG_VIDEO_LOGO
1245 CONFIG_VIDEO_BMP_LOGO
1246
Timur Tabiba8e76b2011-04-11 14:18:22 -05001247 The DIU driver will look for the 'video-mode' environment
1248 variable, and if defined, enable the DIU as a console during
Fabio Estevam8eca9432016-04-02 11:53:18 -03001249 boot. See the documentation file doc/README.video for a
Timur Tabiba8e76b2011-04-11 14:18:22 -05001250 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001251
wdenkc6097192002-11-03 00:24:07 +00001252- LCD Support: CONFIG_LCD
1253
1254 Define this to enable LCD support (for output to LCD
1255 display); also select one of the supported displays
1256 by defining one of these:
1257
Stelian Pop39cf4802008-05-09 21:57:18 +02001258 CONFIG_ATMEL_LCD:
1259
1260 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1261
wdenkfd3103b2003-11-25 16:55:19 +00001262 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001263
wdenkfd3103b2003-11-25 16:55:19 +00001264 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001265
wdenkfd3103b2003-11-25 16:55:19 +00001266 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001267
wdenkfd3103b2003-11-25 16:55:19 +00001268 NEC NL6448BC20-08. 6.5", 640x480.
1269 Active, color, single scan.
1270
1271 CONFIG_NEC_NL6448BC33_54
1272
1273 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001274 Active, color, single scan.
1275
1276 CONFIG_SHARP_16x9
1277
1278 Sharp 320x240. Active, color, single scan.
1279 It isn't 16x9, and I am not sure what it is.
1280
1281 CONFIG_SHARP_LQ64D341
1282
1283 Sharp LQ64D341 display, 640x480.
1284 Active, color, single scan.
1285
1286 CONFIG_HLD1045
1287
1288 HLD1045 display, 640x480.
1289 Active, color, single scan.
1290
1291 CONFIG_OPTREX_BW
1292
1293 Optrex CBL50840-2 NF-FW 99 22 M5
1294 or
1295 Hitachi LMG6912RPFC-00T
1296 or
1297 Hitachi SP14Q002
1298
1299 320x240. Black & white.
1300
Simon Glass676d3192012-10-17 13:24:54 +00001301 CONFIG_LCD_ALIGNMENT
1302
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001303 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001304 defined then the LCD will be aligned to this value instead.
1305 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1306 here, since it is cheaper to change data cache settings on
1307 a per-section basis.
1308
1309
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001310 CONFIG_LCD_ROTATION
1311
1312 Sometimes, for example if the display is mounted in portrait
1313 mode or even if it's mounted landscape but rotated by 180degree,
1314 we need to rotate our content of the display relative to the
1315 framebuffer, so that user can read the messages which are
1316 printed out.
1317 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1318 initialized with a given rotation from "vl_rot" out of
1319 "vidinfo_t" which is provided by the board specific code.
1320 The value for vl_rot is coded as following (matching to
1321 fbcon=rotate:<n> linux-kernel commandline):
1322 0 = no rotation respectively 0 degree
1323 1 = 90 degree rotation
1324 2 = 180 degree rotation
1325 3 = 270 degree rotation
1326
1327 If CONFIG_LCD_ROTATION is not defined, the console will be
1328 initialized with 0degree rotation.
1329
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001330 CONFIG_LCD_BMP_RLE8
1331
1332 Support drawing of RLE8-compressed bitmaps on the LCD.
1333
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001334 CONFIG_I2C_EDID
1335
1336 Enables an 'i2c edid' command which can read EDID
1337 information over I2C from an attached LCD display.
1338
wdenk7152b1d2003-09-05 23:19:14 +00001339- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001340
wdenk8bde7f72003-06-27 21:31:46 +00001341 If this option is set, the environment is checked for
1342 a variable "splashimage". If found, the usual display
1343 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001344 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001345 specified in "splashimage" is loaded instead. The
1346 console is redirected to the "nulldev", too. This
1347 allows for a "silent" boot where a splash screen is
1348 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001349
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001350 CONFIG_SPLASHIMAGE_GUARD
1351
1352 If this option is set, then U-Boot will prevent the environment
1353 variable "splashimage" from being set to a problematic address
Fabio Estevamab5645f2016-03-23 12:46:12 -03001354 (see doc/README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001355 This option is useful for targets where, due to alignment
1356 restrictions, an improperly aligned BMP image will cause a data
1357 abort. If you think you will not have problems with unaligned
1358 accesses (for example because your toolchain prevents them)
1359 there is no need to set this option.
1360
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001361 CONFIG_SPLASH_SCREEN_ALIGN
1362
1363 If this option is set the splash image can be freely positioned
1364 on the screen. Environment variable "splashpos" specifies the
1365 position as "x,y". If a positive number is given it is used as
1366 number of pixel from left/top. If a negative number is given it
1367 is used as number of pixel from right/bottom. You can also
1368 specify 'm' for centering the image.
1369
1370 Example:
1371 setenv splashpos m,m
1372 => image at center of screen
1373
1374 setenv splashpos 30,20
1375 => image at x = 30 and y = 20
1376
1377 setenv splashpos -10,m
1378 => vertically centered image
1379 at x = dspWidth - bmpWidth - 9
1380
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001381- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1382
1383 If this option is set, additionally to standard BMP
1384 images, gzipped BMP images can be displayed via the
1385 splashscreen support or the bmp command.
1386
Anatolij Gustschind5011762010-03-15 14:50:25 +01001387- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1388
1389 If this option is set, 8-bit RLE compressed BMP images
1390 can be displayed via the splashscreen support or the
1391 bmp command.
1392
wdenkc29fdfc2003-08-29 20:57:53 +00001393- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001394 CONFIG_GZIP
1395
1396 Enabled by default to support gzip compressed images.
1397
wdenkc29fdfc2003-08-29 20:57:53 +00001398 CONFIG_BZIP2
1399
1400 If this option is set, support for bzip2 compressed
1401 images is included. If not, only uncompressed and gzip
1402 compressed images are supported.
1403
wdenk42d1f032003-10-15 23:53:47 +00001404 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001405 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001406 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001407
wdenk17ea1172004-06-06 21:51:03 +00001408- MII/PHY support:
wdenk17ea1172004-06-06 21:51:03 +00001409 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1410
1411 The clock frequency of the MII bus
1412
wdenk17ea1172004-06-06 21:51:03 +00001413 CONFIG_PHY_RESET_DELAY
1414
1415 Some PHY like Intel LXT971A need extra delay after
1416 reset before any MII register access is possible.
1417 For such PHY, set this option to the usec delay
1418 required. (minimum 300usec for LXT971A)
1419
1420 CONFIG_PHY_CMD_DELAY (ppc4xx)
1421
1422 Some PHY like Intel LXT971A need extra delay after
1423 command issued before MII status register can be read
1424
wdenkc6097192002-11-03 00:24:07 +00001425- IP address:
1426 CONFIG_IPADDR
1427
1428 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001429 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001430 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001431 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001432
1433- Server IP address:
1434 CONFIG_SERVERIP
1435
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001436 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001437 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001438 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001439
Robin Getz97cfe862009-07-21 12:15:28 -04001440 CONFIG_KEEP_SERVERADDR
1441
1442 Keeps the server's MAC address, in the env 'serveraddr'
1443 for passing to bootargs (like Linux's netconsole option)
1444
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001445- Gateway IP address:
1446 CONFIG_GATEWAYIP
1447
1448 Defines a default value for the IP address of the
1449 default router where packets to other networks are
1450 sent to.
1451 (Environment variable "gatewayip")
1452
1453- Subnet mask:
1454 CONFIG_NETMASK
1455
1456 Defines a default value for the subnet mask (or
1457 routing prefix) which is used to determine if an IP
1458 address belongs to the local subnet or needs to be
1459 forwarded through a router.
1460 (Environment variable "netmask")
1461
David Updegraff53a5c422007-06-11 10:41:07 -05001462- Multicast TFTP Mode:
1463 CONFIG_MCAST_TFTP
1464
1465 Defines whether you want to support multicast TFTP as per
1466 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001467 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05001468 driver in use must provide a function: mcast() to join/leave a
1469 multicast group.
1470
wdenkc6097192002-11-03 00:24:07 +00001471- BOOTP Recovery Mode:
1472 CONFIG_BOOTP_RANDOM_DELAY
1473
1474 If you have many targets in a network that try to
1475 boot using BOOTP, you may want to avoid that all
1476 systems send out BOOTP requests at precisely the same
1477 moment (which would happen for instance at recovery
1478 from a power failure, when all systems will try to
1479 boot, thus flooding the BOOTP server. Defining
1480 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1481 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02001482 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00001483
1484 1st BOOTP request: delay 0 ... 1 sec
1485 2nd BOOTP request: delay 0 ... 2 sec
1486 3rd BOOTP request: delay 0 ... 4 sec
1487 4th and following
1488 BOOTP requests: delay 0 ... 8 sec
1489
Thierry Reding92ac8ac2014-08-19 10:21:24 +02001490 CONFIG_BOOTP_ID_CACHE_SIZE
1491
1492 BOOTP packets are uniquely identified using a 32-bit ID. The
1493 server will copy the ID from client requests to responses and
1494 U-Boot will use this to determine if it is the destination of
1495 an incoming response. Some servers will check that addresses
1496 aren't in use before handing them out (usually using an ARP
1497 ping) and therefore take up to a few hundred milliseconds to
1498 respond. Network congestion may also influence the time it
1499 takes for a response to make it back to the client. If that
1500 time is too long, U-Boot will retransmit requests. In order
1501 to allow earlier responses to still be accepted after these
1502 retransmissions, U-Boot's BOOTP client keeps a small cache of
1503 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
1504 cache. The default is to keep IDs for up to four outstanding
1505 requests. Increasing this will allow U-Boot to accept offers
1506 from a BOOTP client in networks with unusually high latency.
1507
stroesefe389a82003-08-28 14:17:32 +00001508- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001509 You can fine tune the DHCP functionality by defining
1510 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00001511
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001512 CONFIG_BOOTP_NISDOMAIN
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001513 CONFIG_BOOTP_BOOTFILESIZE
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001514 CONFIG_BOOTP_SEND_HOSTNAME
1515 CONFIG_BOOTP_NTPSERVER
1516 CONFIG_BOOTP_TIMEOFFSET
1517 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00001518 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00001519
Wilson Callan5d110f02007-07-28 10:56:13 -04001520 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
1521 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00001522
Joe Hershberger2c00e092012-05-23 07:59:19 +00001523 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
1524 after the configured retry count, the call will fail
1525 instead of starting over. This can be used to fail over
1526 to Link-local IP address configuration if the DHCP server
1527 is not available.
1528
stroesefe389a82003-08-28 14:17:32 +00001529 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1530 to do a dynamic update of a DNS server. To do this, they
1531 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04001532 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05001533 of the "hostname" environment variable is passed as
1534 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00001535
Aras Vaichasd9a2f412008-03-26 09:43:57 +11001536 CONFIG_BOOTP_DHCP_REQUEST_DELAY
1537
1538 A 32bit value in microseconds for a delay between
1539 receiving a "DHCP Offer" and sending the "DHCP Request".
1540 This fixes a problem with certain DHCP servers that don't
1541 respond 100% of the time to a "DHCP request". E.g. On an
1542 AT91RM9200 processor running at 180MHz, this delay needed
1543 to be *at least* 15,000 usec before a Windows Server 2003
1544 DHCP server would reply 100% of the time. I recommend at
1545 least 50,000 usec to be safe. The alternative is to hope
1546 that one of the retries will be successful but note that
1547 the DHCP timeout and retry process takes a longer than
1548 this delay.
1549
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001550 - Link-local IP address negotiation:
1551 Negotiate with other link-local clients on the local network
1552 for an address that doesn't require explicit configuration.
1553 This is especially useful if a DHCP server cannot be guaranteed
1554 to exist in all environments that the device must operate.
1555
1556 See doc/README.link-local for more information.
1557
Prabhakar Kushwaha24acb832017-11-23 16:51:32 +05301558 - MAC address from environment variables
1559
1560 FDT_SEQ_MACADDR_FROM_ENV
1561
1562 Fix-up device tree with MAC addresses fetched sequentially from
1563 environment variables. This config work on assumption that
1564 non-usable ethernet node of device-tree are either not present
1565 or their status has been marked as "disabled".
1566
wdenka3d991b2004-04-15 21:48:45 +00001567 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00001568 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00001569
1570 The device id used in CDP trigger frames.
1571
1572 CONFIG_CDP_DEVICE_ID_PREFIX
1573
1574 A two character string which is prefixed to the MAC address
1575 of the device.
1576
1577 CONFIG_CDP_PORT_ID
1578
1579 A printf format string which contains the ascii name of
1580 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001581 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00001582
1583 CONFIG_CDP_CAPABILITIES
1584
1585 A 32bit integer which indicates the device capabilities;
1586 0x00000010 for a normal host which does not forwards.
1587
1588 CONFIG_CDP_VERSION
1589
1590 An ascii string containing the version of the software.
1591
1592 CONFIG_CDP_PLATFORM
1593
1594 An ascii string containing the name of the platform.
1595
1596 CONFIG_CDP_TRIGGER
1597
1598 A 32bit integer sent on the trigger.
1599
1600 CONFIG_CDP_POWER_CONSUMPTION
1601
1602 A 16bit integer containing the power consumption of the
1603 device in .1 of milliwatts.
1604
1605 CONFIG_CDP_APPLIANCE_VLAN_TYPE
1606
1607 A byte containing the id of the VLAN.
1608
Uri Mashiach79267ed2017-01-19 10:51:05 +02001609- Status LED: CONFIG_LED_STATUS
wdenkc6097192002-11-03 00:24:07 +00001610
1611 Several configurations allow to display the current
1612 status using a LED. For instance, the LED will blink
1613 fast while running U-Boot code, stop blinking as
1614 soon as a reply to a BOOTP request was received, and
1615 start blinking slow once the Linux kernel is running
1616 (supported by a status LED driver in the Linux
Uri Mashiach79267ed2017-01-19 10:51:05 +02001617 kernel). Defining CONFIG_LED_STATUS enables this
wdenkc6097192002-11-03 00:24:07 +00001618 feature in U-Boot.
1619
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001620 Additional options:
1621
Uri Mashiach79267ed2017-01-19 10:51:05 +02001622 CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001623 The status LED can be connected to a GPIO pin.
1624 In such cases, the gpio_led driver can be used as a
Uri Mashiach79267ed2017-01-19 10:51:05 +02001625 status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02001626 to include the gpio_led driver in the U-Boot binary.
1627
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02001628 CONFIG_GPIO_LED_INVERTED_TABLE
1629 Some GPIO connected LEDs may have inverted polarity in which
1630 case the GPIO high value corresponds to LED off state and
1631 GPIO low value corresponds to LED on state.
1632 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
1633 with a list of GPIO LEDs that have inverted polarity.
1634
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001635- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00001636
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001637 This enable the NEW i2c subsystem, and will allow you to use
1638 i2c commands at the u-boot command line (as long as you set
1639 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
1640 based realtime clock chips or other i2c devices. See
1641 common/cmd_i2c.c for a description of the command line
1642 interface.
1643
1644 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01001645 - drivers/i2c/soft_i2c.c:
1646 - activate first bus with CONFIG_SYS_I2C_SOFT define
1647 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1648 for defining speed and slave address
1649 - activate second bus with I2C_SOFT_DECLARATIONS2 define
1650 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1651 for defining speed and slave address
1652 - activate third bus with I2C_SOFT_DECLARATIONS3 define
1653 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1654 for defining speed and slave address
1655 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1656 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1657 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001658
Heiko Schocher00f792e2012-10-24 13:48:22 +02001659 - drivers/i2c/fsl_i2c.c:
1660 - activate i2c driver with CONFIG_SYS_I2C_FSL
1661 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
1662 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
1663 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
1664 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02001665 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02001666 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
1667 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
1668 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
1669 second bus.
1670
Simon Glass1f2ba722012-10-30 07:28:53 +00001671 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09001672 - activate this driver with CONFIG_SYS_I2C_TEGRA
1673 - This driver adds 4 i2c buses with a fix speed from
1674 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00001675
Dirk Eibach880540d2013-04-25 02:40:01 +00001676 - drivers/i2c/ppc4xx_i2c.c
1677 - activate this driver with CONFIG_SYS_I2C_PPC4XX
1678 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1679 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1680
tremfac96402013-09-21 18:13:35 +02001681 - drivers/i2c/i2c_mxc.c
1682 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001683 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
1684 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
1685 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
1686 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02001687 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1688 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1689 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1690 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1691 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1692 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02001693 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
1694 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001695 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02001696 for speed, and 0 for slave.
1697
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09001698 - drivers/i2c/rcar_i2c.c:
1699 - activate this driver with CONFIG_SYS_I2C_RCAR
1700 - This driver adds 4 i2c buses
1701
1702 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
1703 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
1704 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
1705 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
1706 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
1707 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
1708 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
1709 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
1710 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
1711
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001712 - drivers/i2c/sh_i2c.c:
1713 - activate this driver with CONFIG_SYS_I2C_SH
1714 - This driver adds from 2 to 5 i2c buses
1715
1716 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
1717 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
1718 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
1719 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
1720 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
1721 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
1722 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
1723 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
1724 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
1725 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001726 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09001727
Heiko Schocher6789e842013-10-22 11:03:18 +02001728 - drivers/i2c/omap24xx_i2c.c
1729 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
1730 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
1731 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
1732 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
1733 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
1734 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
1735 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
1736 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
1737 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
1738 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
1739 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
1740
Heiko Schocher0bdffe72013-11-08 07:30:53 +01001741 - drivers/i2c/zynq_i2c.c
1742 - activate this driver with CONFIG_SYS_I2C_ZYNQ
1743 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
1744 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
1745
Naveen Krishna Che717fc62013-12-06 12:12:38 +05301746 - drivers/i2c/s3c24x0_i2c.c:
1747 - activate this driver with CONFIG_SYS_I2C_S3C24X0
1748 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1749 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1750 with a fix speed from 100000 and the slave addr 0!
1751
Dirk Eibachb46226b2014-07-03 09:28:18 +02001752 - drivers/i2c/ihs_i2c.c
1753 - activate this driver with CONFIG_SYS_I2C_IHS
1754 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
1755 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
1756 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
1757 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
1758 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
1759 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
1760 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
1761 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
1762 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
1763 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
1764 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
1765 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01001766 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
1767 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
1768 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
1769 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
1770 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
1771 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
1772 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
1773 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
1774 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02001775
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001776 additional defines:
1777
1778 CONFIG_SYS_NUM_I2C_BUSES
Simon Glass945a18e2016-10-02 18:01:05 -06001779 Hold the number of i2c buses you want to use.
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001780
1781 CONFIG_SYS_I2C_DIRECT_BUS
1782 define this, if you don't use i2c muxes on your hardware.
1783 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
1784 omit this define.
1785
1786 CONFIG_SYS_I2C_MAX_HOPS
1787 define how many muxes are maximal consecutively connected
1788 on one i2c bus. If you not use i2c muxes, omit this
1789 define.
1790
1791 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001792 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001793 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
1794 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
1795 CONFIG_SYS_NUM_I2C_BUSES = 9:
1796
1797 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
1798 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
1799 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
1800 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
1801 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
1802 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
1803 {1, {I2C_NULL_HOP}}, \
1804 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
1805 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
1806 }
1807
1808 which defines
1809 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001810 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
1811 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
1812 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
1813 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
1814 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001815 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01001816 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
1817 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00001818
1819 If you do not have i2c muxes on your board, omit this define.
1820
Simon Glassce3b5d62017-05-12 21:10:00 -06001821- Legacy I2C Support:
Heiko Schocherea818db2013-01-29 08:53:15 +01001822 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00001823 then the following macros need to be defined (examples are
1824 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00001825
1826 I2C_INIT
1827
wdenkb37c7e52003-06-30 16:24:52 +00001828 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00001829 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00001830
wdenkba56f622004-02-06 23:19:44 +00001831 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00001832
wdenkc6097192002-11-03 00:24:07 +00001833 I2C_ACTIVE
1834
1835 The code necessary to make the I2C data line active
1836 (driven). If the data line is open collector, this
1837 define can be null.
1838
wdenkb37c7e52003-06-30 16:24:52 +00001839 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
1840
wdenkc6097192002-11-03 00:24:07 +00001841 I2C_TRISTATE
1842
1843 The code necessary to make the I2C data line tri-stated
1844 (inactive). If the data line is open collector, this
1845 define can be null.
1846
wdenkb37c7e52003-06-30 16:24:52 +00001847 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
1848
wdenkc6097192002-11-03 00:24:07 +00001849 I2C_READ
1850
York Sun472d5462013-04-01 11:29:11 -07001851 Code that returns true if the I2C data line is high,
1852 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00001853
wdenkb37c7e52003-06-30 16:24:52 +00001854 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
1855
wdenkc6097192002-11-03 00:24:07 +00001856 I2C_SDA(bit)
1857
York Sun472d5462013-04-01 11:29:11 -07001858 If <bit> is true, sets the I2C data line high. If it
1859 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001860
wdenkb37c7e52003-06-30 16:24:52 +00001861 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00001862 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00001863 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00001864
wdenkc6097192002-11-03 00:24:07 +00001865 I2C_SCL(bit)
1866
York Sun472d5462013-04-01 11:29:11 -07001867 If <bit> is true, sets the I2C clock line high. If it
1868 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00001869
wdenkb37c7e52003-06-30 16:24:52 +00001870 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00001871 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00001872 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00001873
wdenkc6097192002-11-03 00:24:07 +00001874 I2C_DELAY
1875
1876 This delay is invoked four times per clock cycle so this
1877 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00001878 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00001879 like:
1880
wdenkb37c7e52003-06-30 16:24:52 +00001881 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00001882
Mike Frysinger793b5722010-07-21 13:38:02 -04001883 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
1884
1885 If your arch supports the generic GPIO framework (asm/gpio.h),
1886 then you may alternatively define the two GPIOs that are to be
1887 used as SCL / SDA. Any of the previous I2C_xxx macros will
1888 have GPIO-based defaults assigned to them as appropriate.
1889
1890 You should define these to the GPIO value as given directly to
1891 the generic GPIO functions.
1892
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001893 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00001894
wdenk8bde7f72003-06-27 21:31:46 +00001895 When a board is reset during an i2c bus transfer
1896 chips might think that the current transfer is still
1897 in progress. On some boards it is possible to access
1898 the i2c SCLK line directly, either by using the
1899 processor pin as a GPIO or by having a second pin
1900 connected to the bus. If this option is defined a
1901 custom i2c_init_board() routine in boards/xxx/board.c
1902 is run early in the boot sequence.
wdenk47cd00f2003-03-06 13:39:27 +00001903
Ben Warrenbb99ad62006-09-07 16:50:54 -04001904 CONFIG_I2C_MULTI_BUS
1905
1906 This option allows the use of multiple I2C buses, each of which
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001907 must have a controller. At any point in time, only one bus is
1908 active. To switch to a different bus, use the 'i2c dev' command.
Ben Warrenbb99ad62006-09-07 16:50:54 -04001909 Note that bus numbering is zero-based.
1910
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001911 CONFIG_SYS_I2C_NOPROBES
Ben Warrenbb99ad62006-09-07 16:50:54 -04001912
1913 This option specifies a list of I2C devices that will be skipped
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001914 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS
Peter Tyser0f89c542009-04-18 22:34:03 -05001915 is set, specify a list of bus-device pairs. Otherwise, specify
1916 a 1D array of device addresses
Ben Warrenbb99ad62006-09-07 16:50:54 -04001917
1918 e.g.
1919 #undef CONFIG_I2C_MULTI_BUS
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001920 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001921
1922 will skip addresses 0x50 and 0x68 on a board with one I2C bus
1923
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001924 #define CONFIG_I2C_MULTI_BUS
Simon Glass945a18e2016-10-02 18:01:05 -06001925 #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
Ben Warrenbb99ad62006-09-07 16:50:54 -04001926
1927 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
1928
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001929 CONFIG_SYS_SPD_BUS_NUM
Timur Tabibe5e6182006-11-03 19:15:00 -06001930
1931 If defined, then this indicates the I2C bus number for DDR SPD.
1932 If not defined, then U-Boot assumes that SPD is on I2C bus 0.
1933
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001934 CONFIG_SYS_RTC_BUS_NUM
Stefan Roese0dc018e2007-02-20 10:51:26 +01001935
1936 If defined, then this indicates the I2C bus number for the RTC.
1937 If not defined, then U-Boot assumes that RTC is on I2C bus 0.
1938
Andrew Dyer2ac69852008-12-29 17:36:01 -06001939 CONFIG_SOFT_I2C_READ_REPEATED_START
1940
1941 defining this will force the i2c_read() function in
1942 the soft_i2c driver to perform an I2C repeated start
1943 between writing the address pointer and reading the
1944 data. If this define is omitted the default behaviour
1945 of doing a stop-start sequence will be used. Most I2C
1946 devices can use either method, but some require one or
1947 the other.
Timur Tabibe5e6182006-11-03 19:15:00 -06001948
wdenkc6097192002-11-03 00:24:07 +00001949- SPI Support: CONFIG_SPI
1950
1951 Enables SPI driver (so far only tested with
1952 SPI EEPROM, also an instance works with Crystal A/D and
1953 D/As on the SACSng board)
1954
wdenkc6097192002-11-03 00:24:07 +00001955 CONFIG_SOFT_SPI
1956
wdenk43d96162003-03-06 00:02:04 +00001957 Enables a software (bit-bang) SPI driver rather than
1958 using hardware support. This is a general purpose
1959 driver that only requires three general I/O port pins
1960 (two outputs, one input) to function. If this is
1961 defined, the board configuration must define several
1962 SPI configuration items (port pins to use, etc). For
1963 an example, see include/configs/sacsng.h.
wdenkc6097192002-11-03 00:24:07 +00001964
Ben Warren04a9e112008-01-16 22:37:35 -05001965 CONFIG_HARD_SPI
1966
1967 Enables a hardware SPI driver for general-purpose reads
1968 and writes. As with CONFIG_SOFT_SPI, the board configuration
1969 must define a list of chip-select function pointers.
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001970 Currently supported on some MPC8xxx processors. For an
Ben Warren04a9e112008-01-16 22:37:35 -05001971 example, see include/configs/mpc8349emds.h.
1972
Heiko Schocherf659b572014-07-14 10:22:11 +02001973 CONFIG_SYS_SPI_MXC_WAIT
1974 Timeout for waiting until spi transfer completed.
1975 default: (CONFIG_SYS_HZ/100) /* 10 ms */
1976
Matthias Fuchs01335022007-12-27 17:12:34 +01001977- FPGA Support: CONFIG_FPGA
1978
1979 Enables FPGA subsystem.
1980
1981 CONFIG_FPGA_<vendor>
1982
1983 Enables support for specific chip vendors.
1984 (ALTERA, XILINX)
1985
1986 CONFIG_FPGA_<family>
1987
1988 Enables support for FPGA family.
1989 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
1990
1991 CONFIG_FPGA_COUNT
wdenkc6097192002-11-03 00:24:07 +00001992
wdenk43d96162003-03-06 00:02:04 +00001993 Specify the number of FPGA devices to support.
wdenkc6097192002-11-03 00:24:07 +00001994
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001995 CONFIG_SYS_FPGA_PROG_FEEDBACK
wdenkc6097192002-11-03 00:24:07 +00001996
wdenk8bde7f72003-06-27 21:31:46 +00001997 Enable printing of hash marks during FPGA configuration.
wdenkc6097192002-11-03 00:24:07 +00001998
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001999 CONFIG_SYS_FPGA_CHECK_BUSY
wdenkc6097192002-11-03 00:24:07 +00002000
wdenk43d96162003-03-06 00:02:04 +00002001 Enable checks on FPGA configuration interface busy
2002 status by the configuration function. This option
2003 will require a board or device specific function to
2004 be written.
wdenkc6097192002-11-03 00:24:07 +00002005
2006 CONFIG_FPGA_DELAY
2007
2008 If defined, a function that provides delays in the FPGA
2009 configuration driver.
2010
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002011 CONFIG_SYS_FPGA_CHECK_CTRLC
wdenkc6097192002-11-03 00:24:07 +00002012 Allow Control-C to interrupt FPGA configuration
2013
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002014 CONFIG_SYS_FPGA_CHECK_ERROR
wdenkc6097192002-11-03 00:24:07 +00002015
wdenk43d96162003-03-06 00:02:04 +00002016 Check for configuration errors during FPGA bitfile
2017 loading. For example, abort during Virtex II
2018 configuration if the INIT_B line goes low (which
2019 indicated a CRC error).
wdenkc6097192002-11-03 00:24:07 +00002020
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002021 CONFIG_SYS_FPGA_WAIT_INIT
wdenkc6097192002-11-03 00:24:07 +00002022
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002023 Maximum time to wait for the INIT_B line to de-assert
2024 after PROB_B has been de-asserted during a Virtex II
wdenk43d96162003-03-06 00:02:04 +00002025 FPGA configuration sequence. The default time is 500
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002026 ms.
wdenkc6097192002-11-03 00:24:07 +00002027
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002028 CONFIG_SYS_FPGA_WAIT_BUSY
wdenkc6097192002-11-03 00:24:07 +00002029
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002030 Maximum time to wait for BUSY to de-assert during
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002031 Virtex II FPGA configuration. The default is 5 ms.
wdenkc6097192002-11-03 00:24:07 +00002032
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002033 CONFIG_SYS_FPGA_WAIT_CONFIG
wdenkc6097192002-11-03 00:24:07 +00002034
wdenk43d96162003-03-06 00:02:04 +00002035 Time to wait after FPGA configuration. The default is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002036 200 ms.
wdenkc6097192002-11-03 00:24:07 +00002037
2038- Configuration Management:
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002039 CONFIG_BUILD_TARGET
2040
2041 Some SoCs need special image types (e.g. U-Boot binary
2042 with a special header) as build targets. By defining
2043 CONFIG_BUILD_TARGET in the SoC / board header, this
2044 special image will be automatically built upon calling
Simon Glass6de80f22016-07-27 20:33:08 -06002045 make / buildman.
Stefan Roeseb2b8a692014-10-22 12:13:24 +02002046
wdenkc6097192002-11-03 00:24:07 +00002047 CONFIG_IDENT_STRING
2048
wdenk43d96162003-03-06 00:02:04 +00002049 If defined, this string will be added to the U-Boot
2050 version information (U_BOOT_VERSION)
wdenkc6097192002-11-03 00:24:07 +00002051
2052- Vendor Parameter Protection:
2053
wdenk43d96162003-03-06 00:02:04 +00002054 U-Boot considers the values of the environment
2055 variables "serial#" (Board Serial Number) and
wdenk7152b1d2003-09-05 23:19:14 +00002056 "ethaddr" (Ethernet Address) to be parameters that
wdenk43d96162003-03-06 00:02:04 +00002057 are set once by the board vendor / manufacturer, and
2058 protects these variables from casual modification by
2059 the user. Once set, these variables are read-only,
2060 and write or delete attempts are rejected. You can
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002061 change this behaviour:
wdenkc6097192002-11-03 00:24:07 +00002062
2063 If CONFIG_ENV_OVERWRITE is #defined in your config
2064 file, the write protection for vendor parameters is
wdenk47cd00f2003-03-06 13:39:27 +00002065 completely disabled. Anybody can change or delete
wdenkc6097192002-11-03 00:24:07 +00002066 these parameters.
2067
Joe Hershberger92ac5202015-05-04 14:55:14 -05002068 Alternatively, if you define _both_ an ethaddr in the
2069 default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002070 Ethernet address is installed in the environment,
wdenkc6097192002-11-03 00:24:07 +00002071 which can be changed exactly ONCE by the user. [The
2072 serial# is unaffected by this, i. e. it remains
2073 read-only.]
2074
Joe Hershberger25980902012-12-11 22:16:31 -06002075 The same can be accomplished in a more flexible way
2076 for any variable by configuring the type of access
2077 to allow for those variables in the ".flags" variable
2078 or define CONFIG_ENV_FLAGS_LIST_STATIC.
2079
wdenkc6097192002-11-03 00:24:07 +00002080- Protected RAM:
2081 CONFIG_PRAM
2082
2083 Define this variable to enable the reservation of
2084 "protected RAM", i. e. RAM which is not overwritten
2085 by U-Boot. Define CONFIG_PRAM to hold the number of
2086 kB you want to reserve for pRAM. You can overwrite
2087 this default value by defining an environment
2088 variable "pram" to the number of kB you want to
2089 reserve. Note that the board info structure will
2090 still show the full amount of RAM. If pRAM is
2091 reserved, a new environment variable "mem" will
2092 automatically be defined to hold the amount of
2093 remaining RAM in a form that can be passed as boot
2094 argument to Linux, for instance like that:
2095
Wolfgang Denkfe126d82005-11-20 21:40:11 +01002096 setenv bootargs ... mem=\${mem}
wdenkc6097192002-11-03 00:24:07 +00002097 saveenv
2098
2099 This way you can tell Linux not to use this memory,
2100 either, which results in a memory region that will
2101 not be affected by reboots.
2102
2103 *WARNING* If your board configuration uses automatic
2104 detection of the RAM size, you must make sure that
2105 this memory test is non-destructive. So far, the
2106 following board configurations are known to be
2107 "pRAM-clean":
2108
Heiko Schocher5b8e76c2017-06-07 17:33:09 +02002109 IVMS8, IVML24, SPD8xx,
Wolfgang Denk1b0757e2012-10-24 02:36:15 +00002110 HERMES, IP860, RPXlite, LWMON,
Heiko Schocher2eb48ff2017-06-07 17:33:10 +02002111 FLAGADM
wdenkc6097192002-11-03 00:24:07 +00002112
Gabe Black40fef042012-12-02 04:55:18 +00002113- Access to physical memory region (> 4GB)
2114 Some basic support is provided for operations on memory not
2115 normally accessible to U-Boot - e.g. some architectures
2116 support access to more than 4GB of memory on 32-bit
2117 machines using physical address extension or similar.
2118 Define CONFIG_PHYSMEM to access this basic support, which
2119 currently only supports clearing the memory.
2120
wdenkc6097192002-11-03 00:24:07 +00002121- Error Recovery:
wdenkc6097192002-11-03 00:24:07 +00002122 CONFIG_NET_RETRY_COUNT
2123
wdenk43d96162003-03-06 00:02:04 +00002124 This variable defines the number of retries for
2125 network operations like ARP, RARP, TFTP, or BOOTP
2126 before giving up the operation. If not defined, a
2127 default value of 5 is used.
wdenkc6097192002-11-03 00:24:07 +00002128
Guennadi Liakhovetski40cb90e2008-04-03 17:04:19 +02002129 CONFIG_ARP_TIMEOUT
2130
2131 Timeout waiting for an ARP reply in milliseconds.
2132
Tetsuyuki Kobayashi48a3e992012-07-03 22:25:21 +00002133 CONFIG_NFS_TIMEOUT
2134
2135 Timeout in milliseconds used in NFS protocol.
2136 If you encounter "ERROR: Cannot umount" in nfs command,
2137 try longer timeout such as
2138 #define CONFIG_NFS_TIMEOUT 10000UL
2139
wdenkc6097192002-11-03 00:24:07 +00002140- Command Interpreter:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002141 CONFIG_SYS_PROMPT_HUSH_PS2
wdenkc6097192002-11-03 00:24:07 +00002142
2143 This defines the secondary prompt string, which is
2144 printed when the command interpreter needs more input
2145 to complete a command. Usually "> ".
2146
2147 Note:
2148
wdenk8bde7f72003-06-27 21:31:46 +00002149 In the current implementation, the local variables
2150 space and global environment variables space are
2151 separated. Local variables are those you define by
2152 simply typing `name=value'. To access a local
2153 variable later on, you have write `$name' or
2154 `${name}'; to execute the contents of a variable
2155 directly type `$name' at the command prompt.
wdenkc6097192002-11-03 00:24:07 +00002156
wdenk43d96162003-03-06 00:02:04 +00002157 Global environment variables are those you use
2158 setenv/printenv to work with. To run a command stored
2159 in such a variable, you need to use the run command,
2160 and you must not use the '$' sign to access them.
wdenkc6097192002-11-03 00:24:07 +00002161
2162 To store commands and special characters in a
2163 variable, please use double quotation marks
2164 surrounding the whole text of the variable, instead
2165 of the backslashes before semicolons and special
2166 symbols.
2167
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002168- Command Line Editing and History:
Marek Vasutf3b267b2016-01-27 04:47:55 +01002169 CONFIG_CMDLINE_PS_SUPPORT
2170
2171 Enable support for changing the command prompt string
2172 at run-time. Only static string is supported so far.
2173 The string is obtained from environment variables PS1
2174 and PS2.
2175
wdenka8c7c702003-12-06 19:49:23 +00002176- Default Environment:
wdenkc6097192002-11-03 00:24:07 +00002177 CONFIG_EXTRA_ENV_SETTINGS
2178
wdenk43d96162003-03-06 00:02:04 +00002179 Define this to contain any number of null terminated
2180 strings (variable = value pairs) that will be part of
wdenk7152b1d2003-09-05 23:19:14 +00002181 the default environment compiled into the boot image.
wdenk2262cfe2002-11-18 00:14:45 +00002182
wdenk43d96162003-03-06 00:02:04 +00002183 For example, place something like this in your
2184 board's config file:
wdenkc6097192002-11-03 00:24:07 +00002185
2186 #define CONFIG_EXTRA_ENV_SETTINGS \
2187 "myvar1=value1\0" \
2188 "myvar2=value2\0"
2189
wdenk43d96162003-03-06 00:02:04 +00002190 Warning: This method is based on knowledge about the
2191 internal format how the environment is stored by the
2192 U-Boot code. This is NOT an official, exported
2193 interface! Although it is unlikely that this format
wdenk7152b1d2003-09-05 23:19:14 +00002194 will change soon, there is no guarantee either.
wdenkc6097192002-11-03 00:24:07 +00002195 You better know what you are doing here.
2196
wdenk43d96162003-03-06 00:02:04 +00002197 Note: overly (ab)use of the default environment is
2198 discouraged. Make sure to check other ways to preset
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002199 the environment like the "source" command or the
wdenk43d96162003-03-06 00:02:04 +00002200 boot command first.
wdenkc6097192002-11-03 00:24:07 +00002201
Simon Glass06fd8532012-11-30 13:01:17 +00002202 CONFIG_DELAY_ENVIRONMENT
2203
2204 Normally the environment is loaded when the board is
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002205 initialised so that it is available to U-Boot. This inhibits
Simon Glass06fd8532012-11-30 13:01:17 +00002206 that so that the environment is not available until
2207 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
2208 this is instead controlled by the value of
2209 /config/load-environment.
2210
Eric Nelsonf61ec452012-01-31 10:52:08 -07002211- Serial Flash support
Simon Glass00fd59d2017-08-04 16:35:06 -06002212 Usage requires an initial 'sf probe' to define the serial
Eric Nelsonf61ec452012-01-31 10:52:08 -07002213 flash parameters, followed by read/write/erase/update
2214 commands.
2215
2216 The following defaults may be provided by the platform
2217 to handle the common case when only a single serial
2218 flash is present on the system.
2219
2220 CONFIG_SF_DEFAULT_BUS Bus identifier
2221 CONFIG_SF_DEFAULT_CS Chip-select
2222 CONFIG_SF_DEFAULT_MODE (see include/spi.h)
2223 CONFIG_SF_DEFAULT_SPEED in Hz
2224
wdenk3f85ce22004-02-23 16:11:30 +00002225
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002226- TFTP Fixed UDP Port:
2227 CONFIG_TFTP_PORT
2228
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002229 If this is defined, the environment variable tftpsrcp
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002230 is used to supply the TFTP UDP source port value.
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002231 If tftpsrcp isn't defined, the normal pseudo-random port
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002232 number generator is used.
2233
Wolfgang Denk28cb9372005-09-24 23:25:46 +02002234 Also, the environment variable tftpdstp is used to supply
2235 the TFTP UDP destination port value. If tftpdstp isn't
2236 defined, the normal port 69 is used.
2237
2238 The purpose for tftpsrcp is to allow a TFTP server to
Wolfgang Denkecb0ccd2005-09-24 22:37:32 +02002239 blindly start the TFTP transfer using the pre-configured
2240 target IP address and UDP port. This has the effect of
2241 "punching through" the (Windows XP) firewall, allowing
2242 the remainder of the TFTP transfer to proceed normally.
2243 A better solution is to properly configure the firewall,
2244 but sometimes that is not allowed.
2245
wdenka8c7c702003-12-06 19:49:23 +00002246- Show boot progress:
wdenkc6097192002-11-03 00:24:07 +00002247 CONFIG_SHOW_BOOT_PROGRESS
2248
wdenk43d96162003-03-06 00:02:04 +00002249 Defining this option allows to add some board-
2250 specific code (calling a user-provided function
2251 "show_boot_progress(int)") that enables you to show
2252 the system's boot progress on some display (for
2253 example, some LED's) on your board. At the moment,
2254 the following checkpoints are implemented:
wdenkc6097192002-11-03 00:24:07 +00002255
Simon Glass94fd1312012-09-28 08:56:37 +00002256
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002257Legacy uImage format:
2258
wdenkc6097192002-11-03 00:24:07 +00002259 Arg Where When
2260 1 common/cmd_bootm.c before attempting to boot an image
wdenkba56f622004-02-06 23:19:44 +00002261 -1 common/cmd_bootm.c Image header has bad magic number
wdenkc6097192002-11-03 00:24:07 +00002262 2 common/cmd_bootm.c Image header has correct magic number
wdenkba56f622004-02-06 23:19:44 +00002263 -2 common/cmd_bootm.c Image header has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002264 3 common/cmd_bootm.c Image header has correct checksum
wdenkba56f622004-02-06 23:19:44 +00002265 -3 common/cmd_bootm.c Image data has bad checksum
wdenkc6097192002-11-03 00:24:07 +00002266 4 common/cmd_bootm.c Image data has correct checksum
2267 -4 common/cmd_bootm.c Image is for unsupported architecture
2268 5 common/cmd_bootm.c Architecture check OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002269 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi)
wdenkc6097192002-11-03 00:24:07 +00002270 6 common/cmd_bootm.c Image Type check OK
2271 -6 common/cmd_bootm.c gunzip uncompression error
2272 -7 common/cmd_bootm.c Unimplemented compression type
2273 7 common/cmd_bootm.c Uncompression OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002274 8 common/cmd_bootm.c No uncompress/copy overwrite error
wdenkc6097192002-11-03 00:24:07 +00002275 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002276
2277 9 common/image.c Start initial ramdisk verification
2278 -10 common/image.c Ramdisk header has bad magic number
2279 -11 common/image.c Ramdisk header has bad checksum
2280 10 common/image.c Ramdisk header is OK
2281 -12 common/image.c Ramdisk data has bad checksum
2282 11 common/image.c Ramdisk data has correct checksum
2283 12 common/image.c Ramdisk verification complete, start loading
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002284 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk)
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002285 13 common/image.c Start multifile image verification
2286 14 common/image.c No initial ramdisk, no multifile, continue.
2287
Wolfgang Denkc0f40852011-10-26 10:21:21 +00002288 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
wdenkc6097192002-11-03 00:24:07 +00002289
Stefan Roesea47a12b2010-04-15 16:07:28 +02002290 -30 arch/powerpc/lib/board.c Fatal error, hang the system
wdenk11dadd52004-02-27 00:07:27 +00002291 -31 post/post.c POST test failed, detected by post_output_backlog()
2292 -32 post/post.c POST test failed, detected by post_run_single()
wdenk63e73c92004-02-23 22:22:28 +00002293
Heiko Schocher566a4942007-06-22 19:11:54 +02002294 34 common/cmd_doc.c before loading a Image from a DOC device
2295 -35 common/cmd_doc.c Bad usage of "doc" command
2296 35 common/cmd_doc.c correct usage of "doc" command
2297 -36 common/cmd_doc.c No boot device
2298 36 common/cmd_doc.c correct boot device
2299 -37 common/cmd_doc.c Unknown Chip ID on boot device
2300 37 common/cmd_doc.c correct chip ID found, device available
2301 -38 common/cmd_doc.c Read Error on boot device
2302 38 common/cmd_doc.c reading Image header from DOC device OK
2303 -39 common/cmd_doc.c Image header has bad magic number
2304 39 common/cmd_doc.c Image header has correct magic number
2305 -40 common/cmd_doc.c Error reading Image from DOC device
2306 40 common/cmd_doc.c Image header has correct magic number
2307 41 common/cmd_ide.c before loading a Image from a IDE device
2308 -42 common/cmd_ide.c Bad usage of "ide" command
2309 42 common/cmd_ide.c correct usage of "ide" command
2310 -43 common/cmd_ide.c No boot device
2311 43 common/cmd_ide.c boot device found
2312 -44 common/cmd_ide.c Device not available
2313 44 common/cmd_ide.c Device available
2314 -45 common/cmd_ide.c wrong partition selected
2315 45 common/cmd_ide.c partition selected
2316 -46 common/cmd_ide.c Unknown partition table
2317 46 common/cmd_ide.c valid partition table found
2318 -47 common/cmd_ide.c Invalid partition type
2319 47 common/cmd_ide.c correct partition type
2320 -48 common/cmd_ide.c Error reading Image Header on boot device
2321 48 common/cmd_ide.c reading Image Header from IDE device OK
2322 -49 common/cmd_ide.c Image header has bad magic number
2323 49 common/cmd_ide.c Image header has correct magic number
2324 -50 common/cmd_ide.c Image header has bad checksum
2325 50 common/cmd_ide.c Image header has correct checksum
2326 -51 common/cmd_ide.c Error reading Image from IDE device
2327 51 common/cmd_ide.c reading Image from IDE device OK
2328 52 common/cmd_nand.c before loading a Image from a NAND device
2329 -53 common/cmd_nand.c Bad usage of "nand" command
2330 53 common/cmd_nand.c correct usage of "nand" command
2331 -54 common/cmd_nand.c No boot device
2332 54 common/cmd_nand.c boot device found
2333 -55 common/cmd_nand.c Unknown Chip ID on boot device
2334 55 common/cmd_nand.c correct chip ID found, device available
2335 -56 common/cmd_nand.c Error reading Image Header on boot device
2336 56 common/cmd_nand.c reading Image Header from NAND device OK
2337 -57 common/cmd_nand.c Image header has bad magic number
2338 57 common/cmd_nand.c Image header has correct magic number
2339 -58 common/cmd_nand.c Error reading Image from NAND device
2340 58 common/cmd_nand.c reading Image from NAND device OK
wdenkc6097192002-11-03 00:24:07 +00002341
Heiko Schocher566a4942007-06-22 19:11:54 +02002342 -60 common/env_common.c Environment has a bad CRC, using default
wdenkc6097192002-11-03 00:24:07 +00002343
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002344 64 net/eth.c starting with Ethernet configuration.
Heiko Schocher566a4942007-06-22 19:11:54 +02002345 -64 net/eth.c no Ethernet found.
2346 65 net/eth.c Ethernet found.
wdenk206c60c2003-09-18 10:02:25 +00002347
Heiko Schocher566a4942007-06-22 19:11:54 +02002348 -80 common/cmd_net.c usage wrong
Joe Hershbergerbc0571f2015-04-08 01:41:21 -05002349 80 common/cmd_net.c before calling net_loop()
2350 -81 common/cmd_net.c some error in net_loop() occurred
2351 81 common/cmd_net.c net_loop() back without error
Heiko Schocher566a4942007-06-22 19:11:54 +02002352 -82 common/cmd_net.c size == 0 (File with size 0 loaded)
2353 82 common/cmd_net.c trying automatic boot
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02002354 83 common/cmd_net.c running "source" command
2355 -83 common/cmd_net.c some error in automatic boot or "source" command
Heiko Schocher566a4942007-06-22 19:11:54 +02002356 84 common/cmd_net.c end without errors
wdenkc6097192002-11-03 00:24:07 +00002357
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002358FIT uImage format:
2359
2360 Arg Where When
2361 100 common/cmd_bootm.c Kernel FIT Image has correct format
2362 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format
2363 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration
2364 -101 common/cmd_bootm.c Can't get configuration for kernel subimage
2365 102 common/cmd_bootm.c Kernel unit name specified
2366 -103 common/cmd_bootm.c Can't get kernel subimage node offset
Marian Balakowiczf773bea2008-03-12 10:35:46 +01002367 103 common/cmd_bootm.c Found configuration node
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002368 104 common/cmd_bootm.c Got kernel subimage node offset
2369 -104 common/cmd_bootm.c Kernel subimage hash verification failed
2370 105 common/cmd_bootm.c Kernel subimage hash verification OK
2371 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture
2372 106 common/cmd_bootm.c Architecture check OK
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002373 -106 common/cmd_bootm.c Kernel subimage has wrong type
2374 107 common/cmd_bootm.c Kernel subimage type OK
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002375 -107 common/cmd_bootm.c Can't get kernel subimage data/size
2376 108 common/cmd_bootm.c Got kernel subimage data/size
2377 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT)
2378 -109 common/cmd_bootm.c Can't get kernel subimage type
2379 -110 common/cmd_bootm.c Can't get kernel subimage comp
2380 -111 common/cmd_bootm.c Can't get kernel subimage os
2381 -112 common/cmd_bootm.c Can't get kernel subimage load address
2382 -113 common/cmd_bootm.c Image uncompress/copy overwrite error
2383
2384 120 common/image.c Start initial ramdisk verification
2385 -120 common/image.c Ramdisk FIT image has incorrect format
2386 121 common/image.c Ramdisk FIT image has correct format
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002387 122 common/image.c No ramdisk subimage unit name, using configuration
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002388 -122 common/image.c Can't get configuration for ramdisk subimage
2389 123 common/image.c Ramdisk unit name specified
2390 -124 common/image.c Can't get ramdisk subimage node offset
2391 125 common/image.c Got ramdisk subimage node offset
2392 -125 common/image.c Ramdisk subimage hash verification failed
2393 126 common/image.c Ramdisk subimage hash verification OK
2394 -126 common/image.c Ramdisk subimage for unsupported architecture
2395 127 common/image.c Architecture check OK
2396 -127 common/image.c Can't get ramdisk subimage data/size
2397 128 common/image.c Got ramdisk subimage data/size
2398 129 common/image.c Can't get ramdisk load address
2399 -129 common/image.c Got ramdisk load address
2400
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002401 -130 common/cmd_doc.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002402 131 common/cmd_doc.c FIT image format OK
2403
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002404 -140 common/cmd_ide.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002405 141 common/cmd_ide.c FIT image format OK
2406
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002407 -150 common/cmd_nand.c Incorrect FIT image format
Marian Balakowicz1372cce2008-03-12 10:33:01 +01002408 151 common/cmd_nand.c FIT image format OK
2409
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002410- Standalone program support:
2411 CONFIG_STANDALONE_LOAD_ADDR
2412
Wolfgang Denk6feff892011-10-09 21:06:34 +02002413 This option defines a board specific value for the
2414 address where standalone program gets loaded, thus
2415 overwriting the architecture dependent default
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002416 settings.
2417
2418- Frame Buffer Address:
2419 CONFIG_FB_ADDR
2420
2421 Define CONFIG_FB_ADDR if you want to use specific
Wolfgang Denk44a53b52013-01-03 00:43:59 +00002422 address for frame buffer. This is typically the case
2423 when using a graphics controller has separate video
2424 memory. U-Boot will then place the frame buffer at
2425 the given address instead of dynamically reserving it
2426 in system RAM by calling lcd_setmem(), which grabs
2427 the memory for the frame buffer depending on the
2428 configured panel size.
Wolfgang Denk4cf26092011-10-07 09:58:21 +02002429
2430 Please see board_init_f function.
2431
Detlev Zundelcccfc2a2009-12-01 17:16:19 +01002432- Automatic software updates via TFTP server
2433 CONFIG_UPDATE_TFTP
2434 CONFIG_UPDATE_TFTP_CNT_MAX
2435 CONFIG_UPDATE_TFTP_MSEC_MAX
2436
2437 These options enable and control the auto-update feature;
2438 for a more detailed description refer to doc/README.update.
2439
2440- MTD Support (mtdparts command, UBI support)
2441 CONFIG_MTD_DEVICE
2442
2443 Adds the MTD device infrastructure from the Linux kernel.
2444 Needed for mtdparts command support.
2445
2446 CONFIG_MTD_PARTITIONS
2447
2448 Adds the MTD partitioning infrastructure from the Linux
2449 kernel. Needed for UBI support.
2450
Joe Hershberger70c219c2013-04-08 10:32:48 +00002451- UBI support
Heiko Schocherff94bc42014-06-24 10:10:04 +02002452 CONFIG_MTD_UBI_WL_THRESHOLD
2453 This parameter defines the maximum difference between the highest
2454 erase counter value and the lowest erase counter value of eraseblocks
2455 of UBI devices. When this threshold is exceeded, UBI starts performing
2456 wear leveling by means of moving data from eraseblock with low erase
2457 counter to eraseblocks with high erase counter.
2458
2459 The default value should be OK for SLC NAND flashes, NOR flashes and
2460 other flashes which have eraseblock life-cycle 100000 or more.
2461 However, in case of MLC NAND flashes which typically have eraseblock
2462 life-cycle less than 10000, the threshold should be lessened (e.g.,
2463 to 128 or 256, although it does not have to be power of 2).
2464
2465 default: 4096
Simon Glassc654b512014-10-23 18:58:54 -06002466
Heiko Schocherff94bc42014-06-24 10:10:04 +02002467 CONFIG_MTD_UBI_BEB_LIMIT
2468 This option specifies the maximum bad physical eraseblocks UBI
2469 expects on the MTD device (per 1024 eraseblocks). If the
2470 underlying flash does not admit of bad eraseblocks (e.g. NOR
2471 flash), this value is ignored.
2472
2473 NAND datasheets often specify the minimum and maximum NVM
2474 (Number of Valid Blocks) for the flashes' endurance lifetime.
2475 The maximum expected bad eraseblocks per 1024 eraseblocks
2476 then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2477 which gives 20 for most NANDs (MaxNVB is basically the total
2478 count of eraseblocks on the chip).
2479
2480 To put it differently, if this value is 20, UBI will try to
2481 reserve about 1.9% of physical eraseblocks for bad blocks
2482 handling. And that will be 1.9% of eraseblocks on the entire
2483 NAND chip, not just the MTD partition UBI attaches. This means
2484 that if you have, say, a NAND flash chip admits maximum 40 bad
2485 eraseblocks, and it is split on two MTD partitions of the same
2486 size, UBI will reserve 40 eraseblocks when attaching a
2487 partition.
2488
2489 default: 20
2490
2491 CONFIG_MTD_UBI_FASTMAP
2492 Fastmap is a mechanism which allows attaching an UBI device
2493 in nearly constant time. Instead of scanning the whole MTD device it
2494 only has to locate a checkpoint (called fastmap) on the device.