blob: ece479315f4cb8152fa86a5e1cd0fca6d21e4603 [file] [log] [blame]
wdenkc6097192002-11-03 00:24:07 +00001#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02002# (C) Copyright 2000 - 2013
wdenkc6097192002-11-03 00:24:07 +00003# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4#
Wolfgang Denkeca3aeb2013-06-21 10:22:36 +02005# SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00006#
7
8Summary:
9========
10
wdenk24ee89b2002-11-03 17:56:27 +000011This directory contains the source code for U-Boot, a boot loader for
wdenke86e5a02004-10-17 21:12:06 +000012Embedded boards based on PowerPC, ARM, MIPS and several other
13processors, which can be installed in a boot ROM and used to
14initialize and test the hardware or to download and run application
15code.
wdenkc6097192002-11-03 00:24:07 +000016
17The development of U-Boot is closely related to Linux: some parts of
wdenk24ee89b2002-11-03 17:56:27 +000018the source code originate in the Linux source tree, we have some
19header files in common, and special provision has been made to
wdenkc6097192002-11-03 00:24:07 +000020support booting of Linux images.
21
22Some attention has been paid to make this software easily
23configurable and extendable. For instance, all monitor commands are
24implemented with the same call interface, so that it's very easy to
25add new commands. Also, instead of permanently adding rarely used
26code (for instance hardware test utilities) to the monitor, you can
27load and run it dynamically.
28
29
30Status:
31=======
32
33In general, all boards for which a configuration option exists in the
wdenk24ee89b2002-11-03 17:56:27 +000034Makefile have been tested to some extent and can be considered
wdenkc6097192002-11-03 00:24:07 +000035"working". In fact, many of them are used in production systems.
36
Robert P. J. Day7207b362015-12-19 07:16:10 -050037In case of problems see the CHANGELOG file to find out who contributed
38the specific port. In addition, there are various MAINTAINERS files
39scattered throughout the U-Boot source identifying the people or
40companies responsible for various boards and subsystems.
wdenkc6097192002-11-03 00:24:07 +000041
Robert P. J. Day7207b362015-12-19 07:16:10 -050042Note: As of August, 2010, there is no longer a CHANGELOG file in the
43actual U-Boot source tree; however, it can be created dynamically
44from the Git log using:
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000045
46 make CHANGELOG
47
wdenkc6097192002-11-03 00:24:07 +000048
49Where to get help:
50==================
51
wdenk24ee89b2002-11-03 17:56:27 +000052In case you have questions about, problems with or contributions for
Robert P. J. Day7207b362015-12-19 07:16:10 -050053U-Boot, you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050054<u-boot@lists.denx.de>. There is also an archive of previous traffic
55on the mailing list - please search the archive before asking FAQ's.
56Please see http://lists.denx.de/pipermail/u-boot and
57http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000058
59
Wolfgang Denk218ca722008-03-26 10:40:12 +010060Where to get source code:
61=========================
62
Robert P. J. Day7207b362015-12-19 07:16:10 -050063The U-Boot source code is maintained in the Git repository at
Wolfgang Denk218ca722008-03-26 10:40:12 +010064git://www.denx.de/git/u-boot.git ; you can browse it online at
65http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66
67The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020068any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010069available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70directory.
71
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010072Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010073ftp://ftp.denx.de/pub/u-boot/images/
74
75
wdenkc6097192002-11-03 00:24:07 +000076Where we come from:
77===================
78
79- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000080- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000081- clean up code
82- make it easier to add custom boards
83- make it possible to add other [PowerPC] CPUs
84- extend functions, especially:
85 * Provide extended interface to Linux boot loader
86 * S-Record download
87 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020088 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000089- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000090- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000091- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020092- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000093
94
95Names and Spelling:
96===================
97
98The "official" name of this project is "Das U-Boot". The spelling
99"U-Boot" shall be used in all written text (documentation, comments
100in source files etc.). Example:
101
102 This is the README file for the U-Boot project.
103
104File names etc. shall be based on the string "u-boot". Examples:
105
106 include/asm-ppc/u-boot.h
107
108 #include <asm/u-boot.h>
109
110Variable names, preprocessor constants etc. shall be either based on
111the string "u_boot" or on "U_BOOT". Example:
112
113 U_BOOT_VERSION u_boot_logo
114 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000115
116
wdenk93f19cc2002-12-17 17:55:09 +0000117Versioning:
118===========
119
Thomas Weber360d8832010-09-28 08:06:25 +0200120Starting with the release in October 2008, the names of the releases
121were changed from numerical release numbers without deeper meaning
122into a time stamp based numbering. Regular releases are identified by
123names consisting of the calendar year and month of the release date.
124Additional fields (if present) indicate release candidates or bug fix
125releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000126
Thomas Weber360d8832010-09-28 08:06:25 +0200127Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000128 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200129 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
130 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000131
132
wdenkc6097192002-11-03 00:24:07 +0000133Directory Hierarchy:
134====================
135
Peter Tyser8d321b82010-04-12 22:28:21 -0500136/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900137 /arc Files generic to ARC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500138 /arm Files generic to ARM architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /avr32 Files generic to AVR32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500140 /blackfin Files generic to Analog Devices Blackfin architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500141 /m68k Files generic to m68k architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500142 /microblaze Files generic to microblaze architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500143 /mips Files generic to MIPS architecture
Macpaul Linafc1ce82011-10-19 20:41:11 +0000144 /nds32 Files generic to NDS32 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500145 /nios2 Files generic to Altera NIOS2 architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400146 /openrisc Files generic to OpenRISC architecture
Stefan Roesea47a12b2010-04-15 16:07:28 +0200147 /powerpc Files generic to PowerPC architecture
Robert P. J. Day7207b362015-12-19 07:16:10 -0500148 /sandbox Files generic to HW-independent "sandbox"
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sh Files generic to SH architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500150 /sparc Files generic to SPARC architecture
Robert P. J. Day33c77312013-09-15 18:34:15 -0400151 /x86 Files generic to x86 architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500152/api Machine/arch independent API for external apps
153/board Board dependent files
154/common Misc architecture independent functions
Robert P. J. Day7207b362015-12-19 07:16:10 -0500155/configs Board default configuration files
Peter Tyser8d321b82010-04-12 22:28:21 -0500156/disk Code for disk drive partition handling
157/doc Documentation (don't expect too much)
158/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400159/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500160/examples Example code for standalone applications, etc.
161/fs Filesystem code (cramfs, ext2, jffs2, etc.)
162/include Header Files
Robert P. J. Day7207b362015-12-19 07:16:10 -0500163/lib Library routines generic to all architectures
164/Licenses Various license files
Peter Tyser8d321b82010-04-12 22:28:21 -0500165/net Networking code
166/post Power On Self Test
Robert P. J. Day7207b362015-12-19 07:16:10 -0500167/scripts Various build scripts and Makefiles
168/test Various unit test files
Peter Tyser8d321b82010-04-12 22:28:21 -0500169/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000170
wdenkc6097192002-11-03 00:24:07 +0000171Software Configuration:
172=======================
173
174Configuration is usually done using C preprocessor defines; the
175rationale behind that is to avoid dead code whenever possible.
176
177There are two classes of configuration variables:
178
179* Configuration _OPTIONS_:
180 These are selectable by the user and have names beginning with
181 "CONFIG_".
182
183* Configuration _SETTINGS_:
184 These depend on the hardware etc. and should not be meddled with if
185 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200186 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000187
Robert P. J. Day7207b362015-12-19 07:16:10 -0500188Previously, all configuration was done by hand, which involved creating
189symbolic links and editing configuration files manually. More recently,
190U-Boot has added the Kbuild infrastructure used by the Linux kernel,
191allowing you to use the "make menuconfig" command to configure your
192build.
wdenkc6097192002-11-03 00:24:07 +0000193
194
195Selection of Processor Architecture and Board Type:
196---------------------------------------------------
197
198For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200199configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000200
201Example: For a TQM823L module type:
202
203 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200204 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000205
Robert P. J. Day7207b362015-12-19 07:16:10 -0500206Note: If you're looking for the default configuration file for a board
207you're sure used to be there but is now missing, check the file
208doc/README.scrapyard for a list of no longer supported boards.
wdenkc6097192002-11-03 00:24:07 +0000209
Simon Glass75b3c3a2014-03-22 17:12:59 -0600210Sandbox Environment:
211--------------------
212
213U-Boot can be built natively to run on a Linux host using the 'sandbox'
214board. This allows feature development which is not board- or architecture-
215specific to be undertaken on a native platform. The sandbox is also used to
216run some of U-Boot's tests.
217
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530218See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600219
220
Simon Glassdb910352015-03-03 08:03:00 -0700221Board Initialisation Flow:
222--------------------------
223
224This is the intended start-up flow for boards. This should apply for both
Robert P. J. Day7207b362015-12-19 07:16:10 -0500225SPL and U-Boot proper (i.e. they both follow the same rules).
Simon Glassdb910352015-03-03 08:03:00 -0700226
Robert P. J. Day7207b362015-12-19 07:16:10 -0500227Note: "SPL" stands for "Secondary Program Loader," which is explained in
228more detail later in this file.
229
230At present, SPL mostly uses a separate code path, but the function names
231and roles of each function are the same. Some boards or architectures
232may not conform to this. At least most ARM boards which use
233CONFIG_SPL_FRAMEWORK conform to this.
234
235Execution typically starts with an architecture-specific (and possibly
236CPU-specific) start.S file, such as:
237
238 - arch/arm/cpu/armv7/start.S
239 - arch/powerpc/cpu/mpc83xx/start.S
240 - arch/mips/cpu/start.S
241
242and so on. From there, three functions are called; the purpose and
243limitations of each of these functions are described below.
Simon Glassdb910352015-03-03 08:03:00 -0700244
245lowlevel_init():
246 - purpose: essential init to permit execution to reach board_init_f()
247 - no global_data or BSS
248 - there is no stack (ARMv7 may have one but it will soon be removed)
249 - must not set up SDRAM or use console
250 - must only do the bare minimum to allow execution to continue to
251 board_init_f()
252 - this is almost never needed
253 - return normally from this function
254
255board_init_f():
256 - purpose: set up the machine ready for running board_init_r():
257 i.e. SDRAM and serial UART
258 - global_data is available
259 - stack is in SRAM
260 - BSS is not available, so you cannot use global/static variables,
261 only stack variables and global_data
262
263 Non-SPL-specific notes:
264 - dram_init() is called to set up DRAM. If already done in SPL this
265 can do nothing
266
267 SPL-specific notes:
268 - you can override the entire board_init_f() function with your own
269 version as needed.
270 - preloader_console_init() can be called here in extremis
271 - should set up SDRAM, and anything needed to make the UART work
272 - these is no need to clear BSS, it will be done by crt0.S
273 - must return normally from this function (don't call board_init_r()
274 directly)
275
276Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
277this point the stack and global_data are relocated to below
278CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
279memory.
280
281board_init_r():
282 - purpose: main execution, common code
283 - global_data is available
284 - SDRAM is available
285 - BSS is available, all static/global variables can be used
286 - execution eventually continues to main_loop()
287
288 Non-SPL-specific notes:
289 - U-Boot is relocated to the top of memory and is now running from
290 there.
291
292 SPL-specific notes:
293 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
294 CONFIG_SPL_STACK_R_ADDR points into SDRAM
295 - preloader_console_init() can be called here - typically this is
296 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
297 spl_board_init() function containing this call
298 - loads U-Boot or (in falcon mode) Linux
299
300
301
wdenkc6097192002-11-03 00:24:07 +0000302Configuration Options:
303----------------------
304
305Configuration depends on the combination of board and CPU type; all
306such information is kept in a configuration file
307"include/configs/<board_name>.h".
308
309Example: For a TQM823L module, all configuration settings are in
310"include/configs/TQM823L.h".
311
312
wdenk7f6c2cb2002-11-10 22:06:23 +0000313Many of the options are named exactly as the corresponding Linux
314kernel configuration options. The intention is to make it easier to
315build a config tool - later.
316
317
wdenkc6097192002-11-03 00:24:07 +0000318The following options need to be configured:
319
Kim Phillips26281142007-08-10 13:28:25 -0500320- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000321
Kim Phillips26281142007-08-10 13:28:25 -0500322- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200323
324- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100325 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000326
327- CPU Module Type: (if CONFIG_COGENT is defined)
328 Define exactly one of
329 CONFIG_CMA286_60_OLD
330--- FIXME --- not tested yet:
331 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
332 CONFIG_CMA287_23, CONFIG_CMA287_50
333
334- Motherboard Type: (if CONFIG_COGENT is defined)
335 Define exactly one of
336 CONFIG_CMA101, CONFIG_CMA102
337
338- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
339 Define one or more of
340 CONFIG_CMA302
341
342- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
343 Define one or more of
344 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200345 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000346 a "rotator" |\-/|\-/
347
Lei Wencf946c62011-02-09 18:06:58 +0530348- Marvell Family Member
349 CONFIG_SYS_MVFS - define it if you want to enable
350 multiple fs option at one time
351 for marvell soc family
352
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200353- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000354 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
355 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000356 e.g. if there is no 32KHz
357 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000358 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
359 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000360
wdenk66ca92a2004-09-28 17:59:53 +0000361- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200362 CONFIG_SYS_8xx_CPUCLK_MIN
363 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000364 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000365 See doc/README.MPC866
366
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200367 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000368
wdenkba56f622004-02-06 23:19:44 +0000369 Define this to measure the actual CPU clock instead
370 of relying on the correctness of the configured
371 values. Mostly useful for board bringup to make sure
372 the PLL is locked at the intended frequency. Note
373 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200374 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000375
Heiko Schocher506f3912009-03-12 07:37:15 +0100376 CONFIG_SYS_DELAYED_ICACHE
377
378 Define this option if you want to enable the
379 ICache only when Code runs from RAM.
380
Kumar Gala66412c62011-02-18 05:40:54 -0600381- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000382 CONFIG_SYS_PPC64
383
384 Specifies that the core is a 64-bit PowerPC implementation (implements
385 the "64" category of the Power ISA). This is necessary for ePAPR
386 compliance, among other possible reasons.
387
Kumar Gala66412c62011-02-18 05:40:54 -0600388 CONFIG_SYS_FSL_TBCLK_DIV
389
390 Defines the core time base clock divider ratio compared to the
391 system clock. On most PQ3 devices this is 8, on newer QorIQ
392 devices it can be 16 or 32. The ratio varies from SoC to Soc.
393
Kumar Gala8f290842011-05-20 00:39:21 -0500394 CONFIG_SYS_FSL_PCIE_COMPAT
395
396 Defines the string to utilize when trying to match PCIe device
397 tree nodes for the given platform.
398
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000399 CONFIG_SYS_PPC_E500_DEBUG_TLB
400
401 Enables a temporary TLB entry to be used during boot to work
402 around limitations in e500v1 and e500v2 external debugger
403 support. This reduces the portions of the boot code where
404 breakpoints and single stepping do not work. The value of this
405 symbol should be set to the TLB1 entry to be used for this
406 purpose.
407
Scott Wood33eee332012-08-14 10:14:53 +0000408 CONFIG_SYS_FSL_ERRATUM_A004510
409
410 Enables a workaround for erratum A004510. If set,
411 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
413
414 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
415 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
416
417 Defines one or two SoC revisions (low 8 bits of SVR)
418 for which the A004510 workaround should be applied.
419
420 The rest of SVR is either not relevant to the decision
421 of whether the erratum is present (e.g. p2040 versus
422 p2041) or is implied by the build target, which controls
423 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
424
425 See Freescale App Note 4493 for more information about
426 this erratum.
427
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530428 CONFIG_A003399_NOR_WORKAROUND
429 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800430 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530431
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530432 CONFIG_A008044_WORKAROUND
433 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800434 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530435
Scott Wood33eee332012-08-14 10:14:53 +0000436 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
437
438 This is the value to write into CCSR offset 0x18600
439 according to the A004510 workaround.
440
Priyanka Jain64501c62013-07-02 09:21:04 +0530441 CONFIG_SYS_FSL_DSP_DDR_ADDR
442 This value denotes start offset of DDR memory which is
443 connected exclusively to the DSP cores.
444
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530445 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
446 This value denotes start offset of M2 memory
447 which is directly connected to the DSP core.
448
Priyanka Jain64501c62013-07-02 09:21:04 +0530449 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
450 This value denotes start offset of M3 memory which is directly
451 connected to the DSP core.
452
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530453 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
454 This value denotes start offset of DSP CCSR space.
455
Priyanka Jainb1359912013-12-17 14:25:52 +0530456 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
457 Single Source Clock is clocking mode present in some of FSL SoC's.
458 In this mode, a single differential clock is used to supply
459 clocks to the sysclock, ddrclock and usbclock.
460
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530461 CONFIG_SYS_CPC_REINIT_F
462 This CONFIG is defined when the CPC is configured as SRAM at the
463 time of U-boot entry and is required to be re-initialized.
464
Tang Yuantianaade2002014-04-17 15:33:46 +0800465 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800466 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800467 supported, core will start to execute uboot when wakes up.
468
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000469- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700470 CONFIG_SYS_GENERIC_GLOBAL_DATA
471 Defines global data is initialized in generic board board_init_f().
472 If this macro is defined, global data is created and cleared in
473 generic board board_init_f(). Without this macro, architecture/board
474 should initialize global data before calling board_init_f().
475
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000476 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
477
478 Defines the endianess of the CPU. Implementation of those
479 values is arch specific.
480
York Sun5614e712013-09-30 09:22:09 -0700481 CONFIG_SYS_FSL_DDR
482 Freescale DDR driver in use. This type of DDR controller is
483 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
484 SoCs.
485
486 CONFIG_SYS_FSL_DDR_ADDR
487 Freescale DDR memory-mapped register base.
488
489 CONFIG_SYS_FSL_DDR_EMU
490 Specify emulator support for DDR. Some DDR features such as
491 deskew training are not available.
492
493 CONFIG_SYS_FSL_DDRC_GEN1
494 Freescale DDR1 controller.
495
496 CONFIG_SYS_FSL_DDRC_GEN2
497 Freescale DDR2 controller.
498
499 CONFIG_SYS_FSL_DDRC_GEN3
500 Freescale DDR3 controller.
501
York Sun34e026f2014-03-27 17:54:47 -0700502 CONFIG_SYS_FSL_DDRC_GEN4
503 Freescale DDR4 controller.
504
York Sun9ac4ffb2013-09-30 14:20:51 -0700505 CONFIG_SYS_FSL_DDRC_ARM_GEN3
506 Freescale DDR3 controller for ARM-based SoCs.
507
York Sun5614e712013-09-30 09:22:09 -0700508 CONFIG_SYS_FSL_DDR1
509 Board config to use DDR1. It can be enabled for SoCs with
510 Freescale DDR1 or DDR2 controllers, depending on the board
511 implemetation.
512
513 CONFIG_SYS_FSL_DDR2
514 Board config to use DDR2. It can be eanbeld for SoCs with
515 Freescale DDR2 or DDR3 controllers, depending on the board
516 implementation.
517
518 CONFIG_SYS_FSL_DDR3
519 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700520 Freescale DDR3 or DDR3L controllers.
521
522 CONFIG_SYS_FSL_DDR3L
523 Board config to use DDR3L. It can be enabled for SoCs with
524 DDR3L controllers.
525
526 CONFIG_SYS_FSL_DDR4
527 Board config to use DDR4. It can be enabled for SoCs with
528 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700529
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530530 CONFIG_SYS_FSL_IFC_BE
531 Defines the IFC controller register space as Big Endian
532
533 CONFIG_SYS_FSL_IFC_LE
534 Defines the IFC controller register space as Little Endian
535
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530536 CONFIG_SYS_FSL_PBL_PBI
537 It enables addition of RCW (Power on reset configuration) in built image.
538 Please refer doc/README.pblimage for more details
539
540 CONFIG_SYS_FSL_PBL_RCW
541 It adds PBI(pre-boot instructions) commands in u-boot build image.
542 PBI commands can be used to configure SoC before it starts the execution.
543 Please refer doc/README.pblimage for more details
544
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530545 CONFIG_SPL_FSL_PBL
546 It adds a target to create boot binary having SPL binary in PBI format
547 concatenated with u-boot binary.
548
York Sun4e5b1bd2014-02-10 13:59:42 -0800549 CONFIG_SYS_FSL_DDR_BE
550 Defines the DDR controller register space as Big Endian
551
552 CONFIG_SYS_FSL_DDR_LE
553 Defines the DDR controller register space as Little Endian
554
York Sun6b9e3092014-02-10 13:59:43 -0800555 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
556 Physical address from the view of DDR controllers. It is the
557 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
558 it could be different for ARM SoCs.
559
York Sun6b1e1252014-02-10 13:59:44 -0800560 CONFIG_SYS_FSL_DDR_INTLV_256B
561 DDR controller interleaving on 256-byte. This is a special
562 interleaving mode, handled by Dickens for Freescale layerscape
563 SoCs with ARM core.
564
York Sun1d71efb2014-08-01 15:51:00 -0700565 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
566 Number of controllers used as main memory.
567
568 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
569 Number of controllers used for other than main memory.
570
Prabhakar Kushwaha44937212015-11-09 16:42:07 +0530571 CONFIG_SYS_FSL_HAS_DP_DDR
572 Defines the SoC has DP-DDR used for DPAA.
573
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530574 CONFIG_SYS_FSL_SEC_BE
575 Defines the SEC controller register space as Big Endian
576
577 CONFIG_SYS_FSL_SEC_LE
578 Defines the SEC controller register space as Little Endian
579
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100580- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200581 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100582
583 Defines the Monahans run mode to oscillator
584 ratio. Valid values are 8, 16, 24, 31. The core
585 frequency is this value multiplied by 13 MHz.
586
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200587 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200588
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100589 Defines the Monahans turbo mode to oscillator
590 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200591 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100592 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200593
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200594- MIPS CPU options:
595 CONFIG_SYS_INIT_SP_OFFSET
596
597 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
598 pointer. This is needed for the temporary stack before
599 relocation.
600
601 CONFIG_SYS_MIPS_CACHE_MODE
602
603 Cache operation mode for the MIPS CPU.
604 See also arch/mips/include/asm/mipsregs.h.
605 Possible values are:
606 CONF_CM_CACHABLE_NO_WA
607 CONF_CM_CACHABLE_WA
608 CONF_CM_UNCACHED
609 CONF_CM_CACHABLE_NONCOHERENT
610 CONF_CM_CACHABLE_CE
611 CONF_CM_CACHABLE_COW
612 CONF_CM_CACHABLE_CUW
613 CONF_CM_CACHABLE_ACCELERATED
614
615 CONFIG_SYS_XWAY_EBU_BOOTCFG
616
617 Special option for Lantiq XWAY SoCs for booting from NOR flash.
618 See also arch/mips/cpu/mips32/start.S.
619
620 CONFIG_XWAY_SWAP_BYTES
621
622 Enable compilation of tools/xway-swap-bytes needed for Lantiq
623 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
624 be swapped if a flash programmer is used.
625
Christian Rieschb67d8812012-02-02 00:44:39 +0000626- ARM options:
627 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
628
629 Select high exception vectors of the ARM core, e.g., do not
630 clear the V bit of the c1 register of CP15.
631
Aneesh V5356f542012-03-08 07:20:19 +0000632 CONFIG_SYS_THUMB_BUILD
633
634 Use this flag to build U-Boot using the Thumb instruction
635 set for ARM architectures. Thumb instruction set provides
636 better code density. For ARM architectures that support
637 Thumb2 this flag will result in Thumb2 code generated by
638 GCC.
639
Stephen Warrenc5d47522013-03-04 13:29:40 +0000640 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000641 CONFIG_ARM_ERRATA_742230
642 CONFIG_ARM_ERRATA_743622
643 CONFIG_ARM_ERRATA_751472
Nitin Gargb7588e32014-04-02 08:55:02 -0500644 CONFIG_ARM_ERRATA_761320
Ian Campbelle392b922015-09-29 10:27:09 +0100645 CONFIG_ARM_ERRATA_773022
646 CONFIG_ARM_ERRATA_774769
647 CONFIG_ARM_ERRATA_794072
Stephen Warren06785872013-02-26 12:28:27 +0000648
649 If set, the workarounds for these ARM errata are applied early
650 during U-Boot startup. Note that these options force the
651 workarounds to be applied; no CPU-type/version detection
652 exists, unlike the similar options in the Linux kernel. Do not
653 set these options unless they apply!
654
York Sun207774b2015-03-20 19:28:08 -0700655 COUNTER_FREQUENCY
656 Generic timer clock source frequency.
657
658 COUNTER_FREQUENCY_REAL
659 Generic timer clock source frequency if the real clock is
660 different from COUNTER_FREQUENCY, and can only be determined
661 at run time.
662
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500663 NOTE: The following can be machine specific errata. These
664 do have ability to provide rudimentary version and machine
665 specific checks, but expect no product checks.
Nishanth Menon5902f4c2015-03-09 17:12:01 -0500666 CONFIG_ARM_ERRATA_430973
Nishanth Menonb45c48a2015-03-09 17:12:00 -0500667 CONFIG_ARM_ERRATA_454179
Nishanth Menon9b4d65f2015-03-09 17:12:02 -0500668 CONFIG_ARM_ERRATA_621766
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500669 CONFIG_ARM_ERRATA_798870
Nishanth Menona615d0b2015-07-27 16:26:05 -0500670 CONFIG_ARM_ERRATA_801819
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500671
Stephen Warren73c38932015-01-19 16:25:52 -0700672- Tegra SoC options:
673 CONFIG_TEGRA_SUPPORT_NON_SECURE
674
675 Support executing U-Boot in non-secure (NS) mode. Certain
676 impossible actions will be skipped if the CPU is in NS mode,
677 such as ARM architectural timer initialization.
678
wdenk5da627a2003-10-09 20:09:04 +0000679- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000680 CONFIG_CLOCKS_IN_MHZ
681
682 U-Boot stores all clock information in Hz
683 internally. For binary compatibility with older Linux
684 kernels (which expect the clocks passed in the
685 bd_info data to be in MHz) the environment variable
686 "clocks_in_mhz" can be defined so that U-Boot
687 converts clock data to MHZ before passing it to the
688 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000689 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100690 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000691 default environment.
692
wdenk5da627a2003-10-09 20:09:04 +0000693 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
694
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800695 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000696 expect it to be in bytes, others in MB.
697 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
698
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400699 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200700
701 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400702 passed using flattened device trees (based on open firmware
703 concepts).
704
705 CONFIG_OF_LIBFDT
706 * New libfdt-based support
707 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500708 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400709
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200710 OF_CPU - The proper name of the cpus node (only required for
711 MPC512X and MPC5xxx based boards).
712 OF_SOC - The proper name of the soc node (only required for
713 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200714 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600715 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200716
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200717 boards with QUICC Engines require OF_QE to set UCC MAC
718 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500719
Kumar Gala4e253132006-01-11 13:54:17 -0600720 CONFIG_OF_BOARD_SETUP
721
722 Board code has addition modification that it wants to make
723 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000724
Simon Glassc654b512014-10-23 18:58:54 -0600725 CONFIG_OF_SYSTEM_SETUP
726
727 Other code has addition modification that it wants to make
728 to the flat device tree before handing it off to the kernel.
729 This causes ft_system_setup() to be called before booting
730 the kernel.
731
Matthew McClintock02677682006-06-28 10:41:37 -0500732 CONFIG_OF_BOOT_CPU
733
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200734 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500735 param header, the default value is zero if undefined.
736
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200737 CONFIG_OF_IDE_FIXUP
738
739 U-Boot can detect if an IDE device is present or not.
740 If not, and this new config option is activated, U-Boot
741 removes the ATA node from the DTS before booting Linux,
742 so the Linux IDE driver does not probe the device and
743 crash. This is needed for buggy hardware (uc101) where
744 no pull down resistor is connected to the signal IDE5V_DD7.
745
Igor Grinberg7eb29392011-07-14 05:45:07 +0000746 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
747
748 This setting is mandatory for all boards that have only one
749 machine type and must be used to specify the machine type
750 number as it appears in the ARM machine registry
751 (see http://www.arm.linux.org.uk/developer/machines/).
752 Only boards that have multiple machine types supported
753 in a single configuration file and the machine type is
754 runtime discoverable, do not have to use this setting.
755
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100756- vxWorks boot parameters:
757
758 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700759 environments variables: bootdev, bootfile, ipaddr, netmask,
760 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100761 It loads the vxWorks image pointed bootfile.
762
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100763 Note: If a "bootargs" environment is defined, it will overwride
764 the defaults discussed just above.
765
Aneesh V2c451f72011-06-16 23:30:47 +0000766- Cache Configuration:
767 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
768 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
769 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
770
Aneesh V93bc2192011-06-16 23:30:51 +0000771- Cache Configuration for ARM:
772 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
773 controller
774 CONFIG_SYS_PL310_BASE - Physical base address of PL310
775 controller register space
776
wdenk6705d812004-08-02 23:22:59 +0000777- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200778 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000779
780 Define this if you want support for Amba PrimeCell PL010 UARTs.
781
Andreas Engel48d01922008-09-08 14:30:53 +0200782 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000783
784 Define this if you want support for Amba PrimeCell PL011 UARTs.
785
786 CONFIG_PL011_CLOCK
787
788 If you have Amba PrimeCell PL011 UARTs, set this variable to
789 the clock speed of the UARTs.
790
791 CONFIG_PL01x_PORTS
792
793 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
794 define this to a list of base addresses for each (supported)
795 port. See e.g. include/configs/versatile.h
796
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400797 CONFIG_SERIAL_HW_FLOW_CONTROL
798
799 Define this variable to enable hw flow control in serial driver.
800 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000801
wdenkc6097192002-11-03 00:24:07 +0000802- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000803 Depending on board, define exactly one serial port
804 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
805 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
806 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000807
808 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
809 port routines must be defined elsewhere
810 (i.e. serial_init(), serial_getc(), ...)
811
812 CONFIG_CFB_CONSOLE
813 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000814 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000815 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
816 (default big endian)
817 VIDEO_HW_RECTFILL graphic chip supports
818 rectangle fill
819 (cf. smiLynxEM)
820 VIDEO_HW_BITBLT graphic chip supports
821 bit-blit (cf. smiLynxEM)
822 VIDEO_VISIBLE_COLS visible pixel columns
823 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000824 VIDEO_VISIBLE_ROWS visible pixel rows
825 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000826 VIDEO_DATA_FORMAT graphic data format
827 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000828 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000829 VIDEO_KBD_INIT_FCT keyboard int fct
Simon Glass39f615e2015-11-11 10:05:47 -0700830 (i.e. rx51_kp_init())
wdenkc6097192002-11-03 00:24:07 +0000831 VIDEO_TSTC_FCT test char fct
Simon Glass39f615e2015-11-11 10:05:47 -0700832 (i.e. rx51_kp_tstc)
wdenkc6097192002-11-03 00:24:07 +0000833 VIDEO_GETC_FCT get char fct
Simon Glass39f615e2015-11-11 10:05:47 -0700834 (i.e. rx51_kp_getc)
wdenkc6097192002-11-03 00:24:07 +0000835 CONFIG_VIDEO_LOGO display Linux logo in
836 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000837 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
838 linux_logo.h for logo.
839 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000840 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200841 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000842 the logo
843
Pali Rohár33a35bb2012-10-19 13:30:09 +0000844 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
845 a limited number of ANSI escape sequences (cursor control,
846 erase functions and limited graphics rendition control).
847
wdenk43d96162003-03-06 00:02:04 +0000848 When CONFIG_CFB_CONSOLE is defined, video console is
849 default i/o. Serial console can be forced with
850 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000851
wdenkd4ca31c2004-01-02 14:00:00 +0000852 When CONFIG_SILENT_CONSOLE is defined, all console
853 messages (by U-Boot and Linux!) can be silenced with
854 the "silent" environment variable. See
855 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000856
Heiko Schocher45ae2542013-10-22 11:06:06 +0200857 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
858 is 0x00.
859 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
860 is 0xa0.
861
wdenkc6097192002-11-03 00:24:07 +0000862- Console Baudrate:
863 CONFIG_BAUDRATE - in bps
864 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200865 CONFIG_SYS_BAUDRATE_TABLE, see below.
866 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000867
Heiko Schocherc92fac92009-01-30 12:55:38 +0100868- Console Rx buffer length
869 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
870 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100871 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100872 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
873 must be defined, to setup the maximum idle timeout for
874 the SMC.
875
Graeme Russ9558b482011-09-01 00:48:27 +0000876- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200877 Prior to the console being initialised (i.e. serial UART
878 initialised etc) all console output is silently discarded.
879 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
880 buffer any console messages prior to the console being
881 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
882 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
883 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200884 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200885 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000886
Hans de Goedea8552c72015-05-05 13:13:36 +0200887 Note that when printing the buffer a copy is made on the
888 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
889
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200890 'Sane' compilers will generate smaller code if
891 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000892
wdenkc6097192002-11-03 00:24:07 +0000893- Boot Delay: CONFIG_BOOTDELAY - in seconds
894 Delay before automatically booting the default image;
895 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000896 set to -2 to autoboot with no delay and not check for abort
897 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000898
899 See doc/README.autoboot for these options that
900 work with CONFIG_BOOTDELAY. None are required.
901 CONFIG_BOOT_RETRY_TIME
902 CONFIG_BOOT_RETRY_MIN
903 CONFIG_AUTOBOOT_KEYED
904 CONFIG_AUTOBOOT_PROMPT
905 CONFIG_AUTOBOOT_DELAY_STR
906 CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +0000907 CONFIG_ZERO_BOOTDELAY_CHECK
908 CONFIG_RESET_TO_RETRY
909
910- Autoboot Command:
911 CONFIG_BOOTCOMMAND
912 Only needed when CONFIG_BOOTDELAY is enabled;
913 define a command string that is automatically executed
914 when no character is read on the console interface
915 within "Boot Delay" after reset.
916
917 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000918 This can be used to pass arguments to the bootm
919 command. The value of CONFIG_BOOTARGS goes into the
920 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000921
922 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000923 The value of these goes into the environment as
924 "ramboot" and "nfsboot" respectively, and can be used
925 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200926 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000927
Heiko Schochereda0ba32013-11-04 14:04:59 +0100928- Bootcount:
929 CONFIG_BOOTCOUNT_LIMIT
930 Implements a mechanism for detecting a repeating reboot
931 cycle, see:
932 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
933
934 CONFIG_BOOTCOUNT_ENV
935 If no softreset save registers are found on the hardware
936 "bootcount" is stored in the environment. To prevent a
937 saveenv on all reboots, the environment variable
938 "upgrade_available" is used. If "upgrade_available" is
939 0, "bootcount" is always 0, if "upgrade_available" is
940 1 "bootcount" is incremented in the environment.
941 So the Userspace Applikation must set the "upgrade_available"
942 and "bootcount" variable to 0, if a boot was successfully.
943
wdenkc6097192002-11-03 00:24:07 +0000944- Pre-Boot Commands:
945 CONFIG_PREBOOT
946
947 When this option is #defined, the existence of the
948 environment variable "preboot" will be checked
949 immediately before starting the CONFIG_BOOTDELAY
950 countdown and/or running the auto-boot command resp.
951 entering interactive mode.
952
953 This feature is especially useful when "preboot" is
954 automatically generated or modified. For an example
955 see the LWMON board specific code: here "preboot" is
956 modified when the user holds down a certain
957 combination of keys on the (special) keyboard when
958 booting the systems
959
960- Serial Download Echo Mode:
961 CONFIG_LOADS_ECHO
962 If defined to 1, all characters received during a
963 serial download (using the "loads" command) are
964 echoed back. This might be needed by some terminal
965 emulations (like "cu"), but may as well just take
966 time on others. This setting #define's the initial
967 value of the "loads_echo" environment variable.
968
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500969- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000970 CONFIG_KGDB_BAUDRATE
971 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200972 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000973
974- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500975 Monitor commands can be included or excluded
976 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000977 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -0500978 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000979
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500980 The default command configuration includes all commands
981 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000982
Marek Vasutb401b732014-03-05 19:58:39 +0100983 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500984 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500985 CONFIG_CMD_BDI bdinfo
986 CONFIG_CMD_BEDBUG * Include BedBug Debugger
987 CONFIG_CMD_BMP * BMP support
988 CONFIG_CMD_BSP * Board specific commands
989 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400990 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500991 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800992 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500993 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500994 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500995 CONFIG_CMD_DATE * support for RTC, date/time...
996 CONFIG_CMD_DHCP * DHCP support
997 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600998 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
999 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1000 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1001 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001002 CONFIG_CMD_DTT * Digital Therm and Thermostat
1003 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001004 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001005 CONFIG_CMD_EEPROM * EEPROM read/write support
1006 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001007 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001008 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001009 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001010 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001011 CONFIG_CMD_EXT2 * ext2 command support
1012 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001013 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1014 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001015 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001016 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001017 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001018 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001019 CONFIG_CMD_FLASH flinfo, erase, protect
1020 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001021 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001022 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001023 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001024 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001025 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001026 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1027 CONFIG_CMD_I2C * I2C serial bus support
1028 CONFIG_CMD_IDE * IDE harddisk support
1029 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001030 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001031 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001032 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001033 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001034 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001035 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001036 CONFIG_CMD_IRQ * irqinfo
1037 CONFIG_CMD_ITEST Integer/string test of 2 values
1038 CONFIG_CMD_JFFS2 * JFFS2 Support
1039 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001040 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001041 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1042 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001043 CONFIG_CMD_LOADB loadb
1044 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001045 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001046 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001047 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001048 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001049 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001050 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001051 CONFIG_CMD_MISC Misc functions like sleep etc
1052 CONFIG_CMD_MMC * MMC memory mapped support
1053 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001054 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001055 CONFIG_CMD_NAND * NAND support
1056 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001057 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001058 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001059 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001060 CONFIG_CMD_PCI * pciinfo
1061 CONFIG_CMD_PCMCIA * PCMCIA support
1062 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1063 host
1064 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001065 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001066 CONFIG_CMD_REGINFO * Register dump
1067 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001068 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001069 CONFIG_CMD_SAVES * save S record dump
1070 CONFIG_CMD_SCSI * SCSI Support
1071 CONFIG_CMD_SDRAM * print SDRAM configuration information
1072 (requires CONFIG_CMD_I2C)
1073 CONFIG_CMD_SETGETDCR Support for DCR Register access
1074 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001075 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001076 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001077 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001078 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001079 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001080 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001081 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001082 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001083 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1084 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001085 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001086 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001087 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001088 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001089 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001090
1091 EXAMPLE: If you want all functions except of network
1092 support you can write:
1093
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001094 #include "config_cmd_all.h"
1095 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001096
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001097 Other Commands:
1098 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001099
1100 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001101 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001102 what you (and your U-Boot users) are doing. Data
1103 cache cannot be enabled on systems like the 8xx or
1104 8260 (where accesses to the IMMR region must be
1105 uncached), and it cannot be disabled on all other
1106 systems where we (mis-) use the data cache to hold an
1107 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001108
1109
1110 XXX - this list needs to get updated!
1111
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001112- Regular expression support:
1113 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001114 If this variable is defined, U-Boot is linked against
1115 the SLRE (Super Light Regular Expression) library,
1116 which adds regex support to some commands, as for
1117 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001118
Simon Glass45ba8072011-10-15 05:48:20 +00001119- Device tree:
1120 CONFIG_OF_CONTROL
1121 If this variable is defined, U-Boot will use a device tree
1122 to configure its devices, instead of relying on statically
1123 compiled #defines in the board file. This option is
1124 experimental and only available on a few boards. The device
1125 tree is available in the global data as gd->fdt_blob.
1126
Simon Glass2c0f79e2011-10-24 19:15:31 +00001127 U-Boot needs to get its device tree from somewhere. This can
1128 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001129
1130 CONFIG_OF_EMBED
1131 If this variable is defined, U-Boot will embed a device tree
1132 binary in its image. This device tree file should be in the
1133 board directory and called <soc>-<board>.dts. The binary file
1134 is then picked up in board_init_f() and made available through
1135 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001136
Simon Glass2c0f79e2011-10-24 19:15:31 +00001137 CONFIG_OF_SEPARATE
1138 If this variable is defined, U-Boot will build a device tree
1139 binary. It will be called u-boot.dtb. Architecture-specific
1140 code will locate it at run-time. Generally this works by:
1141
1142 cat u-boot.bin u-boot.dtb >image.bin
1143
1144 and in fact, U-Boot does this for you, creating a file called
1145 u-boot-dtb.bin which is useful in the common case. You can
1146 still use the individual files if you need something more
1147 exotic.
1148
wdenkc6097192002-11-03 00:24:07 +00001149- Watchdog:
1150 CONFIG_WATCHDOG
1151 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001152 support for the SoC. There must be support in the SoC
1153 specific code for a watchdog. For the 8xx and 8260
1154 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1155 register. When supported for a specific SoC is
1156 available, then no further board specific code should
1157 be needed to use it.
1158
1159 CONFIG_HW_WATCHDOG
1160 When using a watchdog circuitry external to the used
1161 SoC, then define this variable and provide board
1162 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001163
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001164 CONFIG_AT91_HW_WDT_TIMEOUT
1165 specify the timeout in seconds. default 2 seconds.
1166
stroesec1551ea2003-04-04 15:53:41 +00001167- U-Boot Version:
1168 CONFIG_VERSION_VARIABLE
1169 If this variable is defined, an environment variable
1170 named "ver" is created by U-Boot showing the U-Boot
1171 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001172 Any change to this variable will be reverted at the
1173 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001174
wdenkc6097192002-11-03 00:24:07 +00001175- Real-Time Clock:
1176
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001177 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001178 has to be selected, too. Define exactly one of the
1179 following options:
1180
1181 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1182 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001183 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001184 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001185 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001186 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001187 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001188 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001189 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001190 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001191 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001192 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001193 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1194 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001195
wdenkb37c7e52003-06-30 16:24:52 +00001196 Note that if the RTC uses I2C, then the I2C interface
1197 must also be configured. See I2C Support, below.
1198
Peter Tysere92739d2008-12-17 16:36:21 -06001199- GPIO Support:
1200 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001201
Chris Packham5dec49c2010-12-19 10:12:13 +00001202 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1203 chip-ngpio pairs that tell the PCA953X driver the number of
1204 pins supported by a particular chip.
1205
Peter Tysere92739d2008-12-17 16:36:21 -06001206 Note that if the GPIO device uses I2C, then the I2C interface
1207 must also be configured. See I2C Support, below.
1208
Simon Glassaa532332014-06-11 23:29:41 -06001209- I/O tracing:
1210 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1211 accesses and can checksum them or write a list of them out
1212 to memory. See the 'iotrace' command for details. This is
1213 useful for testing device drivers since it can confirm that
1214 the driver behaves the same way before and after a code
1215 change. Currently this is supported on sandbox and arm. To
1216 add support for your architecture, add '#include <iotrace.h>'
1217 to the bottom of arch/<arch>/include/asm/io.h and test.
1218
1219 Example output from the 'iotrace stats' command is below.
1220 Note that if the trace buffer is exhausted, the checksum will
1221 still continue to operate.
1222
1223 iotrace is enabled
1224 Start: 10000000 (buffer start address)
1225 Size: 00010000 (buffer size)
1226 Offset: 00000120 (current buffer offset)
1227 Output: 10000120 (start + offset)
1228 Count: 00000018 (number of trace records)
1229 CRC32: 9526fb66 (CRC32 of all trace records)
1230
wdenkc6097192002-11-03 00:24:07 +00001231- Timestamp Support:
1232
wdenk43d96162003-03-06 00:02:04 +00001233 When CONFIG_TIMESTAMP is selected, the timestamp
1234 (date and time) of an image is printed by image
1235 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001236 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001237
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001238- Partition Labels (disklabels) Supported:
1239 Zero or more of the following:
1240 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1241 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1242 Intel architecture, USB sticks, etc.
1243 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1244 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1245 bootloader. Note 2TB partition limit; see
1246 disk/part_efi.c
1247 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001248
Wolfgang Denk218ca722008-03-26 10:40:12 +01001249 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1250 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001251 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001252
1253- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001254 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1255 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001256
wdenk4d13cba2004-03-14 14:09:05 +00001257 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1258 be performed by calling the function
1259 ide_set_reset(int reset)
1260 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001261
1262- ATAPI Support:
1263 CONFIG_ATAPI
1264
1265 Set this to enable ATAPI support.
1266
wdenkc40b2952004-03-13 23:29:43 +00001267- LBA48 Support
1268 CONFIG_LBA48
1269
1270 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001271 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001272 Whithout these , LBA48 support uses 32bit variables and will 'only'
1273 support disks up to 2.1TB.
1274
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001275 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001276 When enabled, makes the IDE subsystem use 64bit sector addresses.
1277 Default is 32bit.
1278
wdenkc6097192002-11-03 00:24:07 +00001279- SCSI Support:
1280 At the moment only there is only support for the
1281 SYM53C8XX SCSI controller; define
1282 CONFIG_SCSI_SYM53C8XX to enable it.
1283
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001284 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1285 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1286 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001287 maximum numbers of LUNs, SCSI ID's and target
1288 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001289 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001290
Wolfgang Denk93e14592013-10-04 17:43:24 +02001291 The environment variable 'scsidevs' is set to the number of
1292 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001293
wdenkc6097192002-11-03 00:24:07 +00001294- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001295 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001296 Support for Intel 8254x/8257x gigabit chips.
1297
1298 CONFIG_E1000_SPI
1299 Utility code for direct access to the SPI bus on Intel 8257x.
1300 This does not do anything useful unless you set at least one
1301 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1302
1303 CONFIG_E1000_SPI_GENERIC
1304 Allow generic access to the SPI bus on the Intel 8257x, for
1305 example with the "sspi" command.
1306
1307 CONFIG_CMD_E1000
1308 Management command for E1000 devices. When used on devices
1309 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001310
wdenkc6097192002-11-03 00:24:07 +00001311 CONFIG_EEPRO100
1312 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001313 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001314 write routine for first time initialisation.
1315
1316 CONFIG_TULIP
1317 Support for Digital 2114x chips.
1318 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1319 modem chip initialisation (KS8761/QS6611).
1320
1321 CONFIG_NATSEMI
1322 Support for National dp83815 chips.
1323
1324 CONFIG_NS8382X
1325 Support for National dp8382[01] gigabit chips.
1326
wdenk45219c42003-05-12 21:50:16 +00001327- NETWORK Support (other):
1328
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001329 CONFIG_DRIVER_AT91EMAC
1330 Support for AT91RM9200 EMAC.
1331
1332 CONFIG_RMII
1333 Define this to use reduced MII inteface
1334
1335 CONFIG_DRIVER_AT91EMAC_QUIET
1336 If this defined, the driver is quiet.
1337 The driver doen't show link status messages.
1338
Rob Herringefdd7312011-12-15 11:15:49 +00001339 CONFIG_CALXEDA_XGMAC
1340 Support for the Calxeda XGMAC device
1341
Ashok3bb46d22012-10-15 06:20:47 +00001342 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001343 Support for SMSC's LAN91C96 chips.
1344
1345 CONFIG_LAN91C96_BASE
1346 Define this to hold the physical address
1347 of the LAN91C96's I/O space
1348
1349 CONFIG_LAN91C96_USE_32_BIT
1350 Define this to enable 32 bit addressing
1351
Ashok3bb46d22012-10-15 06:20:47 +00001352 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001353 Support for SMSC's LAN91C111 chip
1354
1355 CONFIG_SMC91111_BASE
1356 Define this to hold the physical address
1357 of the device (I/O space)
1358
1359 CONFIG_SMC_USE_32_BIT
1360 Define this if data bus is 32 bits
1361
1362 CONFIG_SMC_USE_IOFUNCS
1363 Define this to use i/o functions instead of macros
1364 (some hardware wont work with macros)
1365
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001366 CONFIG_DRIVER_TI_EMAC
1367 Support for davinci emac
1368
1369 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1370 Define this if you have more then 3 PHYs.
1371
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001372 CONFIG_FTGMAC100
1373 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1374
1375 CONFIG_FTGMAC100_EGIGA
1376 Define this to use GE link update with gigabit PHY.
1377 Define this if FTGMAC100 is connected to gigabit PHY.
1378 If your system has 10/100 PHY only, it might not occur
1379 wrong behavior. Because PHY usually return timeout or
1380 useless data when polling gigabit status and gigabit
1381 control registers. This behavior won't affect the
1382 correctnessof 10/100 link speed update.
1383
Mike Rapoportc2fff332009-11-11 10:03:03 +02001384 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001385 Support for SMSC's LAN911x and LAN921x chips
1386
Mike Rapoportc2fff332009-11-11 10:03:03 +02001387 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001388 Define this to hold the physical address
1389 of the device (I/O space)
1390
Mike Rapoportc2fff332009-11-11 10:03:03 +02001391 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001392 Define this if data bus is 32 bits
1393
Mike Rapoportc2fff332009-11-11 10:03:03 +02001394 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001395 Define this if data bus is 16 bits. If your processor
1396 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001397 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001398
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001399 CONFIG_SH_ETHER
1400 Support for Renesas on-chip Ethernet controller
1401
1402 CONFIG_SH_ETHER_USE_PORT
1403 Define the number of ports to be used
1404
1405 CONFIG_SH_ETHER_PHY_ADDR
1406 Define the ETH PHY's address
1407
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001408 CONFIG_SH_ETHER_CACHE_WRITEBACK
1409 If this option is set, the driver enables cache flush.
1410
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001411- PWM Support:
1412 CONFIG_PWM_IMX
1413 Support for PWM modul on the imx6.
1414
Vadim Bendebury5e124722011-10-17 08:36:14 +00001415- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001416 CONFIG_TPM
1417 Support TPM devices.
1418
Christophe Ricard0766ad22015-10-06 22:54:41 +02001419 CONFIG_TPM_TIS_INFINEON
1420 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001421 per system is supported at this time.
1422
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001423 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1424 Define the burst count bytes upper limit
1425
Dirk Eibachc01939c2013-06-26 15:55:15 +02001426 CONFIG_TPM_ATMEL_TWI
1427 Support for Atmel TWI TPM device. Requires I2C support.
1428
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001429 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001430 Support for generic parallel port TPM devices. Only one device
1431 per system is supported at this time.
1432
1433 CONFIG_TPM_TIS_BASE_ADDRESS
1434 Base address where the generic TPM device is mapped
1435 to. Contemporary x86 systems usually map it at
1436 0xfed40000.
1437
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001438 CONFIG_CMD_TPM
1439 Add tpm monitor functions.
1440 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1441 provides monitor access to authorized functions.
1442
1443 CONFIG_TPM
1444 Define this to enable the TPM support library which provides
1445 functional interfaces to some TPM commands.
1446 Requires support for a TPM device.
1447
1448 CONFIG_TPM_AUTH_SESSIONS
1449 Define this to enable authorized functions in the TPM library.
1450 Requires CONFIG_TPM and CONFIG_SHA1.
1451
wdenkc6097192002-11-03 00:24:07 +00001452- USB Support:
1453 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001454 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001455 CONFIG_USB_UHCI to enable it.
1456 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001457 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001458 storage devices.
1459 Note:
1460 Supported are USB Keyboards and USB Floppy drives
1461 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001462 MPC5200 USB requires additional defines:
1463 CONFIG_USB_CLOCK
1464 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001465 CONFIG_PSC3_USB
1466 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001467 CONFIG_USB_CONFIG
1468 for differential drivers: 0x00001000
1469 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001470 for differential drivers on PSC3: 0x00000100
1471 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001472 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001473 May be defined to allow interrupt polling
1474 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001475
Simon Glass9ab4ce22012-02-27 10:52:47 +00001476 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1477 txfilltuning field in the EHCI controller on reset.
1478
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001479 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1480 HW module registers.
1481
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001482- USB Device:
1483 Define the below if you wish to use the USB console.
1484 Once firmware is rebuilt from a serial console issue the
1485 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001486 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001487 it has found a new device. The environment variable usbtty
1488 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001489 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001490 Common Device Class Abstract Control Model serial device.
1491 If you select usbtty = gserial you should be able to enumerate
1492 a Linux host by
1493 # modprobe usbserial vendor=0xVendorID product=0xProductID
1494 else if using cdc_acm, simply setting the environment
1495 variable usbtty to be cdc_acm should suffice. The following
1496 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001497
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001498 CONFIG_USB_DEVICE
1499 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001500
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001501 CONFIG_USB_TTY
1502 Define this to have a tty type of device available to
1503 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001504
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301505 CONFIG_USBD_HS
1506 Define this to enable the high speed support for usb
1507 device and usbtty. If this feature is enabled, a routine
1508 int is_usbd_high_speed(void)
1509 also needs to be defined by the driver to dynamically poll
1510 whether the enumeration has succeded at high speed or full
1511 speed.
1512
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001513 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001514 Define this if you want stdin, stdout &/or stderr to
1515 be set to usbtty.
1516
1517 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001518 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001519 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001520 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001521
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001522 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001523 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001524 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001525
Wolfgang Denk386eda02006-06-14 18:14:56 +02001526 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001527 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001528 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001529 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1530 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1531 should pretend to be a Linux device to it's target host.
1532
1533 CONFIG_USBD_MANUFACTURER
1534 Define this string as the name of your company for
1535 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001536
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001537 CONFIG_USBD_PRODUCT_NAME
1538 Define this string as the name of your product
1539 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1540
1541 CONFIG_USBD_VENDORID
1542 Define this as your assigned Vendor ID from the USB
1543 Implementors Forum. This *must* be a genuine Vendor ID
1544 to avoid polluting the USB namespace.
1545 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001546
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001547 CONFIG_USBD_PRODUCTID
1548 Define this as the unique Product ID
1549 for your device
1550 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001551
Igor Grinbergd70a5602011-12-12 12:08:35 +02001552- ULPI Layer Support:
1553 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1554 the generic ULPI layer. The generic layer accesses the ULPI PHY
1555 via the platform viewport, so you need both the genric layer and
1556 the viewport enabled. Currently only Chipidea/ARC based
1557 viewport is supported.
1558 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1559 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001560 If your ULPI phy needs a different reference clock than the
1561 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1562 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001563
1564- MMC Support:
1565 The MMC controller on the Intel PXA is supported. To
1566 enable this define CONFIG_MMC. The MMC can be
1567 accessed from the boot prompt by mapping the device
1568 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001569 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1570 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001571
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001572 CONFIG_SH_MMCIF
1573 Support for Renesas on-chip MMCIF controller
1574
1575 CONFIG_SH_MMCIF_ADDR
1576 Define the base address of MMCIF registers
1577
1578 CONFIG_SH_MMCIF_CLK
1579 Define the clock frequency for MMCIF
1580
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001581 CONFIG_GENERIC_MMC
1582 Enable the generic MMC driver
1583
1584 CONFIG_SUPPORT_EMMC_BOOT
1585 Enable some additional features of the eMMC boot partitions.
1586
1587 CONFIG_SUPPORT_EMMC_RPMB
1588 Enable the commands for reading, writing and programming the
1589 key for the Replay Protection Memory Block partition in eMMC.
1590
Tom Rinib3ba6e92013-03-14 05:32:47 +00001591- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001592 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001593 This enables the USB portion of the DFU USB class
1594
1595 CONFIG_CMD_DFU
1596 This enables the command "dfu" which is used to have
1597 U-Boot create a DFU class device via USB. This command
1598 requires that the "dfu_alt_info" environment variable be
1599 set and define the alt settings to expose to the host.
1600
1601 CONFIG_DFU_MMC
1602 This enables support for exposing (e)MMC devices via DFU.
1603
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001604 CONFIG_DFU_NAND
1605 This enables support for exposing NAND devices via DFU.
1606
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301607 CONFIG_DFU_RAM
1608 This enables support for exposing RAM via DFU.
1609 Note: DFU spec refer to non-volatile memory usage, but
1610 allow usages beyond the scope of spec - here RAM usage,
1611 one that would help mostly the developer.
1612
Heiko Schochere7e75c72013-06-12 06:05:51 +02001613 CONFIG_SYS_DFU_DATA_BUF_SIZE
1614 Dfu transfer uses a buffer before writing data to the
1615 raw storage device. Make the size (in bytes) of this buffer
1616 configurable. The size of this buffer is also configurable
1617 through the "dfu_bufsiz" environment variable.
1618
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001619 CONFIG_SYS_DFU_MAX_FILE_SIZE
1620 When updating files rather than the raw storage device,
1621 we use a static buffer to copy the file into and then write
1622 the buffer once we've been given the whole file. Define
1623 this to the maximum filesize (in bytes) for the buffer.
1624 Default is 4 MiB if undefined.
1625
Heiko Schocher001a8312014-03-18 08:09:56 +01001626 DFU_DEFAULT_POLL_TIMEOUT
1627 Poll timeout [ms], is the timeout a device can send to the
1628 host. The host must wait for this timeout before sending
1629 a subsequent DFU_GET_STATUS request to the device.
1630
1631 DFU_MANIFEST_POLL_TIMEOUT
1632 Poll timeout [ms], which the device sends to the host when
1633 entering dfuMANIFEST state. Host waits this timeout, before
1634 sending again an USB request to the device.
1635
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001636- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001637 CONFIG_USB_FUNCTION_FASTBOOT
1638 This enables the USB part of the fastboot gadget
1639
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001640 CONFIG_CMD_FASTBOOT
1641 This enables the command "fastboot" which enables the Android
1642 fastboot mode for the platform's USB device. Fastboot is a USB
1643 protocol for downloading images, flashing and device control
1644 used on Android devices.
1645 See doc/README.android-fastboot for more information.
1646
1647 CONFIG_ANDROID_BOOT_IMAGE
1648 This enables support for booting images which use the Android
1649 image format header.
1650
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001651 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001652 The fastboot protocol requires a large memory buffer for
1653 downloads. Define this to the starting RAM address to use for
1654 downloaded images.
1655
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001656 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001657 The fastboot protocol requires a large memory buffer for
1658 downloads. This buffer should be as large as possible for a
1659 platform. Define this to the size available RAM for fastboot.
1660
Steve Raed1b5ed02014-08-26 11:47:28 -07001661 CONFIG_FASTBOOT_FLASH
1662 The fastboot protocol includes a "flash" command for writing
1663 the downloaded image to a non-volatile storage device. Define
1664 this to enable the "fastboot flash" command.
1665
1666 CONFIG_FASTBOOT_FLASH_MMC_DEV
1667 The fastboot "flash" command requires additional information
1668 regarding the non-volatile storage device. Define this to
1669 the eMMC device that fastboot should use to store the image.
1670
Steve Rae0ff7e582014-12-12 15:51:54 -08001671 CONFIG_FASTBOOT_GPT_NAME
1672 The fastboot "flash" command supports writing the downloaded
1673 image to the Protective MBR and the Primary GUID Partition
1674 Table. (Additionally, this downloaded image is post-processed
1675 to generate and write the Backup GUID Partition Table.)
1676 This occurs when the specified "partition name" on the
1677 "fastboot flash" command line matches this value.
1678 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1679
wdenk6705d812004-08-02 23:22:59 +00001680- Journaling Flash filesystem support:
1681 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1682 CONFIG_JFFS2_NAND_DEV
1683 Define these for a default partition on a NAND device
1684
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001685 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1686 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001687 Define these for a default partition on a NOR device
1688
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001689 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001690 Define this to create an own partition. You have to provide a
1691 function struct part_info* jffs2_part_info(int part_num)
1692
1693 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001694 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001695 to disable the command chpart. This is the default when you
1696 have not defined a custom partition
1697
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001698- FAT(File Allocation Table) filesystem write function support:
1699 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001700
1701 Define this to enable support for saving memory data as a
1702 file in FAT formatted partition.
1703
1704 This will also enable the command "fatwrite" enabling the
1705 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001706
Gabe Black84cd9322012-10-12 14:26:11 +00001707CBFS (Coreboot Filesystem) support
1708 CONFIG_CMD_CBFS
1709
1710 Define this to enable support for reading from a Coreboot
1711 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1712 and cbfsload.
1713
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301714- FAT(File Allocation Table) filesystem cluster size:
1715 CONFIG_FS_FAT_MAX_CLUSTSIZE
1716
1717 Define the max cluster size for fat operations else
1718 a default value of 65536 will be defined.
1719
wdenkc6097192002-11-03 00:24:07 +00001720- Keyboard Support:
Simon Glass39f615e2015-11-11 10:05:47 -07001721 See Kconfig help for available keyboard drivers.
1722
1723 CONFIG_KEYBOARD
1724
1725 Define this to enable a custom keyboard support.
1726 This simply calls drv_keyboard_init() which must be
1727 defined in your board-specific files. This option is deprecated
1728 and is only used by novena. For new boards, use driver model
1729 instead.
wdenkc6097192002-11-03 00:24:07 +00001730
1731- Video support:
1732 CONFIG_VIDEO
1733
1734 Define this to enable video support (for output to
1735 video).
1736
1737 CONFIG_VIDEO_CT69000
1738
1739 Enable Chips & Technologies 69000 Video chip
1740
1741 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001742 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001743 video output is selected via environment 'videoout'
1744 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1745 assumed.
wdenkc6097192002-11-03 00:24:07 +00001746
wdenkb79a11c2004-03-25 15:14:43 +00001747 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001748 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001749 are possible:
1750 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001751 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001752
1753 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1754 -------------+---------------------------------------------
1755 8 bits | 0x301* 0x303 0x305 0x161 0x307
1756 15 bits | 0x310 0x313 0x316 0x162 0x319
1757 16 bits | 0x311 0x314 0x317 0x163 0x31A
1758 24 bits | 0x312 0x315 0x318 ? 0x31B
1759 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001760 (i.e. setenv videomode 317; saveenv; reset;)
1761
wdenkb79a11c2004-03-25 15:14:43 +00001762 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001763 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001764
1765
stroesec1551ea2003-04-04 15:53:41 +00001766 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001767 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001768 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1769 or CONFIG_VIDEO_SED13806_16BPP
1770
Timur Tabi7d3053f2011-02-15 17:09:19 -06001771 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001772 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001773 SOCs that have a DIU should define this macro to enable DIU
1774 support, and should also define these other macros:
1775
1776 CONFIG_SYS_DIU_ADDR
1777 CONFIG_VIDEO
1778 CONFIG_CMD_BMP
1779 CONFIG_CFB_CONSOLE
1780 CONFIG_VIDEO_SW_CURSOR
1781 CONFIG_VGA_AS_SINGLE_DEVICE
1782 CONFIG_VIDEO_LOGO
1783 CONFIG_VIDEO_BMP_LOGO
1784
Timur Tabiba8e76b2011-04-11 14:18:22 -05001785 The DIU driver will look for the 'video-mode' environment
1786 variable, and if defined, enable the DIU as a console during
1787 boot. See the documentation file README.video for a
1788 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001789
wdenkc6097192002-11-03 00:24:07 +00001790- LCD Support: CONFIG_LCD
1791
1792 Define this to enable LCD support (for output to LCD
1793 display); also select one of the supported displays
1794 by defining one of these:
1795
Stelian Pop39cf4802008-05-09 21:57:18 +02001796 CONFIG_ATMEL_LCD:
1797
1798 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1799
wdenkfd3103b2003-11-25 16:55:19 +00001800 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001801
wdenkfd3103b2003-11-25 16:55:19 +00001802 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001803
wdenkfd3103b2003-11-25 16:55:19 +00001804 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001805
wdenkfd3103b2003-11-25 16:55:19 +00001806 NEC NL6448BC20-08. 6.5", 640x480.
1807 Active, color, single scan.
1808
1809 CONFIG_NEC_NL6448BC33_54
1810
1811 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001812 Active, color, single scan.
1813
1814 CONFIG_SHARP_16x9
1815
1816 Sharp 320x240. Active, color, single scan.
1817 It isn't 16x9, and I am not sure what it is.
1818
1819 CONFIG_SHARP_LQ64D341
1820
1821 Sharp LQ64D341 display, 640x480.
1822 Active, color, single scan.
1823
1824 CONFIG_HLD1045
1825
1826 HLD1045 display, 640x480.
1827 Active, color, single scan.
1828
1829 CONFIG_OPTREX_BW
1830
1831 Optrex CBL50840-2 NF-FW 99 22 M5
1832 or
1833 Hitachi LMG6912RPFC-00T
1834 or
1835 Hitachi SP14Q002
1836
1837 320x240. Black & white.
1838
1839 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001840 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001841
Simon Glass676d3192012-10-17 13:24:54 +00001842 CONFIG_LCD_ALIGNMENT
1843
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001844 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001845 defined then the LCD will be aligned to this value instead.
1846 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1847 here, since it is cheaper to change data cache settings on
1848 a per-section basis.
1849
Simon Glass0d89efe2012-10-17 13:24:59 +00001850 CONFIG_CONSOLE_SCROLL_LINES
1851
1852 When the console need to be scrolled, this is the number of
1853 lines to scroll by. It defaults to 1. Increasing this makes
1854 the console jump but can help speed up operation when scrolling
1855 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001856
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001857 CONFIG_LCD_ROTATION
1858
1859 Sometimes, for example if the display is mounted in portrait
1860 mode or even if it's mounted landscape but rotated by 180degree,
1861 we need to rotate our content of the display relative to the
1862 framebuffer, so that user can read the messages which are
1863 printed out.
1864 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1865 initialized with a given rotation from "vl_rot" out of
1866 "vidinfo_t" which is provided by the board specific code.
1867 The value for vl_rot is coded as following (matching to
1868 fbcon=rotate:<n> linux-kernel commandline):
1869 0 = no rotation respectively 0 degree
1870 1 = 90 degree rotation
1871 2 = 180 degree rotation
1872 3 = 270 degree rotation
1873
1874 If CONFIG_LCD_ROTATION is not defined, the console will be
1875 initialized with 0degree rotation.
1876
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001877 CONFIG_LCD_BMP_RLE8
1878
1879 Support drawing of RLE8-compressed bitmaps on the LCD.
1880
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001881 CONFIG_I2C_EDID
1882
1883 Enables an 'i2c edid' command which can read EDID
1884 information over I2C from an attached LCD display.
1885
wdenk7152b1d2003-09-05 23:19:14 +00001886- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001887
wdenk8bde7f72003-06-27 21:31:46 +00001888 If this option is set, the environment is checked for
1889 a variable "splashimage". If found, the usual display
1890 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001891 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001892 specified in "splashimage" is loaded instead. The
1893 console is redirected to the "nulldev", too. This
1894 allows for a "silent" boot where a splash screen is
1895 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001896
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001897 CONFIG_SPLASHIMAGE_GUARD
1898
1899 If this option is set, then U-Boot will prevent the environment
1900 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001901 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001902 This option is useful for targets where, due to alignment
1903 restrictions, an improperly aligned BMP image will cause a data
1904 abort. If you think you will not have problems with unaligned
1905 accesses (for example because your toolchain prevents them)
1906 there is no need to set this option.
1907
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001908 CONFIG_SPLASH_SCREEN_ALIGN
1909
1910 If this option is set the splash image can be freely positioned
1911 on the screen. Environment variable "splashpos" specifies the
1912 position as "x,y". If a positive number is given it is used as
1913 number of pixel from left/top. If a negative number is given it
1914 is used as number of pixel from right/bottom. You can also
1915 specify 'm' for centering the image.
1916
1917 Example:
1918 setenv splashpos m,m
1919 => image at center of screen
1920
1921 setenv splashpos 30,20
1922 => image at x = 30 and y = 20
1923
1924 setenv splashpos -10,m
1925 => vertically centered image
1926 at x = dspWidth - bmpWidth - 9
1927
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001928- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1929
1930 If this option is set, additionally to standard BMP
1931 images, gzipped BMP images can be displayed via the
1932 splashscreen support or the bmp command.
1933
Anatolij Gustschind5011762010-03-15 14:50:25 +01001934- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1935
1936 If this option is set, 8-bit RLE compressed BMP images
1937 can be displayed via the splashscreen support or the
1938 bmp command.
1939
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001940- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00001941 CONFIG_CMD_ZIP
1942
1943 If this option is set, it would use zlib deflate method
1944 to compress the specified memory at its best effort.
1945
wdenkc29fdfc2003-08-29 20:57:53 +00001946- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001947 CONFIG_GZIP
1948
1949 Enabled by default to support gzip compressed images.
1950
wdenkc29fdfc2003-08-29 20:57:53 +00001951 CONFIG_BZIP2
1952
1953 If this option is set, support for bzip2 compressed
1954 images is included. If not, only uncompressed and gzip
1955 compressed images are supported.
1956
wdenk42d1f032003-10-15 23:53:47 +00001957 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001958 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001959 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001960
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001961 CONFIG_LZMA
1962
1963 If this option is set, support for lzma compressed
1964 images is included.
1965
1966 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1967 requires an amount of dynamic memory that is given by the
1968 formula:
1969
1970 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1971
1972 Where lc and lp stand for, respectively, Literal context bits
1973 and Literal pos bits.
1974
1975 This value is upper-bounded by 14MB in the worst case. Anyway,
1976 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1977 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1978 a very small buffer.
1979
1980 Use the lzmainfo tool to determinate the lc and lp values and
1981 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001982 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001983
Kees Cook8ef70472013-08-16 07:59:12 -07001984 CONFIG_LZO
1985
1986 If this option is set, support for LZO compressed images
1987 is included.
1988
wdenk17ea1172004-06-06 21:51:03 +00001989- MII/PHY support:
1990 CONFIG_PHY_ADDR
1991
1992 The address of PHY on MII bus.
1993
1994 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1995
1996 The clock frequency of the MII bus
1997
1998 CONFIG_PHY_GIGE
1999
2000 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002001 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002002
2003 CONFIG_PHY_RESET_DELAY
2004
2005 Some PHY like Intel LXT971A need extra delay after
2006 reset before any MII register access is possible.
2007 For such PHY, set this option to the usec delay
2008 required. (minimum 300usec for LXT971A)
2009
2010 CONFIG_PHY_CMD_DELAY (ppc4xx)
2011
2012 Some PHY like Intel LXT971A need extra delay after
2013 command issued before MII status register can be read
2014
wdenkc6097192002-11-03 00:24:07 +00002015- IP address:
2016 CONFIG_IPADDR
2017
2018 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002019 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002020 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002021 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002022
2023- Server IP address:
2024 CONFIG_SERVERIP
2025
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002026 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002027 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002028 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002029
Robin Getz97cfe862009-07-21 12:15:28 -04002030 CONFIG_KEEP_SERVERADDR
2031
2032 Keeps the server's MAC address, in the env 'serveraddr'
2033 for passing to bootargs (like Linux's netconsole option)
2034
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002035- Gateway IP address:
2036 CONFIG_GATEWAYIP
2037
2038 Defines a default value for the IP address of the
2039 default router where packets to other networks are
2040 sent to.
2041 (Environment variable "gatewayip")
2042
2043- Subnet mask:
2044 CONFIG_NETMASK
2045
2046 Defines a default value for the subnet mask (or
2047 routing prefix) which is used to determine if an IP
2048 address belongs to the local subnet or needs to be
2049 forwarded through a router.
2050 (Environment variable "netmask")
2051
David Updegraff53a5c422007-06-11 10:41:07 -05002052- Multicast TFTP Mode:
2053 CONFIG_MCAST_TFTP
2054
2055 Defines whether you want to support multicast TFTP as per
2056 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002057 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002058 driver in use must provide a function: mcast() to join/leave a
2059 multicast group.
2060
wdenkc6097192002-11-03 00:24:07 +00002061- BOOTP Recovery Mode:
2062 CONFIG_BOOTP_RANDOM_DELAY
2063
2064 If you have many targets in a network that try to
2065 boot using BOOTP, you may want to avoid that all
2066 systems send out BOOTP requests at precisely the same
2067 moment (which would happen for instance at recovery
2068 from a power failure, when all systems will try to
2069 boot, thus flooding the BOOTP server. Defining
2070 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2071 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002072 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002073
2074 1st BOOTP request: delay 0 ... 1 sec
2075 2nd BOOTP request: delay 0 ... 2 sec
2076 3rd BOOTP request: delay 0 ... 4 sec
2077 4th and following
2078 BOOTP requests: delay 0 ... 8 sec
2079
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002080 CONFIG_BOOTP_ID_CACHE_SIZE
2081
2082 BOOTP packets are uniquely identified using a 32-bit ID. The
2083 server will copy the ID from client requests to responses and
2084 U-Boot will use this to determine if it is the destination of
2085 an incoming response. Some servers will check that addresses
2086 aren't in use before handing them out (usually using an ARP
2087 ping) and therefore take up to a few hundred milliseconds to
2088 respond. Network congestion may also influence the time it
2089 takes for a response to make it back to the client. If that
2090 time is too long, U-Boot will retransmit requests. In order
2091 to allow earlier responses to still be accepted after these
2092 retransmissions, U-Boot's BOOTP client keeps a small cache of
2093 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2094 cache. The default is to keep IDs for up to four outstanding
2095 requests. Increasing this will allow U-Boot to accept offers
2096 from a BOOTP client in networks with unusually high latency.
2097
stroesefe389a82003-08-28 14:17:32 +00002098- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002099 You can fine tune the DHCP functionality by defining
2100 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002101
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002102 CONFIG_BOOTP_SUBNETMASK
2103 CONFIG_BOOTP_GATEWAY
2104 CONFIG_BOOTP_HOSTNAME
2105 CONFIG_BOOTP_NISDOMAIN
2106 CONFIG_BOOTP_BOOTPATH
2107 CONFIG_BOOTP_BOOTFILESIZE
2108 CONFIG_BOOTP_DNS
2109 CONFIG_BOOTP_DNS2
2110 CONFIG_BOOTP_SEND_HOSTNAME
2111 CONFIG_BOOTP_NTPSERVER
2112 CONFIG_BOOTP_TIMEOFFSET
2113 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002114 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002115
Wilson Callan5d110f02007-07-28 10:56:13 -04002116 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2117 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002118
Joe Hershberger2c00e092012-05-23 07:59:19 +00002119 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2120 after the configured retry count, the call will fail
2121 instead of starting over. This can be used to fail over
2122 to Link-local IP address configuration if the DHCP server
2123 is not available.
2124
stroesefe389a82003-08-28 14:17:32 +00002125 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2126 serverip from a DHCP server, it is possible that more
2127 than one DNS serverip is offered to the client.
2128 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2129 serverip will be stored in the additional environment
2130 variable "dnsip2". The first DNS serverip is always
2131 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002132 is defined.
stroesefe389a82003-08-28 14:17:32 +00002133
2134 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2135 to do a dynamic update of a DNS server. To do this, they
2136 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002137 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002138 of the "hostname" environment variable is passed as
2139 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002140
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002141 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2142
2143 A 32bit value in microseconds for a delay between
2144 receiving a "DHCP Offer" and sending the "DHCP Request".
2145 This fixes a problem with certain DHCP servers that don't
2146 respond 100% of the time to a "DHCP request". E.g. On an
2147 AT91RM9200 processor running at 180MHz, this delay needed
2148 to be *at least* 15,000 usec before a Windows Server 2003
2149 DHCP server would reply 100% of the time. I recommend at
2150 least 50,000 usec to be safe. The alternative is to hope
2151 that one of the retries will be successful but note that
2152 the DHCP timeout and retry process takes a longer than
2153 this delay.
2154
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002155 - Link-local IP address negotiation:
2156 Negotiate with other link-local clients on the local network
2157 for an address that doesn't require explicit configuration.
2158 This is especially useful if a DHCP server cannot be guaranteed
2159 to exist in all environments that the device must operate.
2160
2161 See doc/README.link-local for more information.
2162
wdenka3d991b2004-04-15 21:48:45 +00002163 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002164 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002165
2166 The device id used in CDP trigger frames.
2167
2168 CONFIG_CDP_DEVICE_ID_PREFIX
2169
2170 A two character string which is prefixed to the MAC address
2171 of the device.
2172
2173 CONFIG_CDP_PORT_ID
2174
2175 A printf format string which contains the ascii name of
2176 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002177 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002178
2179 CONFIG_CDP_CAPABILITIES
2180
2181 A 32bit integer which indicates the device capabilities;
2182 0x00000010 for a normal host which does not forwards.
2183
2184 CONFIG_CDP_VERSION
2185
2186 An ascii string containing the version of the software.
2187
2188 CONFIG_CDP_PLATFORM
2189
2190 An ascii string containing the name of the platform.
2191
2192 CONFIG_CDP_TRIGGER
2193
2194 A 32bit integer sent on the trigger.
2195
2196 CONFIG_CDP_POWER_CONSUMPTION
2197
2198 A 16bit integer containing the power consumption of the
2199 device in .1 of milliwatts.
2200
2201 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2202
2203 A byte containing the id of the VLAN.
2204
wdenkc6097192002-11-03 00:24:07 +00002205- Status LED: CONFIG_STATUS_LED
2206
2207 Several configurations allow to display the current
2208 status using a LED. For instance, the LED will blink
2209 fast while running U-Boot code, stop blinking as
2210 soon as a reply to a BOOTP request was received, and
2211 start blinking slow once the Linux kernel is running
2212 (supported by a status LED driver in the Linux
2213 kernel). Defining CONFIG_STATUS_LED enables this
2214 feature in U-Boot.
2215
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002216 Additional options:
2217
2218 CONFIG_GPIO_LED
2219 The status LED can be connected to a GPIO pin.
2220 In such cases, the gpio_led driver can be used as a
2221 status LED backend implementation. Define CONFIG_GPIO_LED
2222 to include the gpio_led driver in the U-Boot binary.
2223
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002224 CONFIG_GPIO_LED_INVERTED_TABLE
2225 Some GPIO connected LEDs may have inverted polarity in which
2226 case the GPIO high value corresponds to LED off state and
2227 GPIO low value corresponds to LED on state.
2228 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2229 with a list of GPIO LEDs that have inverted polarity.
2230
wdenkc6097192002-11-03 00:24:07 +00002231- CAN Support: CONFIG_CAN_DRIVER
2232
2233 Defining CONFIG_CAN_DRIVER enables CAN driver support
2234 on those systems that support this (optional)
2235 feature, like the TQM8xxL modules.
2236
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002237- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002238
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002239 This enable the NEW i2c subsystem, and will allow you to use
2240 i2c commands at the u-boot command line (as long as you set
2241 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2242 based realtime clock chips or other i2c devices. See
2243 common/cmd_i2c.c for a description of the command line
2244 interface.
2245
2246 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002247 - drivers/i2c/soft_i2c.c:
2248 - activate first bus with CONFIG_SYS_I2C_SOFT define
2249 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2250 for defining speed and slave address
2251 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2252 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2253 for defining speed and slave address
2254 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2255 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2256 for defining speed and slave address
2257 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2258 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2259 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002260
Heiko Schocher00f792e2012-10-24 13:48:22 +02002261 - drivers/i2c/fsl_i2c.c:
2262 - activate i2c driver with CONFIG_SYS_I2C_FSL
2263 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2264 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2265 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2266 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002267 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002268 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2269 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2270 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2271 second bus.
2272
Simon Glass1f2ba722012-10-30 07:28:53 +00002273 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002274 - activate this driver with CONFIG_SYS_I2C_TEGRA
2275 - This driver adds 4 i2c buses with a fix speed from
2276 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002277
Dirk Eibach880540d2013-04-25 02:40:01 +00002278 - drivers/i2c/ppc4xx_i2c.c
2279 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2280 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2281 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2282
tremfac96402013-09-21 18:13:35 +02002283 - drivers/i2c/i2c_mxc.c
2284 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002285 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2286 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2287 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2288 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002289 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2290 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2291 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2292 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2293 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2294 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002295 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2296 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002297 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002298 for speed, and 0 for slave.
2299
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002300 - drivers/i2c/rcar_i2c.c:
2301 - activate this driver with CONFIG_SYS_I2C_RCAR
2302 - This driver adds 4 i2c buses
2303
2304 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2305 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2306 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2307 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2308 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2309 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2310 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2311 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2312 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2313
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002314 - drivers/i2c/sh_i2c.c:
2315 - activate this driver with CONFIG_SYS_I2C_SH
2316 - This driver adds from 2 to 5 i2c buses
2317
2318 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2319 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2320 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2321 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2322 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2323 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2324 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2325 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2326 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2327 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2328 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2329 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002330 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002331
Heiko Schocher6789e842013-10-22 11:03:18 +02002332 - drivers/i2c/omap24xx_i2c.c
2333 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2334 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2335 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2336 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2337 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2338 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2339 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2340 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2341 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2342 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2343 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2344
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002345 - drivers/i2c/zynq_i2c.c
2346 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2347 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2348 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2349
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302350 - drivers/i2c/s3c24x0_i2c.c:
2351 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2352 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2353 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2354 with a fix speed from 100000 and the slave addr 0!
2355
Dirk Eibachb46226b2014-07-03 09:28:18 +02002356 - drivers/i2c/ihs_i2c.c
2357 - activate this driver with CONFIG_SYS_I2C_IHS
2358 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2359 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2360 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2361 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2362 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2363 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2364 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2365 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2366 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2367 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2368 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2369 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
Dirk Eibach071be892015-10-28 11:46:22 +01002370 - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2371 - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2372 - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2373 - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2374 - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2375 - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2376 - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2377 - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2378 - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
Dirk Eibachb46226b2014-07-03 09:28:18 +02002379
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002380 additional defines:
2381
2382 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002383 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002384 don't use/have i2c muxes on your i2c bus, this
2385 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2386 omit this define.
2387
2388 CONFIG_SYS_I2C_DIRECT_BUS
2389 define this, if you don't use i2c muxes on your hardware.
2390 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2391 omit this define.
2392
2393 CONFIG_SYS_I2C_MAX_HOPS
2394 define how many muxes are maximal consecutively connected
2395 on one i2c bus. If you not use i2c muxes, omit this
2396 define.
2397
2398 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002399 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002400 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2401 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2402 CONFIG_SYS_NUM_I2C_BUSES = 9:
2403
2404 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2405 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2406 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2407 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2408 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2409 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2410 {1, {I2C_NULL_HOP}}, \
2411 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2412 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2413 }
2414
2415 which defines
2416 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002417 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2418 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2419 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2420 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2421 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002422 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002423 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2424 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002425
2426 If you do not have i2c muxes on your board, omit this define.
2427
Heiko Schocherea818db2013-01-29 08:53:15 +01002428- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002429
2430 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2431 provides the following compelling advantages:
2432
2433 - more than one i2c adapter is usable
2434 - approved multibus support
2435 - better i2c mux support
2436
2437 ** Please consider updating your I2C driver now. **
2438
Heiko Schocherea818db2013-01-29 08:53:15 +01002439 These enable legacy I2C serial bus commands. Defining
2440 CONFIG_HARD_I2C will include the appropriate I2C driver
2441 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002442
wdenk945af8d2003-07-16 21:53:01 +00002443 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002444 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002445 CONFIG_COMMANDS) and communicate with i2c based realtime
2446 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002447 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002448
Ben Warrenbb99ad62006-09-07 16:50:54 -04002449 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002450
wdenk945af8d2003-07-16 21:53:01 +00002451 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002452 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002453
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002454 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002455 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002456 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002457 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002458
Peter Tyser8d321b82010-04-12 22:28:21 -05002459 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002460 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002461 and so its address should therefore be cleared to 0 (See,
2462 eg, MPC823e User's Manual p.16-473). So, set
2463 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002464
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002465 CONFIG_SYS_I2C_INIT_MPC5XXX
2466
2467 When a board is reset during an i2c bus transfer
2468 chips might think that the current transfer is still
2469 in progress. Reset the slave devices by sending start
2470 commands until the slave device responds.
2471
wdenk945af8d2003-07-16 21:53:01 +00002472 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002473
Heiko Schocherea818db2013-01-29 08:53:15 +01002474 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002475 then the following macros need to be defined (examples are
2476 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002477
2478 I2C_INIT
2479
wdenk