blob: ef8d437fbd46bf350eb6b259eeed3dd0a1810276 [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
Peter Tyser8d321b82010-04-12 22:28:21 -0500185 /mpc5xx Files specific to Freescale MPC5xx CPUs
186 /mpc5xxx Files specific to Freescale MPC5xxx CPUs
187 /mpc8xx Files specific to Freescale MPC8xx CPUs
Peter Tyser8d321b82010-04-12 22:28:21 -0500188 /mpc8260 Files specific to Freescale MPC8260 CPUs
189 /mpc85xx Files specific to Freescale MPC85xx CPUs
190 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs
191 /lib Architecture specific library files
192 /sh Files generic to SH architecture
193 /cpu CPU specific files
194 /sh2 Files specific to sh2 CPUs
195 /sh3 Files specific to sh3 CPUs
196 /sh4 Files specific to sh4 CPUs
197 /lib Architecture specific library files
198 /sparc Files generic to SPARC architecture
199 /cpu CPU specific files
200 /leon2 Files specific to Gaisler LEON2 SPARC CPU
201 /leon3 Files specific to Gaisler LEON3 SPARC CPU
202 /lib Architecture specific library files
Robert P. J. Day33c77312013-09-15 18:34:15 -0400203 /x86 Files generic to x86 architecture
204 /cpu CPU specific files
205 /lib Architecture specific library files
Peter Tyser8d321b82010-04-12 22:28:21 -0500206/api Machine/arch independent API for external apps
207/board Board dependent files
208/common Misc architecture independent functions
209/disk Code for disk drive partition handling
210/doc Documentation (don't expect too much)
211/drivers Commonly used device drivers
Robert P. J. Day33c77312013-09-15 18:34:15 -0400212/dts Contains Makefile for building internal U-Boot fdt.
Peter Tyser8d321b82010-04-12 22:28:21 -0500213/examples Example code for standalone applications, etc.
214/fs Filesystem code (cramfs, ext2, jffs2, etc.)
215/include Header Files
216/lib Files generic to all architectures
217 /libfdt Library files to support flattened device trees
218 /lzma Library files to support LZMA decompression
219 /lzo Library files to support LZO decompression
220/net Networking code
221/post Power On Self Test
Robert P. J. Day33c77312013-09-15 18:34:15 -0400222/spl Secondary Program Loader framework
Peter Tyser8d321b82010-04-12 22:28:21 -0500223/tools Tools to build S-Record or U-Boot images, etc.
wdenkc6097192002-11-03 00:24:07 +0000224
wdenkc6097192002-11-03 00:24:07 +0000225Software Configuration:
226=======================
227
228Configuration is usually done using C preprocessor defines; the
229rationale behind that is to avoid dead code whenever possible.
230
231There are two classes of configuration variables:
232
233* Configuration _OPTIONS_:
234 These are selectable by the user and have names beginning with
235 "CONFIG_".
236
237* Configuration _SETTINGS_:
238 These depend on the hardware etc. and should not be meddled with if
239 you don't know what you're doing; they have names beginning with
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200240 "CONFIG_SYS_".
wdenkc6097192002-11-03 00:24:07 +0000241
242Later we will add a configuration tool - probably similar to or even
243identical to what's used for the Linux kernel. Right now, we have to
244do the configuration by hand, which means creating some symbolic
245links and editing some configuration files. We use the TQM8xxL boards
246as an example here.
247
248
249Selection of Processor Architecture and Board Type:
250---------------------------------------------------
251
252For all supported boards there are ready-to-use default
Holger Freytherab584d62014-08-04 09:26:05 +0200253configurations available; just type "make <board_name>_defconfig".
wdenkc6097192002-11-03 00:24:07 +0000254
255Example: For a TQM823L module type:
256
257 cd u-boot
Holger Freytherab584d62014-08-04 09:26:05 +0200258 make TQM823L_defconfig
wdenkc6097192002-11-03 00:24:07 +0000259
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200260For the Cogent platform, you need to specify the CPU type as well;
Holger Freytherab584d62014-08-04 09:26:05 +0200261e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenkc6097192002-11-03 00:24:07 +0000262directory according to the instructions in cogent/README.
263
264
Simon Glass75b3c3a2014-03-22 17:12:59 -0600265Sandbox Environment:
266--------------------
267
268U-Boot can be built natively to run on a Linux host using the 'sandbox'
269board. This allows feature development which is not board- or architecture-
270specific to be undertaken on a native platform. The sandbox is also used to
271run some of U-Boot's tests.
272
Jagannadha Sutradharudu Teki6b1978f2014-08-31 21:19:43 +0530273See board/sandbox/README.sandbox for more details.
Simon Glass75b3c3a2014-03-22 17:12:59 -0600274
275
Simon Glassdb910352015-03-03 08:03:00 -0700276Board Initialisation Flow:
277--------------------------
278
279This is the intended start-up flow for boards. This should apply for both
280SPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
281mostly uses a separate code path, but the funtion names and roles of each
282function are the same. Some boards or architectures may not conform to this.
283At least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.
284
285Execution starts with start.S with three functions called during init after
286that. The purpose and limitations of each is described below.
287
288lowlevel_init():
289 - purpose: essential init to permit execution to reach board_init_f()
290 - no global_data or BSS
291 - there is no stack (ARMv7 may have one but it will soon be removed)
292 - must not set up SDRAM or use console
293 - must only do the bare minimum to allow execution to continue to
294 board_init_f()
295 - this is almost never needed
296 - return normally from this function
297
298board_init_f():
299 - purpose: set up the machine ready for running board_init_r():
300 i.e. SDRAM and serial UART
301 - global_data is available
302 - stack is in SRAM
303 - BSS is not available, so you cannot use global/static variables,
304 only stack variables and global_data
305
306 Non-SPL-specific notes:
307 - dram_init() is called to set up DRAM. If already done in SPL this
308 can do nothing
309
310 SPL-specific notes:
311 - you can override the entire board_init_f() function with your own
312 version as needed.
313 - preloader_console_init() can be called here in extremis
314 - should set up SDRAM, and anything needed to make the UART work
315 - these is no need to clear BSS, it will be done by crt0.S
316 - must return normally from this function (don't call board_init_r()
317 directly)
318
319Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
320this point the stack and global_data are relocated to below
321CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
322memory.
323
324board_init_r():
325 - purpose: main execution, common code
326 - global_data is available
327 - SDRAM is available
328 - BSS is available, all static/global variables can be used
329 - execution eventually continues to main_loop()
330
331 Non-SPL-specific notes:
332 - U-Boot is relocated to the top of memory and is now running from
333 there.
334
335 SPL-specific notes:
336 - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
337 CONFIG_SPL_STACK_R_ADDR points into SDRAM
338 - preloader_console_init() can be called here - typically this is
339 done by defining CONFIG_SPL_BOARD_INIT and then supplying a
340 spl_board_init() function containing this call
341 - loads U-Boot or (in falcon mode) Linux
342
343
344
wdenkc6097192002-11-03 00:24:07 +0000345Configuration Options:
346----------------------
347
348Configuration depends on the combination of board and CPU type; all
349such information is kept in a configuration file
350"include/configs/<board_name>.h".
351
352Example: For a TQM823L module, all configuration settings are in
353"include/configs/TQM823L.h".
354
355
wdenk7f6c2cb2002-11-10 22:06:23 +0000356Many of the options are named exactly as the corresponding Linux
357kernel configuration options. The intention is to make it easier to
358build a config tool - later.
359
360
wdenkc6097192002-11-03 00:24:07 +0000361The following options need to be configured:
362
Kim Phillips26281142007-08-10 13:28:25 -0500363- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX.
wdenkc6097192002-11-03 00:24:07 +0000364
Kim Phillips26281142007-08-10 13:28:25 -0500365- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS.
Wolfgang Denk6ccec442006-10-24 14:42:37 +0200366
367- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
Haavard Skinnemoen09ea0de2007-11-01 12:44:20 +0100368 Define exactly one, e.g. CONFIG_ATSTK1002
wdenkc6097192002-11-03 00:24:07 +0000369
370- CPU Module Type: (if CONFIG_COGENT is defined)
371 Define exactly one of
372 CONFIG_CMA286_60_OLD
373--- FIXME --- not tested yet:
374 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
375 CONFIG_CMA287_23, CONFIG_CMA287_50
376
377- Motherboard Type: (if CONFIG_COGENT is defined)
378 Define exactly one of
379 CONFIG_CMA101, CONFIG_CMA102
380
381- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
382 Define one or more of
383 CONFIG_CMA302
384
385- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
386 Define one or more of
387 CONFIG_LCD_HEARTBEAT - update a character position on
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200388 the LCD display every second with
wdenkc6097192002-11-03 00:24:07 +0000389 a "rotator" |\-/|\-/
390
Lei Wencf946c62011-02-09 18:06:58 +0530391- Marvell Family Member
392 CONFIG_SYS_MVFS - define it if you want to enable
393 multiple fs option at one time
394 for marvell soc family
395
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200396- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk66ca92a2004-09-28 17:59:53 +0000397 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if
398 get_gclk_freq() cannot work
wdenk5da627a2003-10-09 20:09:04 +0000399 e.g. if there is no 32KHz
400 reference PIT/RTC clock
wdenk66ca92a2004-09-28 17:59:53 +0000401 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK
402 or XTAL/EXTAL)
wdenkc6097192002-11-03 00:24:07 +0000403
wdenk66ca92a2004-09-28 17:59:53 +0000404- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200405 CONFIG_SYS_8xx_CPUCLK_MIN
406 CONFIG_SYS_8xx_CPUCLK_MAX
wdenk66ca92a2004-09-28 17:59:53 +0000407 CONFIG_8xx_CPUCLK_DEFAULT
wdenk75d1ea72004-01-31 20:06:54 +0000408 See doc/README.MPC866
409
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200410 CONFIG_SYS_MEASURE_CPUCLK
wdenk75d1ea72004-01-31 20:06:54 +0000411
wdenkba56f622004-02-06 23:19:44 +0000412 Define this to measure the actual CPU clock instead
413 of relying on the correctness of the configured
414 values. Mostly useful for board bringup to make sure
415 the PLL is locked at the intended frequency. Note
416 that this requires a (stable) reference clock (32 kHz
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200417 RTC clock or CONFIG_SYS_8XX_XIN)
wdenk75d1ea72004-01-31 20:06:54 +0000418
Heiko Schocher506f3912009-03-12 07:37:15 +0100419 CONFIG_SYS_DELAYED_ICACHE
420
421 Define this option if you want to enable the
422 ICache only when Code runs from RAM.
423
Kumar Gala66412c62011-02-18 05:40:54 -0600424- 85xx CPU Options:
York Sunffd06e02012-10-08 07:44:30 +0000425 CONFIG_SYS_PPC64
426
427 Specifies that the core is a 64-bit PowerPC implementation (implements
428 the "64" category of the Power ISA). This is necessary for ePAPR
429 compliance, among other possible reasons.
430
Kumar Gala66412c62011-02-18 05:40:54 -0600431 CONFIG_SYS_FSL_TBCLK_DIV
432
433 Defines the core time base clock divider ratio compared to the
434 system clock. On most PQ3 devices this is 8, on newer QorIQ
435 devices it can be 16 or 32. The ratio varies from SoC to Soc.
436
Kumar Gala8f290842011-05-20 00:39:21 -0500437 CONFIG_SYS_FSL_PCIE_COMPAT
438
439 Defines the string to utilize when trying to match PCIe device
440 tree nodes for the given platform.
441
Prabhakar Kushwahaafa6b552012-04-29 23:56:13 +0000442 CONFIG_SYS_PPC_E500_DEBUG_TLB
443
444 Enables a temporary TLB entry to be used during boot to work
445 around limitations in e500v1 and e500v2 external debugger
446 support. This reduces the portions of the boot code where
447 breakpoints and single stepping do not work. The value of this
448 symbol should be set to the TLB1 entry to be used for this
449 purpose.
450
Scott Wood33eee332012-08-14 10:14:53 +0000451 CONFIG_SYS_FSL_ERRATUM_A004510
452
453 Enables a workaround for erratum A004510. If set,
454 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
455 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
456
457 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
458 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
459
460 Defines one or two SoC revisions (low 8 bits of SVR)
461 for which the A004510 workaround should be applied.
462
463 The rest of SVR is either not relevant to the decision
464 of whether the erratum is present (e.g. p2040 versus
465 p2041) or is implied by the build target, which controls
466 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
467
468 See Freescale App Note 4493 for more information about
469 this erratum.
470
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530471 CONFIG_A003399_NOR_WORKAROUND
472 Enables a workaround for IFC erratum A003399. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800473 required during NOR boot.
Prabhakar Kushwaha74fa22e2013-04-16 13:27:44 +0530474
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530475 CONFIG_A008044_WORKAROUND
476 Enables a workaround for T1040/T1042 erratum A008044. It is only
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800477 required during NAND boot and valid for Rev 1.0 SoC revision
Prabhakar Kushwaha9f074e62014-10-29 22:33:09 +0530478
Scott Wood33eee332012-08-14 10:14:53 +0000479 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
480
481 This is the value to write into CCSR offset 0x18600
482 according to the A004510 workaround.
483
Priyanka Jain64501c62013-07-02 09:21:04 +0530484 CONFIG_SYS_FSL_DSP_DDR_ADDR
485 This value denotes start offset of DDR memory which is
486 connected exclusively to the DSP cores.
487
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530488 CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
489 This value denotes start offset of M2 memory
490 which is directly connected to the DSP core.
491
Priyanka Jain64501c62013-07-02 09:21:04 +0530492 CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
493 This value denotes start offset of M3 memory which is directly
494 connected to the DSP core.
495
Priyanka Jain765b0bd2013-04-04 09:31:54 +0530496 CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
497 This value denotes start offset of DSP CCSR space.
498
Priyanka Jainb1359912013-12-17 14:25:52 +0530499 CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
500 Single Source Clock is clocking mode present in some of FSL SoC's.
501 In this mode, a single differential clock is used to supply
502 clocks to the sysclock, ddrclock and usbclock.
503
Aneesh Bansalfb4a2402014-03-18 23:40:26 +0530504 CONFIG_SYS_CPC_REINIT_F
505 This CONFIG is defined when the CPC is configured as SRAM at the
506 time of U-boot entry and is required to be re-initialized.
507
Tang Yuantianaade2002014-04-17 15:33:46 +0800508 CONFIG_DEEP_SLEEP
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800509 Indicates this SoC supports deep sleep feature. If deep sleep is
Tang Yuantianaade2002014-04-17 15:33:46 +0800510 supported, core will start to execute uboot when wakes up.
511
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000512- Generic CPU options:
York Sun2a1680e2014-05-02 17:28:04 -0700513 CONFIG_SYS_GENERIC_GLOBAL_DATA
514 Defines global data is initialized in generic board board_init_f().
515 If this macro is defined, global data is created and cleared in
516 generic board board_init_f(). Without this macro, architecture/board
517 should initialize global data before calling board_init_f().
518
Daniel Schwierzeck6cb461b2012-04-02 02:57:56 +0000519 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
520
521 Defines the endianess of the CPU. Implementation of those
522 values is arch specific.
523
York Sun5614e712013-09-30 09:22:09 -0700524 CONFIG_SYS_FSL_DDR
525 Freescale DDR driver in use. This type of DDR controller is
526 found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
527 SoCs.
528
529 CONFIG_SYS_FSL_DDR_ADDR
530 Freescale DDR memory-mapped register base.
531
532 CONFIG_SYS_FSL_DDR_EMU
533 Specify emulator support for DDR. Some DDR features such as
534 deskew training are not available.
535
536 CONFIG_SYS_FSL_DDRC_GEN1
537 Freescale DDR1 controller.
538
539 CONFIG_SYS_FSL_DDRC_GEN2
540 Freescale DDR2 controller.
541
542 CONFIG_SYS_FSL_DDRC_GEN3
543 Freescale DDR3 controller.
544
York Sun34e026f2014-03-27 17:54:47 -0700545 CONFIG_SYS_FSL_DDRC_GEN4
546 Freescale DDR4 controller.
547
York Sun9ac4ffb2013-09-30 14:20:51 -0700548 CONFIG_SYS_FSL_DDRC_ARM_GEN3
549 Freescale DDR3 controller for ARM-based SoCs.
550
York Sun5614e712013-09-30 09:22:09 -0700551 CONFIG_SYS_FSL_DDR1
552 Board config to use DDR1. It can be enabled for SoCs with
553 Freescale DDR1 or DDR2 controllers, depending on the board
554 implemetation.
555
556 CONFIG_SYS_FSL_DDR2
557 Board config to use DDR2. It can be eanbeld for SoCs with
558 Freescale DDR2 or DDR3 controllers, depending on the board
559 implementation.
560
561 CONFIG_SYS_FSL_DDR3
562 Board config to use DDR3. It can be enabled for SoCs with
York Sun34e026f2014-03-27 17:54:47 -0700563 Freescale DDR3 or DDR3L controllers.
564
565 CONFIG_SYS_FSL_DDR3L
566 Board config to use DDR3L. It can be enabled for SoCs with
567 DDR3L controllers.
568
569 CONFIG_SYS_FSL_DDR4
570 Board config to use DDR4. It can be enabled for SoCs with
571 DDR4 controllers.
York Sun5614e712013-09-30 09:22:09 -0700572
Prabhakar Kushwaha1b4175d2014-01-18 12:28:30 +0530573 CONFIG_SYS_FSL_IFC_BE
574 Defines the IFC controller register space as Big Endian
575
576 CONFIG_SYS_FSL_IFC_LE
577 Defines the IFC controller register space as Little Endian
578
Prabhakar Kushwaha690e4252014-01-13 11:28:04 +0530579 CONFIG_SYS_FSL_PBL_PBI
580 It enables addition of RCW (Power on reset configuration) in built image.
581 Please refer doc/README.pblimage for more details
582
583 CONFIG_SYS_FSL_PBL_RCW
584 It adds PBI(pre-boot instructions) commands in u-boot build image.
585 PBI commands can be used to configure SoC before it starts the execution.
586 Please refer doc/README.pblimage for more details
587
Prabhakar Kushwaha89ad7be2014-04-08 19:13:34 +0530588 CONFIG_SPL_FSL_PBL
589 It adds a target to create boot binary having SPL binary in PBI format
590 concatenated with u-boot binary.
591
York Sun4e5b1bd2014-02-10 13:59:42 -0800592 CONFIG_SYS_FSL_DDR_BE
593 Defines the DDR controller register space as Big Endian
594
595 CONFIG_SYS_FSL_DDR_LE
596 Defines the DDR controller register space as Little Endian
597
York Sun6b9e3092014-02-10 13:59:43 -0800598 CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
599 Physical address from the view of DDR controllers. It is the
600 same as CONFIG_SYS_DDR_SDRAM_BASE for all Power SoCs. But
601 it could be different for ARM SoCs.
602
York Sun6b1e1252014-02-10 13:59:44 -0800603 CONFIG_SYS_FSL_DDR_INTLV_256B
604 DDR controller interleaving on 256-byte. This is a special
605 interleaving mode, handled by Dickens for Freescale layerscape
606 SoCs with ARM core.
607
York Sun1d71efb2014-08-01 15:51:00 -0700608 CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
609 Number of controllers used as main memory.
610
611 CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
612 Number of controllers used for other than main memory.
613
Ruchika Gupta028dbb82014-09-09 11:50:31 +0530614 CONFIG_SYS_FSL_SEC_BE
615 Defines the SEC controller register space as Big Endian
616
617 CONFIG_SYS_FSL_SEC_LE
618 Defines the SEC controller register space as Little Endian
619
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100620- Intel Monahans options:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200621 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100622
623 Defines the Monahans run mode to oscillator
624 ratio. Valid values are 8, 16, 24, 31. The core
625 frequency is this value multiplied by 13 MHz.
626
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200627 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200628
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100629 Defines the Monahans turbo mode to oscillator
630 ratio. Valid values are 1 (default if undefined) and
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200631 2. The core frequency as calculated above is multiplied
Markus Klotzbuecher0b953ff2006-03-24 15:28:02 +0100632 by this value.
Wolfgang Denkcf48eb92006-04-16 10:51:58 +0200633
Daniel Schwierzeck92bbd642011-07-27 13:22:39 +0200634- MIPS CPU options:
635 CONFIG_SYS_INIT_SP_OFFSET
636
637 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
638 pointer. This is needed for the temporary stack before
639 relocation.
640
641 CONFIG_SYS_MIPS_CACHE_MODE
642
643 Cache operation mode for the MIPS CPU.
644 See also arch/mips/include/asm/mipsregs.h.
645 Possible values are:
646 CONF_CM_CACHABLE_NO_WA
647 CONF_CM_CACHABLE_WA
648 CONF_CM_UNCACHED
649 CONF_CM_CACHABLE_NONCOHERENT
650 CONF_CM_CACHABLE_CE
651 CONF_CM_CACHABLE_COW
652 CONF_CM_CACHABLE_CUW
653 CONF_CM_CACHABLE_ACCELERATED
654
655 CONFIG_SYS_XWAY_EBU_BOOTCFG
656
657 Special option for Lantiq XWAY SoCs for booting from NOR flash.
658 See also arch/mips/cpu/mips32/start.S.
659
660 CONFIG_XWAY_SWAP_BYTES
661
662 Enable compilation of tools/xway-swap-bytes needed for Lantiq
663 XWAY SoCs for booting from NOR flash. The U-Boot image needs to
664 be swapped if a flash programmer is used.
665
Christian Rieschb67d8812012-02-02 00:44:39 +0000666- ARM options:
667 CONFIG_SYS_EXCEPTION_VECTORS_HIGH
668
669 Select high exception vectors of the ARM core, e.g., do not
670 clear the V bit of the c1 register of CP15.
671
Aneesh V5356f542012-03-08 07:20:19 +0000672 CONFIG_SYS_THUMB_BUILD
673
674 Use this flag to build U-Boot using the Thumb instruction
675 set for ARM architectures. Thumb instruction set provides
676 better code density. For ARM architectures that support
677 Thumb2 this flag will result in Thumb2 code generated by
678 GCC.
679
Stephen Warrenc5d47522013-03-04 13:29:40 +0000680 CONFIG_ARM_ERRATA_716044
Stephen Warren06785872013-02-26 12:28:27 +0000681 CONFIG_ARM_ERRATA_742230
682 CONFIG_ARM_ERRATA_743622
683 CONFIG_ARM_ERRATA_751472
Nitin Gargb7588e32014-04-02 08:55:02 -0500684 CONFIG_ARM_ERRATA_761320
Ian Campbelle392b922015-09-29 10:27:09 +0100685 CONFIG_ARM_ERRATA_773022
686 CONFIG_ARM_ERRATA_774769
687 CONFIG_ARM_ERRATA_794072
Stephen Warren06785872013-02-26 12:28:27 +0000688
689 If set, the workarounds for these ARM errata are applied early
690 during U-Boot startup. Note that these options force the
691 workarounds to be applied; no CPU-type/version detection
692 exists, unlike the similar options in the Linux kernel. Do not
693 set these options unless they apply!
694
York Sun207774b2015-03-20 19:28:08 -0700695 COUNTER_FREQUENCY
696 Generic timer clock source frequency.
697
698 COUNTER_FREQUENCY_REAL
699 Generic timer clock source frequency if the real clock is
700 different from COUNTER_FREQUENCY, and can only be determined
701 at run time.
702
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500703 NOTE: The following can be machine specific errata. These
704 do have ability to provide rudimentary version and machine
705 specific checks, but expect no product checks.
Nishanth Menon5902f4c2015-03-09 17:12:01 -0500706 CONFIG_ARM_ERRATA_430973
Nishanth Menonb45c48a2015-03-09 17:12:00 -0500707 CONFIG_ARM_ERRATA_454179
Nishanth Menon9b4d65f2015-03-09 17:12:02 -0500708 CONFIG_ARM_ERRATA_621766
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500709 CONFIG_ARM_ERRATA_798870
Nishanth Menona615d0b2015-07-27 16:26:05 -0500710 CONFIG_ARM_ERRATA_801819
Nishanth Menonc616a0d2015-03-09 17:11:59 -0500711
Stephen Warren73c38932015-01-19 16:25:52 -0700712- Tegra SoC options:
713 CONFIG_TEGRA_SUPPORT_NON_SECURE
714
715 Support executing U-Boot in non-secure (NS) mode. Certain
716 impossible actions will be skipped if the CPU is in NS mode,
717 such as ARM architectural timer initialization.
718
wdenk5da627a2003-10-09 20:09:04 +0000719- Linux Kernel Interface:
wdenkc6097192002-11-03 00:24:07 +0000720 CONFIG_CLOCKS_IN_MHZ
721
722 U-Boot stores all clock information in Hz
723 internally. For binary compatibility with older Linux
724 kernels (which expect the clocks passed in the
725 bd_info data to be in MHz) the environment variable
726 "clocks_in_mhz" can be defined so that U-Boot
727 converts clock data to MHZ before passing it to the
728 Linux kernel.
wdenkc6097192002-11-03 00:24:07 +0000729 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
Wolfgang Denk218ca722008-03-26 10:40:12 +0100730 "clocks_in_mhz=1" is automatically included in the
wdenkc6097192002-11-03 00:24:07 +0000731 default environment.
732
wdenk5da627a2003-10-09 20:09:04 +0000733 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only]
734
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -0800735 When transferring memsize parameter to Linux, some versions
wdenk5da627a2003-10-09 20:09:04 +0000736 expect it to be in bytes, others in MB.
737 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
738
Gerald Van Barenfec6d9e2008-06-03 20:34:45 -0400739 CONFIG_OF_LIBFDT
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200740
741 New kernel versions are expecting firmware settings to be
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400742 passed using flattened device trees (based on open firmware
743 concepts).
744
745 CONFIG_OF_LIBFDT
746 * New libfdt-based support
747 * Adds the "fdt" command
Kim Phillips3bb342f2007-08-10 14:34:14 -0500748 * The bootm command automatically updates the fdt
Gerald Van Baren213bf8c2007-03-31 12:23:51 -0400749
Marcel Ziswilerb55ae402009-09-09 21:18:41 +0200750 OF_CPU - The proper name of the cpus node (only required for
751 MPC512X and MPC5xxx based boards).
752 OF_SOC - The proper name of the soc node (only required for
753 MPC512X and MPC5xxx based boards).
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200754 OF_TBCLK - The timebase frequency.
Kumar Galac2871f02006-01-11 13:59:02 -0600755 OF_STDOUT_PATH - The path to the console device
Wolfgang Denkf57f70a2005-10-13 01:45:54 +0200756
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200757 boards with QUICC Engines require OF_QE to set UCC MAC
758 addresses
Kim Phillips3bb342f2007-08-10 14:34:14 -0500759
Kumar Gala4e253132006-01-11 13:54:17 -0600760 CONFIG_OF_BOARD_SETUP
761
762 Board code has addition modification that it wants to make
763 to the flat device tree before handing it off to the kernel
wdenk6705d812004-08-02 23:22:59 +0000764
Simon Glassc654b512014-10-23 18:58:54 -0600765 CONFIG_OF_SYSTEM_SETUP
766
767 Other code has addition modification that it wants to make
768 to the flat device tree before handing it off to the kernel.
769 This causes ft_system_setup() to be called before booting
770 the kernel.
771
Matthew McClintock02677682006-06-28 10:41:37 -0500772 CONFIG_OF_BOOT_CPU
773
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200774 This define fills in the correct boot CPU in the boot
Matthew McClintock02677682006-06-28 10:41:37 -0500775 param header, the default value is zero if undefined.
776
Heiko Schocher3887c3f2009-09-23 07:56:08 +0200777 CONFIG_OF_IDE_FIXUP
778
779 U-Boot can detect if an IDE device is present or not.
780 If not, and this new config option is activated, U-Boot
781 removes the ATA node from the DTS before booting Linux,
782 so the Linux IDE driver does not probe the device and
783 crash. This is needed for buggy hardware (uc101) where
784 no pull down resistor is connected to the signal IDE5V_DD7.
785
Igor Grinberg7eb29392011-07-14 05:45:07 +0000786 CONFIG_MACH_TYPE [relevant for ARM only][mandatory]
787
788 This setting is mandatory for all boards that have only one
789 machine type and must be used to specify the machine type
790 number as it appears in the ARM machine registry
791 (see http://www.arm.linux.org.uk/developer/machines/).
792 Only boards that have multiple machine types supported
793 in a single configuration file and the machine type is
794 runtime discoverable, do not have to use this setting.
795
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100796- vxWorks boot parameters:
797
798 bootvx constructs a valid bootline using the following
Bin Meng9e98b7e2015-10-07 20:19:17 -0700799 environments variables: bootdev, bootfile, ipaddr, netmask,
800 serverip, gatewayip, hostname, othbootargs.
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100801 It loads the vxWorks image pointed bootfile.
802
Niklaus Giger0b2f4ec2008-11-03 22:13:47 +0100803 Note: If a "bootargs" environment is defined, it will overwride
804 the defaults discussed just above.
805
Aneesh V2c451f72011-06-16 23:30:47 +0000806- Cache Configuration:
807 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
808 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
809 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
810
Aneesh V93bc2192011-06-16 23:30:51 +0000811- Cache Configuration for ARM:
812 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
813 controller
814 CONFIG_SYS_PL310_BASE - Physical base address of PL310
815 controller register space
816
wdenk6705d812004-08-02 23:22:59 +0000817- Serial Ports:
Andreas Engel48d01922008-09-08 14:30:53 +0200818 CONFIG_PL010_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000819
820 Define this if you want support for Amba PrimeCell PL010 UARTs.
821
Andreas Engel48d01922008-09-08 14:30:53 +0200822 CONFIG_PL011_SERIAL
wdenk6705d812004-08-02 23:22:59 +0000823
824 Define this if you want support for Amba PrimeCell PL011 UARTs.
825
826 CONFIG_PL011_CLOCK
827
828 If you have Amba PrimeCell PL011 UARTs, set this variable to
829 the clock speed of the UARTs.
830
831 CONFIG_PL01x_PORTS
832
833 If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
834 define this to a list of base addresses for each (supported)
835 port. See e.g. include/configs/versatile.h
836
Karicheri, Muralidharand57dee52014-04-09 15:38:46 -0400837 CONFIG_SERIAL_HW_FLOW_CONTROL
838
839 Define this variable to enable hw flow control in serial driver.
840 Current user of this option is drivers/serial/nsl16550.c driver
wdenk6705d812004-08-02 23:22:59 +0000841
wdenkc6097192002-11-03 00:24:07 +0000842- Console Interface:
wdenk43d96162003-03-06 00:02:04 +0000843 Depending on board, define exactly one serial port
844 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
845 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
846 console by defining CONFIG_8xx_CONS_NONE
wdenkc6097192002-11-03 00:24:07 +0000847
848 Note: if CONFIG_8xx_CONS_NONE is defined, the serial
849 port routines must be defined elsewhere
850 (i.e. serial_init(), serial_getc(), ...)
851
852 CONFIG_CFB_CONSOLE
853 Enables console device for a color framebuffer. Needs following
Wolfgang Denkc53043b2011-12-07 12:19:20 +0000854 defines (cf. smiLynxEM, i8042)
wdenkc6097192002-11-03 00:24:07 +0000855 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation
856 (default big endian)
857 VIDEO_HW_RECTFILL graphic chip supports
858 rectangle fill
859 (cf. smiLynxEM)
860 VIDEO_HW_BITBLT graphic chip supports
861 bit-blit (cf. smiLynxEM)
862 VIDEO_VISIBLE_COLS visible pixel columns
863 (cols=pitch)
wdenkba56f622004-02-06 23:19:44 +0000864 VIDEO_VISIBLE_ROWS visible pixel rows
865 VIDEO_PIXEL_SIZE bytes per pixel
wdenkc6097192002-11-03 00:24:07 +0000866 VIDEO_DATA_FORMAT graphic data format
867 (0-5, cf. cfb_console.c)
wdenkba56f622004-02-06 23:19:44 +0000868 VIDEO_FB_ADRS framebuffer address
wdenkc6097192002-11-03 00:24:07 +0000869 VIDEO_KBD_INIT_FCT keyboard int fct
870 (i.e. i8042_kbd_init())
871 VIDEO_TSTC_FCT test char fct
872 (i.e. i8042_tstc)
873 VIDEO_GETC_FCT get char fct
874 (i.e. i8042_getc)
875 CONFIG_CONSOLE_CURSOR cursor drawing on/off
876 (requires blink timer
877 cf. i8042.c)
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200878 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenkc6097192002-11-03 00:24:07 +0000879 CONFIG_CONSOLE_TIME display time/date info in
880 upper right corner
Jon Loeliger602ad3b2007-06-11 19:03:39 -0500881 (requires CONFIG_CMD_DATE)
wdenkc6097192002-11-03 00:24:07 +0000882 CONFIG_VIDEO_LOGO display Linux logo in
883 upper left corner
wdenka6c7ad22002-12-03 21:28:10 +0000884 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of
885 linux_logo.h for logo.
886 Requires CONFIG_VIDEO_LOGO
wdenkc6097192002-11-03 00:24:07 +0000887 CONFIG_CONSOLE_EXTRA_INFO
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200888 additional board info beside
wdenkc6097192002-11-03 00:24:07 +0000889 the logo
890
Pali Rohár33a35bb2012-10-19 13:30:09 +0000891 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
892 a limited number of ANSI escape sequences (cursor control,
893 erase functions and limited graphics rendition control).
894
wdenk43d96162003-03-06 00:02:04 +0000895 When CONFIG_CFB_CONSOLE is defined, video console is
896 default i/o. Serial console can be forced with
897 environment 'console=serial'.
wdenkc6097192002-11-03 00:24:07 +0000898
wdenkd4ca31c2004-01-02 14:00:00 +0000899 When CONFIG_SILENT_CONSOLE is defined, all console
900 messages (by U-Boot and Linux!) can be silenced with
901 the "silent" environment variable. See
902 doc/README.silent for more information.
wdenka3ad8e22003-10-19 23:22:11 +0000903
Heiko Schocher45ae2542013-10-22 11:06:06 +0200904 CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
905 is 0x00.
906 CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
907 is 0xa0.
908
wdenkc6097192002-11-03 00:24:07 +0000909- Console Baudrate:
910 CONFIG_BAUDRATE - in bps
911 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +0200912 CONFIG_SYS_BAUDRATE_TABLE, see below.
913 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenkc6097192002-11-03 00:24:07 +0000914
Heiko Schocherc92fac92009-01-30 12:55:38 +0100915- Console Rx buffer length
916 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
917 the maximum receive buffer length for the SMC.
Heiko Schocher2b3f12c2009-02-10 09:31:47 +0100918 This option is actual only for 82xx and 8xx possible.
Heiko Schocherc92fac92009-01-30 12:55:38 +0100919 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
920 must be defined, to setup the maximum idle timeout for
921 the SMC.
922
Graeme Russ9558b482011-09-01 00:48:27 +0000923- Pre-Console Buffer:
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200924 Prior to the console being initialised (i.e. serial UART
925 initialised etc) all console output is silently discarded.
926 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
927 buffer any console messages prior to the console being
928 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
929 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
930 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
Wolfgang Denk6feff892011-10-09 21:06:34 +0200931 bytes are output before the console is initialised, the
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200932 earlier bytes are discarded.
Graeme Russ9558b482011-09-01 00:48:27 +0000933
Hans de Goedea8552c72015-05-05 13:13:36 +0200934 Note that when printing the buffer a copy is made on the
935 stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
936
Wolfgang Denk4cf26092011-10-07 09:58:21 +0200937 'Sane' compilers will generate smaller code if
938 CONFIG_PRE_CON_BUF_SZ is a power of 2
Graeme Russ9558b482011-09-01 00:48:27 +0000939
Sonny Rao046a37b2011-11-02 09:52:08 +0000940- Safe printf() functions
941 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
942 the printf() functions. These are defined in
943 include/vsprintf.h and include snprintf(), vsnprintf() and
944 so on. Code size increase is approximately 300-500 bytes.
945 If this option is not given then these functions will
946 silently discard their buffer size argument - this means
947 you are not getting any overflow checking in this case.
948
wdenkc6097192002-11-03 00:24:07 +0000949- Boot Delay: CONFIG_BOOTDELAY - in seconds
950 Delay before automatically booting the default image;
951 set to -1 to disable autoboot.
Joe Hershberger93d72122012-08-17 10:53:12 +0000952 set to -2 to autoboot with no delay and not check for abort
953 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenkc6097192002-11-03 00:24:07 +0000954
955 See doc/README.autoboot for these options that
956 work with CONFIG_BOOTDELAY. None are required.
957 CONFIG_BOOT_RETRY_TIME
958 CONFIG_BOOT_RETRY_MIN
959 CONFIG_AUTOBOOT_KEYED
960 CONFIG_AUTOBOOT_PROMPT
961 CONFIG_AUTOBOOT_DELAY_STR
962 CONFIG_AUTOBOOT_STOP_STR
wdenkc6097192002-11-03 00:24:07 +0000963 CONFIG_ZERO_BOOTDELAY_CHECK
964 CONFIG_RESET_TO_RETRY
965
966- Autoboot Command:
967 CONFIG_BOOTCOMMAND
968 Only needed when CONFIG_BOOTDELAY is enabled;
969 define a command string that is automatically executed
970 when no character is read on the console interface
971 within "Boot Delay" after reset.
972
973 CONFIG_BOOTARGS
wdenk43d96162003-03-06 00:02:04 +0000974 This can be used to pass arguments to the bootm
975 command. The value of CONFIG_BOOTARGS goes into the
976 environment value "bootargs".
wdenkc6097192002-11-03 00:24:07 +0000977
978 CONFIG_RAMBOOT and CONFIG_NFSBOOT
wdenk43d96162003-03-06 00:02:04 +0000979 The value of these goes into the environment as
980 "ramboot" and "nfsboot" respectively, and can be used
981 as a convenience, when switching between booting from
Marcel Ziswiler11ccc332008-07-09 08:17:15 +0200982 RAM and NFS.
wdenkc6097192002-11-03 00:24:07 +0000983
Heiko Schochereda0ba32013-11-04 14:04:59 +0100984- Bootcount:
985 CONFIG_BOOTCOUNT_LIMIT
986 Implements a mechanism for detecting a repeating reboot
987 cycle, see:
988 http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
989
990 CONFIG_BOOTCOUNT_ENV
991 If no softreset save registers are found on the hardware
992 "bootcount" is stored in the environment. To prevent a
993 saveenv on all reboots, the environment variable
994 "upgrade_available" is used. If "upgrade_available" is
995 0, "bootcount" is always 0, if "upgrade_available" is
996 1 "bootcount" is incremented in the environment.
997 So the Userspace Applikation must set the "upgrade_available"
998 and "bootcount" variable to 0, if a boot was successfully.
999
wdenkc6097192002-11-03 00:24:07 +00001000- Pre-Boot Commands:
1001 CONFIG_PREBOOT
1002
1003 When this option is #defined, the existence of the
1004 environment variable "preboot" will be checked
1005 immediately before starting the CONFIG_BOOTDELAY
1006 countdown and/or running the auto-boot command resp.
1007 entering interactive mode.
1008
1009 This feature is especially useful when "preboot" is
1010 automatically generated or modified. For an example
1011 see the LWMON board specific code: here "preboot" is
1012 modified when the user holds down a certain
1013 combination of keys on the (special) keyboard when
1014 booting the systems
1015
1016- Serial Download Echo Mode:
1017 CONFIG_LOADS_ECHO
1018 If defined to 1, all characters received during a
1019 serial download (using the "loads" command) are
1020 echoed back. This might be needed by some terminal
1021 emulations (like "cu"), but may as well just take
1022 time on others. This setting #define's the initial
1023 value of the "loads_echo" environment variable.
1024
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001025- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenkc6097192002-11-03 00:24:07 +00001026 CONFIG_KGDB_BAUDRATE
1027 Select one of the baudrates listed in
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001028 CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenkc6097192002-11-03 00:24:07 +00001029
1030- Monitor Functions:
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001031 Monitor commands can be included or excluded
1032 from the build by using the #include files
Stephen Warrenc6c621b2012-08-05 16:07:19 +00001033 <config_cmd_all.h> and #undef'ing unwanted
Joe Hershbergeref0f2f52015-06-22 16:15:30 -05001034 commands, or adding #define's for wanted commands.
wdenkc6097192002-11-03 00:24:07 +00001035
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001036 The default command configuration includes all commands
1037 except those marked below with a "*".
wdenkc6097192002-11-03 00:24:07 +00001038
Marek Vasutb401b732014-03-05 19:58:39 +01001039 CONFIG_CMD_AES AES 128 CBC encrypt/decrypt
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001040 CONFIG_CMD_ASKENV * ask for env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001041 CONFIG_CMD_BDI bdinfo
1042 CONFIG_CMD_BEDBUG * Include BedBug Debugger
1043 CONFIG_CMD_BMP * BMP support
1044 CONFIG_CMD_BSP * Board specific commands
1045 CONFIG_CMD_BOOTD bootd
Tom Rinid2b2ffe2014-08-14 06:42:36 -04001046 CONFIG_CMD_BOOTI * ARM64 Linux kernel Image support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001047 CONFIG_CMD_CACHE * icache, dcache
Michal Simek08d0d6f2013-11-21 13:39:02 -08001048 CONFIG_CMD_CLK * clock command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001049 CONFIG_CMD_CONSOLE coninfo
Mike Frysinger710b9932010-12-21 14:19:51 -05001050 CONFIG_CMD_CRC32 * crc32
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001051 CONFIG_CMD_DATE * support for RTC, date/time...
1052 CONFIG_CMD_DHCP * DHCP support
1053 CONFIG_CMD_DIAG * Diagnostics
Peter Tysera7c93102008-12-17 16:36:22 -06001054 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands
1055 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command
1056 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd
1057 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001058 CONFIG_CMD_DTT * Digital Therm and Thermostat
1059 CONFIG_CMD_ECHO echo arguments
Peter Tyser246c6922009-10-25 15:12:56 -05001060 CONFIG_CMD_EDITENV edit env variable
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001061 CONFIG_CMD_EEPROM * EEPROM read/write support
1062 CONFIG_CMD_ELF * bootelf, bootvx
Joe Hershberger5e2b3e02012-12-11 22:16:25 -06001063 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
Joe Hershbergerfffad712012-12-11 22:16:33 -06001064 CONFIG_CMD_ENV_FLAGS * display details about env flags
Andrew Ruder88733e22013-10-22 19:07:34 -05001065 CONFIG_CMD_ENV_EXISTS * check existence of env variable
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001066 CONFIG_CMD_EXPORTENV * export the environment
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001067 CONFIG_CMD_EXT2 * ext2 command support
1068 CONFIG_CMD_EXT4 * ext4 command support
Stephen Warren16f4d932014-01-24 20:46:37 -07001069 CONFIG_CMD_FS_GENERIC * filesystem commands (e.g. load, ls)
1070 that work for multiple fs types
Christian Gmeiner59e890e2014-11-12 14:35:04 +01001071 CONFIG_CMD_FS_UUID * Look up a filesystem UUID
Mike Frysingerbdab39d2009-01-28 19:08:14 -05001072 CONFIG_CMD_SAVEENV saveenv
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001073 CONFIG_CMD_FDC * Floppy Disk Support
Stephen Warren03e2ecf2012-10-22 06:43:50 +00001074 CONFIG_CMD_FAT * FAT command support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001075 CONFIG_CMD_FLASH flinfo, erase, protect
1076 CONFIG_CMD_FPGA FPGA device initialization support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001077 CONFIG_CMD_FUSE * Device fuse support
Anton Staaf53fdc7e2012-12-05 14:46:29 +00001078 CONFIG_CMD_GETTIME * Get time since boot
Mike Frysingera641b972010-12-26 23:32:22 -05001079 CONFIG_CMD_GO * the 'go' command (exec code)
Kim Phillipsa000b792011-04-05 07:15:14 +00001080 CONFIG_CMD_GREPENV * search environment
Simon Glassbf36c5d2012-12-05 14:46:38 +00001081 CONFIG_CMD_HASH * calculate hash / digest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001082 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control
1083 CONFIG_CMD_I2C * I2C serial bus support
1084 CONFIG_CMD_IDE * IDE harddisk support
1085 CONFIG_CMD_IMI iminfo
Vipin Kumar8fdf1e02012-12-16 22:32:48 +00001086 CONFIG_CMD_IMLS List all images found in NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001087 CONFIG_CMD_IMLS_NAND * List all images found in NAND flash
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001088 CONFIG_CMD_IMMAP * IMMR dump support
Simon Glassaa532332014-06-11 23:29:41 -06001089 CONFIG_CMD_IOTRACE * I/O tracing for debugging
Mike Frysinger0c79cda2010-12-26 23:09:45 -05001090 CONFIG_CMD_IMPORTENV * import an environment
Joe Hershbergerc167cc02012-10-03 11:15:51 +00001091 CONFIG_CMD_INI * import data from an ini file into the env
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001092 CONFIG_CMD_IRQ * irqinfo
1093 CONFIG_CMD_ITEST Integer/string test of 2 values
1094 CONFIG_CMD_JFFS2 * JFFS2 Support
1095 CONFIG_CMD_KGDB * kgdb
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001096 CONFIG_CMD_LDRINFO * ldrinfo (display Blackfin loader)
Joe Hershbergerd22c3382012-05-23 08:00:12 +00001097 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration
1098 (169.254.*.*)
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001099 CONFIG_CMD_LOADB loadb
1100 CONFIG_CMD_LOADS loads
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001101 CONFIG_CMD_MD5SUM * print md5 message digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001102 (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
Simon Glass15a33e42012-11-30 13:01:20 +00001103 CONFIG_CMD_MEMINFO * Display detailed memory information
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001104 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base,
Wolfgang Denka2681702013-03-08 10:51:32 +00001105 loop, loopw
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001106 CONFIG_CMD_MEMTEST * mtest
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001107 CONFIG_CMD_MISC Misc functions like sleep etc
1108 CONFIG_CMD_MMC * MMC memory mapped support
1109 CONFIG_CMD_MII * MII utility commands
Stefan Roese68d7d652009-03-19 13:30:36 +01001110 CONFIG_CMD_MTDPARTS * MTD partition support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001111 CONFIG_CMD_NAND * NAND support
1112 CONFIG_CMD_NET bootp, tftpboot, rarpboot
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001113 CONFIG_CMD_NFS NFS support
Peter Tysere92739d2008-12-17 16:36:21 -06001114 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands
Wolfgang Denkc0f40852011-10-26 10:21:21 +00001115 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001116 CONFIG_CMD_PCI * pciinfo
1117 CONFIG_CMD_PCMCIA * PCMCIA support
1118 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network
1119 host
1120 CONFIG_CMD_PORTIO * Port I/O
Kenneth Watersff048ea2012-12-05 14:46:30 +00001121 CONFIG_CMD_READ * Read raw data from partition
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001122 CONFIG_CMD_REGINFO * Register dump
1123 CONFIG_CMD_RUN run command in env variable
Simon Glassd3049312012-12-26 09:53:36 +00001124 CONFIG_CMD_SANDBOX * sb command to access sandbox features
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001125 CONFIG_CMD_SAVES * save S record dump
1126 CONFIG_CMD_SCSI * SCSI Support
1127 CONFIG_CMD_SDRAM * print SDRAM configuration information
1128 (requires CONFIG_CMD_I2C)
1129 CONFIG_CMD_SETGETDCR Support for DCR Register access
1130 (4xx only)
Eric Nelsonf61ec452012-01-31 10:52:08 -07001131 CONFIG_CMD_SF * Read/write/erase SPI NOR flash
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001132 CONFIG_CMD_SHA1SUM * print sha1 memory digest
Robin Getz02c9aa12009-07-27 00:07:59 -04001133 (requires CONFIG_CMD_MEMORY)
Bob Liu7d861d92013-02-05 19:05:41 +08001134 CONFIG_CMD_SOFTSWITCH * Soft switch setting command for BF60x
Wolfgang Denk74de7ae2009-04-01 23:34:12 +02001135 CONFIG_CMD_SOURCE "source" command Support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001136 CONFIG_CMD_SPI * SPI serial bus support
Luca Ceresoli7a83af02011-05-17 00:03:40 +00001137 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode
Simon Glass1fb7cd42011-10-24 18:00:07 +00001138 CONFIG_CMD_TFTPPUT * TFTP put command (upload)
Joe Hershbergerda83bcd2012-10-03 12:14:57 +00001139 CONFIG_CMD_TIME * run command and report execution time (ARM specific)
1140 CONFIG_CMD_TIMER * access to the system tick timer
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001141 CONFIG_CMD_USB * USB support
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001142 CONFIG_CMD_CDP * Cisco Discover Protocol support
Marek Vasutc8339f52012-03-31 07:47:16 +00001143 CONFIG_CMD_MFSL * Microblaze FSL support
Vincent Stehlé4d98b5c2013-06-20 18:14:22 +02001144 CONFIG_CMD_XIMG Load part of Multi Image
Przemyslaw Marczak89c82302014-04-02 10:20:05 +02001145 CONFIG_CMD_UUID * Generate random UUID or GUID string
wdenkc6097192002-11-03 00:24:07 +00001146
1147 EXAMPLE: If you want all functions except of network
1148 support you can write:
1149
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001150 #include "config_cmd_all.h"
1151 #undef CONFIG_CMD_NET
wdenkc6097192002-11-03 00:24:07 +00001152
Gerald Van Baren213bf8c2007-03-31 12:23:51 -04001153 Other Commands:
1154 fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenkc6097192002-11-03 00:24:07 +00001155
1156 Note: Don't enable the "icache" and "dcache" commands
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001157 (configuration option CONFIG_CMD_CACHE) unless you know
wdenk43d96162003-03-06 00:02:04 +00001158 what you (and your U-Boot users) are doing. Data
1159 cache cannot be enabled on systems like the 8xx or
1160 8260 (where accesses to the IMMR region must be
1161 uncached), and it cannot be disabled on all other
1162 systems where we (mis-) use the data cache to hold an
1163 initial stack and some data.
wdenkc6097192002-11-03 00:24:07 +00001164
1165
1166 XXX - this list needs to get updated!
1167
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001168- Regular expression support:
1169 CONFIG_REGEX
Wolfgang Denk93e14592013-10-04 17:43:24 +02001170 If this variable is defined, U-Boot is linked against
1171 the SLRE (Super Light Regular Expression) library,
1172 which adds regex support to some commands, as for
1173 example "env grep" and "setexpr".
Wolfgang Denka5ecbe62013-03-23 23:50:31 +00001174
Simon Glass45ba8072011-10-15 05:48:20 +00001175- Device tree:
1176 CONFIG_OF_CONTROL
1177 If this variable is defined, U-Boot will use a device tree
1178 to configure its devices, instead of relying on statically
1179 compiled #defines in the board file. This option is
1180 experimental and only available on a few boards. The device
1181 tree is available in the global data as gd->fdt_blob.
1182
Simon Glass2c0f79e2011-10-24 19:15:31 +00001183 U-Boot needs to get its device tree from somewhere. This can
1184 be done using one of the two options below:
Simon Glassbbb0b122011-10-15 05:48:21 +00001185
1186 CONFIG_OF_EMBED
1187 If this variable is defined, U-Boot will embed a device tree
1188 binary in its image. This device tree file should be in the
1189 board directory and called <soc>-<board>.dts. The binary file
1190 is then picked up in board_init_f() and made available through
1191 the global data structure as gd->blob.
Simon Glass45ba8072011-10-15 05:48:20 +00001192
Simon Glass2c0f79e2011-10-24 19:15:31 +00001193 CONFIG_OF_SEPARATE
1194 If this variable is defined, U-Boot will build a device tree
1195 binary. It will be called u-boot.dtb. Architecture-specific
1196 code will locate it at run-time. Generally this works by:
1197
1198 cat u-boot.bin u-boot.dtb >image.bin
1199
1200 and in fact, U-Boot does this for you, creating a file called
1201 u-boot-dtb.bin which is useful in the common case. You can
1202 still use the individual files if you need something more
1203 exotic.
1204
wdenkc6097192002-11-03 00:24:07 +00001205- Watchdog:
1206 CONFIG_WATCHDOG
1207 If this variable is defined, it enables watchdog
Detlev Zundel6abe6fb2011-04-27 05:25:59 +00001208 support for the SoC. There must be support in the SoC
1209 specific code for a watchdog. For the 8xx and 8260
1210 CPUs, the SIU Watchdog feature is enabled in the SYPCR
1211 register. When supported for a specific SoC is
1212 available, then no further board specific code should
1213 be needed to use it.
1214
1215 CONFIG_HW_WATCHDOG
1216 When using a watchdog circuitry external to the used
1217 SoC, then define this variable and provide board
1218 specific code for the "hw_watchdog_reset" function.
wdenkc6097192002-11-03 00:24:07 +00001219
Heiko Schocher7bae0d62015-01-21 08:38:22 +01001220 CONFIG_AT91_HW_WDT_TIMEOUT
1221 specify the timeout in seconds. default 2 seconds.
1222
stroesec1551ea2003-04-04 15:53:41 +00001223- U-Boot Version:
1224 CONFIG_VERSION_VARIABLE
1225 If this variable is defined, an environment variable
1226 named "ver" is created by U-Boot showing the U-Boot
1227 version as printed by the "version" command.
Benoît Thébaudeaua1ea8e52012-08-13 15:01:14 +02001228 Any change to this variable will be reverted at the
1229 next reset.
stroesec1551ea2003-04-04 15:53:41 +00001230
wdenkc6097192002-11-03 00:24:07 +00001231- Real-Time Clock:
1232
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001233 When CONFIG_CMD_DATE is selected, the type of the RTC
wdenkc6097192002-11-03 00:24:07 +00001234 has to be selected, too. Define exactly one of the
1235 following options:
1236
1237 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx
1238 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC
Fabio Estevam4e8b7542011-10-24 06:44:15 +00001239 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC
wdenkc6097192002-11-03 00:24:07 +00001240 CONFIG_RTC_MC146818 - use MC146818 RTC
wdenk1cb8e982003-03-06 21:55:29 +00001241 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC
wdenkc6097192002-11-03 00:24:07 +00001242 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC
wdenk7f70e852003-05-20 14:25:27 +00001243 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC
Markus Niebel412921d2014-07-21 11:06:16 +02001244 CONFIG_RTC_DS1339 - use Maxim, Inc. DS1339 RTC
wdenk3bac3512003-03-12 10:41:04 +00001245 CONFIG_RTC_DS164x - use Dallas DS164x RTC
Tor Krill9536dfc2008-03-15 15:40:26 +01001246 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC
wdenk4c0d4c32004-06-09 17:34:58 +00001247 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001248 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337
Heiko Schocher71d19f32011-03-28 09:24:22 +02001249 CONFIG_SYS_RV3029_TCR - enable trickle charger on
1250 RV3029 RTC.
wdenkc6097192002-11-03 00:24:07 +00001251
wdenkb37c7e52003-06-30 16:24:52 +00001252 Note that if the RTC uses I2C, then the I2C interface
1253 must also be configured. See I2C Support, below.
1254
Peter Tysere92739d2008-12-17 16:36:21 -06001255- GPIO Support:
1256 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO
Peter Tysere92739d2008-12-17 16:36:21 -06001257
Chris Packham5dec49c2010-12-19 10:12:13 +00001258 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
1259 chip-ngpio pairs that tell the PCA953X driver the number of
1260 pins supported by a particular chip.
1261
Peter Tysere92739d2008-12-17 16:36:21 -06001262 Note that if the GPIO device uses I2C, then the I2C interface
1263 must also be configured. See I2C Support, below.
1264
Simon Glassaa532332014-06-11 23:29:41 -06001265- I/O tracing:
1266 When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
1267 accesses and can checksum them or write a list of them out
1268 to memory. See the 'iotrace' command for details. This is
1269 useful for testing device drivers since it can confirm that
1270 the driver behaves the same way before and after a code
1271 change. Currently this is supported on sandbox and arm. To
1272 add support for your architecture, add '#include <iotrace.h>'
1273 to the bottom of arch/<arch>/include/asm/io.h and test.
1274
1275 Example output from the 'iotrace stats' command is below.
1276 Note that if the trace buffer is exhausted, the checksum will
1277 still continue to operate.
1278
1279 iotrace is enabled
1280 Start: 10000000 (buffer start address)
1281 Size: 00010000 (buffer size)
1282 Offset: 00000120 (current buffer offset)
1283 Output: 10000120 (start + offset)
1284 Count: 00000018 (number of trace records)
1285 CRC32: 9526fb66 (CRC32 of all trace records)
1286
wdenkc6097192002-11-03 00:24:07 +00001287- Timestamp Support:
1288
wdenk43d96162003-03-06 00:02:04 +00001289 When CONFIG_TIMESTAMP is selected, the timestamp
1290 (date and time) of an image is printed by image
1291 commands like bootm or iminfo. This option is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001292 automatically enabled when you select CONFIG_CMD_DATE .
wdenkc6097192002-11-03 00:24:07 +00001293
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001294- Partition Labels (disklabels) Supported:
1295 Zero or more of the following:
1296 CONFIG_MAC_PARTITION Apple's MacOS partition table.
1297 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the
1298 Intel architecture, USB sticks, etc.
1299 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc.
1300 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the
1301 bootloader. Note 2TB partition limit; see
1302 disk/part_efi.c
1303 CONFIG_MTD_PARTITIONS Memory Technology Device partition table.
wdenkc6097192002-11-03 00:24:07 +00001304
Wolfgang Denk218ca722008-03-26 10:40:12 +01001305 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1306 CONFIG_CMD_SCSI) you must configure support for at
Karl O. Pinc923c46f2012-08-16 06:20:15 +00001307 least one non-MTD partition type as well.
wdenkc6097192002-11-03 00:24:07 +00001308
1309- IDE Reset method:
wdenk4d13cba2004-03-14 14:09:05 +00001310 CONFIG_IDE_RESET_ROUTINE - this is defined in several
1311 board configurations files but used nowhere!
wdenkc6097192002-11-03 00:24:07 +00001312
wdenk4d13cba2004-03-14 14:09:05 +00001313 CONFIG_IDE_RESET - is this is defined, IDE Reset will
1314 be performed by calling the function
1315 ide_set_reset(int reset)
1316 which has to be defined in a board specific file
wdenkc6097192002-11-03 00:24:07 +00001317
1318- ATAPI Support:
1319 CONFIG_ATAPI
1320
1321 Set this to enable ATAPI support.
1322
wdenkc40b2952004-03-13 23:29:43 +00001323- LBA48 Support
1324 CONFIG_LBA48
1325
1326 Set this to enable support for disks larger than 137GB
Heiko Schocher4b142fe2009-12-03 11:21:21 +01001327 Also look at CONFIG_SYS_64BIT_LBA.
wdenkc40b2952004-03-13 23:29:43 +00001328 Whithout these , LBA48 support uses 32bit variables and will 'only'
1329 support disks up to 2.1TB.
1330
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001331 CONFIG_SYS_64BIT_LBA:
wdenkc40b2952004-03-13 23:29:43 +00001332 When enabled, makes the IDE subsystem use 64bit sector addresses.
1333 Default is 32bit.
1334
wdenkc6097192002-11-03 00:24:07 +00001335- SCSI Support:
1336 At the moment only there is only support for the
1337 SYM53C8XX SCSI controller; define
1338 CONFIG_SCSI_SYM53C8XX to enable it.
1339
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001340 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
1341 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
1342 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenkc6097192002-11-03 00:24:07 +00001343 maximum numbers of LUNs, SCSI ID's and target
1344 devices.
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001345 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenkc6097192002-11-03 00:24:07 +00001346
Wolfgang Denk93e14592013-10-04 17:43:24 +02001347 The environment variable 'scsidevs' is set to the number of
1348 SCSI devices found during the last scan.
Stefan Reinauer447c0312012-10-29 05:23:48 +00001349
wdenkc6097192002-11-03 00:24:07 +00001350- NETWORK Support (PCI):
wdenk682011f2003-06-03 23:54:09 +00001351 CONFIG_E1000
Kyle Moffettce5207e2011-10-18 11:05:29 +00001352 Support for Intel 8254x/8257x gigabit chips.
1353
1354 CONFIG_E1000_SPI
1355 Utility code for direct access to the SPI bus on Intel 8257x.
1356 This does not do anything useful unless you set at least one
1357 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1358
1359 CONFIG_E1000_SPI_GENERIC
1360 Allow generic access to the SPI bus on the Intel 8257x, for
1361 example with the "sspi" command.
1362
1363 CONFIG_CMD_E1000
1364 Management command for E1000 devices. When used on devices
1365 with SPI support you can reprogram the EEPROM from U-Boot.
stroese53cf9432003-06-05 15:39:44 +00001366
wdenkc6097192002-11-03 00:24:07 +00001367 CONFIG_EEPRO100
1368 Support for Intel 82557/82559/82559ER chips.
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001369 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenkc6097192002-11-03 00:24:07 +00001370 write routine for first time initialisation.
1371
1372 CONFIG_TULIP
1373 Support for Digital 2114x chips.
1374 Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1375 modem chip initialisation (KS8761/QS6611).
1376
1377 CONFIG_NATSEMI
1378 Support for National dp83815 chips.
1379
1380 CONFIG_NS8382X
1381 Support for National dp8382[01] gigabit chips.
1382
wdenk45219c42003-05-12 21:50:16 +00001383- NETWORK Support (other):
1384
Jens Scharsigc041e9d2010-01-23 12:03:45 +01001385 CONFIG_DRIVER_AT91EMAC
1386 Support for AT91RM9200 EMAC.
1387
1388 CONFIG_RMII
1389 Define this to use reduced MII inteface
1390
1391 CONFIG_DRIVER_AT91EMAC_QUIET
1392 If this defined, the driver is quiet.
1393 The driver doen't show link status messages.
1394
Rob Herringefdd7312011-12-15 11:15:49 +00001395 CONFIG_CALXEDA_XGMAC
1396 Support for the Calxeda XGMAC device
1397
Ashok3bb46d22012-10-15 06:20:47 +00001398 CONFIG_LAN91C96
wdenk45219c42003-05-12 21:50:16 +00001399 Support for SMSC's LAN91C96 chips.
1400
1401 CONFIG_LAN91C96_BASE
1402 Define this to hold the physical address
1403 of the LAN91C96's I/O space
1404
1405 CONFIG_LAN91C96_USE_32_BIT
1406 Define this to enable 32 bit addressing
1407
Ashok3bb46d22012-10-15 06:20:47 +00001408 CONFIG_SMC91111
wdenkf39748a2004-06-09 13:37:52 +00001409 Support for SMSC's LAN91C111 chip
1410
1411 CONFIG_SMC91111_BASE
1412 Define this to hold the physical address
1413 of the device (I/O space)
1414
1415 CONFIG_SMC_USE_32_BIT
1416 Define this if data bus is 32 bits
1417
1418 CONFIG_SMC_USE_IOFUNCS
1419 Define this to use i/o functions instead of macros
1420 (some hardware wont work with macros)
1421
Heiko Schocherdc02bad2011-11-15 10:00:04 -05001422 CONFIG_DRIVER_TI_EMAC
1423 Support for davinci emac
1424
1425 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1426 Define this if you have more then 3 PHYs.
1427
Macpaul Linb3dbf4a52010-12-21 16:59:46 +08001428 CONFIG_FTGMAC100
1429 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1430
1431 CONFIG_FTGMAC100_EGIGA
1432 Define this to use GE link update with gigabit PHY.
1433 Define this if FTGMAC100 is connected to gigabit PHY.
1434 If your system has 10/100 PHY only, it might not occur
1435 wrong behavior. Because PHY usually return timeout or
1436 useless data when polling gigabit status and gigabit
1437 control registers. This behavior won't affect the
1438 correctnessof 10/100 link speed update.
1439
Mike Rapoportc2fff332009-11-11 10:03:03 +02001440 CONFIG_SMC911X
Jens Gehrlein557b3772008-05-05 14:06:11 +02001441 Support for SMSC's LAN911x and LAN921x chips
1442
Mike Rapoportc2fff332009-11-11 10:03:03 +02001443 CONFIG_SMC911X_BASE
Jens Gehrlein557b3772008-05-05 14:06:11 +02001444 Define this to hold the physical address
1445 of the device (I/O space)
1446
Mike Rapoportc2fff332009-11-11 10:03:03 +02001447 CONFIG_SMC911X_32_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001448 Define this if data bus is 32 bits
1449
Mike Rapoportc2fff332009-11-11 10:03:03 +02001450 CONFIG_SMC911X_16_BIT
Jens Gehrlein557b3772008-05-05 14:06:11 +02001451 Define this if data bus is 16 bits. If your processor
1452 automatically converts one 32 bit word to two 16 bit
Mike Rapoportc2fff332009-11-11 10:03:03 +02001453 words you may also try CONFIG_SMC911X_32_BIT.
Jens Gehrlein557b3772008-05-05 14:06:11 +02001454
Yoshihiro Shimoda3d0075f2011-01-27 10:06:03 +09001455 CONFIG_SH_ETHER
1456 Support for Renesas on-chip Ethernet controller
1457
1458 CONFIG_SH_ETHER_USE_PORT
1459 Define the number of ports to be used
1460
1461 CONFIG_SH_ETHER_PHY_ADDR
1462 Define the ETH PHY's address
1463
Yoshihiro Shimoda68260aa2011-01-27 10:06:08 +09001464 CONFIG_SH_ETHER_CACHE_WRITEBACK
1465 If this option is set, the driver enables cache flush.
1466
Heiko Schocherb2f97cf2014-07-18 06:07:19 +02001467- PWM Support:
1468 CONFIG_PWM_IMX
1469 Support for PWM modul on the imx6.
1470
Vadim Bendebury5e124722011-10-17 08:36:14 +00001471- TPM Support:
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001472 CONFIG_TPM
1473 Support TPM devices.
1474
Christophe Ricard0766ad22015-10-06 22:54:41 +02001475 CONFIG_TPM_TIS_INFINEON
1476 Support for Infineon i2c bus TPM devices. Only one device
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001477 per system is supported at this time.
1478
Tom Wai-Hong Tam1b393db2013-04-12 11:04:37 +00001479 CONFIG_TPM_TIS_I2C_BURST_LIMITATION
1480 Define the burst count bytes upper limit
1481
Dirk Eibachc01939c2013-06-26 15:55:15 +02001482 CONFIG_TPM_ATMEL_TWI
1483 Support for Atmel TWI TPM device. Requires I2C support.
1484
Che-liang Chiou90899cc2013-04-12 11:04:34 +00001485 CONFIG_TPM_TIS_LPC
Vadim Bendebury5e124722011-10-17 08:36:14 +00001486 Support for generic parallel port TPM devices. Only one device
1487 per system is supported at this time.
1488
1489 CONFIG_TPM_TIS_BASE_ADDRESS
1490 Base address where the generic TPM device is mapped
1491 to. Contemporary x86 systems usually map it at
1492 0xfed40000.
1493
Reinhard Pfaube6c1522013-06-26 15:55:13 +02001494 CONFIG_CMD_TPM
1495 Add tpm monitor functions.
1496 Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1497 provides monitor access to authorized functions.
1498
1499 CONFIG_TPM
1500 Define this to enable the TPM support library which provides
1501 functional interfaces to some TPM commands.
1502 Requires support for a TPM device.
1503
1504 CONFIG_TPM_AUTH_SESSIONS
1505 Define this to enable authorized functions in the TPM library.
1506 Requires CONFIG_TPM and CONFIG_SHA1.
1507
wdenkc6097192002-11-03 00:24:07 +00001508- USB Support:
1509 At the moment only the UHCI host controller is
wdenk4d13cba2004-03-14 14:09:05 +00001510 supported (PIP405, MIP405, MPC5200); define
wdenkc6097192002-11-03 00:24:07 +00001511 CONFIG_USB_UHCI to enable it.
1512 define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk30d56fa2004-10-09 22:44:59 +00001513 and define CONFIG_USB_STORAGE to enable the USB
wdenkc6097192002-11-03 00:24:07 +00001514 storage devices.
1515 Note:
1516 Supported are USB Keyboards and USB Floppy drives
1517 (TEAC FD-05PUB).
wdenk4d13cba2004-03-14 14:09:05 +00001518 MPC5200 USB requires additional defines:
1519 CONFIG_USB_CLOCK
1520 for 528 MHz Clock: 0x0001bbbb
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001521 CONFIG_PSC3_USB
1522 for USB on PSC3
wdenk4d13cba2004-03-14 14:09:05 +00001523 CONFIG_USB_CONFIG
1524 for differential drivers: 0x00001000
1525 for single ended drivers: 0x00005000
Eric Millbrandt307ecb62009-08-13 08:32:37 -05001526 for differential drivers on PSC3: 0x00000100
1527 for single ended drivers on PSC3: 0x00004100
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001528 CONFIG_SYS_USB_EVENT_POLL
Zhang Weifdcfaa12007-06-06 10:08:13 +02001529 May be defined to allow interrupt polling
1530 instead of using asynchronous interrupts
wdenk4d13cba2004-03-14 14:09:05 +00001531
Simon Glass9ab4ce22012-02-27 10:52:47 +00001532 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
1533 txfilltuning field in the EHCI controller on reset.
1534
Oleksandr Tymoshenko6e9e0622014-02-01 21:51:25 -07001535 CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
1536 HW module registers.
1537
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001538- USB Device:
1539 Define the below if you wish to use the USB console.
1540 Once firmware is rebuilt from a serial console issue the
1541 command "setenv stdin usbtty; setenv stdout usbtty" and
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001542 attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001543 it has found a new device. The environment variable usbtty
1544 can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk386eda02006-06-14 18:14:56 +02001545 appear to a USB host as a Linux gserial device or a
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001546 Common Device Class Abstract Control Model serial device.
1547 If you select usbtty = gserial you should be able to enumerate
1548 a Linux host by
1549 # modprobe usbserial vendor=0xVendorID product=0xProductID
1550 else if using cdc_acm, simply setting the environment
1551 variable usbtty to be cdc_acm should suffice. The following
1552 might be defined in YourBoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001553
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001554 CONFIG_USB_DEVICE
1555 Define this to build a UDC device
wdenkc6097192002-11-03 00:24:07 +00001556
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001557 CONFIG_USB_TTY
1558 Define this to have a tty type of device available to
1559 talk to the UDC device
Wolfgang Denk386eda02006-06-14 18:14:56 +02001560
Vipin KUMARf9da0f82012-03-26 15:38:06 +05301561 CONFIG_USBD_HS
1562 Define this to enable the high speed support for usb
1563 device and usbtty. If this feature is enabled, a routine
1564 int is_usbd_high_speed(void)
1565 also needs to be defined by the driver to dynamically poll
1566 whether the enumeration has succeded at high speed or full
1567 speed.
1568
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001569 CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001570 Define this if you want stdin, stdout &/or stderr to
1571 be set to usbtty.
1572
1573 mpc8xx:
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001574 CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001575 Derive USB clock from external clock "blah"
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001576 - CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk386eda02006-06-14 18:14:56 +02001577
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001578 CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001579 Derive USB clock from brgclk
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001580 - CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001581
Wolfgang Denk386eda02006-06-14 18:14:56 +02001582 If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001583 define your own vendor specific values either in BoardName.h
Wolfgang Denk386eda02006-06-14 18:14:56 +02001584 or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001585 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
1586 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
1587 should pretend to be a Linux device to it's target host.
1588
1589 CONFIG_USBD_MANUFACTURER
1590 Define this string as the name of your company for
1591 - CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk386eda02006-06-14 18:14:56 +02001592
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001593 CONFIG_USBD_PRODUCT_NAME
1594 Define this string as the name of your product
1595 - CONFIG_USBD_PRODUCT_NAME "acme usb device"
1596
1597 CONFIG_USBD_VENDORID
1598 Define this as your assigned Vendor ID from the USB
1599 Implementors Forum. This *must* be a genuine Vendor ID
1600 to avoid polluting the USB namespace.
1601 - CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk386eda02006-06-14 18:14:56 +02001602
Wolfgang Denk16c8d5e2006-06-14 17:45:53 +02001603 CONFIG_USBD_PRODUCTID
1604 Define this as the unique Product ID
1605 for your device
1606 - CONFIG_USBD_PRODUCTID 0xFFFF
wdenkc6097192002-11-03 00:24:07 +00001607
Igor Grinbergd70a5602011-12-12 12:08:35 +02001608- ULPI Layer Support:
1609 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1610 the generic ULPI layer. The generic layer accesses the ULPI PHY
1611 via the platform viewport, so you need both the genric layer and
1612 the viewport enabled. Currently only Chipidea/ARC based
1613 viewport is supported.
1614 To enable the ULPI layer support, define CONFIG_USB_ULPI and
1615 CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
Lucas Stach6d365ea2012-10-01 00:44:35 +02001616 If your ULPI phy needs a different reference clock than the
1617 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
1618 the appropriate value in Hz.
wdenkc6097192002-11-03 00:24:07 +00001619
1620- MMC Support:
1621 The MMC controller on the Intel PXA is supported. To
1622 enable this define CONFIG_MMC. The MMC can be
1623 accessed from the boot prompt by mapping the device
1624 to physical memory similar to flash. Command line is
Jon Loeliger602ad3b2007-06-11 19:03:39 -05001625 enabled with CONFIG_CMD_MMC. The MMC driver also works with
1626 the FAT fs. This is enabled with CONFIG_CMD_FAT.
wdenkc6097192002-11-03 00:24:07 +00001627
Yoshihiro Shimodaafb35662011-07-04 22:21:22 +00001628 CONFIG_SH_MMCIF
1629 Support for Renesas on-chip MMCIF controller
1630
1631 CONFIG_SH_MMCIF_ADDR
1632 Define the base address of MMCIF registers
1633
1634 CONFIG_SH_MMCIF_CLK
1635 Define the clock frequency for MMCIF
1636
Pierre Aubert1fd93c62014-04-24 10:30:08 +02001637 CONFIG_GENERIC_MMC
1638 Enable the generic MMC driver
1639
1640 CONFIG_SUPPORT_EMMC_BOOT
1641 Enable some additional features of the eMMC boot partitions.
1642
1643 CONFIG_SUPPORT_EMMC_RPMB
1644 Enable the commands for reading, writing and programming the
1645 key for the Replay Protection Memory Block partition in eMMC.
1646
Tom Rinib3ba6e92013-03-14 05:32:47 +00001647- USB Device Firmware Update (DFU) class support:
Paul Kocialkowski01acd6a2015-06-12 19:56:58 +02001648 CONFIG_USB_FUNCTION_DFU
Tom Rinib3ba6e92013-03-14 05:32:47 +00001649 This enables the USB portion of the DFU USB class
1650
1651 CONFIG_CMD_DFU
1652 This enables the command "dfu" which is used to have
1653 U-Boot create a DFU class device via USB. This command
1654 requires that the "dfu_alt_info" environment variable be
1655 set and define the alt settings to expose to the host.
1656
1657 CONFIG_DFU_MMC
1658 This enables support for exposing (e)MMC devices via DFU.
1659
Pantelis Antoniouc6631762013-03-14 05:32:52 +00001660 CONFIG_DFU_NAND
1661 This enables support for exposing NAND devices via DFU.
1662
Afzal Mohammeda9479f02013-09-18 01:15:24 +05301663 CONFIG_DFU_RAM
1664 This enables support for exposing RAM via DFU.
1665 Note: DFU spec refer to non-volatile memory usage, but
1666 allow usages beyond the scope of spec - here RAM usage,
1667 one that would help mostly the developer.
1668
Heiko Schochere7e75c72013-06-12 06:05:51 +02001669 CONFIG_SYS_DFU_DATA_BUF_SIZE
1670 Dfu transfer uses a buffer before writing data to the
1671 raw storage device. Make the size (in bytes) of this buffer
1672 configurable. The size of this buffer is also configurable
1673 through the "dfu_bufsiz" environment variable.
1674
Pantelis Antoniouea2453d2013-03-14 05:32:48 +00001675 CONFIG_SYS_DFU_MAX_FILE_SIZE
1676 When updating files rather than the raw storage device,
1677 we use a static buffer to copy the file into and then write
1678 the buffer once we've been given the whole file. Define
1679 this to the maximum filesize (in bytes) for the buffer.
1680 Default is 4 MiB if undefined.
1681
Heiko Schocher001a8312014-03-18 08:09:56 +01001682 DFU_DEFAULT_POLL_TIMEOUT
1683 Poll timeout [ms], is the timeout a device can send to the
1684 host. The host must wait for this timeout before sending
1685 a subsequent DFU_GET_STATUS request to the device.
1686
1687 DFU_MANIFEST_POLL_TIMEOUT
1688 Poll timeout [ms], which the device sends to the host when
1689 entering dfuMANIFEST state. Host waits this timeout, before
1690 sending again an USB request to the device.
1691
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001692- USB Device Android Fastboot support:
Paul Kocialkowski17da3c02015-06-12 19:56:59 +02001693 CONFIG_USB_FUNCTION_FASTBOOT
1694 This enables the USB part of the fastboot gadget
1695
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001696 CONFIG_CMD_FASTBOOT
1697 This enables the command "fastboot" which enables the Android
1698 fastboot mode for the platform's USB device. Fastboot is a USB
1699 protocol for downloading images, flashing and device control
1700 used on Android devices.
1701 See doc/README.android-fastboot for more information.
1702
1703 CONFIG_ANDROID_BOOT_IMAGE
1704 This enables support for booting images which use the Android
1705 image format header.
1706
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001707 CONFIG_FASTBOOT_BUF_ADDR
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001708 The fastboot protocol requires a large memory buffer for
1709 downloads. Define this to the starting RAM address to use for
1710 downloaded images.
1711
Paul Kocialkowskia588d992015-07-20 12:38:22 +02001712 CONFIG_FASTBOOT_BUF_SIZE
Sebastian Siewior3aab70a2014-05-05 15:08:10 -05001713 The fastboot protocol requires a large memory buffer for
1714 downloads. This buffer should be as large as possible for a
1715 platform. Define this to the size available RAM for fastboot.
1716
Steve Raed1b5ed02014-08-26 11:47:28 -07001717 CONFIG_FASTBOOT_FLASH
1718 The fastboot protocol includes a "flash" command for writing
1719 the downloaded image to a non-volatile storage device. Define
1720 this to enable the "fastboot flash" command.
1721
1722 CONFIG_FASTBOOT_FLASH_MMC_DEV
1723 The fastboot "flash" command requires additional information
1724 regarding the non-volatile storage device. Define this to
1725 the eMMC device that fastboot should use to store the image.
1726
Steve Rae0ff7e582014-12-12 15:51:54 -08001727 CONFIG_FASTBOOT_GPT_NAME
1728 The fastboot "flash" command supports writing the downloaded
1729 image to the Protective MBR and the Primary GUID Partition
1730 Table. (Additionally, this downloaded image is post-processed
1731 to generate and write the Backup GUID Partition Table.)
1732 This occurs when the specified "partition name" on the
1733 "fastboot flash" command line matches this value.
1734 Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
1735
wdenk6705d812004-08-02 23:22:59 +00001736- Journaling Flash filesystem support:
1737 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
1738 CONFIG_JFFS2_NAND_DEV
1739 Define these for a default partition on a NAND device
1740
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001741 CONFIG_SYS_JFFS2_FIRST_SECTOR,
1742 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk6705d812004-08-02 23:22:59 +00001743 Define these for a default partition on a NOR device
1744
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001745 CONFIG_SYS_JFFS_CUSTOM_PART
wdenk6705d812004-08-02 23:22:59 +00001746 Define this to create an own partition. You have to provide a
1747 function struct part_info* jffs2_part_info(int part_num)
1748
1749 If you define only one JFFS2 partition you may also want to
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001750 #define CONFIG_SYS_JFFS_SINGLE_PART 1
wdenk6705d812004-08-02 23:22:59 +00001751 to disable the command chpart. This is the default when you
1752 have not defined a custom partition
1753
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001754- FAT(File Allocation Table) filesystem write function support:
1755 CONFIG_FAT_WRITE
Donggeun Kim656f4c62012-03-22 04:38:56 +00001756
1757 Define this to enable support for saving memory data as a
1758 file in FAT formatted partition.
1759
1760 This will also enable the command "fatwrite" enabling the
1761 user to write files to FAT.
Donggeun Kimc30a15e2011-10-24 21:15:28 +00001762
Gabe Black84cd9322012-10-12 14:26:11 +00001763CBFS (Coreboot Filesystem) support
1764 CONFIG_CMD_CBFS
1765
1766 Define this to enable support for reading from a Coreboot
1767 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
1768 and cbfsload.
1769
Siva Durga Prasad Paladugu4f0d1a22014-05-26 19:18:37 +05301770- FAT(File Allocation Table) filesystem cluster size:
1771 CONFIG_FS_FAT_MAX_CLUSTSIZE
1772
1773 Define the max cluster size for fat operations else
1774 a default value of 65536 will be defined.
1775
wdenkc6097192002-11-03 00:24:07 +00001776- Keyboard Support:
1777 CONFIG_ISA_KEYBOARD
1778
1779 Define this to enable standard (PC-Style) keyboard
1780 support
1781
1782 CONFIG_I8042_KBD
1783 Standard PC keyboard driver with US (is default) and
1784 GERMAN key layout (switch via environment 'keymap=de') support.
1785 Export function i8042_kbd_init, i8042_tstc and i8042_getc
1786 for cfb_console. Supports cursor blinking.
1787
Hung-ying Tyan713cb682013-05-15 18:27:32 +08001788 CONFIG_CROS_EC_KEYB
1789 Enables a Chrome OS keyboard using the CROS_EC interface.
1790 This uses CROS_EC to communicate with a second microcontroller
1791 which provides key scans on request.
1792
wdenkc6097192002-11-03 00:24:07 +00001793- Video support:
1794 CONFIG_VIDEO
1795
1796 Define this to enable video support (for output to
1797 video).
1798
1799 CONFIG_VIDEO_CT69000
1800
1801 Enable Chips & Technologies 69000 Video chip
1802
1803 CONFIG_VIDEO_SMI_LYNXEM
wdenkb79a11c2004-03-25 15:14:43 +00001804 Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenkeeb1b772004-03-23 22:53:55 +00001805 video output is selected via environment 'videoout'
1806 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
1807 assumed.
wdenkc6097192002-11-03 00:24:07 +00001808
wdenkb79a11c2004-03-25 15:14:43 +00001809 For the CT69000 and SMI_LYNXEM drivers, videomode is
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02001810 selected via environment 'videomode'. Two different ways
wdenkeeb1b772004-03-23 22:53:55 +00001811 are possible:
1812 - "videomode=num" 'num' is a standard LiLo mode numbers.
wdenk6e592382004-04-18 17:39:38 +00001813 Following standard modes are supported (* is default):
wdenkeeb1b772004-03-23 22:53:55 +00001814
1815 Colors 640x480 800x600 1024x768 1152x864 1280x1024
1816 -------------+---------------------------------------------
1817 8 bits | 0x301* 0x303 0x305 0x161 0x307
1818 15 bits | 0x310 0x313 0x316 0x162 0x319
1819 16 bits | 0x311 0x314 0x317 0x163 0x31A
1820 24 bits | 0x312 0x315 0x318 ? 0x31B
1821 -------------+---------------------------------------------
wdenkc6097192002-11-03 00:24:07 +00001822 (i.e. setenv videomode 317; saveenv; reset;)
1823
wdenkb79a11c2004-03-25 15:14:43 +00001824 - "videomode=bootargs" all the video parameters are parsed
Marcel Ziswiler7817cb22007-12-30 03:30:46 +01001825 from the bootargs. (See drivers/video/videomodes.c)
wdenkeeb1b772004-03-23 22:53:55 +00001826
1827
stroesec1551ea2003-04-04 15:53:41 +00001828 CONFIG_VIDEO_SED13806
wdenk43d96162003-03-06 00:02:04 +00001829 Enable Epson SED13806 driver. This driver supports 8bpp
wdenka6c7ad22002-12-03 21:28:10 +00001830 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
1831 or CONFIG_VIDEO_SED13806_16BPP
1832
Timur Tabi7d3053f2011-02-15 17:09:19 -06001833 CONFIG_FSL_DIU_FB
Wolfgang Denk04e5ae72011-09-11 21:24:09 +02001834 Enable the Freescale DIU video driver. Reference boards for
Timur Tabi7d3053f2011-02-15 17:09:19 -06001835 SOCs that have a DIU should define this macro to enable DIU
1836 support, and should also define these other macros:
1837
1838 CONFIG_SYS_DIU_ADDR
1839 CONFIG_VIDEO
1840 CONFIG_CMD_BMP
1841 CONFIG_CFB_CONSOLE
1842 CONFIG_VIDEO_SW_CURSOR
1843 CONFIG_VGA_AS_SINGLE_DEVICE
1844 CONFIG_VIDEO_LOGO
1845 CONFIG_VIDEO_BMP_LOGO
1846
Timur Tabiba8e76b2011-04-11 14:18:22 -05001847 The DIU driver will look for the 'video-mode' environment
1848 variable, and if defined, enable the DIU as a console during
1849 boot. See the documentation file README.video for a
1850 description of this variable.
Timur Tabi7d3053f2011-02-15 17:09:19 -06001851
Simon Glass058d59b2012-12-03 13:59:47 +00001852
wdenk682011f2003-06-03 23:54:09 +00001853- Keyboard Support:
wdenk8bde7f72003-06-27 21:31:46 +00001854 CONFIG_KEYBOARD
wdenk682011f2003-06-03 23:54:09 +00001855
wdenk8bde7f72003-06-27 21:31:46 +00001856 Define this to enable a custom keyboard support.
1857 This simply calls drv_keyboard_init() which must be
1858 defined in your board-specific files.
1859 The only board using this so far is RBC823.
wdenka6c7ad22002-12-03 21:28:10 +00001860
wdenkc6097192002-11-03 00:24:07 +00001861- LCD Support: CONFIG_LCD
1862
1863 Define this to enable LCD support (for output to LCD
1864 display); also select one of the supported displays
1865 by defining one of these:
1866
Stelian Pop39cf4802008-05-09 21:57:18 +02001867 CONFIG_ATMEL_LCD:
1868
1869 HITACHI TX09D70VM1CCA, 3.5", 240x320.
1870
wdenkfd3103b2003-11-25 16:55:19 +00001871 CONFIG_NEC_NL6448AC33:
wdenkc6097192002-11-03 00:24:07 +00001872
wdenkfd3103b2003-11-25 16:55:19 +00001873 NEC NL6448AC33-18. Active, color, single scan.
wdenkc6097192002-11-03 00:24:07 +00001874
wdenkfd3103b2003-11-25 16:55:19 +00001875 CONFIG_NEC_NL6448BC20
wdenkc6097192002-11-03 00:24:07 +00001876
wdenkfd3103b2003-11-25 16:55:19 +00001877 NEC NL6448BC20-08. 6.5", 640x480.
1878 Active, color, single scan.
1879
1880 CONFIG_NEC_NL6448BC33_54
1881
1882 NEC NL6448BC33-54. 10.4", 640x480.
wdenkc6097192002-11-03 00:24:07 +00001883 Active, color, single scan.
1884
1885 CONFIG_SHARP_16x9
1886
1887 Sharp 320x240. Active, color, single scan.
1888 It isn't 16x9, and I am not sure what it is.
1889
1890 CONFIG_SHARP_LQ64D341
1891
1892 Sharp LQ64D341 display, 640x480.
1893 Active, color, single scan.
1894
1895 CONFIG_HLD1045
1896
1897 HLD1045 display, 640x480.
1898 Active, color, single scan.
1899
1900 CONFIG_OPTREX_BW
1901
1902 Optrex CBL50840-2 NF-FW 99 22 M5
1903 or
1904 Hitachi LMG6912RPFC-00T
1905 or
1906 Hitachi SP14Q002
1907
1908 320x240. Black & white.
1909
1910 Normally display is black on white background; define
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02001911 CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenkc6097192002-11-03 00:24:07 +00001912
Simon Glass676d3192012-10-17 13:24:54 +00001913 CONFIG_LCD_ALIGNMENT
1914
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08001915 Normally the LCD is page-aligned (typically 4KB). If this is
Simon Glass676d3192012-10-17 13:24:54 +00001916 defined then the LCD will be aligned to this value instead.
1917 For ARM it is sometimes useful to use MMU_SECTION_SIZE
1918 here, since it is cheaper to change data cache settings on
1919 a per-section basis.
1920
Simon Glass0d89efe2012-10-17 13:24:59 +00001921 CONFIG_CONSOLE_SCROLL_LINES
1922
1923 When the console need to be scrolled, this is the number of
1924 lines to scroll by. It defaults to 1. Increasing this makes
1925 the console jump but can help speed up operation when scrolling
1926 is slow.
Simon Glass676d3192012-10-17 13:24:54 +00001927
Hannes Petermaier604c7d42015-03-27 08:01:38 +01001928 CONFIG_LCD_ROTATION
1929
1930 Sometimes, for example if the display is mounted in portrait
1931 mode or even if it's mounted landscape but rotated by 180degree,
1932 we need to rotate our content of the display relative to the
1933 framebuffer, so that user can read the messages which are
1934 printed out.
1935 Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1936 initialized with a given rotation from "vl_rot" out of
1937 "vidinfo_t" which is provided by the board specific code.
1938 The value for vl_rot is coded as following (matching to
1939 fbcon=rotate:<n> linux-kernel commandline):
1940 0 = no rotation respectively 0 degree
1941 1 = 90 degree rotation
1942 2 = 180 degree rotation
1943 3 = 270 degree rotation
1944
1945 If CONFIG_LCD_ROTATION is not defined, the console will be
1946 initialized with 0degree rotation.
1947
Tom Wai-Hong Tam45d7f522012-09-28 15:11:16 +00001948 CONFIG_LCD_BMP_RLE8
1949
1950 Support drawing of RLE8-compressed bitmaps on the LCD.
1951
Tom Wai-Hong Tam735987c2012-12-05 14:46:40 +00001952 CONFIG_I2C_EDID
1953
1954 Enables an 'i2c edid' command which can read EDID
1955 information over I2C from an attached LCD display.
1956
wdenk7152b1d2003-09-05 23:19:14 +00001957- Splash Screen Support: CONFIG_SPLASH_SCREEN
wdenkd791b1d2003-04-20 14:04:18 +00001958
wdenk8bde7f72003-06-27 21:31:46 +00001959 If this option is set, the environment is checked for
1960 a variable "splashimage". If found, the usual display
1961 of logo, copyright and system information on the LCD
wdenke94d2cd2004-06-30 22:59:18 +00001962 is suppressed and the BMP image at the address
wdenk8bde7f72003-06-27 21:31:46 +00001963 specified in "splashimage" is loaded instead. The
1964 console is redirected to the "nulldev", too. This
1965 allows for a "silent" boot where a splash screen is
1966 loaded very quickly after power-on.
wdenkd791b1d2003-04-20 14:04:18 +00001967
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001968 CONFIG_SPLASHIMAGE_GUARD
1969
1970 If this option is set, then U-Boot will prevent the environment
1971 variable "splashimage" from being set to a problematic address
Tom Rini1551df32014-02-25 10:27:01 -05001972 (see README.displaying-bmps).
Nikita Kiryanovc0880482013-02-24 21:28:43 +00001973 This option is useful for targets where, due to alignment
1974 restrictions, an improperly aligned BMP image will cause a data
1975 abort. If you think you will not have problems with unaligned
1976 accesses (for example because your toolchain prevents them)
1977 there is no need to set this option.
1978
Matthias Weisser1ca298c2009-07-09 16:07:30 +02001979 CONFIG_SPLASH_SCREEN_ALIGN
1980
1981 If this option is set the splash image can be freely positioned
1982 on the screen. Environment variable "splashpos" specifies the
1983 position as "x,y". If a positive number is given it is used as
1984 number of pixel from left/top. If a negative number is given it
1985 is used as number of pixel from right/bottom. You can also
1986 specify 'm' for centering the image.
1987
1988 Example:
1989 setenv splashpos m,m
1990 => image at center of screen
1991
1992 setenv splashpos 30,20
1993 => image at x = 30 and y = 20
1994
1995 setenv splashpos -10,m
1996 => vertically centered image
1997 at x = dspWidth - bmpWidth - 9
1998
Stefan Roese98f4a3d2005-09-22 09:04:17 +02001999- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
2000
2001 If this option is set, additionally to standard BMP
2002 images, gzipped BMP images can be displayed via the
2003 splashscreen support or the bmp command.
2004
Anatolij Gustschind5011762010-03-15 14:50:25 +01002005- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
2006
2007 If this option is set, 8-bit RLE compressed BMP images
2008 can be displayed via the splashscreen support or the
2009 bmp command.
2010
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002011- Do compressing for memory range:
Lei Wenf2b96df2012-09-28 04:26:47 +00002012 CONFIG_CMD_ZIP
2013
2014 If this option is set, it would use zlib deflate method
2015 to compress the specified memory at its best effort.
2016
wdenkc29fdfc2003-08-29 20:57:53 +00002017- Compression support:
Kees Cook8ef70472013-08-16 07:59:12 -07002018 CONFIG_GZIP
2019
2020 Enabled by default to support gzip compressed images.
2021
wdenkc29fdfc2003-08-29 20:57:53 +00002022 CONFIG_BZIP2
2023
2024 If this option is set, support for bzip2 compressed
2025 images is included. If not, only uncompressed and gzip
2026 compressed images are supported.
2027
wdenk42d1f032003-10-15 23:53:47 +00002028 NOTE: the bzip2 algorithm requires a lot of RAM, so
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002029 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
wdenk42d1f032003-10-15 23:53:47 +00002030 be at least 4MB.
wdenkd791b1d2003-04-20 14:04:18 +00002031
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002032 CONFIG_LZMA
2033
2034 If this option is set, support for lzma compressed
2035 images is included.
2036
2037 Note: The LZMA algorithm adds between 2 and 4KB of code and it
2038 requires an amount of dynamic memory that is given by the
2039 formula:
2040
2041 (1846 + 768 << (lc + lp)) * sizeof(uint16)
2042
2043 Where lc and lp stand for, respectively, Literal context bits
2044 and Literal pos bits.
2045
2046 This value is upper-bounded by 14MB in the worst case. Anyway,
2047 for a ~4MB large kernel image, we have lc=3 and lp=0 for a
2048 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
2049 a very small buffer.
2050
2051 Use the lzmainfo tool to determinate the lc and lp values and
2052 then calculate the amount of needed dynamic memory (ensuring
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +02002053 the appropriate CONFIG_SYS_MALLOC_LEN value).
Luigi 'Comio' Mantellinifc9c1722008-09-08 02:46:13 +02002054
Kees Cook8ef70472013-08-16 07:59:12 -07002055 CONFIG_LZO
2056
2057 If this option is set, support for LZO compressed images
2058 is included.
2059
wdenk17ea1172004-06-06 21:51:03 +00002060- MII/PHY support:
2061 CONFIG_PHY_ADDR
2062
2063 The address of PHY on MII bus.
2064
2065 CONFIG_PHY_CLOCK_FREQ (ppc4xx)
2066
2067 The clock frequency of the MII bus
2068
2069 CONFIG_PHY_GIGE
2070
2071 If this option is set, support for speed/duplex
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002072 detection of gigabit PHY is included.
wdenk17ea1172004-06-06 21:51:03 +00002073
2074 CONFIG_PHY_RESET_DELAY
2075
2076 Some PHY like Intel LXT971A need extra delay after
2077 reset before any MII register access is possible.
2078 For such PHY, set this option to the usec delay
2079 required. (minimum 300usec for LXT971A)
2080
2081 CONFIG_PHY_CMD_DELAY (ppc4xx)
2082
2083 Some PHY like Intel LXT971A need extra delay after
2084 command issued before MII status register can be read
2085
wdenkc6097192002-11-03 00:24:07 +00002086- IP address:
2087 CONFIG_IPADDR
2088
2089 Define a default value for the IP address to use for
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002090 the default Ethernet interface, in case this is not
wdenkc6097192002-11-03 00:24:07 +00002091 determined through e.g. bootp.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002092 (Environment variable "ipaddr")
wdenkc6097192002-11-03 00:24:07 +00002093
2094- Server IP address:
2095 CONFIG_SERVERIP
2096
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002097 Defines a default value for the IP address of a TFTP
wdenkc6097192002-11-03 00:24:07 +00002098 server to contact when using the "tftboot" command.
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002099 (Environment variable "serverip")
wdenkc6097192002-11-03 00:24:07 +00002100
Robin Getz97cfe862009-07-21 12:15:28 -04002101 CONFIG_KEEP_SERVERADDR
2102
2103 Keeps the server's MAC address, in the env 'serveraddr'
2104 for passing to bootargs (like Linux's netconsole option)
2105
Wolfgang Denk1ebcd652011-10-26 10:21:22 +00002106- Gateway IP address:
2107 CONFIG_GATEWAYIP
2108
2109 Defines a default value for the IP address of the
2110 default router where packets to other networks are
2111 sent to.
2112 (Environment variable "gatewayip")
2113
2114- Subnet mask:
2115 CONFIG_NETMASK
2116
2117 Defines a default value for the subnet mask (or
2118 routing prefix) which is used to determine if an IP
2119 address belongs to the local subnet or needs to be
2120 forwarded through a router.
2121 (Environment variable "netmask")
2122
David Updegraff53a5c422007-06-11 10:41:07 -05002123- Multicast TFTP Mode:
2124 CONFIG_MCAST_TFTP
2125
2126 Defines whether you want to support multicast TFTP as per
2127 rfc-2090; for example to work with atftp. Lets lots of targets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002128 tftp down the same boot image concurrently. Note: the Ethernet
David Updegraff53a5c422007-06-11 10:41:07 -05002129 driver in use must provide a function: mcast() to join/leave a
2130 multicast group.
2131
wdenkc6097192002-11-03 00:24:07 +00002132- BOOTP Recovery Mode:
2133 CONFIG_BOOTP_RANDOM_DELAY
2134
2135 If you have many targets in a network that try to
2136 boot using BOOTP, you may want to avoid that all
2137 systems send out BOOTP requests at precisely the same
2138 moment (which would happen for instance at recovery
2139 from a power failure, when all systems will try to
2140 boot, thus flooding the BOOTP server. Defining
2141 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
2142 inserted before sending out BOOTP requests. The
Wolfgang Denk6c33c782007-08-06 23:21:05 +02002143 following delays are inserted then:
wdenkc6097192002-11-03 00:24:07 +00002144
2145 1st BOOTP request: delay 0 ... 1 sec
2146 2nd BOOTP request: delay 0 ... 2 sec
2147 3rd BOOTP request: delay 0 ... 4 sec
2148 4th and following
2149 BOOTP requests: delay 0 ... 8 sec
2150
Thierry Reding92ac8ac2014-08-19 10:21:24 +02002151 CONFIG_BOOTP_ID_CACHE_SIZE
2152
2153 BOOTP packets are uniquely identified using a 32-bit ID. The
2154 server will copy the ID from client requests to responses and
2155 U-Boot will use this to determine if it is the destination of
2156 an incoming response. Some servers will check that addresses
2157 aren't in use before handing them out (usually using an ARP
2158 ping) and therefore take up to a few hundred milliseconds to
2159 respond. Network congestion may also influence the time it
2160 takes for a response to make it back to the client. If that
2161 time is too long, U-Boot will retransmit requests. In order
2162 to allow earlier responses to still be accepted after these
2163 retransmissions, U-Boot's BOOTP client keeps a small cache of
2164 IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
2165 cache. The default is to keep IDs for up to four outstanding
2166 requests. Increasing this will allow U-Boot to accept offers
2167 from a BOOTP client in networks with unusually high latency.
2168
stroesefe389a82003-08-28 14:17:32 +00002169- DHCP Advanced Options:
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002170 You can fine tune the DHCP functionality by defining
2171 CONFIG_BOOTP_* symbols:
stroesefe389a82003-08-28 14:17:32 +00002172
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002173 CONFIG_BOOTP_SUBNETMASK
2174 CONFIG_BOOTP_GATEWAY
2175 CONFIG_BOOTP_HOSTNAME
2176 CONFIG_BOOTP_NISDOMAIN
2177 CONFIG_BOOTP_BOOTPATH
2178 CONFIG_BOOTP_BOOTFILESIZE
2179 CONFIG_BOOTP_DNS
2180 CONFIG_BOOTP_DNS2
2181 CONFIG_BOOTP_SEND_HOSTNAME
2182 CONFIG_BOOTP_NTPSERVER
2183 CONFIG_BOOTP_TIMEOFFSET
2184 CONFIG_BOOTP_VENDOREX
Joe Hershberger2c00e092012-05-23 07:59:19 +00002185 CONFIG_BOOTP_MAY_FAIL
stroesefe389a82003-08-28 14:17:32 +00002186
Wilson Callan5d110f02007-07-28 10:56:13 -04002187 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
2188 environment variable, not the BOOTP server.
stroesefe389a82003-08-28 14:17:32 +00002189
Joe Hershberger2c00e092012-05-23 07:59:19 +00002190 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
2191 after the configured retry count, the call will fail
2192 instead of starting over. This can be used to fail over
2193 to Link-local IP address configuration if the DHCP server
2194 is not available.
2195
stroesefe389a82003-08-28 14:17:32 +00002196 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
2197 serverip from a DHCP server, it is possible that more
2198 than one DNS serverip is offered to the client.
2199 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
2200 serverip will be stored in the additional environment
2201 variable "dnsip2". The first DNS serverip is always
2202 stored in the variable "dnsip", when CONFIG_BOOTP_DNS
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002203 is defined.
stroesefe389a82003-08-28 14:17:32 +00002204
2205 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
2206 to do a dynamic update of a DNS server. To do this, they
2207 need the hostname of the DHCP requester.
Wilson Callan5d110f02007-07-28 10:56:13 -04002208 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
Jon Loeliger1fe80d72007-07-09 22:08:34 -05002209 of the "hostname" environment variable is passed as
2210 option 12 to the DHCP server.
stroesefe389a82003-08-28 14:17:32 +00002211
Aras Vaichasd9a2f412008-03-26 09:43:57 +11002212 CONFIG_BOOTP_DHCP_REQUEST_DELAY
2213
2214 A 32bit value in microseconds for a delay between
2215 receiving a "DHCP Offer" and sending the "DHCP Request".
2216 This fixes a problem with certain DHCP servers that don't
2217 respond 100% of the time to a "DHCP request". E.g. On an
2218 AT91RM9200 processor running at 180MHz, this delay needed
2219 to be *at least* 15,000 usec before a Windows Server 2003
2220 DHCP server would reply 100% of the time. I recommend at
2221 least 50,000 usec to be safe. The alternative is to hope
2222 that one of the retries will be successful but note that
2223 the DHCP timeout and retry process takes a longer than
2224 this delay.
2225
Joe Hershbergerd22c3382012-05-23 08:00:12 +00002226 - Link-local IP address negotiation:
2227 Negotiate with other link-local clients on the local network
2228 for an address that doesn't require explicit configuration.
2229 This is especially useful if a DHCP server cannot be guaranteed
2230 to exist in all environments that the device must operate.
2231
2232 See doc/README.link-local for more information.
2233
wdenka3d991b2004-04-15 21:48:45 +00002234 - CDP Options:
wdenk6e592382004-04-18 17:39:38 +00002235 CONFIG_CDP_DEVICE_ID
wdenka3d991b2004-04-15 21:48:45 +00002236
2237 The device id used in CDP trigger frames.
2238
2239 CONFIG_CDP_DEVICE_ID_PREFIX
2240
2241 A two character string which is prefixed to the MAC address
2242 of the device.
2243
2244 CONFIG_CDP_PORT_ID
2245
2246 A printf format string which contains the ascii name of
2247 the port. Normally is set to "eth%d" which sets
Marcel Ziswiler11ccc332008-07-09 08:17:15 +02002248 eth0 for the first Ethernet, eth1 for the second etc.
wdenka3d991b2004-04-15 21:48:45 +00002249
2250 CONFIG_CDP_CAPABILITIES
2251
2252 A 32bit integer which indicates the device capabilities;
2253 0x00000010 for a normal host which does not forwards.
2254
2255 CONFIG_CDP_VERSION
2256
2257 An ascii string containing the version of the software.
2258
2259 CONFIG_CDP_PLATFORM
2260
2261 An ascii string containing the name of the platform.
2262
2263 CONFIG_CDP_TRIGGER
2264
2265 A 32bit integer sent on the trigger.
2266
2267 CONFIG_CDP_POWER_CONSUMPTION
2268
2269 A 16bit integer containing the power consumption of the
2270 device in .1 of milliwatts.
2271
2272 CONFIG_CDP_APPLIANCE_VLAN_TYPE
2273
2274 A byte containing the id of the VLAN.
2275
wdenkc6097192002-11-03 00:24:07 +00002276- Status LED: CONFIG_STATUS_LED
2277
2278 Several configurations allow to display the current
2279 status using a LED. For instance, the LED will blink
2280 fast while running U-Boot code, stop blinking as
2281 soon as a reply to a BOOTP request was received, and
2282 start blinking slow once the Linux kernel is running
2283 (supported by a status LED driver in the Linux
2284 kernel). Defining CONFIG_STATUS_LED enables this
2285 feature in U-Boot.
2286
Igor Grinberg1df7bbb2013-11-08 01:03:50 +02002287 Additional options:
2288
2289 CONFIG_GPIO_LED
2290 The status LED can be connected to a GPIO pin.
2291 In such cases, the gpio_led driver can be used as a
2292 status LED backend implementation. Define CONFIG_GPIO_LED
2293 to include the gpio_led driver in the U-Boot binary.
2294
Igor Grinberg9dfdcdf2013-11-08 01:03:52 +02002295 CONFIG_GPIO_LED_INVERTED_TABLE
2296 Some GPIO connected LEDs may have inverted polarity in which
2297 case the GPIO high value corresponds to LED off state and
2298 GPIO low value corresponds to LED on state.
2299 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
2300 with a list of GPIO LEDs that have inverted polarity.
2301
wdenkc6097192002-11-03 00:24:07 +00002302- CAN Support: CONFIG_CAN_DRIVER
2303
2304 Defining CONFIG_CAN_DRIVER enables CAN driver support
2305 on those systems that support this (optional)
2306 feature, like the TQM8xxL modules.
2307
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002308- I2C Support: CONFIG_SYS_I2C
wdenkc6097192002-11-03 00:24:07 +00002309
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002310 This enable the NEW i2c subsystem, and will allow you to use
2311 i2c commands at the u-boot command line (as long as you set
2312 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
2313 based realtime clock chips or other i2c devices. See
2314 common/cmd_i2c.c for a description of the command line
2315 interface.
2316
2317 ported i2c driver to the new framework:
Heiko Schocherea818db2013-01-29 08:53:15 +01002318 - drivers/i2c/soft_i2c.c:
2319 - activate first bus with CONFIG_SYS_I2C_SOFT define
2320 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
2321 for defining speed and slave address
2322 - activate second bus with I2C_SOFT_DECLARATIONS2 define
2323 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
2324 for defining speed and slave address
2325 - activate third bus with I2C_SOFT_DECLARATIONS3 define
2326 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
2327 for defining speed and slave address
2328 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
2329 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
2330 for defining speed and slave address
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002331
Heiko Schocher00f792e2012-10-24 13:48:22 +02002332 - drivers/i2c/fsl_i2c.c:
2333 - activate i2c driver with CONFIG_SYS_I2C_FSL
2334 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
2335 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
2336 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
2337 bus.
Wolfgang Denk93e14592013-10-04 17:43:24 +02002338 - If your board supports a second fsl i2c bus, define
Heiko Schocher00f792e2012-10-24 13:48:22 +02002339 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
2340 CONFIG_SYS_FSL_I2C2_SPEED for the speed and
2341 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
2342 second bus.
2343
Simon Glass1f2ba722012-10-30 07:28:53 +00002344 - drivers/i2c/tegra_i2c.c:
Nobuhiro Iwamatsu10cee512013-10-11 16:23:53 +09002345 - activate this driver with CONFIG_SYS_I2C_TEGRA
2346 - This driver adds 4 i2c buses with a fix speed from
2347 100000 and the slave addr 0!
Simon Glass1f2ba722012-10-30 07:28:53 +00002348
Dirk Eibach880540d2013-04-25 02:40:01 +00002349 - drivers/i2c/ppc4xx_i2c.c
2350 - activate this driver with CONFIG_SYS_I2C_PPC4XX
2351 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
2352 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
2353
tremfac96402013-09-21 18:13:35 +02002354 - drivers/i2c/i2c_mxc.c
2355 - activate this driver with CONFIG_SYS_I2C_MXC
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002356 - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
2357 - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
2358 - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
2359 - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
tremfac96402013-09-21 18:13:35 +02002360 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
2361 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
2362 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
2363 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
2364 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
2365 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
Albert ARIBAUD \\(3ADEV\\)03544c62015-09-21 22:43:38 +02002366 - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
2367 - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002368 If those defines are not set, default value is 100000
tremfac96402013-09-21 18:13:35 +02002369 for speed, and 0 for slave.
2370
Nobuhiro Iwamatsu1086bfa2013-09-27 16:58:30 +09002371 - drivers/i2c/rcar_i2c.c:
2372 - activate this driver with CONFIG_SYS_I2C_RCAR
2373 - This driver adds 4 i2c buses
2374
2375 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
2376 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
2377 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
2378 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
2379 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
2380 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
2381 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
2382 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
2383 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
2384
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002385 - drivers/i2c/sh_i2c.c:
2386 - activate this driver with CONFIG_SYS_I2C_SH
2387 - This driver adds from 2 to 5 i2c buses
2388
2389 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
2390 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
2391 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
2392 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
2393 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
2394 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
2395 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
2396 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
2397 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
2398 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2399 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
2400 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002401 - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
Nobuhiro Iwamatsu2035d772013-10-29 13:33:51 +09002402
Heiko Schocher6789e842013-10-22 11:03:18 +02002403 - drivers/i2c/omap24xx_i2c.c
2404 - activate this driver with CONFIG_SYS_I2C_OMAP24XX
2405 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
2406 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
2407 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
2408 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
2409 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
2410 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
2411 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
2412 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
2413 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
2414 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
2415
Heiko Schocher0bdffe72013-11-08 07:30:53 +01002416 - drivers/i2c/zynq_i2c.c
2417 - activate this driver with CONFIG_SYS_I2C_ZYNQ
2418 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
2419 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
2420
Naveen Krishna Che717fc62013-12-06 12:12:38 +05302421 - drivers/i2c/s3c24x0_i2c.c:
2422 - activate this driver with CONFIG_SYS_I2C_S3C24X0
2423 - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2424 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2425 with a fix speed from 100000 and the slave addr 0!
2426
Dirk Eibachb46226b2014-07-03 09:28:18 +02002427 - drivers/i2c/ihs_i2c.c
2428 - activate this driver with CONFIG_SYS_I2C_IHS
2429 - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2430 - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2431 - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2432 - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2433 - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2434 - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2435 - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2436 - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2437 - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2438 - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2439 - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2440 - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2441
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002442 additional defines:
2443
2444 CONFIG_SYS_NUM_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002445 Hold the number of i2c buses you want to use. If you
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002446 don't use/have i2c muxes on your i2c bus, this
2447 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
2448 omit this define.
2449
2450 CONFIG_SYS_I2C_DIRECT_BUS
2451 define this, if you don't use i2c muxes on your hardware.
2452 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
2453 omit this define.
2454
2455 CONFIG_SYS_I2C_MAX_HOPS
2456 define how many muxes are maximal consecutively connected
2457 on one i2c bus. If you not use i2c muxes, omit this
2458 define.
2459
2460 CONFIG_SYS_I2C_BUSES
Jeremiah Mahlerb445bbb2015-01-04 18:56:50 -08002461 hold a list of buses you want to use, only used if
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002462 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
2463 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
2464 CONFIG_SYS_NUM_I2C_BUSES = 9:
2465
2466 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \
2467 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
2468 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
2469 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
2470 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
2471 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
2472 {1, {I2C_NULL_HOP}}, \
2473 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
2474 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
2475 }
2476
2477 which defines
2478 bus 0 on adapter 0 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002479 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2480 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2481 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2482 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2483 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002484 bus 6 on adapter 1 without a mux
Heiko Schocherea818db2013-01-29 08:53:15 +01002485 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2486 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002487
2488 If you do not have i2c muxes on your board, omit this define.
2489
Heiko Schocherea818db2013-01-29 08:53:15 +01002490- Legacy I2C Support: CONFIG_HARD_I2C
Heiko Schocher3f4978c2012-01-16 21:12:24 +00002491
2492 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
2493 provides the following compelling advantages:
2494
2495 - more than one i2c adapter is usable
2496 - approved multibus support
2497 - better i2c mux support
2498
2499 ** Please consider updating your I2C driver now. **
2500
Heiko Schocherea818db2013-01-29 08:53:15 +01002501 These enable legacy I2C serial bus commands. Defining
2502 CONFIG_HARD_I2C will include the appropriate I2C driver
2503 for the selected CPU.
wdenkc6097192002-11-03 00:24:07 +00002504
wdenk945af8d2003-07-16 21:53:01 +00002505 This will allow you to use i2c commands at the u-boot
Jon Loeliger602ad3b2007-06-11 19:03:39 -05002506 command line (as long as you set CONFIG_CMD_I2C in
wdenkb37c7e52003-06-30 16:24:52 +00002507 CONFIG_COMMANDS) and communicate with i2c based realtime
2508 clock chips. See common/cmd_i2c.c for a description of the
wdenk43d96162003-03-06 00:02:04 +00002509 command line interface.
wdenkc6097192002-11-03 00:24:07 +00002510
Ben Warrenbb99ad62006-09-07 16:50:54 -04002511 CONFIG_HARD_I2C selects a hardware I2C controller.
wdenkc6097192002-11-03 00:24:07 +00002512
wdenk945af8d2003-07-16 21:53:01 +00002513 There are several other quantities that must also be
Heiko Schocherea818db2013-01-29 08:53:15 +01002514 defined when you define CONFIG_HARD_I2C.
wdenkc6097192002-11-03 00:24:07 +0000