blob: 0a0f528af117e94f86918078b23b7ec8c5561f96 [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
wdenk24ee89b2002-11-03 17:56:27 +000037In case of problems see the CHANGELOG and CREDITS files to find out
Albert ARIBAUD27af9302013-09-11 15:52:51 +020038who contributed the specific port. The boards.cfg file lists board
Wolfgang Denk218ca722008-03-26 10:40:12 +010039maintainers.
wdenkc6097192002-11-03 00:24:07 +000040
Robert P. J. Dayadb9d852012-11-14 02:03:20 +000041Note: There is no CHANGELOG file in the actual U-Boot source tree;
42it can be created dynamically from the Git log using:
43
44 make CHANGELOG
45
wdenkc6097192002-11-03 00:24:07 +000046
47Where to get help:
48==================
49
wdenk24ee89b2002-11-03 17:56:27 +000050In case you have questions about, problems with or contributions for
51U-Boot you should send a message to the U-Boot mailing list at
Peter Tyser0c325652008-09-10 09:18:34 -050052<u-boot@lists.denx.de>. There is also an archive of previous traffic
53on the mailing list - please search the archive before asking FAQ's.
54Please see http://lists.denx.de/pipermail/u-boot and
55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenkc6097192002-11-03 00:24:07 +000056
57
Wolfgang Denk218ca722008-03-26 10:40:12 +010058Where to get source code:
59=========================
60
61The U-Boot source code is maintained in the git repository at
62git://www.denx.de/git/u-boot.git ; you can browse it online at
63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
64
65The "snapshot" links on this page allow you to download tarballs of
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020066any version you might be interested in. Official releases are also
Wolfgang Denk218ca722008-03-26 10:40:12 +010067available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
68directory.
69
Anatolij Gustschind4ee7112008-03-26 18:13:33 +010070Pre-built (and tested) images are available from
Wolfgang Denk218ca722008-03-26 10:40:12 +010071ftp://ftp.denx.de/pub/u-boot/images/
72
73
wdenkc6097192002-11-03 00:24:07 +000074Where we come from:
75===================
76
77- start from 8xxrom sources
wdenk24ee89b2002-11-03 17:56:27 +000078- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenkc6097192002-11-03 00:24:07 +000079- clean up code
80- make it easier to add custom boards
81- make it possible to add other [PowerPC] CPUs
82- extend functions, especially:
83 * Provide extended interface to Linux boot loader
84 * S-Record download
85 * network boot
Marcel Ziswiler11ccc332008-07-09 08:17:15 +020086 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
wdenk24ee89b2002-11-03 17:56:27 +000087- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenkc6097192002-11-03 00:24:07 +000088- add other CPU families (starting with ARM)
wdenk24ee89b2002-11-03 17:56:27 +000089- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja0d28f342008-08-06 19:32:33 +020090- current project page: see http://www.denx.de/wiki/U-Boot
wdenk24ee89b2002-11-03 17:56:27 +000091
92
93Names and Spelling:
94===================
95
96The "official" name of this project is "Das U-Boot". The spelling
97"U-Boot" shall be used in all written text (documentation, comments
98in source files etc.). Example:
99
100 This is the README file for the U-Boot project.
101
102File names etc. shall be based on the string "u-boot". Examples:
103
104 include/asm-ppc/u-boot.h
105
106 #include <asm/u-boot.h>
107
108Variable names, preprocessor constants etc. shall be either based on
109the string "u_boot" or on "U_BOOT". Example:
110
111 U_BOOT_VERSION u_boot_logo
112 IH_OS_U_BOOT u_boot_hush_start
wdenkc6097192002-11-03 00:24:07 +0000113
114
wdenk93f19cc2002-12-17 17:55:09 +0000115Versioning:
116===========
117
Thomas Weber360d8832010-09-28 08:06:25 +0200118Starting with the release in October 2008, the names of the releases
119were changed from numerical release numbers without deeper meaning
120into a time stamp based numbering. Regular releases are identified by
121names consisting of the calendar year and month of the release date.
122Additional fields (if present) indicate release candidates or bug fix
123releases in "stable" maintenance trees.
wdenk93f19cc2002-12-17 17:55:09 +0000124
Thomas Weber360d8832010-09-28 08:06:25 +0200125Examples:
Wolfgang Denkc0f40852011-10-26 10:21:21 +0000126 U-Boot v2009.11 - Release November 2009
Thomas Weber360d8832010-09-28 08:06:25 +0200127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree
128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
wdenk93f19cc2002-12-17 17:55:09 +0000129
130
wdenkc6097192002-11-03 00:24:07 +0000131Directory Hierarchy:
132====================
133
Peter Tyser8d321b82010-04-12 22:28:21 -0500134/arch Architecture specific files
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900135 /arc Files generic to ARC architecture
136 /cpu CPU specific files
137 /arc700 Files specific to ARC 700 CPUs
138 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500139 /arm Files generic to ARM architecture
140 /cpu CPU specific files
141 /arm720t Files specific to ARM 720 CPUs
142 /arm920t Files specific to ARM 920 CPUs
Andreas Bießmann6eb09212011-07-18 09:41:08 +0000143 /at91 Files specific to Atmel AT91RM9200 CPU
Wolfgang Denka9046b92010-06-13 17:48:15 +0200144 /imx Files specific to Freescale MC9328 i.MX CPUs
145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500146 /arm926ejs Files specific to ARM 926 CPUs
147 /arm1136 Files specific to ARM 1136 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500148 /pxa Files specific to Intel XScale PXA CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs
150 /lib Architecture specific library files
151 /avr32 Files generic to AVR32 architecture
152 /cpu CPU specific files
153 /lib Architecture specific library files
154 /blackfin Files generic to Analog Devices Blackfin architecture
155 /cpu CPU specific files
156 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500157 /m68k Files generic to m68k architecture
158 /cpu CPU specific files
159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs
160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs
161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs
162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs
163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
164 /lib Architecture specific library files
165 /microblaze Files generic to microblaze architecture
166 /cpu CPU specific files
167 /lib Architecture specific library files
168 /mips Files generic to MIPS architecture
169 /cpu CPU specific files
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200170 /mips32 Files specific to MIPS32 CPUs
Masahiro Yamada6eae68e2014-03-07 18:02:02 +0900171 /mips64 Files specific to MIPS64 CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500172 /lib Architecture specific library files
Macpaul Linafc1ce82011-10-19 20:41:11 +0000173 /nds32 Files generic to NDS32 architecture
174 /cpu CPU specific files
175 /n1213 Files specific to Andes Technology N1213 CPUs
176 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500177 /nios2 Files generic to Altera NIOS2 architecture
178 /cpu CPU specific files
179 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400180 /openrisc Files generic to OpenRISC architecture
181 /cpu CPU specific files
182 /lib Architecture specific library files
Stefan Roesea47a12b2010-04-15 16:07:28 +0200183 /powerpc Files generic to PowerPC architecture
Peter Tyser8d321b82010-04-12 22:28:21 -0500184 /cpu CPU specific files
185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs
186 /mpc5xx Files specific to Freescale MPC5xx CPUs
187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
188 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500189 /mpc824x Files specific to Freescale MPC824x CPUs
190 /mpc8260 Files specific to Freescale MPC8260 CPUs
191 /mpc85xx Files specific to Freescale MPC85xx CPUs
192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
193 /lib Architecture specific library files
194 /sh Files generic to SH architecture
195 /cpu CPU specific files
196 /sh2 Files specific to sh2 CPUs
197 /sh3 Files specific to sh3 CPUs
198 /sh4 Files specific to sh4 CPUs
199 /lib Architecture specific library files
200 /sparc Files generic to SPARC architecture
201 /cpu CPU specific files
202 /leon2 Files specific to Gaisler LEON2 SPARC CPU
203 /leon3 Files specific to Gaisler LEON3 SPARC CPU
204 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400205 /x86 Files generic to x86 architecture
206 /cpu CPU specific files
207 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500208/api Machine/arch independent API for external apps
209/board Board dependent files
210/common Misc architecture independent functions
211/disk Code for disk drive partition handling
212/doc Documentation (don't expect too much)
213/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400214/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500215/examples Example code for standalone applications, etc.
216/fs Filesystem code (cramfs, ext2, jffs2, etc.)
217/include Header Files
218/lib Files generic to all architectures
219 /libfdt Library files to support flattened device trees
220 /lzma Library files to support LZMA decompression
221 /lzo Library files to support LZO decompression
222/net Networking code
223/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400224/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500225/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000226
wdenkc6097192002-11-03 00:24:07 +0000227Software Configuration:
228=======================
229
230Configuration is usually done using C preprocessor defines; the
231rationale behind that is to avoid dead code whenever possible.
232
233There are two classes of configuration variables:
234
235* Configuration _OPTIONS_:
236 These are selectable by the user and have names beginning with
237 "CONFIG_".
238
239* Configuration _SETTINGS_:
240 These depend on the hardware etc. and should not be meddled with if
241 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200242 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000243
244Later we will add a configuration tool - probably similar to or even
245identical to what's used for the Linux kernel. Right now, we have to
246do the configuration by hand, which means creating some symbolic
247links and editing some configuration files. We use the TQM8xxL boards
248as an example here.
249
250
251Selection of Processor Architecture and Board Type:
252---------------------------------------------------
253
254For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200255configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000256
257Example: For a TQM823L module type:
258
259 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200260 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000261
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200262For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-08-04 09:26:05 +0200263e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000264directory according to the instructions in cogent/README.
265
266
Simon Glass75b3c3a2014-03-22 17:12:59 -0600267Sandbox Environment:
268--------------------
269
270U-Boot can be built natively to run on a Linux host using the 'sandbox'
271board. This allows feature development which is not board- or architecture-
272specific to be undertaken on a native platform. The sandbox is also used to
273run some of U-Boot's tests.
274
275See board/sandbox/sandbox/README.sandbox for more details.
276
277
wdenkc6097192002-11-03 00:24:07 +0000278Configuration Options:
279----------------------
280
281Configuration depends on the combination of board and CPU type; all
282such information is kept in a configuration file
283"include/configs/<board_name>.h".
284
285Example: For a TQM823L module, all configuration settings are in
286"include/configs/TQM823L.h".
287
288
wdenk7f6c2cb2002-11-10 22:06:23 +0000289Many of the options are named exactly as the corresponding Linux
290kernel configuration options. The intention is to make it easier to
291build a config tool - later.
292
293
wdenkc6097192002-11-03 00:24:07 +0000294The following options need to be configured:
295
Kim Phillips26281142007-08-10 13:28:25 -0500296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000297
Kim Phillips26281142007-08-10 13:28:25 -0500298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200299
300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100301 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000302
303- CPU Module Type: (if CONFIG_COGENT is defined)
304 Define exactly one of
305 CONFIG_CMA286_60_OLD
306--- FIXME --- not tested yet:
307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
308 CONFIG_CMA287_23, CONFIG_CMA287_50
309
310- Motherboard Type: (if CONFIG_COGENT is defined)
311 Define exactly one of
312 CONFIG_CMA101, CONFIG_CMA102
313
314- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
315 Define one or more of
316 CONFIG_CMA302
317
318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
319 Define one or more of
320 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200321 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000322 a "rotator" |\-/|\-/
323
Lei Wencf946c62011-02-09 18:06:58 +0530324- Marvell Family Member
325 CONFIG_SYS_MVFS - define it if you want to enable
326 multiple fs option at one time
327 for marvell soc family
328
wdenkc6097192002-11-03 00:24:07 +0000329- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk5da627a2003-10-09 20:09:04 +0000330 Define exactly one of
331 CONFIG_MPC8240, CONFIG_MPC8245
wdenkc6097192002-11-03 00:24:07 +0000332
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200333- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000334 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
335 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000336 e.g. if there is no 32KHz
337 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000338 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
339 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000340
wdenk66ca92a2004-09-28 17:59:53 +0000341- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200342 CONFIG_SYS_8xx_CPUCLK_MIN
343 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000344 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000345 See doc/README.MPC866
346
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200347 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000348
wdenkba56f622004-02-06 23:19:44 +0000349 Define this to measure the actual CPU clock instead
350 of relying on the correctness of the configured
351 values. Mostly useful for board bringup to make sure
352 the PLL is locked at the intended frequency. Note
353 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200354 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000355
Heiko Schocher506f3912009-03-12 07:37:15 +0100356 CONFIG_SYS_DELAYED_ICACHE
357
358 Define this option if you want to enable the
359 ICache only when Code runs from RAM.
360
Kumar Gala66412c62011-02-18 05:40:54 -0600361- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000362 CONFIG_SYS_PPC64
363
364 Specifies that the core is a 64-bit PowerPC implementation (implements
365 the "64" category of the Power ISA). This is necessary for ePAPR
366 compliance, among other possible reasons.
367
Kumar Gala66412c62011-02-18 05:40:54 -0600368 CONFIG_SYS_FSL_TBCLK_DIV
369
370 Defines the core time base clock divider ratio compared to the
371 system clock. On most PQ3 devices this is 8, on newer QorIQ
372 devices it can be 16 or 32. The ratio varies from SoC to Soc.
373
Kumar Gala8f290842011-05-20 00:39:21 -0500374 CONFIG_SYS_FSL_PCIE_COMPAT
375
376 Defines the string to utilize when trying to match PCIe device
377 tree nodes for the given platform.
378
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000379 CONFIG_SYS_PPC_E500_DEBUG_TLB
380
381 Enables a temporary TLB entry to be used during boot to work
382 around limitations in e500v1 and e500v2 external debugger
383 support. This reduces the portions of the boot code where
384 breakpoints and single stepping do not work. The value of this
385 symbol should be set to the TLB1 entry to be used for this
386 purpose.
387
Scott Wood33eee332012-08-14 10:14:53 +0000388 CONFIG_SYS_FSL_ERRATUM_A004510
389
390 Enables a workaround for erratum A004510. If set,
391 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
392 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
393
394 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
395 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
396
397 Defines one or two SoC revisions (low 8 bits of SVR)
398 for which the A004510 workaround should be applied.
399
400 The rest of SVR is either not relevant to the decision
401 of whether the erratum is present (e.g. p2040 versus
402 p2041) or is implied by the build target, which controls
403 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
404
405 See Freescale App Note 4493 for more information about
406 this erratum.
407
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530408 CONFIG_A003399_NOR_WORKAROUND
409 Enables a workaround for IFC erratum A003399. It is only
410 requred during NOR boot.
411
Scott Wood33eee332012-08-14 10:14:53 +0000412 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
413
414 This is the value to write into CCSR offset 0x18600
415 according to the A004510 workaround.
416
Priyanka Jain64501c62013-07-02 09:21:04 +0530417 CONFIG_SYS_FSL_DSP_DDR_ADDR
418 This value denotes start offset of DDR memory which is
419 connected exclusively to the DSP cores.
420
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530421 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
422 This value denotes start offset of M2 memory
423 which is directly connected to the DSP core.
424
Priyanka Jain64501c62013-07-02 09:21:04 +0530425 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
426 This value denotes start offset of M3 memory which is directly
427 connected to the DSP core.
428
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530429 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
430 This value denotes start offset of DSP CCSR space.
431
Priyanka Jainb1359912013-12-17 14:25:52 +0530432 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
433 Single Source Clock is clocking mode present in some of FSL SoC's.
434 In this mode, a single differential clock is used to supply
435 clocks to the sysclock, ddrclock and usbclock.
436
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530437 CONFIG_SYS_CPC_REINIT_F
438 This CONFIG is defined when the CPC is configured as SRAM at the
439 time of U-boot entry and is required to be re-initialized.
440
Tang Yuantianaade2002014-04-17 15:33:46 +0800441 CONFIG_DEEP_SLEEP
442 Inidcates this SoC supports deep sleep feature. If deep sleep is
443 supported, core will start to execute uboot when wakes up.
444
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000445- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700446 CONFIG_SYS_GENERIC_GLOBAL_DATA
447 Defines global data is initialized in generic board board_init_f().
448 If this macro is defined, global data is created and cleared in
449 generic board board_init_f(). Without this macro, architecture/board
450 should initialize global data before calling board_init_f().
451
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000452 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
453
454 Defines the endianess of the CPU. Implementation of those
455 values is arch specific.
456
York Sun5614e712013-09-30 09:22:09 -0700457 CONFIG_SYS_FSL_DDR
458 Freescale DDR driver in use. This type of DDR controller is
459 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
460 SoCs.
461
462 CONFIG_SYS_FSL_DDR_ADDR
463 Freescale DDR memory-mapped register base.
464
465 CONFIG_SYS_FSL_DDR_EMU
466 Specify emulator support for DDR. Some DDR features such as
467 deskew training are not available.
468
469 CONFIG_SYS_FSL_DDRC_GEN1
470 Freescale DDR1 controller.
471
472 CONFIG_SYS_FSL_DDRC_GEN2
473 Freescale DDR2 controller.
474
475 CONFIG_SYS_FSL_DDRC_GEN3
476 Freescale DDR3 controller.
477
York Sun34e026f2014-03-27 17:54:47 -0700478 CONFIG_SYS_FSL_DDRC_GEN4
479 Freescale DDR4 controller.
480
York Sun9ac4ffb2013-09-30 14:20:51 -0700481 CONFIG_SYS_FSL_DDRC_ARM_GEN3
482 Freescale DDR3 controller for ARM-based SoCs.
483
York Sun5614e712013-09-30 09:22:09 -0700484 CONFIG_SYS_FSL_DDR1
485 Board config to use DDR1. It can be enabled for SoCs with
486 Freescale DDR1 or DDR2 controllers, depending on the board
487 implemetation.
488
489 CONFIG_SYS_FSL_DDR2
490 Board config to use DDR2. It can be eanbeld for SoCs with
491 Freescale DDR2 or DDR3 controllers, depending on the board
492 implementation.
493
494 CONFIG_SYS_FSL_DDR3
495 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700496 Freescale DDR3 or DDR3L controllers.
497
498 CONFIG_SYS_FSL_DDR3L
499 Board config to use DDR3L. It can be enabled for SoCs with
500 DDR3L controllers.
501
502 CONFIG_SYS_FSL_DDR4
503 Board config to use DDR4. It can be enabled for SoCs with
504 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700505
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530506 CONFIG_SYS_FSL_IFC_BE
507 Defines the IFC controller register space as Big Endian
508
509 CONFIG_SYS_FSL_IFC_LE
510 Defines the IFC controller register space as Little Endian
511
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530512 CONFIG_SYS_FSL_PBL_PBI
513 It enables addition of RCW (Power on reset configuration) in built image.
514 Please refer doc/README.pblimage for more details
515
516 CONFIG_SYS_FSL_PBL_RCW
517 It adds PBI(pre-boot instructions) commands in u-boot build image.
518 PBI commands can be used to configure SoC before it starts the execution.
519 Please refer doc/README.pblimage for more details
520
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530521 CONFIG_SPL_FSL_PBL
522 It adds a target to create boot binary having SPL binary in PBI format
523 concatenated with u-boot binary.
524
York Sun4e5b1bd2014-02-10 13:59:42 -0800525 CONFIG_SYS_FSL_DDR_BE
526 Defines the DDR controller register space as Big Endian
527
528 CONFIG_SYS_FSL_DDR_LE
529 Defines the DDR controller register space as Little Endian
530
York Sun6b9e3092014-02-10 13:59:43 -0800531 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
532 Physical address from the view of DDR controllers. It is the
533 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
534 it could be different for ARM SoCs.
535
York Sun6b1e1252014-02-10 13:59:44 -0800536 CONFIG_SYS_FSL_DDR_INTLV_256B
537 DDR controller interleaving on 256-byte. This is a special
538 interleaving mode, handled by Dickens for Freescale layerscape
539 SoCs with ARM core.
540
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100541- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200542 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100543
544 Defines the Monahans run mode to oscillator
545 ratio. Valid values are 8, 16, 24, 31. The core
546 frequency is this value multiplied by 13 MHz.
547
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200548 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200549
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100550 Defines the Monahans turbo mode to oscillator
551 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200552 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100553 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200554
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200555- MIPS CPU options:
556 CONFIG_SYS_INIT_SP_OFFSET
557
558 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
559 pointer. This is needed for the temporary stack before
560 relocation.
561
562 CONFIG_SYS_MIPS_CACHE_MODE
563
564 Cache operation mode for the MIPS CPU.
565 See also arch/mips/include/asm/mipsregs.h.
566 Possible values are:
567 CONF_CM_CACHABLE_NO_WA
568 CONF_CM_CACHABLE_WA
569 CONF_CM_UNCACHED
570 CONF_CM_CACHABLE_NONCOHERENT
571 CONF_CM_CACHABLE_CE
572 CONF_CM_CACHABLE_COW
573 CONF_CM_CACHABLE_CUW
574 CONF_CM_CACHABLE_ACCELERATED
575
576 CONFIG_SYS_XWAY_EBU_BOOTCFG
577
578 Special option for Lantiq XWAY SoCs for booting from NOR flash.
579 See also arch/mips/cpu/mips32/start.S.
580
581 CONFIG_XWAY_SWAP_BYTES
582
583 Enable compilation of tools/xway-swap-bytes needed for Lantiq
584 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
585 be swapped if a flash programmer is used.
586
Christian Rieschb67d8812012-02-02 00:44:39 +0000587- ARM options:
588 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
589
590 Select high exception vectors of the ARM core, e.g., do not
591 clear the V bit of the c1 register of CP15.
592
Aneesh V5356f542012-03-08 07:20:19 +0000593 CONFIG_SYS_THUMB_BUILD
594
595 Use this flag to build U-Boot using the Thumb instruction
596 set for ARM architectures. Thumb instruction set provides
597 better code density. For ARM architectures that support
598 Thumb2 this flag will result in Thumb2 code generated by
599 GCC.
600
Stephen Warrenc5d47522013-03-04 13:29:40 +0000601 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000602 CONFIG_ARM_ERRATA_742230
603 CONFIG_ARM_ERRATA_743622
604 CONFIG_ARM_ERRATA_751472
Nitin Gargf71cbfe2014-04-02 08:55:01 -0500605 CONFIG_ARM_ERRATA_794072
Nitin Gargb7588e32014-04-02 08:55:02 -0500606 CONFIG_ARM_ERRATA_761320
Stephen Warren06785872013-02-26 12:28:27 +0000607
608 If set, the workarounds for these ARM errata are applied early
609 during U-Boot startup. Note that these options force the
610 workarounds to be applied; no CPU-type/version detection
611 exists, unlike the similar options in the Linux kernel. Do not
612 set these options unless they apply!
613
Stephen Warren795659d2013-03-27 17:06:41 +0000614- CPU timer options:
615 CONFIG_SYS_HZ
616
617 The frequency of the timer returned by get_timer().
618 get_timer() must operate in milliseconds and this CONFIG
619 option must be set to 1000.
620
wdenk5da627a2003-10-09 20:09:04 +0000621- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000622 CONFIG_CLOCKS_IN_MHZ
623
624 U-Boot stores all clock information in Hz
625 internally. For binary compatibility with older Linux
626 kernels (which expect the clocks passed in the
627 bd_info data to be in MHz) the environment variable
628 "clocks_in_mhz" can be defined so that U-Boot
629 converts clock data to MHZ before passing it to the
630 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000631 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100632 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000633 default environment.
634
wdenk5da627a2003-10-09 20:09:04 +0000635 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
636
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200637 When transferring memsize parameter to linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000638 expect it to be in bytes, others in MB.
639 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
640
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400641 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200642
643 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400644 passed using flattened device trees (based on open firmware
645 concepts).
646
647 CONFIG_OF_LIBFDT
648 * New libfdt-based support
649 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500650 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400651
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200652 OF_CPU - The proper name of the cpus node (only required for
653 MPC512X and MPC5xxx based boards).
654 OF_SOC - The proper name of the soc node (only required for
655 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200656 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600657 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200658
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200659 boards with QUICC Engines require OF_QE to set UCC MAC
660 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500661
Kumar Gala4e253132006-01-11 13:54:17 -0600662 CONFIG_OF_BOARD_SETUP
663
664 Board code has addition modification that it wants to make
665 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000666
Matthew McClintock02677682006-06-28 10:41:37 -0500667 CONFIG_OF_BOOT_CPU
668
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200669 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500670 param header, the default value is zero if undefined.
671
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200672 CONFIG_OF_IDE_FIXUP
673
674 U-Boot can detect if an IDE device is present or not.
675 If not, and this new config option is activated, U-Boot
676 removes the ATA node from the DTS before booting Linux,
677 so the Linux IDE driver does not probe the device and
678 crash. This is needed for buggy hardware (uc101) where
679 no pull down resistor is connected to the signal IDE5V_DD7.
680
Igor Grinberg7eb29392011-07-14 05:45:07 +0000681 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
682
683 This setting is mandatory for all boards that have only one
684 machine type and must be used to specify the machine type
685 number as it appears in the ARM machine registry
686 (see http://www.arm.linux.org.uk/developer/machines/).
687 Only boards that have multiple machine types supported
688 in a single configuration file and the machine type is
689 runtime discoverable, do not have to use this setting.
690
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100691- vxWorks boot parameters:
692
693 bootvx constructs a valid bootline using the following
694 environments variables: bootfile, ipaddr, serverip, hostname.
695 It loads the vxWorks image pointed bootfile.
696
697 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
698 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
699 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
700 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters
701
702 CONFIG_SYS_VXWORKS_ADD_PARAMS
703
704 Add it at the end of the bootline. E.g "u=username pw=secret"
705
706 Note: If a "bootargs" environment is defined, it will overwride
707 the defaults discussed just above.
708
Aneesh V2c451f72011-06-16 23:30:47 +0000709- Cache Configuration:
710 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
711 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
712 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
713
Aneesh V93bc2192011-06-16 23:30:51 +0000714- Cache Configuration for ARM:
715 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
716 controller
717 CONFIG_SYS_PL310_BASE - Physical base address of PL310
718 controller register space
719
wdenk6705d812004-08-02 23:22:59 +0000720- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200721 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000722
723 Define this if you want support for Amba PrimeCell PL010 UARTs.
724
Andreas Engel48d01922008-09-08 14:30:53 +0200725 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000726
727 Define this if you want support for Amba PrimeCell PL011 UARTs.
728
729 CONFIG_PL011_CLOCK
730
731 If you have Amba PrimeCell PL011 UARTs, set this variable to
732 the clock speed of the UARTs.
733
734 CONFIG_PL01x_PORTS
735
736 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
737 define this to a list of base addresses for each (supported)
738 port. See e.g. include/configs/versatile.h
739
John Rigby910f1ae2011-04-19 10:42:39 +0000740 CONFIG_PL011_SERIAL_RLCR
741
742 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
743 have separate receive and transmit line control registers. Set
744 this variable to initialize the extra register.
745
746 CONFIG_PL011_SERIAL_FLUSH_ON_INIT
747
748 On some platforms (e.g. U8500) U-Boot is loaded by a second stage
749 boot loader that has already initialized the UART. Define this
750 variable to flush the UART at init time.
751
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400752 CONFIG_SERIAL_HW_FLOW_CONTROL
753
754 Define this variable to enable hw flow control in serial driver.
755 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000756
wdenkc6097192002-11-03 00:24:07 +0000757- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000758 Depending on board, define exactly one serial port
759 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
760 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
761 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000762
763 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
764 port routines must be defined elsewhere
765 (i.e. serial_init(), serial_getc(), ...)
766
767 CONFIG_CFB_CONSOLE
768 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000769 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000770 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
771 (default big endian)
772 VIDEO_HW_RECTFILL graphic chip supports
773 rectangle fill
774 (cf. smiLynxEM)
775 VIDEO_HW_BITBLT graphic chip supports
776 bit-blit (cf. smiLynxEM)
777 VIDEO_VISIBLE_COLS visible pixel columns
778 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000779 VIDEO_VISIBLE_ROWS visible pixel rows
780 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000781 VIDEO_DATA_FORMAT graphic data format
782 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000783 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000784 VIDEO_KBD_INIT_FCT keyboard int fct
785 (i.e. i8042_kbd_init())
786 VIDEO_TSTC_FCT test char fct
787 (i.e. i8042_tstc)
788 VIDEO_GETC_FCT get char fct
789 (i.e. i8042_getc)
790 CONFIG_CONSOLE_CURSOR cursor drawing on/off
791 (requires blink timer
792 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200793 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000794 CONFIG_CONSOLE_TIME display time/date info in
795 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500796 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000797 CONFIG_VIDEO_LOGO display Linux logo in
798 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000799 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
800 linux_logo.h for logo.
801 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000802 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200803 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000804 the logo
805
Pali Rohár33a35bb2012-10-19 13:30:09 +0000806 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
807 a limited number of ANSI escape sequences (cursor control,
808 erase functions and limited graphics rendition control).
809
wdenk43d96162003-03-06 00:02:04 +0000810 When CONFIG_CFB_CONSOLE is defined, video console is
811 default i/o. Serial console can be forced with
812 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000813
wdenkd4ca31c2004-01-02 14:00:00 +0000814 When CONFIG_SILENT_CONSOLE is defined, all console
815 messages (by U-Boot and Linux!) can be silenced with
816 the "silent" environment variable. See
817 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000818
Heiko Schocher45ae2542013-10-22 11:06:06 +0200819 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
820 is 0x00.
821 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
822 is 0xa0.
823
wdenkc6097192002-11-03 00:24:07 +0000824- Console Baudrate:
825 CONFIG_BAUDRATE - in bps
826 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200827 CONFIG_SYS_BAUDRATE_TABLE, see below.
828 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000829
Heiko Schocherc92fac92009-01-30 12:55:38 +0100830- Console Rx buffer length
831 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
832 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100833 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100834 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
835 must be defined, to setup the maximum idle timeout for
836 the SMC.
837
Graeme Russ9558b482011-09-01 00:48:27 +0000838- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200839 Prior to the console being initialised (i.e. serial UART
840 initialised etc) all console output is silently discarded.
841 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
842 buffer any console messages prior to the console being
843 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
844 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
845 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200846 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200847 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000848
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200849 'Sane' compilers will generate smaller code if
850 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000851
Sonny Rao046a37b2011-11-02 09:52:08 +0000852- Safe printf() functions
853 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
854 the printf() functions. These are defined in
855 include/vsprintf.h and include snprintf(), vsnprintf() and
856 so on. Code size increase is approximately 300-500 bytes.
857 If this option is not given then these functions will
858 silently discard their buffer size argument - this means
859 you are not getting any overflow checking in this case.
860
wdenkc6097192002-11-03 00:24:07 +0000861- Boot Delay: CONFIG_BOOTDELAY - in seconds
862 Delay before automatically booting the default image;
863 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000864 set to -2 to autoboot with no delay and not check for abort
865 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000866
867 See doc/README.autoboot for these options that
868 work with CONFIG_BOOTDELAY. None are required.
869 CONFIG_BOOT_RETRY_TIME
870 CONFIG_BOOT_RETRY_MIN
871 CONFIG_AUTOBOOT_KEYED
872 CONFIG_AUTOBOOT_PROMPT
873 CONFIG_AUTOBOOT_DELAY_STR
874 CONFIG_AUTOBOOT_STOP_STR
875 CONFIG_AUTOBOOT_DELAY_STR2
876 CONFIG_AUTOBOOT_STOP_STR2
877 CONFIG_ZERO_BOOTDELAY_CHECK
878 CONFIG_RESET_TO_RETRY
879
880- Autoboot Command:
881 CONFIG_BOOTCOMMAND
882 Only needed when CONFIG_BOOTDELAY is enabled;
883 define a command string that is automatically executed
884 when no character is read on the console interface
885 within "Boot Delay" after reset.
886
887 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000888 This can be used to pass arguments to the bootm
889 command. The value of CONFIG_BOOTARGS goes into the
890 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000891
892 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000893 The value of these goes into the environment as
894 "ramboot" and "nfsboot" respectively, and can be used
895 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200896 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000897
Heiko Schochereda0ba32013-11-04 14:04:59 +0100898- Bootcount:
899 CONFIG_BOOTCOUNT_LIMIT
900 Implements a mechanism for detecting a repeating reboot
901 cycle, see:
902 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
903
904 CONFIG_BOOTCOUNT_ENV
905 If no softreset save registers are found on the hardware
906 "bootcount" is stored in the environment. To prevent a
907 saveenv on all reboots, the environment variable
908 "upgrade_available" is used. If "upgrade_available" is
909 0, "bootcount" is always 0, if "upgrade_available" is
910 1 "bootcount" is incremented in the environment.
911 So the Userspace Applikation must set the "upgrade_available"
912 and "bootcount" variable to 0, if a boot was successfully.
913
wdenkc6097192002-11-03 00:24:07 +0000914- Pre-Boot Commands:
915 CONFIG_PREBOOT
916
917 When this option is #defined, the existence of the
918 environment variable "preboot" will be checked
919 immediately before starting the CONFIG_BOOTDELAY
920 countdown and/or running the auto-boot command resp.
921 entering interactive mode.
922
923 This feature is especially useful when "preboot" is
924 automatically generated or modified. For an example
925 see the LWMON board specific code: here "preboot" is
926 modified when the user holds down a certain
927 combination of keys on the (special) keyboard when
928 booting the systems
929
930- Serial Download Echo Mode:
931 CONFIG_LOADS_ECHO
932 If defined to 1, all characters received during a
933 serial download (using the "loads" command) are
934 echoed back. This might be needed by some terminal
935 emulations (like "cu"), but may as well just take
936 time on others. This setting #define's the initial
937 value of the "loads_echo" environment variable.
938
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500939- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +0000940 CONFIG_KGDB_BAUDRATE
941 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200942 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +0000943
944- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500945 Monitor commands can be included or excluded
946 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +0000947 <config_cmd_all.h> and #undef'ing unwanted
948 commands, or using <config_cmd_default.h>
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500949 and augmenting with additional #define's
950 for wanted commands.
wdenkc6097192002-11-03 00:24:07 +0000951
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500952 The default command configuration includes all commands
953 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +0000954
Marek Vasutb401b732014-03-05 19:58:39 +0100955 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500956 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500957 CONFIG_CMD_BDI bdinfo
958 CONFIG_CMD_BEDBUG * Include BedBug Debugger
959 CONFIG_CMD_BMP * BMP support
960 CONFIG_CMD_BSP * Board specific commands
961 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -0400962 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500963 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -0800964 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500965 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -0500966 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500967 CONFIG_CMD_DATE * support for RTC, date/time...
968 CONFIG_CMD_DHCP * DHCP support
969 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -0600970 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
971 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
972 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
973 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500974 CONFIG_CMD_DTT * Digital Therm and Thermostat
975 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -0500976 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500977 CONFIG_CMD_EEPROM * EEPROM read/write support
978 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -0600979 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -0600980 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -0500981 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -0500982 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000983 CONFIG_CMD_EXT2 * ext2 command support
984 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -0700985 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
986 that work for multiple fs types
Mike Frysingerbdab39d2009-01-28 19:08:14 -0500987 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500988 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +0000989 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500990 CONFIG_CMD_FLASH flinfo, erase, protect
991 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +0200992 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +0000993 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -0500994 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +0000995 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +0000996 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500997 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
998 CONFIG_CMD_I2C * I2C serial bus support
999 CONFIG_CMD_IDE * IDE harddisk support
1000 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001001 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001002 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001003 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001004 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001005 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001006 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001007 CONFIG_CMD_IRQ * irqinfo
1008 CONFIG_CMD_ITEST Integer/string test of 2 values
1009 CONFIG_CMD_JFFS2 * JFFS2 Support
1010 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001011 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001012 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1013 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001014 CONFIG_CMD_LOADB loadb
1015 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001016 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001017 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001018 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001019 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001020 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001021 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001022 CONFIG_CMD_MISC Misc functions like sleep etc
1023 CONFIG_CMD_MMC * MMC memory mapped support
1024 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001025 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001026 CONFIG_CMD_NAND * NAND support
1027 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001028 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001029 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001030 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001031 CONFIG_CMD_PCI * pciinfo
1032 CONFIG_CMD_PCMCIA * PCMCIA support
1033 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1034 host
1035 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001036 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001037 CONFIG_CMD_REGINFO * Register dump
1038 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001039 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001040 CONFIG_CMD_SAVES * save S record dump
1041 CONFIG_CMD_SCSI * SCSI Support
1042 CONFIG_CMD_SDRAM * print SDRAM configuration information
1043 (requires CONFIG_CMD_I2C)
1044 CONFIG_CMD_SETGETDCR Support for DCR Register access
1045 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001046 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001047 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001048 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001049 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001050 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001051 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001052 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001053 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001054 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1055 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001056 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001057 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001058 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001059 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001060 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001061
1062 EXAMPLE: If you want all functions except of network
1063 support you can write:
1064
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001065 #include "config_cmd_all.h"
1066 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001067
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001068 Other Commands:
1069 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001070
1071 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001072 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001073 what you (and your U-Boot users) are doing. Data
1074 cache cannot be enabled on systems like the 8xx or
1075 8260 (where accesses to the IMMR region must be
1076 uncached), and it cannot be disabled on all other
1077 systems where we (mis-) use the data cache to hold an
1078 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001079
1080
1081 XXX - this list needs to get updated!
1082
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001083- Regular expression support:
1084 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001085 If this variable is defined, U-Boot is linked against
1086 the SLRE (Super Light Regular Expression) library,
1087 which adds regex support to some commands, as for
1088 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001089
Simon Glass45ba8072011-10-15 05:48:20 +00001090- Device tree:
1091 CONFIG_OF_CONTROL
1092 If this variable is defined, U-Boot will use a device tree
1093 to configure its devices, instead of relying on statically
1094 compiled #defines in the board file. This option is
1095 experimental and only available on a few boards. The device
1096 tree is available in the global data as gd->fdt_blob.
1097
Simon Glass2c0f79e2011-10-24 19:15:31 +00001098 U-Boot needs to get its device tree from somewhere. This can
1099 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001100
1101 CONFIG_OF_EMBED
1102 If this variable is defined, U-Boot will embed a device tree
1103 binary in its image. This device tree file should be in the
1104 board directory and called <soc>-<board>.dts. The binary file
1105 is then picked up in board_init_f() and made available through
1106 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001107
Simon Glass2c0f79e2011-10-24 19:15:31 +00001108 CONFIG_OF_SEPARATE
1109 If this variable is defined, U-Boot will build a device tree
1110 binary. It will be called u-boot.dtb. Architecture-specific
1111 code will locate it at run-time. Generally this works by:
1112
1113 cat u-boot.bin u-boot.dtb >image.bin
1114
1115 and in fact, U-Boot does this for you, creating a file called
1116 u-boot-dtb.bin which is useful in the common case. You can
1117 still use the individual files if you need something more
1118 exotic.
1119
wdenkc6097192002-11-03 00:24:07 +00001120- Watchdog:
1121 CONFIG_WATCHDOG
1122 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001123 support for the SoC. There must be support in the SoC
1124 specific code for a watchdog. For the 8xx and 8260
1125 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1126 register. When supported for a specific SoC is
1127 available, then no further board specific code should
1128 be needed to use it.
1129
1130 CONFIG_HW_WATCHDOG
1131 When using a watchdog circuitry external to the used
1132 SoC, then define this variable and provide board
1133 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001134
stroesec1551ea2003-04-04 15:53:41 +00001135- U-Boot Version:
1136 CONFIG_VERSION_VARIABLE
1137 If this variable is defined, an environment variable
1138 named "ver" is created by U-Boot showing the U-Boot
1139 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001140 Any change to this variable will be reverted at the
1141 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001142
wdenkc6097192002-11-03 00:24:07 +00001143- Real-Time Clock:
1144
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001145 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001146 has to be selected, too. Define exactly one of the
1147 following options:
1148
1149 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1150 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001151 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001152 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001153 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001154 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001155 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001156 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001157 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001158 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001159 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001160 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001161 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1162 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001163
wdenkb37c7e52003-06-30 16:24:52 +00001164 Note that if the RTC uses I2C, then the I2C interface
1165 must also be configured. See I2C Support, below.
1166
Peter Tysere92739d2008-12-17 16:36:21 -06001167- GPIO Support:
1168 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001169
Chris Packham5dec49c2010-12-19 10:12:13 +00001170 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1171 chip-ngpio pairs that tell the PCA953X driver the number of
1172 pins supported by a particular chip.
1173
Peter Tysere92739d2008-12-17 16:36:21 -06001174 Note that if the GPIO device uses I2C, then the I2C interface
1175 must also be configured. See I2C Support, below.
1176
Simon Glassaa532332014-06-11 23:29:41 -06001177- I/O tracing:
1178 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1179 accesses and can checksum them or write a list of them out
1180 to memory. See the 'iotrace' command for details. This is
1181 useful for testing device drivers since it can confirm that
1182 the driver behaves the same way before and after a code
1183 change. Currently this is supported on sandbox and arm. To
1184 add support for your architecture, add '#include <iotrace.h>'
1185 to the bottom of arch/<arch>/include/asm/io.h and test.
1186
1187 Example output from the 'iotrace stats' command is below.
1188 Note that if the trace buffer is exhausted, the checksum will
1189 still continue to operate.
1190
1191 iotrace is enabled
1192 Start: 10000000 (buffer start address)
1193 Size: 00010000 (buffer size)
1194 Offset: 00000120 (current buffer offset)
1195 Output: 10000120 (start + offset)
1196 Count: 00000018 (number of trace records)
1197 CRC32: 9526fb66 (CRC32 of all trace records)
1198
wdenkc6097192002-11-03 00:24:07 +00001199- Timestamp Support:
1200
wdenk43d96162003-03-06 00:02:04 +00001201 When CONFIG_TIMESTAMP is selected, the timestamp
1202 (date and time) of an image is printed by image
1203 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001204 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001205
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001206- Partition Labels (disklabels) Supported:
1207 Zero or more of the following:
1208 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1209 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1210 Intel architecture, USB sticks, etc.
1211 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1212 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1213 bootloader. Note 2TB partition limit; see
1214 disk/part_efi.c
1215 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001216
Wolfgang Denk218ca722008-03-26 10:40:12 +01001217 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1218 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001219 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001220
1221- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001222 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1223 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001224
wdenk4d13cba2004-03-14 14:09:05 +00001225 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1226 be performed by calling the function
1227 ide_set_reset(int reset)
1228 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001229
1230- ATAPI Support:
1231 CONFIG_ATAPI
1232
1233 Set this to enable ATAPI support.
1234
wdenkc40b2952004-03-13 23:29:43 +00001235- LBA48 Support
1236 CONFIG_LBA48
1237
1238 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001239 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001240 Whithout these , LBA48 support uses 32bit variables and will 'only'
1241 support disks up to 2.1TB.
1242
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001243 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001244 When enabled, makes the IDE subsystem use 64bit sector addresses.
1245 Default is 32bit.
1246
wdenkc6097192002-11-03 00:24:07 +00001247- SCSI Support:
1248 At the moment only there is only support for the
1249 SYM53C8XX SCSI controller; define
1250 CONFIG_SCSI_SYM53C8XX to enable it.
1251
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001252 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1253 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1254 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001255 maximum numbers of LUNs, SCSI ID's and target
1256 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001257 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001258
Wolfgang Denk93e14592013-10-04 17:43:24 +02001259 The environment variable 'scsidevs' is set to the number of
1260 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001261
wdenkc6097192002-11-03 00:24:07 +00001262- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001263 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001264 Support for Intel 8254x/8257x gigabit chips.
1265
1266 CONFIG_E1000_SPI
1267 Utility code for direct access to the SPI bus on Intel 8257x.
1268 This does not do anything useful unless you set at least one
1269 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1270
1271 CONFIG_E1000_SPI_GENERIC
1272 Allow generic access to the SPI bus on the Intel 8257x, for
1273 example with the "sspi" command.
1274
1275 CONFIG_CMD_E1000
1276 Management command for E1000 devices. When used on devices
1277 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001278
Andre Schwarzac3315c2008-03-06 16:45:44 +01001279 CONFIG_E1000_FALLBACK_MAC
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001280 default MAC for empty EEPROM after production.
Andre Schwarzac3315c2008-03-06 16:45:44 +01001281
wdenkc6097192002-11-03 00:24:07 +00001282 CONFIG_EEPRO100
1283 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001284 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001285 write routine for first time initialisation.
1286
1287 CONFIG_TULIP
1288 Support for Digital 2114x chips.
1289 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1290 modem chip initialisation (KS8761/QS6611).
1291
1292 CONFIG_NATSEMI
1293 Support for National dp83815 chips.
1294
1295 CONFIG_NS8382X
1296 Support for National dp8382[01] gigabit chips.
1297
wdenk45219c42003-05-12 21:50:16 +00001298- NETWORK Support (other):
1299
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001300 CONFIG_DRIVER_AT91EMAC
1301 Support for AT91RM9200 EMAC.
1302
1303 CONFIG_RMII
1304 Define this to use reduced MII inteface
1305
1306 CONFIG_DRIVER_AT91EMAC_QUIET
1307 If this defined, the driver is quiet.
1308 The driver doen't show link status messages.
1309
Rob Herringefdd7312011-12-15 11:15:49 +00001310 CONFIG_CALXEDA_XGMAC
1311 Support for the Calxeda XGMAC device
1312
Ashok3bb46d22012-10-15 06:20:47 +00001313 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001314 Support for SMSC's LAN91C96 chips.
1315
1316 CONFIG_LAN91C96_BASE
1317 Define this to hold the physical address
1318 of the LAN91C96's I/O space
1319
1320 CONFIG_LAN91C96_USE_32_BIT
1321 Define this to enable 32 bit addressing
1322
Ashok3bb46d22012-10-15 06:20:47 +00001323 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001324 Support for SMSC's LAN91C111 chip
1325
1326 CONFIG_SMC91111_BASE
1327 Define this to hold the physical address
1328 of the device (I/O space)
1329
1330 CONFIG_SMC_USE_32_BIT
1331 Define this if data bus is 32 bits
1332
1333 CONFIG_SMC_USE_IOFUNCS
1334 Define this to use i/o functions instead of macros
1335 (some hardware wont work with macros)
1336
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001337 CONFIG_DRIVER_TI_EMAC
1338 Support for davinci emac
1339
1340 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1341 Define this if you have more then 3 PHYs.
1342
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001343 CONFIG_FTGMAC100
1344 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1345
1346 CONFIG_FTGMAC100_EGIGA
1347 Define this to use GE link update with gigabit PHY.
1348 Define this if FTGMAC100 is connected to gigabit PHY.
1349 If your system has 10/100 PHY only, it might not occur
1350 wrong behavior. Because PHY usually return timeout or
1351 useless data when polling gigabit status and gigabit
1352 control registers. This behavior won't affect the
1353 correctnessof 10/100 link speed update.
1354
Mike Rapoportc2fff332009-11-11 10:03:03 +02001355 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001356 Support for SMSC's LAN911x and LAN921x chips
1357
Mike Rapoportc2fff332009-11-11 10:03:03 +02001358 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001359 Define this to hold the physical address
1360 of the device (I/O space)
1361
Mike Rapoportc2fff332009-11-11 10:03:03 +02001362 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001363 Define this if data bus is 32 bits
1364
Mike Rapoportc2fff332009-11-11 10:03:03 +02001365 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001366 Define this if data bus is 16 bits. If your processor
1367 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001368 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001369
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001370 CONFIG_SH_ETHER
1371 Support for Renesas on-chip Ethernet controller
1372
1373 CONFIG_SH_ETHER_USE_PORT
1374 Define the number of ports to be used
1375
1376 CONFIG_SH_ETHER_PHY_ADDR
1377 Define the ETH PHY's address
1378
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001379 CONFIG_SH_ETHER_CACHE_WRITEBACK
1380 If this option is set, the driver enables cache flush.
1381
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001382- PWM Support:
1383 CONFIG_PWM_IMX
1384 Support for PWM modul on the imx6.
1385
Vadim Bendebury5e124722011-10-17 08:36:14 +00001386- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001387 CONFIG_TPM
1388 Support TPM devices.
1389
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001390 CONFIG_TPM_TIS_I2C
1391 Support for i2c bus TPM devices. Only one device
1392 per system is supported at this time.
1393
1394 CONFIG_TPM_TIS_I2C_BUS_NUMBER
1395 Define the the i2c bus number for the TPM device
1396
1397 CONFIG_TPM_TIS_I2C_SLAVE_ADDRESS
1398 Define the TPM's address on the i2c bus
1399
1400 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1401 Define the burst count bytes upper limit
1402
Dirk Eibachc01939c2013-06-26 15:55:15 +02001403 CONFIG_TPM_ATMEL_TWI
1404 Support for Atmel TWI TPM device. Requires I2C support.
1405
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001406 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001407 Support for generic parallel port TPM devices. Only one device
1408 per system is supported at this time.
1409
1410 CONFIG_TPM_TIS_BASE_ADDRESS
1411 Base address where the generic TPM device is mapped
1412 to. Contemporary x86 systems usually map it at
1413 0xfed40000.
1414
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001415 CONFIG_CMD_TPM
1416 Add tpm monitor functions.
1417 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1418 provides monitor access to authorized functions.
1419
1420 CONFIG_TPM
1421 Define this to enable the TPM support library which provides
1422 functional interfaces to some TPM commands.
1423 Requires support for a TPM device.
1424
1425 CONFIG_TPM_AUTH_SESSIONS
1426 Define this to enable authorized functions in the TPM library.
1427 Requires CONFIG_TPM and CONFIG_SHA1.
1428
wdenkc6097192002-11-03 00:24:07 +00001429- USB Support:
1430 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001431 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001432 CONFIG_USB_UHCI to enable it.
1433 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001434 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001435 storage devices.
1436 Note:
1437 Supported are USB Keyboards and USB Floppy drives
1438 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001439 MPC5200 USB requires additional defines:
1440 CONFIG_USB_CLOCK
1441 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001442 CONFIG_PSC3_USB
1443 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001444 CONFIG_USB_CONFIG
1445 for differential drivers: 0x00001000
1446 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001447 for differential drivers on PSC3: 0x00000100
1448 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001449 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001450 May be defined to allow interrupt polling
1451 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001452
Simon Glass9ab4ce22012-02-27 10:52:47 +00001453 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1454 txfilltuning field in the EHCI controller on reset.
1455
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001456- USB Device:
1457 Define the below if you wish to use the USB console.
1458 Once firmware is rebuilt from a serial console issue the
1459 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001460 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001461 it has found a new device. The environment variable usbtty
1462 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001463 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001464 Common Device Class Abstract Control Model serial device.
1465 If you select usbtty = gserial you should be able to enumerate
1466 a Linux host by
1467 # modprobe usbserial vendor=0xVendorID product=0xProductID
1468 else if using cdc_acm, simply setting the environment
1469 variable usbtty to be cdc_acm should suffice. The following
1470 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001471
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001472 CONFIG_USB_DEVICE
1473 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001474
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001475 CONFIG_USB_TTY
1476 Define this to have a tty type of device available to
1477 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001478
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301479 CONFIG_USBD_HS
1480 Define this to enable the high speed support for usb
1481 device and usbtty. If this feature is enabled, a routine
1482 int is_usbd_high_speed(void)
1483 also needs to be defined by the driver to dynamically poll
1484 whether the enumeration has succeded at high speed or full
1485 speed.
1486
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001487 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001488 Define this if you want stdin, stdout &/or stderr to
1489 be set to usbtty.
1490
1491 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001492 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001493 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001494 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001495
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001496 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001497 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001498 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001499
Wolfgang Denk386eda02006-06-14 18:14:56 +02001500 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001501 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001502 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001503 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1504 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1505 should pretend to be a Linux device to it's target host.
1506
1507 CONFIG_USBD_MANUFACTURER
1508 Define this string as the name of your company for
1509 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001510
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001511 CONFIG_USBD_PRODUCT_NAME
1512 Define this string as the name of your product
1513 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1514
1515 CONFIG_USBD_VENDORID
1516 Define this as your assigned Vendor ID from the USB
1517 Implementors Forum. This *must* be a genuine Vendor ID
1518 to avoid polluting the USB namespace.
1519 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001520
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001521 CONFIG_USBD_PRODUCTID
1522 Define this as the unique Product ID
1523 for your device
1524 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001525
Igor Grinbergd70a5602011-12-12 12:08:35 +02001526- ULPI Layer Support:
1527 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1528 the generic ULPI layer. The generic layer accesses the ULPI PHY
1529 via the platform viewport, so you need both the genric layer and
1530 the viewport enabled. Currently only Chipidea/ARC based
1531 viewport is supported.
1532 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1533 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001534 If your ULPI phy needs a different reference clock than the
1535 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1536 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001537
1538- MMC Support:
1539 The MMC controller on the Intel PXA is supported. To
1540 enable this define CONFIG_MMC. The MMC can be
1541 accessed from the boot prompt by mapping the device
1542 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001543 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1544 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001545
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001546 CONFIG_SH_MMCIF
1547 Support for Renesas on-chip MMCIF controller
1548
1549 CONFIG_SH_MMCIF_ADDR
1550 Define the base address of MMCIF registers
1551
1552 CONFIG_SH_MMCIF_CLK
1553 Define the clock frequency for MMCIF
1554
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001555 CONFIG_GENERIC_MMC
1556 Enable the generic MMC driver
1557
1558 CONFIG_SUPPORT_EMMC_BOOT
1559 Enable some additional features of the eMMC boot partitions.
1560
1561 CONFIG_SUPPORT_EMMC_RPMB
1562 Enable the commands for reading, writing and programming the
1563 key for the Replay Protection Memory Block partition in eMMC.
1564
Tom Rinib3ba6e92013-03-14 05:32:47 +00001565- USB Device Firmware Update (DFU) class support:
1566 CONFIG_DFU_FUNCTION
1567 This enables the USB portion of the DFU USB class
1568
1569 CONFIG_CMD_DFU
1570 This enables the command "dfu" which is used to have
1571 U-Boot create a DFU class device via USB. This command
1572 requires that the "dfu_alt_info" environment variable be
1573 set and define the alt settings to expose to the host.
1574
1575 CONFIG_DFU_MMC
1576 This enables support for exposing (e)MMC devices via DFU.
1577
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001578 CONFIG_DFU_NAND
1579 This enables support for exposing NAND devices via DFU.
1580
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301581 CONFIG_DFU_RAM
1582 This enables support for exposing RAM via DFU.
1583 Note: DFU spec refer to non-volatile memory usage, but
1584 allow usages beyond the scope of spec - here RAM usage,
1585 one that would help mostly the developer.
1586
Heiko Schochere7e75c72013-06-12 06:05:51 +02001587 CONFIG_SYS_DFU_DATA_BUF_SIZE
1588 Dfu transfer uses a buffer before writing data to the
1589 raw storage device. Make the size (in bytes) of this buffer
1590 configurable. The size of this buffer is also configurable
1591 through the "dfu_bufsiz" environment variable.
1592
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001593 CONFIG_SYS_DFU_MAX_FILE_SIZE
1594 When updating files rather than the raw storage device,
1595 we use a static buffer to copy the file into and then write
1596 the buffer once we've been given the whole file. Define
1597 this to the maximum filesize (in bytes) for the buffer.
1598 Default is 4 MiB if undefined.
1599
Heiko Schocher001a8312014-03-18 08:09:56 +01001600 DFU_DEFAULT_POLL_TIMEOUT
1601 Poll timeout [ms], is the timeout a device can send to the
1602 host. The host must wait for this timeout before sending
1603 a subsequent DFU_GET_STATUS request to the device.
1604
1605 DFU_MANIFEST_POLL_TIMEOUT
1606 Poll timeout [ms], which the device sends to the host when
1607 entering dfuMANIFEST state. Host waits this timeout, before
1608 sending again an USB request to the device.
1609
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001610- USB Device Android Fastboot support:
1611 CONFIG_CMD_FASTBOOT
1612 This enables the command "fastboot" which enables the Android
1613 fastboot mode for the platform's USB device. Fastboot is a USB
1614 protocol for downloading images, flashing and device control
1615 used on Android devices.
1616 See doc/README.android-fastboot for more information.
1617
1618 CONFIG_ANDROID_BOOT_IMAGE
1619 This enables support for booting images which use the Android
1620 image format header.
1621
1622 CONFIG_USB_FASTBOOT_BUF_ADDR
1623 The fastboot protocol requires a large memory buffer for
1624 downloads. Define this to the starting RAM address to use for
1625 downloaded images.
1626
1627 CONFIG_USB_FASTBOOT_BUF_SIZE
1628 The fastboot protocol requires a large memory buffer for
1629 downloads. This buffer should be as large as possible for a
1630 platform. Define this to the size available RAM for fastboot.
1631
wdenk6705d812004-08-02 23:22:59 +00001632- Journaling Flash filesystem support:
1633 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1634 CONFIG_JFFS2_NAND_DEV
1635 Define these for a default partition on a NAND device
1636
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001637 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1638 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001639 Define these for a default partition on a NOR device
1640
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001641 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001642 Define this to create an own partition. You have to provide a
1643 function struct part_info* jffs2_part_info(int part_num)
1644
1645 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001646 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001647 to disable the command chpart. This is the default when you
1648 have not defined a custom partition
1649
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001650- FAT(File Allocation Table) filesystem write function support:
1651 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001652
1653 Define this to enable support for saving memory data as a
1654 file in FAT formatted partition.
1655
1656 This will also enable the command "fatwrite" enabling the
1657 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001658
Gabe Black84cd9322012-10-12 14:26:11 +00001659CBFS (Coreboot Filesystem) support
1660 CONFIG_CMD_CBFS
1661
1662 Define this to enable support for reading from a Coreboot
1663 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1664 and cbfsload.
1665
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301666- FAT(File Allocation Table) filesystem cluster size:
1667 CONFIG_FS_FAT_MAX_CLUSTSIZE
1668
1669 Define the max cluster size for fat operations else
1670 a default value of 65536 will be defined.
1671
wdenkc6097192002-11-03 00:24:07 +00001672- Keyboard Support:
1673 CONFIG_ISA_KEYBOARD
1674
1675 Define this to enable standard (PC-Style) keyboard
1676 support
1677
1678 CONFIG_I8042_KBD
1679 Standard PC keyboard driver with US (is default) and
1680 GERMAN key layout (switch via environment 'keymap=de') support.
1681 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1682 for cfb_console. Supports cursor blinking.
1683
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001684 CONFIG_CROS_EC_KEYB
1685 Enables a Chrome OS keyboard using the CROS_EC interface.
1686 This uses CROS_EC to communicate with a second microcontroller
1687 which provides key scans on request.
1688
wdenkc6097192002-11-03 00:24:07 +00001689- Video support:
1690 CONFIG_VIDEO
1691
1692 Define this to enable video support (for output to
1693 video).
1694
1695 CONFIG_VIDEO_CT69000
1696
1697 Enable Chips & Technologies 69000 Video chip
1698
1699 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001700 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001701 video output is selected via environment 'videoout'
1702 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1703 assumed.
wdenkc6097192002-11-03 00:24:07 +00001704
wdenkb79a11c2004-03-25 15:14:43 +00001705 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001706 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001707 are possible:
1708 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001709 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001710
1711 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1712 -------------+---------------------------------------------
1713 8 bits | 0x301* 0x303 0x305 0x161 0x307
1714 15 bits | 0x310 0x313 0x316 0x162 0x319
1715 16 bits | 0x311 0x314 0x317 0x163 0x31A
1716 24 bits | 0x312 0x315 0x318 ? 0x31B
1717 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001718 (i.e. setenv videomode 317; saveenv; reset;)
1719
wdenkb79a11c2004-03-25 15:14:43 +00001720 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001721 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001722
1723
stroesec1551ea2003-04-04 15:53:41 +00001724 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001725 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001726 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1727 or CONFIG_VIDEO_SED13806_16BPP
1728
Timur Tabi7d3053f2011-02-15 17:09:19 -06001729 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001730 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001731 SOCs that have a DIU should define this macro to enable DIU
1732 support, and should also define these other macros:
1733
1734 CONFIG_SYS_DIU_ADDR
1735 CONFIG_VIDEO
1736 CONFIG_CMD_BMP
1737 CONFIG_CFB_CONSOLE
1738 CONFIG_VIDEO_SW_CURSOR
1739 CONFIG_VGA_AS_SINGLE_DEVICE
1740 CONFIG_VIDEO_LOGO
1741 CONFIG_VIDEO_BMP_LOGO
1742
Timur Tabiba8e76b2011-04-11 14:18:22 -05001743 The DIU driver will look for the 'video-mode' environment
1744 variable, and if defined, enable the DIU as a console during
1745 boot. See the documentation file README.video for a
1746 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001747
Simon Glass058d59b2012-12-03 13:59:47 +00001748 CONFIG_VIDEO_VGA
1749
1750 Enable the VGA video / BIOS for x86. The alternative if you
1751 are using coreboot is to use the coreboot frame buffer
1752 driver.
1753
1754
wdenk682011f2003-06-03 23:54:09 +00001755- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001756 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001757
wdenk8bde7f72003-06-27 21:31:46 +00001758 Define this to enable a custom keyboard support.
1759 This simply calls drv_keyboard_init() which must be
1760 defined in your board-specific files.
1761 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001762
wdenkc6097192002-11-03 00:24:07 +00001763- LCD Support: CONFIG_LCD
1764
1765 Define this to enable LCD support (for output to LCD
1766 display); also select one of the supported displays
1767 by defining one of these:
1768
Stelian Pop39cf4802008-05-09 21:57:18 +02001769 CONFIG_ATMEL_LCD:
1770
1771 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1772
wdenkfd3103b2003-11-25 16:55:19 +00001773 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001774
wdenkfd3103b2003-11-25 16:55:19 +00001775 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001776
wdenkfd3103b2003-11-25 16:55:19 +00001777 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001778
wdenkfd3103b2003-11-25 16:55:19 +00001779 NEC NL6448BC20-08. 6.5", 640x480.
1780 Active, color, single scan.
1781
1782 CONFIG_NEC_NL6448BC33_54
1783
1784 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001785 Active, color, single scan.
1786
1787 CONFIG_SHARP_16x9
1788
1789 Sharp 320x240. Active, color, single scan.
1790 It isn't 16x9, and I am not sure what it is.
1791
1792 CONFIG_SHARP_LQ64D341
1793
1794 Sharp LQ64D341 display, 640x480.
1795 Active, color, single scan.
1796
1797 CONFIG_HLD1045
1798
1799 HLD1045 display, 640x480.
1800 Active, color, single scan.
1801
1802 CONFIG_OPTREX_BW
1803
1804 Optrex CBL50840-2 NF-FW 99 22 M5
1805 or
1806 Hitachi LMG6912RPFC-00T
1807 or
1808 Hitachi SP14Q002
1809
1810 320x240. Black & white.
1811
1812 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001813 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001814
Simon Glass676d3192012-10-17 13:24:54 +00001815 CONFIG_LCD_ALIGNMENT
1816
1817 Normally the LCD is page-aligned (tyically 4KB). If this is
1818 defined then the LCD will be aligned to this value instead.
1819 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1820 here, since it is cheaper to change data cache settings on
1821 a per-section basis.
1822
Simon Glass0d89efe2012-10-17 13:24:59 +00001823 CONFIG_CONSOLE_SCROLL_LINES
1824
1825 When the console need to be scrolled, this is the number of
1826 lines to scroll by. It defaults to 1. Increasing this makes
1827 the console jump but can help speed up operation when scrolling
1828 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001829
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001830 CONFIG_LCD_BMP_RLE8
1831
1832 Support drawing of RLE8-compressed bitmaps on the LCD.
1833
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001834 CONFIG_I2C_EDID
1835
1836 Enables an 'i2c edid' command which can read EDID
1837 information over I2C from an attached LCD display.
1838
wdenk7152b1d2003-09-05 23:19:14 +00001839- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001840
wdenk8bde7f72003-06-27 21:31:46 +00001841 If this option is set, the environment is checked for
1842 a variable "splashimage". If found, the usual display
1843 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001844 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001845 specified in "splashimage" is loaded instead. The
1846 console is redirected to the "nulldev", too. This
1847 allows for a "silent" boot where a splash screen is
1848 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001849
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001850 CONFIG_SPLASHIMAGE_GUARD
1851
1852 If this option is set, then U-Boot will prevent the environment
1853 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001854 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001855 This option is useful for targets where, due to alignment
1856 restrictions, an improperly aligned BMP image will cause a data
1857 abort. If you think you will not have problems with unaligned
1858 accesses (for example because your toolchain prevents them)
1859 there is no need to set this option.
1860
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001861 CONFIG_SPLASH_SCREEN_ALIGN
1862
1863 If this option is set the splash image can be freely positioned
1864 on the screen. Environment variable "splashpos" specifies the
1865 position as "x,y". If a positive number is given it is used as
1866 number of pixel from left/top. If a negative number is given it
1867 is used as number of pixel from right/bottom. You can also
1868 specify 'm' for centering the image.
1869
1870 Example:
1871 setenv splashpos m,m
1872 => image at center of screen
1873
1874 setenv splashpos 30,20
1875 => image at x = 30 and y = 20
1876
1877 setenv splashpos -10,m
1878 => vertically centered image
1879 at x = dspWidth - bmpWidth - 9
1880
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001881- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
1882
1883 If this option is set, additionally to standard BMP
1884 images, gzipped BMP images can be displayed via the
1885 splashscreen support or the bmp command.
1886
Anatolij Gustschind5011762010-03-15 14:50:25 +01001887- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1888
1889 If this option is set, 8-bit RLE compressed BMP images
1890 can be displayed via the splashscreen support or the
1891 bmp command.
1892
Lei Wenf2b96df2012-09-28 04:26:47 +00001893- Do compresssing for memory range:
1894 CONFIG_CMD_ZIP
1895
1896 If this option is set, it would use zlib deflate method
1897 to compress the specified memory at its best effort.
1898
wdenkc29fdfc2003-08-29 20:57:53 +00001899- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07001900 CONFIG_GZIP
1901
1902 Enabled by default to support gzip compressed images.
1903
wdenkc29fdfc2003-08-29 20:57:53 +00001904 CONFIG_BZIP2
1905
1906 If this option is set, support for bzip2 compressed
1907 images is included. If not, only uncompressed and gzip
1908 compressed images are supported.
1909
wdenk42d1f032003-10-15 23:53:47 +00001910 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001911 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00001912 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00001913
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001914 CONFIG_LZMA
1915
1916 If this option is set, support for lzma compressed
1917 images is included.
1918
1919 Note: The LZMA algorithm adds between 2 and 4KB of code and it
1920 requires an amount of dynamic memory that is given by the
1921 formula:
1922
1923 (1846 + 768 << (lc + lp)) * sizeof(uint16)
1924
1925 Where lc and lp stand for, respectively, Literal context bits
1926 and Literal pos bits.
1927
1928 This value is upper-bounded by 14MB in the worst case. Anyway,
1929 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
1930 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
1931 a very small buffer.
1932
1933 Use the lzmainfo tool to determinate the lc and lp values and
1934 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001935 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02001936
Kees Cook8ef70472013-08-16 07:59:12 -07001937 CONFIG_LZO
1938
1939 If this option is set, support for LZO compressed images
1940 is included.
1941
wdenk17ea1172004-06-06 21:51:03 +00001942- MII/PHY support:
1943 CONFIG_PHY_ADDR
1944
1945 The address of PHY on MII bus.
1946
1947 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
1948
1949 The clock frequency of the MII bus
1950
1951 CONFIG_PHY_GIGE
1952
1953 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001954 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00001955
1956 CONFIG_PHY_RESET_DELAY
1957
1958 Some PHY like Intel LXT971A need extra delay after
1959 reset before any MII register access is possible.
1960 For such PHY, set this option to the usec delay
1961 required. (minimum 300usec for LXT971A)
1962
1963 CONFIG_PHY_CMD_DELAY (ppc4xx)
1964
1965 Some PHY like Intel LXT971A need extra delay after
1966 command issued before MII status register can be read
1967
wdenkc6097192002-11-03 00:24:07 +00001968- Ethernet address:
1969 CONFIG_ETHADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001970 CONFIG_ETH1ADDR
wdenkc6097192002-11-03 00:24:07 +00001971 CONFIG_ETH2ADDR
1972 CONFIG_ETH3ADDR
richardretanubunc68a05f2008-09-29 18:28:23 -04001973 CONFIG_ETH4ADDR
1974 CONFIG_ETH5ADDR
wdenkc6097192002-11-03 00:24:07 +00001975
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001976 Define a default value for Ethernet address to use
1977 for the respective Ethernet interface, in case this
wdenkc6097192002-11-03 00:24:07 +00001978 is not determined automatically.
1979
1980- IP address:
1981 CONFIG_IPADDR
1982
1983 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001984 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00001985 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001986 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00001987
1988- Server IP address:
1989 CONFIG_SERVERIP
1990
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001991 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00001992 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00001993 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00001994
Robin Getz97cfe862009-07-21 12:15:28 -04001995 CONFIG_KEEP_SERVERADDR
1996
1997 Keeps the server's MAC address, in the env 'serveraddr'
1998 for passing to bootargs (like Linux's netconsole option)
1999
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002000- Gateway IP address:
2001 CONFIG_GATEWAYIP
2002
2003 Defines a default value for the IP address of the
2004 default router where packets to other networks are
2005 sent to.
2006 (Environment variable "gatewayip")
2007
2008- Subnet mask:
2009 CONFIG_NETMASK
2010
2011 Defines a default value for the subnet mask (or
2012 routing prefix) which is used to determine if an IP
2013 address belongs to the local subnet or needs to be
2014 forwarded through a router.
2015 (Environment variable "netmask")
2016
David Updegraff53a5c422007-06-11 10:41:07 -05002017- Multicast TFTP Mode:
2018 CONFIG_MCAST_TFTP
2019
2020 Defines whether you want to support multicast TFTP as per
2021 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002022 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002023 driver in use must provide a function: mcast() to join/leave a
2024 multicast group.
2025
wdenkc6097192002-11-03 00:24:07 +00002026- BOOTP Recovery Mode:
2027 CONFIG_BOOTP_RANDOM_DELAY
2028
2029 If you have many targets in a network that try to
2030 boot using BOOTP, you may want to avoid that all
2031 systems send out BOOTP requests at precisely the same
2032 moment (which would happen for instance at recovery
2033 from a power failure, when all systems will try to
2034 boot, thus flooding the BOOTP server. Defining
2035 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2036 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002037 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002038
2039 1st BOOTP request: delay 0 ... 1 sec
2040 2nd BOOTP request: delay 0 ... 2 sec
2041 3rd BOOTP request: delay 0 ... 4 sec
2042 4th and following
2043 BOOTP requests: delay 0 ... 8 sec
2044
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002045 CONFIG_BOOTP_ID_CACHE_SIZE
2046
2047 BOOTP packets are uniquely identified using a 32-bit ID. The
2048 server will copy the ID from client requests to responses and
2049 U-Boot will use this to determine if it is the destination of
2050 an incoming response. Some servers will check that addresses
2051 aren't in use before handing them out (usually using an ARP
2052 ping) and therefore take up to a few hundred milliseconds to
2053 respond. Network congestion may also influence the time it
2054 takes for a response to make it back to the client. If that
2055 time is too long, U-Boot will retransmit requests. In order
2056 to allow earlier responses to still be accepted after these
2057 retransmissions, U-Boot's BOOTP client keeps a small cache of
2058 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2059 cache. The default is to keep IDs for up to four outstanding
2060 requests. Increasing this will allow U-Boot to accept offers
2061 from a BOOTP client in networks with unusually high latency.
2062
stroesefe389a82003-08-28 14:17:32 +00002063- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002064 You can fine tune the DHCP functionality by defining
2065 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002066
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002067 CONFIG_BOOTP_SUBNETMASK
2068 CONFIG_BOOTP_GATEWAY
2069 CONFIG_BOOTP_HOSTNAME
2070 CONFIG_BOOTP_NISDOMAIN
2071 CONFIG_BOOTP_BOOTPATH
2072 CONFIG_BOOTP_BOOTFILESIZE
2073 CONFIG_BOOTP_DNS
2074 CONFIG_BOOTP_DNS2
2075 CONFIG_BOOTP_SEND_HOSTNAME
2076 CONFIG_BOOTP_NTPSERVER
2077 CONFIG_BOOTP_TIMEOFFSET
2078 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002079 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002080
Wilson Callan5d110f02007-07-28 10:56:13 -04002081 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2082 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002083
Joe Hershberger2c00e092012-05-23 07:59:19 +00002084 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2085 after the configured retry count, the call will fail
2086 instead of starting over. This can be used to fail over
2087 to Link-local IP address configuration if the DHCP server
2088 is not available.
2089
stroesefe389a82003-08-28 14:17:32 +00002090 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2091 serverip from a DHCP server, it is possible that more
2092 than one DNS serverip is offered to the client.
2093 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2094 serverip will be stored in the additional environment
2095 variable "dnsip2". The first DNS serverip is always
2096 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002097 is defined.
stroesefe389a82003-08-28 14:17:32 +00002098
2099 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2100 to do a dynamic update of a DNS server. To do this, they
2101 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002102 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002103 of the "hostname" environment variable is passed as
2104 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002105
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002106 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2107
2108 A 32bit value in microseconds for a delay between
2109 receiving a "DHCP Offer" and sending the "DHCP Request".
2110 This fixes a problem with certain DHCP servers that don't
2111 respond 100% of the time to a "DHCP request". E.g. On an
2112 AT91RM9200 processor running at 180MHz, this delay needed
2113 to be *at least* 15,000 usec before a Windows Server 2003
2114 DHCP server would reply 100% of the time. I recommend at
2115 least 50,000 usec to be safe. The alternative is to hope
2116 that one of the retries will be successful but note that
2117 the DHCP timeout and retry process takes a longer than
2118 this delay.
2119
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002120 - Link-local IP address negotiation:
2121 Negotiate with other link-local clients on the local network
2122 for an address that doesn't require explicit configuration.
2123 This is especially useful if a DHCP server cannot be guaranteed
2124 to exist in all environments that the device must operate.
2125
2126 See doc/README.link-local for more information.
2127
wdenka3d991b2004-04-15 21:48:45 +00002128 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002129 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002130
2131 The device id used in CDP trigger frames.
2132
2133 CONFIG_CDP_DEVICE_ID_PREFIX
2134
2135 A two character string which is prefixed to the MAC address
2136 of the device.
2137
2138 CONFIG_CDP_PORT_ID
2139
2140 A printf format string which contains the ascii name of
2141 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002142 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002143
2144 CONFIG_CDP_CAPABILITIES
2145
2146 A 32bit integer which indicates the device capabilities;
2147 0x00000010 for a normal host which does not forwards.
2148
2149 CONFIG_CDP_VERSION
2150
2151 An ascii string containing the version of the software.
2152
2153 CONFIG_CDP_PLATFORM
2154
2155 An ascii string containing the name of the platform.
2156
2157 CONFIG_CDP_TRIGGER
2158
2159 A 32bit integer sent on the trigger.
2160
2161 CONFIG_CDP_POWER_CONSUMPTION
2162
2163 A 16bit integer containing the power consumption of the
2164 device in .1 of milliwatts.
2165
2166 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2167
2168 A byte containing the id of the VLAN.
2169
wdenkc6097192002-11-03 00:24:07 +00002170- Status LED: CONFIG_STATUS_LED
2171
2172 Several configurations allow to display the current
2173 status using a LED. For instance, the LED will blink
2174 fast while running U-Boot code, stop blinking as
2175 soon as a reply to a BOOTP request was received, and
2176 start blinking slow once the Linux kernel is running
2177 (supported by a status LED driver in the Linux
2178 kernel). Defining CONFIG_STATUS_LED enables this
2179 feature in U-Boot.
2180
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002181 Additional options:
2182
2183 CONFIG_GPIO_LED
2184 The status LED can be connected to a GPIO pin.
2185 In such cases, the gpio_led driver can be used as a
2186 status LED backend implementation. Define CONFIG_GPIO_LED
2187 to include the gpio_led driver in the U-Boot binary.
2188
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002189 CONFIG_GPIO_LED_INVERTED_TABLE
2190 Some GPIO connected LEDs may have inverted polarity in which
2191 case the GPIO high value corresponds to LED off state and
2192 GPIO low value corresponds to LED on state.
2193 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2194 with a list of GPIO LEDs that have inverted polarity.
2195
wdenkc6097192002-11-03 00:24:07 +00002196- CAN Support: CONFIG_CAN_DRIVER
2197
2198 Defining CONFIG_CAN_DRIVER enables CAN driver support
2199 on those systems that support this (optional)
2200 feature, like the TQM8xxL modules.
2201
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002202- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002203
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002204 This enable the NEW i2c subsystem, and will allow you to use
2205 i2c commands at the u-boot command line (as long as you set
2206 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2207 based realtime clock chips or other i2c devices. See
2208 common/cmd_i2c.c for a description of the command line
2209 interface.
2210
2211 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002212 - drivers/i2c/soft_i2c.c:
2213 - activate first bus with CONFIG_SYS_I2C_SOFT define
2214 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2215 for defining speed and slave address
2216 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2217 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2218 for defining speed and slave address
2219 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2220 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2221 for defining speed and slave address
2222 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2223 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2224 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002225
Heiko Schocher00f792e2012-10-24 13:48:22 +02002226 - drivers/i2c/fsl_i2c.c:
2227 - activate i2c driver with CONFIG_SYS_I2C_FSL
2228 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2229 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2230 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2231 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002232 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002233 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2234 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2235 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2236 second bus.
2237
Simon Glass1f2ba722012-10-30 07:28:53 +00002238 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002239 - activate this driver with CONFIG_SYS_I2C_TEGRA
2240 - This driver adds 4 i2c buses with a fix speed from
2241 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002242
Dirk Eibach880540d2013-04-25 02:40:01 +00002243 - drivers/i2c/ppc4xx_i2c.c
2244 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2245 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2246 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2247
tremfac96402013-09-21 18:13:35 +02002248 - drivers/i2c/i2c_mxc.c
2249 - activate this driver with CONFIG_SYS_I2C_MXC
2250 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2251 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2252 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2253 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2254 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2255 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2256 If thoses defines are not set, default value is 100000
2257 for speed, and 0 for slave.
2258
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002259 - drivers/i2c/rcar_i2c.c:
2260 - activate this driver with CONFIG_SYS_I2C_RCAR
2261 - This driver adds 4 i2c buses
2262
2263 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2264 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2265 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2266 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2267 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2268 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2269 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2270 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2271 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2272
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002273 - drivers/i2c/sh_i2c.c:
2274 - activate this driver with CONFIG_SYS_I2C_SH
2275 - This driver adds from 2 to 5 i2c buses
2276
2277 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2278 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2279 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2280 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2281 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2282 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2283 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2284 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2285 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2286 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2287 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2288 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2289 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
2290
Heiko Schocher6789e842013-10-22 11:03:18 +02002291 - drivers/i2c/omap24xx_i2c.c
2292 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2293 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2294 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2295 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2296 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2297 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2298 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2299 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2300 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2301 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2302 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2303
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002304 - drivers/i2c/zynq_i2c.c
2305 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2306 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2307 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2308
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302309 - drivers/i2c/s3c24x0_i2c.c:
2310 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2311 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2312 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2313 with a fix speed from 100000 and the slave addr 0!
2314
Dirk Eibachb46226b2014-07-03 09:28:18 +02002315 - drivers/i2c/ihs_i2c.c
2316 - activate this driver with CONFIG_SYS_I2C_IHS
2317 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2318 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2319 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2320 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2321 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2322 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2323 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2324 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2325 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2326 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2327 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2328 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2329
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002330 additional defines:
2331
2332 CONFIG_SYS_NUM_I2C_BUSES
2333 Hold the number of i2c busses you want to use. If you
2334 don't use/have i2c muxes on your i2c bus, this
2335 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2336 omit this define.
2337
2338 CONFIG_SYS_I2C_DIRECT_BUS
2339 define this, if you don't use i2c muxes on your hardware.
2340 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2341 omit this define.
2342
2343 CONFIG_SYS_I2C_MAX_HOPS
2344 define how many muxes are maximal consecutively connected
2345 on one i2c bus. If you not use i2c muxes, omit this
2346 define.
2347
2348 CONFIG_SYS_I2C_BUSES
2349 hold a list of busses you want to use, only used if
2350 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2351 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2352 CONFIG_SYS_NUM_I2C_BUSES = 9:
2353
2354 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2355 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2356 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2357 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2358 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2359 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2360 {1, {I2C_NULL_HOP}}, \
2361 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2362 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2363 }
2364
2365 which defines
2366 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002367 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2368 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2369 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2370 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2371 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002372 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002373 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2374 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002375
2376 If you do not have i2c muxes on your board, omit this define.
2377
Heiko Schocherea818db2013-01-29 08:53:15 +01002378- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002379
2380 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2381 provides the following compelling advantages:
2382
2383 - more than one i2c adapter is usable
2384 - approved multibus support
2385 - better i2c mux support
2386
2387 ** Please consider updating your I2C driver now. **
2388
Heiko Schocherea818db2013-01-29 08:53:15 +01002389 These enable legacy I2C serial bus commands. Defining
2390 CONFIG_HARD_I2C will include the appropriate I2C driver
2391 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002392
wdenk945af8d2003-07-16 21:53:01 +00002393 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002394 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002395 CONFIG_COMMANDS) and communicate with i2c based realtime
2396 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002397 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002398
Ben Warrenbb99ad62006-09-07 16:50:54 -04002399 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002400
wdenk945af8d2003-07-16 21:53:01 +00002401 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002402 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +00002403
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002404 In both cases you will need to define CONFIG_SYS_I2C_SPEED
wdenk945af8d2003-07-16 21:53:01 +00002405 to be the frequency (in Hz) at which you wish your i2c bus
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002406 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002407 the CPU's i2c node address).
wdenk945af8d2003-07-16 21:53:01 +00002408
Peter Tyser8d321b82010-04-12 22:28:21 -05002409 Now, the u-boot i2c code for the mpc8xx
Stefan Roesea47a12b2010-04-15 16:07:28 +02002410 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
Peter Tyser8d321b82010-04-12 22:28:21 -05002411 and so its address should therefore be cleared to 0 (See,
2412 eg, MPC823e User's Manual p.16-473). So, set
2413 CONFIG_SYS_I2C_SLAVE to 0.
wdenkc6097192002-11-03 00:24:07 +00002414
Eric Millbrandt5da71ef2009-09-03 08:09:44 -05002415 CONFIG_SYS_I2C_INIT_MPC5XXX
2416
2417 When a board is reset during an i2c bus transfer
2418 chips might think that the current transfer is still
2419 in progress. Reset the slave devices by sending start
2420 commands until the slave device responds.
2421
wdenk945af8d2003-07-16 21:53:01 +00002422 That's all that's required for CONFIG_HARD_I2C.
wdenkb37c7e52003-06-30 16:24:52 +00002423
Heiko Schocherea818db2013-01-29 08:53:15 +01002424 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
wdenkb37c7e52003-06-30 16:24:52 +00002425 then the following macros need to be defined (examples are
2426 from include/configs/lwmon.h):
wdenkc6097192002-11-03 00:24:07 +00002427
2428 I2C_INIT
2429
wdenkb37c7e52003-06-30 16:24:52 +00002430 (Optional). Any commands necessary to enable the I2C
wdenk43d96162003-03-06 00:02:04 +00002431 controller or configure ports.
wdenkc6097192002-11-03 00:24:07 +00002432
wdenkba56f622004-02-06 23:19:44 +00002433 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL)
wdenkb37c7e52003-06-30 16:24:52 +00002434
wdenkc6097192002-11-03 00:24:07 +00002435 I2C_PORT
2436
wdenk43d96162003-03-06 00:02:04 +00002437 (Only for MPC8260 CPU). The I/O port to use (the code
2438 assumes both bits are on the same port). Valid values
2439 are 0..3 for ports A..D.
wdenkc6097192002-11-03 00:24:07 +00002440
2441 I2C_ACTIVE
2442
2443 The code necessary to make the I2C data line active
2444 (driven). If the data line is open collector, this
2445 define can be null.
2446
wdenkb37c7e52003-06-30 16:24:52 +00002447 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA)
2448
wdenkc6097192002-11-03 00:24:07 +00002449 I2C_TRISTATE
2450
2451 The code necessary to make the I2C data line tri-stated
2452 (inactive). If the data line is open collector, this
2453 define can be null.
2454
wdenkb37c7e52003-06-30 16:24:52 +00002455 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2456
wdenkc6097192002-11-03 00:24:07 +00002457 I2C_READ
2458
York Sun472d5462013-04-01 11:29:11 -07002459 Code that returns true if the I2C data line is high,
2460 false if it is low.
wdenkc6097192002-11-03 00:24:07 +00002461
wdenkb37c7e52003-06-30 16:24:52 +00002462 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2463
wdenkc6097192002-11-03 00:24:07 +00002464 I2C_SDA(bit)
2465
York Sun472d5462013-04-01 11:29:11 -07002466 If <bit> is true, sets the I2C data line high. If it
2467 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002468
wdenkb37c7e52003-06-30 16:24:52 +00002469 eg: #define I2C_SDA(bit) \
wdenk2535d602003-07-17 23:16:40 +00002470 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \
wdenkba56f622004-02-06 23:19:44 +00002471 else immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenkb37c7e52003-06-30 16:24:52 +00002472
wdenkc6097192002-11-03 00:24:07 +00002473 I2C_SCL(bit)
2474
York Sun472d5462013-04-01 11:29:11 -07002475 If <bit> is true, sets the I2C clock line high. If it
2476 is false, it clears it (low).
wdenkc6097192002-11-03 00:24:07 +00002477
wdenkb37c7e52003-06-30 16:24:52 +00002478 eg: #define I2C_SCL(bit) \
wdenk2535d602003-07-17 23:16:40 +00002479 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \
wdenkba56f622004-02-06 23:19:44 +00002480 else immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenkb37c7e52003-06-30 16:24:52 +00002481
wdenkc6097192002-11-03 00:24:07 +00002482 I2C_DELAY
2483
2484 This delay is invoked four times per clock cycle so this
2485 controls the rate of data transfer. The data rate thus
wdenkb37c7e52003-06-30 16:24:52 +00002486 is 1 / (I2C_DELAY * 4). Often defined to be something
wdenk945af8d2003-07-16 21:53:01 +00002487 like:
2488
wdenkb37c7e52003-06-30 16:24:52 +00002489 #define I2C_DELAY udelay(2)
wdenkc6097192002-11-03 00:24:07 +00002490
Mike Frysinger793b5722010-07-21 13:38:02 -04002491 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2492
2493 If your arch supports the generic GPIO framework (asm/gpio.h),
2494 then you may alternatively define the two GPIOs that are to be
2495 used as SCL / SDA. Any of the previous I2C_xxx macros will
2496 have GPIO-based defaults assigned to them as appropriate.
2497
2498 You should define these to the GPIO value as given directly to
2499 the generic GPIO functions.
2500
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002501 CONFIG_SYS_I2C_INIT_BOARD
wdenk47cd00f2003-03-06 13:39:27 +00002502
wdenk8bde7f72003-06-27 21:31:46 +00002503 When a board is reset during an i2c bus transfer
2504 chips might think that the current transfer is still
2505 in progress. On some boards it is possible to